oci 2.0.5 → 2.0.6

data/lib/oci/identity/models/update_user_details.rb

@@ -8,14 +8,16 @@ module OCI
     # @return [String]
     attr_accessor :description
 
-    # Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
-    # Example: `{\"bar-key\": \"value\"}`
+    # Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
+    # For more information, see [Resource Tags](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
+    # Example: `{\"Department\": \"Finance\"}`
     # 
     # @return [Hash<String, String>]
     attr_accessor :freeform_tags
 
-    # Usage of predefined tag keys. These predefined keys are scoped to namespaces.
-    # Example: `{\"foo-namespace\": {\"bar-key\": \"foo-value\"}}`
+    # Defined tags for this resource. Each key is predefined and scoped to a namespace.
+    # For more information, see [Resource Tags](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
+    # Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
     # 
     # @return [Hash<String, Hash<String, Object>>]
     attr_accessor :defined_tags
@@ -23,6 +25,9 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :description The value to assign to the {#description} property
+    # @option attributes [Hash<String, String>] :freeformTags The value to assign to the {#freeform_tags} property
+    # @option attributes [Hash<String, Hash<String, Object>>] :definedTags The value to assign to the {#defined_tags} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

data/lib/oci/identity/models/user.rb

@@ -3,6 +3,23 @@
 require 'date'
 
 module OCI
+  # An individual employee or system that needs to manage or use your company's Oracle Cloud Infrastructure
+  # resources. Users might need to launch instances, manage remote disks, work with your cloud network, etc. Users
+  # have one or more IAM Service credentials ({ApiKey},
+  # {UIPassword}, and {SwiftPassword}).
+  # For more information, see [User Credentials](https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/usercredentials.htm)). End users of your
+  # application are not typically IAM Service users. For conceptual information about users and other IAM Service
+  # components, see [Overview of the IAM Service](https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/overview.htm).
+  #
+  # These users are created directly within the Oracle Cloud Infrastructure system, via the IAM service.
+  # They are different from *federated users*, who authenticate themselves to the Oracle Cloud Infrastructure
+  # Console via an identity provider. For more information, see
+  # [Identity Providers and Federation](https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/federation.htm).
+  #
+  # To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized,
+  # talk to an administrator. If you're an administrator who needs to write policies to give users access,
+  # see [Getting Started with Policies](https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm).
+  #
   class Identity::Models::User
 
     LIFECYCLE_STATE_ENUM = [LIFECYCLE_STATE_CREATING = 'CREATING',
@@ -12,32 +29,32 @@ module OCI
                 LIFECYCLE_STATE_DELETED = 'DELETED',
                 LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']
 
-    # The OCID of the user.
+    # **[Required]** The OCID of the user.
     # @return [String]
     attr_accessor :id
 
-    # The OCID of the tenancy containing the user.
+    # **[Required]** The OCID of the tenancy containing the user.
     # @return [String]
     attr_accessor :compartment_id
 
-    # The name you assign to the user during creation. This is the user's login for the Console. 
+    # **[Required]** The name you assign to the user during creation. This is the user's login for the Console.
     # The name must be unique across all users in the tenancy and cannot be changed.
     # 
     # @return [String]
     attr_accessor :name
 
-    # The description you assign to the user. Does not have to be unique, and it's changeable.
+    # **[Required]** The description you assign to the user. Does not have to be unique, and it's changeable.
     # @return [String]
     attr_accessor :description
 
-    # Date and time the user was created, in the format defined by RFC3339.
+    # **[Required]** Date and time the user was created, in the format defined by RFC3339.
     # 
     # Example: `2016-08-25T21:10:29.600Z`
     # 
     # @return [DateTime]
     attr_accessor :time_created
 
-    # The user's current state. After creating a user, make sure its `lifecycleState` changes from CREATING to
+    # **[Required]** The user's current state. After creating a user, make sure its `lifecycleState` changes from CREATING to
     # ACTIVE before using it.
     # 
     # @return [String]
@@ -53,15 +70,16 @@ module OCI
     # @return [Integer]
     attr_accessor :inactive_status
 
-    # Simple key-value pair that is applied without any predefined name, type or scope. Exists solely for
-    # compatibility with other cloud provider tagging schemes.
-    # Example: `{\"bar-key\": \"value\"}`
+    # Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
+    # For more information, see [Resource Tags](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
+    # Example: `{\"Department\": \"Finance\"}`
     # 
     # @return [Hash<String, String>]
     attr_accessor :freeform_tags
 
-    # Usage of predefined tag keys. These predefined keys are scoped to namespaces.
-    # Example: `{\"foo-namespace\": {\"bar-key\": \"foo-value\"}}`
+    # Defined tags for this resource. Each key is predefined and scoped to a namespace.
+    # For more information, see [Resource Tags](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
+    # Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
     # 
     # @return [Hash<String, Hash<String, Object>>]
     attr_accessor :defined_tags
@@ -69,6 +87,15 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :id The value to assign to the {#id} property
+    # @option attributes [String] :compartmentId The value to assign to the {#compartment_id} property
+    # @option attributes [String] :name The value to assign to the {#name} property
+    # @option attributes [String] :description The value to assign to the {#description} property
+    # @option attributes [DateTime] :timeCreated The value to assign to the {#time_created} property
+    # @option attributes [String] :lifecycleState The value to assign to the {#lifecycle_state} property
+    # @option attributes [Integer] :inactiveStatus The value to assign to the {#inactive_status} property
+    # @option attributes [Hash<String, String>] :freeformTags The value to assign to the {#freeform_tags} property
+    # @option attributes [Hash<String, Hash<String, Object>>] :definedTags The value to assign to the {#defined_tags} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

data/lib/oci/identity/models/user_group_membership.rb

@@ -3,6 +3,9 @@
 require 'date'
 
 module OCI
+  # An object that represents the membership of a user in a group. When you add a user to a group, the result is a
+  # `UserGroupMembership` with its own OCID. To remove a user from a group, you delete the `UserGroupMembership` object.
+  #
   class Identity::Models::UserGroupMembership
 
     LIFECYCLE_STATE_ENUM = [LIFECYCLE_STATE_CREATING = 'CREATING',
@@ -12,30 +15,30 @@ module OCI
                 LIFECYCLE_STATE_DELETED = 'DELETED',
                 LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']
 
-    # The OCID of the membership.
+    # **[Required]** The OCID of the membership.
     # @return [String]
     attr_accessor :id
 
-    # The OCID of the tenancy containing the user, group, and membership object.
+    # **[Required]** The OCID of the tenancy containing the user, group, and membership object.
     # @return [String]
     attr_accessor :compartment_id
 
-    # The OCID of the group.
+    # **[Required]** The OCID of the group.
     # @return [String]
     attr_accessor :group_id
 
-    # The OCID of the user.
+    # **[Required]** The OCID of the user.
     # @return [String]
     attr_accessor :user_id
 
-    # Date and time the membership was created, in the format defined by RFC3339.
+    # **[Required]** Date and time the membership was created, in the format defined by RFC3339.
     # 
     # Example: `2016-08-25T21:10:29.600Z`
     # 
     # @return [DateTime]
     attr_accessor :time_created
 
-    # The membership's current state.  After creating a membership object, make sure its `lifecycleState` changes
+    # **[Required]** The membership's current state.  After creating a membership object, make sure its `lifecycleState` changes
     # from CREATING to ACTIVE before using it.
     # 
     # @return [String]
@@ -48,6 +51,13 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :id The value to assign to the {#id} property
+    # @option attributes [String] :compartmentId The value to assign to the {#compartment_id} property
+    # @option attributes [String] :groupId The value to assign to the {#group_id} property
+    # @option attributes [String] :userId The value to assign to the {#user_id} property
+    # @option attributes [DateTime] :timeCreated The value to assign to the {#time_created} property
+    # @option attributes [String] :lifecycleState The value to assign to the {#lifecycle_state} property
+    # @option attributes [Integer] :inactiveStatus The value to assign to the {#inactive_status} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

data/lib/oci/load_balancer/load_balancer.rb

@@ -16,6 +16,7 @@ require 'oci/load_balancer/models/backend_set_details'
 require 'oci/load_balancer/models/backend_set_health'
 require 'oci/load_balancer/models/certificate'
 require 'oci/load_balancer/models/certificate_details'
+require 'oci/load_balancer/models/connection_configuration'
 require 'oci/load_balancer/models/create_backend_details'
 require 'oci/load_balancer/models/create_backend_set_details'
 require 'oci/load_balancer/models/create_certificate_details'

data/lib/oci/load_balancer/load_balancer_client.rb

@@ -28,15 +28,29 @@ module OCI
     # @param [Config] config A Config object.
     # @param [String] region A region used to determine the service endpoint. This will usually
     #   correspond to a value in {OCI::Regions::REGION_ENUM}, but may be an arbitrary string.
-    #
-    def initialize(config:nil, region:nil)
-      config ||= OCI.config
-      config.validate
+    # @param [OCI::BaseSigner] signer A signer implementation which can be used by this client. If this is not provided then
+    #   a signer will be constructed via the provided config. One use case of this parameter is instance principals authentication,
+    #   so that the instance principals signer can be provided to the client
+    def initialize(config:nil, region:nil, signer:nil)
+      # If the signer is an InstancePrincipalsSecurityTokenSigner and no config was supplied (which is valid for instance principals)
+      # then create a dummy config to pass to the ApiClient constructor. If customers wish to create a client which uses instance principals
+      # and has config (either populated programmatically or loaded from a file), they must construct that config themselves and then
+      # pass it to this constructor.
+      #
+      # If there is no signer (or the signer is not an instance principals signer) and no config was supplied, this is not valid
+      # so try and load the config from the default file.
+      config ||= OCI.config unless signer.is_a?(OCI::Auth::Signers::InstancePrincipalsSecurityTokenSigner)
+      config ||= OCI::Config.new if signer.is_a?(OCI::Auth::Signers::InstancePrincipalsSecurityTokenSigner)
+      config.validate unless signer.is_a?(OCI::Auth::Signers::InstancePrincipalsSecurityTokenSigner)
+
+      if signer.nil?
+        signer = Signer.new(config.user, config.fingerprint, config.tenancy, config.key_file, pass_phrase: config.pass_phrase, private_key_content: config.key_content, signing_strategy: Signer::STANDARD)
+      end
 
-      signer = Signer.new(config.user, config.fingerprint, config.tenancy, config.key_file, pass_phrase: config.pass_phrase, private_key_content: config.key_content, signing_strategy: Signer::STANDARD)
       @api_client = ApiClient.new(config, signer)
 
       region ||= config.region
+      region ||= signer.region if signer.respond_to?(:region)
       self.region = region
     end
 
@@ -990,15 +1004,16 @@ module OCI
     #   
     #   Example: `full`
     #    (default to full)
-    # @option opts [String] :sort_by The field to sort by.  Only one sort order may be provided.  Time created is default ordered as descending.  Display name is default ordered as ascending.
+    # @option opts [String] :sort_by The field to sort by.  You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending.
+    #   Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.
     #   
     #   Allowed values are: TIMECREATED, DISPLAYNAME
-    # @option opts [String] :sort_order The sort order to use, either 'asc' or 'desc'
+    # @option opts [String] :sort_order The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive.
     #   
     #   Allowed values are: ASC, DESC
-    # @option opts [String] :display_name A filter to only return resources that match the given display name exactly.
+    # @option opts [String] :display_name A filter to return only resources that match the given display name exactly.
     #   
-    # @option opts [String] :lifecycle_state A filter to only return resources that match the given lifecycle state.
+    # @option opts [String] :lifecycle_state A filter to return only resources that match the given lifecycle state.
     #   
     # @return [Response] A Response object with data of type Array<OCI::LoadBalancer::Models::LoadBalancer>
     def list_load_balancers(compartment_id, opts = {})

data/lib/oci/load_balancer/models/backend.rb

@@ -3,8 +3,11 @@
 require 'date'
 
 module OCI
+  # The configuration of a backend server that is a member of a load balancer backend set.
+  # For more information, see [Managing Backend Servers](https://docs.us-phoenix-1.oraclecloud.com/Content/Balance/Tasks/managingbackendservers.htm).
+  #
   class LoadBalancer::Models::Backend
-    # Whether the load balancer should treat this server as a backup unit. If `true`, the load balancer forwards no ingress
+    # **[Required]** Whether the load balancer should treat this server as a backup unit. If `true`, the load balancer forwards no ingress
     # traffic to this backend server unless all other backend servers not marked as \"backup\" fail the health check policy.
     # 
     # Example: `true`
@@ -12,7 +15,7 @@ module OCI
     # @return [BOOLEAN]
     attr_accessor :backup
 
-    # Whether the load balancer should drain this server. Servers marked \"drain\" receive no new
+    # **[Required]** Whether the load balancer should drain this server. Servers marked \"drain\" receive no new
     # incoming traffic.
     # 
     # Example: `true`
@@ -20,21 +23,21 @@ module OCI
     # @return [BOOLEAN]
     attr_accessor :drain
 
-    # The IP address of the backend server.
+    # **[Required]** The IP address of the backend server.
     # 
     # Example: `10.10.10.4`
     # 
     # @return [String]
     attr_accessor :ip_address
 
-    # A read-only field showing the IP address and port that uniquely identify this backend server in the backend set.
+    # **[Required]** A read-only field showing the IP address and port that uniquely identify this backend server in the backend set.
     # 
     # Example: `10.10.10.4:8080`
     # 
     # @return [String]
     attr_accessor :name
 
-    # Whether the load balancer should treat this server as offline. Offline servers receive no incoming
+    # **[Required]** Whether the load balancer should treat this server as offline. Offline servers receive no incoming
     # traffic.
     # 
     # Example: `true`
@@ -42,14 +45,14 @@ module OCI
     # @return [BOOLEAN]
     attr_accessor :offline
 
-    # The communication port for the backend server.
+    # **[Required]** The communication port for the backend server.
     # 
     # Example: `8080`
     # 
     # @return [Integer]
     attr_accessor :port
 
-    # The load balancing policy weight assigned to the server. Backend servers with a higher weight receive a larger
+    # **[Required]** The load balancing policy weight assigned to the server. Backend servers with a higher weight receive a larger
     # proportion of incoming traffic. For example, a server weighted '3' receives 3 times the number of new connections
     # as a server weighted '1'.
     # For more information on load balancing policies, see
@@ -63,19 +66,26 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [BOOLEAN] :backup The value to assign to the {#backup} property
+    # @option attributes [BOOLEAN] :drain The value to assign to the {#drain} property
+    # @option attributes [String] :ipAddress The value to assign to the {#ip_address} property
+    # @option attributes [String] :name The value to assign to the {#name} property
+    # @option attributes [BOOLEAN] :offline The value to assign to the {#offline} property
+    # @option attributes [Integer] :port The value to assign to the {#port} property
+    # @option attributes [Integer] :weight The value to assign to the {#weight} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
 
-      if attributes[:'backup']
+      unless attributes[:'backup'].nil?
         self.backup = attributes[:'backup']
       else
         self.backup = false
       end
 
-      if attributes[:'drain']
+      unless attributes[:'drain'].nil?
         self.drain = attributes[:'drain']
       else
         self.drain = false
@@ -89,7 +99,7 @@ module OCI
         self.name = attributes[:'name']
       end
 
-      if attributes[:'offline']
+      unless attributes[:'offline'].nil?
         self.offline = attributes[:'offline']
       else
         self.offline = false

data/lib/oci/load_balancer/models/backend_details.rb

@@ -3,6 +3,7 @@
 require 'date'
 
 module OCI
+  # The load balancing configuration details of a backend server.
   class LoadBalancer::Models::BackendDetails
     # Whether the load balancer should treat this server as a backup unit. If `true`, the load balancer forwards no ingress
     # traffic to this backend server unless all other backend servers not marked as \"backup\" fail the health check policy.
@@ -20,7 +21,7 @@ module OCI
     # @return [BOOLEAN]
     attr_accessor :drain
 
-    # The IP address of the backend server.
+    # **[Required]** The IP address of the backend server.
     # 
     # Example: `10.10.10.4`
     # 
@@ -35,7 +36,7 @@ module OCI
     # @return [BOOLEAN]
     attr_accessor :offline
 
-    # The communication port for the backend server.
+    # **[Required]** The communication port for the backend server.
     # 
     # Example: `8080`
     # 
@@ -56,19 +57,25 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [BOOLEAN] :backup The value to assign to the {#backup} property
+    # @option attributes [BOOLEAN] :drain The value to assign to the {#drain} property
+    # @option attributes [String] :ipAddress The value to assign to the {#ip_address} property
+    # @option attributes [BOOLEAN] :offline The value to assign to the {#offline} property
+    # @option attributes [Integer] :port The value to assign to the {#port} property
+    # @option attributes [Integer] :weight The value to assign to the {#weight} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
 
-      if attributes[:'backup']
+      unless attributes[:'backup'].nil?
         self.backup = attributes[:'backup']
       else
         self.backup = false
       end
 
-      if attributes[:'drain']
+      unless attributes[:'drain'].nil?
         self.drain = attributes[:'drain']
       else
         self.drain = false
@@ -78,7 +85,7 @@ module OCI
         self.ip_address = attributes[:'ipAddress']
       end
 
-      if attributes[:'offline']
+      unless attributes[:'offline'].nil?
         self.offline = attributes[:'offline']
       else
         self.offline = false

data/lib/oci/load_balancer/models/backend_health.rb

@@ -3,6 +3,8 @@
 require 'date'
 
 module OCI
+  # The health status of the specified backend server as reported by the primary and standby load balancers.
+  #
   class LoadBalancer::Models::BackendHealth
 
     STATUS_ENUM = [STATUS_OK = 'OK',
@@ -11,12 +13,12 @@ module OCI
                 STATUS_UNKNOWN = 'UNKNOWN',
                 STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']
 
-    # A list of the most recent health check results returned for the specified backend server.
+    # **[Required]** A list of the most recent health check results returned for the specified backend server.
     # 
     # @return [Array<OCI::LoadBalancer::Models::HealthCheckResult>]
     attr_accessor :health_check_results
 
-    # The general health status of the specified backend server as reported by the primary and standby load balancers.
+    # **[Required]** The general health status of the specified backend server as reported by the primary and standby load balancers.
     # 
     # *   **OK:** Both health checks returned `OK`.
     # 
@@ -32,6 +34,8 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [Array<OCI::LoadBalancer::Models::HealthCheckResult>] :healthCheckResults The value to assign to the {#health_check_results} property
+    # @option attributes [String] :status The value to assign to the {#status} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)