oci 2.0.5 → 2.0.6

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

@@ -4,20 +4,24 @@ require 'date'
 require_relative 'identity_provider'
 
 module OCI
+  # A special type of {IdentityProvider} that
+  # supports the SAML 2.0 protocol. For more information, see
+  # [Identity Providers and Federation](https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/federation.htm).
+  #
   class Identity::Models::Saml2IdentityProvider < Identity::Models::IdentityProvider
-    # The URL for retrieving the identity provider's metadata, which
+    # **[Required]** The URL for retrieving the identity provider's metadata, which
     # contains information required for federating.
     # 
     # @return [String]
     attr_accessor :metadata_url
 
-    # The identity provider's signing certificate used by the IAM Service
+    # **[Required]** The identity provider's signing certificate used by the IAM Service
     # to validate the SAML2 token.
     # 
     # @return [String]
     attr_accessor :signing_certificate
 
-    # The URL to redirect federated users to for authentication with the
+    # **[Required]** The URL to redirect federated users to for authentication with the
     # identity provider.
     # 
     # @return [String]
@@ -26,6 +30,19 @@ 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 {OCI::Identity::Models::IdentityProvider#id #id} proprety
+    # @option attributes [String] :compartmentId The value to assign to the {OCI::Identity::Models::IdentityProvider#compartment_id #compartment_id} proprety
+    # @option attributes [String] :name The value to assign to the {OCI::Identity::Models::IdentityProvider#name #name} proprety
+    # @option attributes [String] :description The value to assign to the {OCI::Identity::Models::IdentityProvider#description #description} proprety
+    # @option attributes [String] :productType The value to assign to the {OCI::Identity::Models::IdentityProvider#product_type #product_type} proprety
+    # @option attributes [DateTime] :timeCreated The value to assign to the {OCI::Identity::Models::IdentityProvider#time_created #time_created} proprety
+    # @option attributes [String] :lifecycleState The value to assign to the {OCI::Identity::Models::IdentityProvider#lifecycle_state #lifecycle_state} proprety
+    # @option attributes [Integer] :inactiveStatus The value to assign to the {OCI::Identity::Models::IdentityProvider#inactive_status #inactive_status} proprety
+    # @option attributes [Hash<String, String>] :freeformTags The value to assign to the {OCI::Identity::Models::IdentityProvider#freeform_tags #freeform_tags} proprety
+    # @option attributes [Hash<String, Hash<String, Object>>] :definedTags The value to assign to the {OCI::Identity::Models::IdentityProvider#defined_tags #defined_tags} proprety
+    # @option attributes [String] :metadataUrl The value to assign to the {#metadata_url} property
+    # @option attributes [String] :signingCertificate The value to assign to the {#signing_certificate} property
+    # @option attributes [String] :redirectUrl The value to assign to the {#redirect_url} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

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

@@ -3,6 +3,14 @@
 require 'date'
 
 module OCI
+  # Swift is the OpenStack object storage service. A `SwiftPassword` is an Oracle-provided password for using a
+  # Swift client with the Oracle Cloud Infrastructure Object Storage Service. This password is associated with
+  # the user's Console login. Swift passwords never expire. A user can have up to two Swift passwords at a time.
+  #
+  # **Note:** The password is always an Oracle-generated string; you can't change it to a string of your choice.
+  #
+  # For more information, see [Managing User Credentials](https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Tasks/managingcredentials.htm).
+  #
   class Identity::Models::SwiftPassword
 
     LIFECYCLE_STATE_ENUM = [LIFECYCLE_STATE_CREATING = 'CREATING',
@@ -12,7 +20,7 @@ module OCI
                 LIFECYCLE_STATE_DELETED = 'DELETED',
                 LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']
 
-    # The Swift password. The value is available only in the response for `CreateSwiftPassword`, and not 
+    # The Swift password. The value is available only in the response for `CreateSwiftPassword`, and not
     # for `ListSwiftPasswords` or `UpdateSwiftPassword`.
     # 
     # @return [String]
@@ -58,6 +66,14 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :password The value to assign to the {#password} property
+    # @option attributes [String] :id The value to assign to the {#id} property
+    # @option attributes [String] :userId The value to assign to the {#user_id} 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 [DateTime] :expiresOn The value to assign to the {#expires_on} 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/identity/models/tag.rb

@@ -3,51 +3,58 @@
 require 'date'
 
 module OCI
+  # A tag definition that belongs to a specific tag namespace.  \"Defined tags\" must be set up in your tenancy before
+  # you can apply them to resources.
+  # For more information, see [Managing Tags and Tag Namespaces](https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/taggingoverview.htm).
+  #
   class Identity::Models::Tag
-    # The OCID of the compartment which the tagRule belongs to.
+    # **[Required]** The OCID of the compartment that contains the tag definition.
     # @return [String]
     attr_accessor :compartment_id
 
-    # The OCID of the containing tagNamespace.
+    # **[Required]** The OCID of the namespace that contains the tag definition.
     # @return [String]
     attr_accessor :tag_namespace_id
 
-    # The name of the tag namespace to which this tag belongs.
+    # **[Required]** The name of the tag namespace that contains the tag definition.
     # 
     # @return [String]
     attr_accessor :tag_namespace_name
 
-    # The OCID of the tag definition.
+    # **[Required]** The OCID of the tag definition.
     # @return [String]
     attr_accessor :id
 
-    # The name of the tag which must be unique across all tags in the tagNamespace and cannot be changed.
+    # **[Required]** The name of the tag. The name must be unique across all tags in the namespace and can't be changed.
     # 
     # @return [String]
     attr_accessor :name
 
-    # The description you assign to the tag.
+    # **[Required]** The description you assign to the tag.
     # @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
 
-    # Indicated whether the tagNamespace is retired or not
+    # **[Required]** Indicates whether the tag is retired.
+    # See [Retiring Key Definitions and Namespace Definitions](https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/taggingoverview.htm#Retiring).
     # 
     # @return [BOOLEAN]
     attr_accessor :is_retired
 
-    # Date and time the tag was created, in the format defined by RFC3339.
+    # **[Required]** Date and time the tag was created, in the format defined by RFC3339.
     # Example: `2016-08-25T21:10:29.600Z`
     # 
     # @return [DateTime]
@@ -56,6 +63,16 @@ 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 [String] :tagNamespaceId The value to assign to the {#tag_namespace_id} property
+    # @option attributes [String] :tagNamespaceName The value to assign to the {#tag_namespace_name} property
+    # @option attributes [String] :id The value to assign to the {#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 [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
+    # @option attributes [BOOLEAN] :isRetired The value to assign to the {#is_retired} property
+    # @option attributes [DateTime] :timeCreated The value to assign to the {#time_created} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 
@@ -94,7 +111,7 @@ module OCI
         self.defined_tags = attributes[:'definedTags']
       end
 
-      if attributes[:'isRetired']
+      unless attributes[:'isRetired'].nil?
         self.is_retired = attributes[:'isRetired']
       end
 

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

@@ -3,42 +3,48 @@
 require 'date'
 
 module OCI
+  # A managed container for defined tags. A tag namespace is unique in a tenancy. A tag namespace can't be deleted.
+  # For more information, see [Managing Tags and Tag Namespaces](https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/taggingoverview.htm).
+  #
   class Identity::Models::TagNamespace
-    # The OCID of the tagNamespace.
+    # **[Required]** The OCID of the tag namespace.
     # @return [String]
     attr_accessor :id
 
-    # The OCID of the compartment which the namespace is attached to.
+    # **[Required]** The OCID of the compartment that contains the tag namespace.
     # @return [String]
     attr_accessor :compartment_id
 
-    # The name of the tagNamespace. It must be unique across all tagNamespaces in the tenancy and cannot be changed.
+    # **[Required]** The name of the tag namespace. It must be unique across all tag namespaces in the tenancy and cannot be changed.
     # 
     # @return [String]
     attr_accessor :name
 
-    # The description you assign to the tagNamespace.
+    # **[Required]** The description you assign to the tag namespace.
     # @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
 
-    # Indicated whether or not the tagNamespace is retired
+    # **[Required]** Whether the tag namespace is retired.
+    # See [Retiring Key Definitions and Namespace Definitions](https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/taggingoverview.htm#Retiring).
     # 
     # @return [BOOLEAN]
     attr_accessor :is_retired
 
-    # Date and time the tagNamespace was created, in the format defined by RFC3339.
+    # **[Required]** Date and time the tagNamespace was created, in the format defined by RFC3339.
     # Example: `2016-08-25T21:10:29.600Z`
     # 
     # @return [DateTime]
@@ -47,6 +53,14 @@ 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 [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
+    # @option attributes [BOOLEAN] :isRetired The value to assign to the {#is_retired} property
+    # @option attributes [DateTime] :timeCreated The value to assign to the {#time_created} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 
@@ -77,7 +91,7 @@ module OCI
         self.defined_tags = attributes[:'definedTags']
       end
 
-      if attributes[:'isRetired']
+      unless attributes[:'isRetired'].nil?
         self.is_retired = attributes[:'isRetired']
       end
 

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

@@ -3,37 +3,42 @@
 require 'date'
 
 module OCI
+  # A container for defined tags.
+  #
   class Identity::Models::TagNamespaceSummary
-    # The OCID of the tagNamespace.
+    # The OCID of the tag namespace.
     # @return [String]
     attr_accessor :id
 
-    # The OCID of the compartment to which the namespace is attached.
+    # The OCID of the compartment that contains the tag namespace.
     # @return [String]
     attr_accessor :compartment_id
 
-    # The name of the tagNamespace. It must be unique across all tagNamespaces in the tenancy and cannot be changed.
+    # The name of the tag namespace. It must be unique across all tag namespaces in the tenancy and cannot be changed.
     # 
     # @return [String]
     attr_accessor :name
 
-    # The description you assign to the tagNamespace.
+    # The description you assign to the tag namespace.
     # @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
 
-    # Indicated whether or not the tagNamespace is retired
+    # Whether the tag namespace is retired.
+    # For more information, see [Retiring Key Definitions and Namespace Definitions](https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/taggingoverview.htm#Retiring).
     # 
     # @return [BOOLEAN]
     attr_accessor :is_retired
@@ -47,6 +52,14 @@ 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 [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
+    # @option attributes [BOOLEAN] :isRetired The value to assign to the {#is_retired} property
+    # @option attributes [DateTime] :timeCreated The value to assign to the {#time_created} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 
@@ -77,7 +90,7 @@ module OCI
         self.defined_tags = attributes[:'definedTags']
       end
 
-      if attributes[:'isRetired']
+      unless attributes[:'isRetired'].nil?
         self.is_retired = attributes[:'isRetired']
       end
 

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

@@ -3,8 +3,10 @@
 require 'date'
 
 module OCI
+  # A tag definition that belongs to a specific tag namespace.
+  #
   class Identity::Models::TagSummary
-    # The OCID of the compartment which the tag definition is attached to.
+    # The OCID of the compartment that contains the tag definition.
     # @return [String]
     attr_accessor :compartment_id
 
@@ -12,7 +14,7 @@ module OCI
     # @return [String]
     attr_accessor :id
 
-    # The name of the tag which must be unique across all tags in the tagNamespace and cannot be changed.
+    # The name of the tag. The name must be unique across all tags in the tag namespace and can't be changed.
     # 
     # @return [String]
     attr_accessor :name
@@ -21,19 +23,22 @@ 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
 
-    # Indicated whether or not the tag is retired
+    # Whether the tag is retired.
+    # See [Retiring Key Definitions and Namespace Definitions](https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/taggingoverview.htm#Retiring).
     # 
     # @return [BOOLEAN]
     attr_accessor :is_retired
@@ -47,6 +52,14 @@ 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 [String] :id The value to assign to the {#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 [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
+    # @option attributes [BOOLEAN] :isRetired The value to assign to the {#is_retired} property
+    # @option attributes [DateTime] :timeCreated The value to assign to the {#time_created} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 
@@ -77,7 +90,7 @@ module OCI
         self.defined_tags = attributes[:'definedTags']
       end
 
-      if attributes[:'isRetired']
+      unless attributes[:'isRetired'].nil?
         self.is_retired = attributes[:'isRetired']
       end
 

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

@@ -3,6 +3,15 @@
 require 'date'
 
 module OCI
+  # The root compartment that contains all of your organization's compartments and other
+  # Oracle Cloud Infrastructure cloud resources. When you sign up for Oracle Cloud Infrastructure,
+  # Oracle creates a tenancy for your company, which is a secure and isolated partition
+  # where you can create, organize, and administer your cloud resources.
+  #
+  # 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::Tenancy
     # The OCID of the tenancy.
     # @return [String]
@@ -26,14 +35,16 @@ module OCI
     # @return [String]
     attr_accessor :home_region_key
 
-    # 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
@@ -41,6 +52,12 @@ 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] :name The value to assign to the {#name} property
+    # @option attributes [String] :description The value to assign to the {#description} property
+    # @option attributes [String] :homeRegionKey The value to assign to the {#home_region_key} 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)