oci 2.0.5 → 2.0.6

data/lib/oci/core/models/vnic_attachment.rb

@@ -3,6 +3,9 @@
 require 'date'
 
 module OCI
+  # Represents an attachment between a VNIC and an instance. For more information, see
+  # [Virtual Network Interface Cards (VNICs)](https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingVNICs.htm).
+  #
   class Core::Models::VnicAttachment
 
     LIFECYCLE_STATE_ENUM = [LIFECYCLE_STATE_ATTACHING = 'ATTACHING',
@@ -11,14 +14,14 @@ module OCI
                 LIFECYCLE_STATE_DETACHED = 'DETACHED',
                 LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']
 
-    # The Availability Domain of the instance.
+    # **[Required]** The Availability Domain of the instance.
     # 
     # Example: `Uocm:PHX-AD-1`
     # 
     # @return [String]
     attr_accessor :availability_domain
 
-    # The OCID of the compartment the VNIC attachment is in, which is the same
+    # **[Required]** The OCID of the compartment the VNIC attachment is in, which is the same
     # compartment the instance is in.
     # 
     # @return [String]
@@ -30,15 +33,15 @@ module OCI
     # @return [String]
     attr_accessor :display_name
 
-    # The OCID of the VNIC attachment.
+    # **[Required]** The OCID of the VNIC attachment.
     # @return [String]
     attr_accessor :id
 
-    # The OCID of the instance.
+    # **[Required]** The OCID of the instance.
     # @return [String]
     attr_accessor :instance_id
 
-    # The current state of the VNIC attachment.
+    # **[Required]** The current state of the VNIC attachment.
     # @return [String]
     attr_accessor :lifecycle_state
 
@@ -51,11 +54,11 @@ module OCI
     # @return [Integer]
     attr_accessor :nic_index
 
-    # The OCID of the VNIC's subnet.
+    # **[Required]** The OCID of the VNIC's subnet.
     # @return [String]
     attr_accessor :subnet_id
 
-    # The date and time the VNIC attachment was created, in the format defined by RFC3339.
+    # **[Required]** The date and time the VNIC attachment was created, in the format defined by RFC3339.
     # 
     # Example: `2016-08-25T21:10:29.600Z`
     # 
@@ -77,6 +80,17 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :availabilityDomain The value to assign to the {#availability_domain} property
+    # @option attributes [String] :compartmentId The value to assign to the {#compartment_id} property
+    # @option attributes [String] :displayName The value to assign to the {#display_name} property
+    # @option attributes [String] :id The value to assign to the {#id} property
+    # @option attributes [String] :instanceId The value to assign to the {#instance_id} property
+    # @option attributes [String] :lifecycleState The value to assign to the {#lifecycle_state} property
+    # @option attributes [Integer] :nicIndex The value to assign to the {#nic_index} property
+    # @option attributes [String] :subnetId The value to assign to the {#subnet_id} property
+    # @option attributes [DateTime] :timeCreated The value to assign to the {#time_created} property
+    # @option attributes [Integer] :vlanTag The value to assign to the {#vlan_tag} property
+    # @option attributes [String] :vnicId The value to assign to the {#vnic_id} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

data/lib/oci/core/models/volume.rb

@@ -3,6 +3,14 @@
 require 'date'
 
 module OCI
+  # A detachable block volume device that allows you to dynamically expand
+  # the storage capacity of an instance. For more information, see
+  # [Overview of Cloud Volume Storage](https://docs.us-phoenix-1.oraclecloud.com/Content/Block/Concepts/overview.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 Core::Models::Volume
 
     LIFECYCLE_STATE_ENUM = [LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING',
@@ -13,14 +21,14 @@ module OCI
                 LIFECYCLE_STATE_FAULTY = 'FAULTY',
                 LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']
 
-    # The Availability Domain of the volume.
+    # **[Required]** The Availability Domain of the volume.
     # 
     # Example: `Uocm:PHX-AD-1`
     # 
     # @return [String]
     attr_accessor :availability_domain
 
-    # The OCID of the compartment that contains the volume.
+    # **[Required]** The OCID of the compartment that contains the volume.
     # @return [String]
     attr_accessor :compartment_id
 
@@ -32,7 +40,7 @@ module OCI
     # @return [Hash<String, Hash<String, Object>>]
     attr_accessor :defined_tags
 
-    # A user-friendly name. Does not have to be unique, and it's changeable.
+    # **[Required]** A user-friendly name. Does not have to be unique, and it's changeable.
     # Avoid entering confidential information.
     # 
     # @return [String]
@@ -47,7 +55,7 @@ module OCI
     # @return [Hash<String, String>]
     attr_accessor :freeform_tags
 
-    # The OCID of the volume.
+    # **[Required]** The OCID of the volume.
     # @return [String]
     attr_accessor :id
 
@@ -55,7 +63,7 @@ module OCI
     # @return [BOOLEAN]
     attr_accessor :is_hydrated
 
-    # The current state of a volume.
+    # **[Required]** The current state of a volume.
     # @return [String]
     attr_accessor :lifecycle_state
 
@@ -63,7 +71,7 @@ module OCI
     # @return [Integer]
     attr_accessor :size_in_gbs
 
-    # The size of the volume in MBs. This field is deprecated. Use sizeInGBs instead.
+    # **[Required]** The size of the volume in MBs. This field is deprecated. Use sizeInGBs instead.
     # @return [Integer]
     attr_accessor :size_in_mbs
 
@@ -73,13 +81,25 @@ module OCI
     # @return [OCI::Core::Models::VolumeSourceDetails]
     attr_accessor :source_details
 
-    # The date and time the volume was created. Format defined by RFC3339.
+    # **[Required]** The date and time the volume was created. Format defined by RFC3339.
     # @return [DateTime]
     attr_accessor :time_created
 
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :availabilityDomain The value to assign to the {#availability_domain} property
+    # @option attributes [String] :compartmentId The value to assign to the {#compartment_id} property
+    # @option attributes [Hash<String, Hash<String, Object>>] :definedTags The value to assign to the {#defined_tags} property
+    # @option attributes [String] :displayName The value to assign to the {#display_name} property
+    # @option attributes [Hash<String, String>] :freeformTags The value to assign to the {#freeform_tags} property
+    # @option attributes [String] :id The value to assign to the {#id} property
+    # @option attributes [BOOLEAN] :isHydrated The value to assign to the {#is_hydrated} property
+    # @option attributes [String] :lifecycleState The value to assign to the {#lifecycle_state} property
+    # @option attributes [Integer] :sizeInGBs The value to assign to the {#size_in_gbs} property
+    # @option attributes [Integer] :sizeInMBs The value to assign to the {#size_in_mbs} property
+    # @option attributes [OCI::Core::Models::VolumeSourceDetails] :sourceDetails The value to assign to the {#source_details} property
+    # @option attributes [DateTime] :timeCreated The value to assign to the {#time_created} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 
@@ -110,7 +130,7 @@ module OCI
         self.id = attributes[:'id']
       end
 
-      if attributes[:'isHydrated']
+      unless attributes[:'isHydrated'].nil?
         self.is_hydrated = attributes[:'isHydrated']
       end
 

data/lib/oci/core/models/volume_attachment.rb

@@ -3,6 +3,14 @@
 require 'date'
 
 module OCI
+  # A base object for all types of attachments between a storage volume and an instance.
+  # For specific details about iSCSI attachments, see
+  # {IScsiVolumeAttachment}.
+  #
+  # For general information about volume attachments, see
+  # [Overview of Block Volume Storage](https://docs.us-phoenix-1.oraclecloud.com/Content/Block/Concepts/overview.htm).
+  #
+  # This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class
   class Core::Models::VolumeAttachment
 
     LIFECYCLE_STATE_ENUM = [LIFECYCLE_STATE_ATTACHING = 'ATTACHING',
@@ -11,18 +19,18 @@ module OCI
                 LIFECYCLE_STATE_DETACHED = 'DETACHED',
                 LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']
 
-    # The type of volume attachment.
+    # **[Required]** The type of volume attachment.
     # @return [String]
     attr_accessor :attachment_type
 
-    # The Availability Domain of an instance.
+    # **[Required]** The Availability Domain of an instance.
     # 
     # Example: `Uocm:PHX-AD-1`
     # 
     # @return [String]
     attr_accessor :availability_domain
 
-    # The OCID of the compartment.
+    # **[Required]** The OCID of the compartment.
     # @return [String]
     attr_accessor :compartment_id
 
@@ -34,26 +42,26 @@ module OCI
     # @return [String]
     attr_accessor :display_name
 
-    # The OCID of the volume attachment.
+    # **[Required]** The OCID of the volume attachment.
     # @return [String]
     attr_accessor :id
 
-    # The OCID of the instance the volume is attached to.
+    # **[Required]** The OCID of the instance the volume is attached to.
     # @return [String]
     attr_accessor :instance_id
 
-    # The current state of the volume attachment.
+    # **[Required]** The current state of the volume attachment.
     # @return [String]
     attr_accessor :lifecycle_state
 
-    # The date and time the volume was created, in the format defined by RFC3339.
+    # **[Required]** The date and time the volume was created, in the format defined by RFC3339.
     # 
     # Example: `2016-08-25T21:10:29.600Z`
     # 
     # @return [DateTime]
     attr_accessor :time_created
 
-    # The OCID of the volume.
+    # **[Required]** The OCID of the volume.
     # @return [String]
     attr_accessor :volume_id
 
@@ -71,6 +79,15 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :attachmentType The value to assign to the {#attachment_type} property
+    # @option attributes [String] :availabilityDomain The value to assign to the {#availability_domain} property
+    # @option attributes [String] :compartmentId The value to assign to the {#compartment_id} property
+    # @option attributes [String] :displayName The value to assign to the {#display_name} property
+    # @option attributes [String] :id The value to assign to the {#id} property
+    # @option attributes [String] :instanceId The value to assign to the {#instance_id} property
+    # @option attributes [String] :lifecycleState The value to assign to the {#lifecycle_state} property
+    # @option attributes [DateTime] :timeCreated The value to assign to the {#time_created} property
+    # @option attributes [String] :volumeId The value to assign to the {#volume_id} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

data/lib/oci/core/models/volume_backup.rb

@@ -3,6 +3,14 @@
 require 'date'
 
 module OCI
+  # A point-in-time copy of a volume that can then be used to create a new block volume
+  # or recover a block volume. For more information, see
+  # [Overview of Cloud Volume Storage](https://docs.us-phoenix-1.oraclecloud.com/Content/Block/Concepts/overview.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 Core::Models::VolumeBackup
 
     LIFECYCLE_STATE_ENUM = [LIFECYCLE_STATE_CREATING = 'CREATING',
@@ -13,7 +21,7 @@ module OCI
                 LIFECYCLE_STATE_REQUEST_RECEIVED = 'REQUEST_RECEIVED',
                 LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']
 
-    # The OCID of the compartment that contains the volume backup.
+    # **[Required]** The OCID of the compartment that contains the volume backup.
     # @return [String]
     attr_accessor :compartment_id
 
@@ -25,7 +33,7 @@ module OCI
     # @return [Hash<String, Hash<String, Object>>]
     attr_accessor :defined_tags
 
-    # A user-friendly name for the volume backup. Does not have to be unique and it's changeable.
+    # **[Required]** A user-friendly name for the volume backup. Does not have to be unique and it's changeable.
     # Avoid entering confidential information.
     # 
     # @return [String]
@@ -40,11 +48,11 @@ module OCI
     # @return [Hash<String, String>]
     attr_accessor :freeform_tags
 
-    # The OCID of the volume backup.
+    # **[Required]** The OCID of the volume backup.
     # @return [String]
     attr_accessor :id
 
-    # The current state of a volume backup.
+    # **[Required]** The current state of a volume backup.
     # @return [String]
     attr_accessor :lifecycle_state
 
@@ -59,7 +67,7 @@ module OCI
     # @return [Integer]
     attr_accessor :size_in_mbs
 
-    # The date and time the volume backup was created. This is the time the actual point-in-time image
+    # **[Required]** The date and time the volume backup was created. This is the time the actual point-in-time image
     # of the volume data was taken. Format defined by RFC3339.
     # 
     # @return [DateTime]
@@ -90,6 +98,19 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :compartmentId The value to assign to the {#compartment_id} property
+    # @option attributes [Hash<String, Hash<String, Object>>] :definedTags The value to assign to the {#defined_tags} property
+    # @option attributes [String] :displayName The value to assign to the {#display_name} property
+    # @option attributes [Hash<String, String>] :freeformTags The value to assign to the {#freeform_tags} property
+    # @option attributes [String] :id The value to assign to the {#id} property
+    # @option attributes [String] :lifecycleState The value to assign to the {#lifecycle_state} property
+    # @option attributes [Integer] :sizeInGBs The value to assign to the {#size_in_gbs} property
+    # @option attributes [Integer] :sizeInMBs The value to assign to the {#size_in_mbs} property
+    # @option attributes [DateTime] :timeCreated The value to assign to the {#time_created} property
+    # @option attributes [DateTime] :timeRequestReceived The value to assign to the {#time_request_received} property
+    # @option attributes [Integer] :uniqueSizeInGBs The value to assign to the {#unique_size_in_gbs} property
+    # @option attributes [Integer] :uniqueSizeInMbs The value to assign to the {#unique_size_in_mbs} property
+    # @option attributes [String] :volumeId The value to assign to the {#volume_id} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

data/lib/oci/core/models/volume_source_details.rb

@@ -3,7 +3,9 @@
 require 'date'
 
 module OCI
+  # This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class
   class Core::Models::VolumeSourceDetails
+    # This attribute is required.
     # @return [String]
     attr_accessor :type
 
@@ -22,6 +24,7 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :type The value to assign to the {#type} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

data/lib/oci/core/models/volume_source_from_volume_backup_details.rb

@@ -4,14 +4,16 @@ require 'date'
 require_relative 'volume_source_details'
 
 module OCI
+  # Specifies the volume backup.
   class Core::Models::VolumeSourceFromVolumeBackupDetails < Core::Models::VolumeSourceDetails
-    # The OCID of the volume backup.
+    # **[Required]** The OCID of the volume backup.
     # @return [String]
     attr_accessor :id
 
 
     # 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
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

data/lib/oci/core/models/volume_source_from_volume_details.rb

@@ -4,14 +4,16 @@ require 'date'
 require_relative 'volume_source_details'
 
 module OCI
+  # Specifies the source volume.
   class Core::Models::VolumeSourceFromVolumeDetails < Core::Models::VolumeSourceDetails
-    # The OCID of the volume.
+    # **[Required]** The OCID of the volume.
     # @return [String]
     attr_accessor :id
 
 
     # 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
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

data/lib/oci/core/virtual_network_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
 

data/lib/oci/database/database_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