oci 2.0.5 → 2.0.6

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

@@ -4,17 +4,19 @@ require 'date'
 
 module OCI
   class Identity::Models::AddUserToGroupDetails
-    # The OCID of the user.
+    # **[Required]** The OCID of the user.
     # @return [String]
     attr_accessor :user_id
 
-    # The OCID of the group.
+    # **[Required]** The OCID of the group.
     # @return [String]
     attr_accessor :group_id
 
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :userId The value to assign to the {#user_id} property
+    # @option attributes [String] :groupId The value to assign to the {#group_id} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

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

@@ -3,6 +3,17 @@
 require 'date'
 
 module OCI
+  # A PEM-format RSA credential for securing requests to the Oracle Cloud Infrastructure REST API. Also known
+  # as an *API signing key*. Specifically, this is the public key from the key pair. The private key remains with
+  # the user calling the API. For information about generating a key pair
+  # in the required PEM format, see [Required Keys and OCIDs](https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm).
+  #
+  # **Important:** This is **not** the SSH key for accessing compute instances.
+  #
+  # Each user can have a maximum of three API signing keys.
+  #
+  # For more information about user credentials, see [User Credentials](https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/usercredentials.htm).
+  #
   class Identity::Models::ApiKey
 
     LIFECYCLE_STATE_ENUM = [LIFECYCLE_STATE_CREATING = 'CREATING',
@@ -50,6 +61,13 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :keyId The value to assign to the {#key_id} property
+    # @option attributes [String] :keyValue The value to assign to the {#key_value} property
+    # @option attributes [String] :fingerprint The value to assign to the {#fingerprint} 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/identity/models/availability_domain.rb

@@ -3,6 +3,10 @@
 require 'date'
 
 module OCI
+  # One or more isolated, fault-tolerant Oracle data centers that host cloud resources such as instances, volumes,
+  # and subnets. A region contains several Availability Domains. For more information, see
+  # [Regions and Availability Domains](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm).
+  #
   class Identity::Models::AvailabilityDomain
     # The name of the Availability Domain.
     # @return [String]
@@ -15,6 +19,8 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :name The value to assign to the {#name} property
+    # @option attributes [String] :compartmentId The value to assign to the {#compartment_id} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

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

@@ -3,6 +3,23 @@
 require 'date'
 
 module OCI
+  # A collection of related resources. Compartments are a fundamental component of Oracle Cloud Infrastructure
+  # for organizing and isolating your cloud resources. You use them to clearly separate resources for the purposes
+  # of measuring usage and billing, access (through the use of IAM Service policies), and isolation (separating the
+  # resources for one project or business unit from another). A common approach is to create a compartment for each
+  # major part of your organization. For more information, see
+  # [Overview of the IAM Service](https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/overview.htm) and also
+  # [Setting Up Your Tenancy](https://docs.us-phoenix-1.oraclecloud.com/Content/GSG/Concepts/settinguptenancy.htm).
+  #
+  # To place a resource in a compartment, simply specify the compartment ID in the \"Create\" request object when
+  # initially creating the resource. For example, to launch an instance into a particular compartment, specify
+  # that compartment's OCID in the `LaunchInstance` request. You can't move an existing resource from one
+  # compartment to another.
+  #
+  # 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::Compartment
 
     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 compartment.
+    # **[Required]** The OCID of the compartment.
     # @return [String]
     attr_accessor :id
 
-    # The OCID of the tenancy containing the compartment.
+    # **[Required]** The OCID of the tenancy containing the compartment.
     # @return [String]
     attr_accessor :compartment_id
 
-    # The name you assign to the compartment during creation. The name must be unique across all 
+    # **[Required]** The name you assign to the compartment during creation. The name must be unique across all
     # compartments in the tenancy.
     # 
     # @return [String]
     attr_accessor :name
 
-    # The description you assign to the compartment. Does not have to be unique, and it's changeable.
+    # **[Required]** The description you assign to the compartment. Does not have to be unique, and it's changeable.
     # @return [String]
     attr_accessor :description
 
-    # Date and time the compartment was created, in the format defined by RFC3339.
+    # **[Required]** Date and time the compartment was created, in the format defined by RFC3339.
     # 
     # Example: `2016-08-25T21:10:29.600Z`
     # 
     # @return [DateTime]
     attr_accessor :time_created
 
-    # The compartment's current state. After creating a compartment, make sure its `lifecycleState` changes from
+    # **[Required]** The compartment's current state. After creating a compartment, make sure its `lifecycleState` changes from
     # CREATING to ACTIVE before using it.
     # 
     # @return [String]
@@ -47,14 +64,16 @@ module OCI
     # @return [Integer]
     attr_accessor :inactive_status
 
-    # 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
@@ -62,6 +81,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/create_api_key_details.rb

@@ -4,13 +4,14 @@ require 'date'
 
 module OCI
   class Identity::Models::CreateApiKeyDetails
-    # The public key.  Must be an RSA key in PEM format.
+    # **[Required]** The public key.  Must be an RSA key in PEM format.
     # @return [String]
     attr_accessor :key
 
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :key The value to assign to the {#key} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

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

@@ -4,29 +4,31 @@ require 'date'
 
 module OCI
   class Identity::Models::CreateCompartmentDetails
-    # The OCID of the tenancy containing the compartment.
+    # **[Required]** The OCID of the tenancy containing the compartment.
     # @return [String]
     attr_accessor :compartment_id
 
-    # The name you assign to the compartment during creation. The name must be unique across all compartments
+    # **[Required]** The name you assign to the compartment during creation. The name must be unique across all compartments
     # in the tenancy.
     # 
     # @return [String]
     attr_accessor :name
 
-    # The description you assign to the compartment during creation. Does not have to be unique, and it's changeable.
+    # **[Required]** The description you assign to the compartment during creation. Does not have to be unique, and it's changeable.
     # 
     # @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
@@ -34,6 +36,11 @@ 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] :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
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

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

@@ -4,7 +4,7 @@ require 'date'
 
 module OCI
   class Identity::Models::CreateCustomerSecretKeyDetails
-    # The name you assign to the secret key during creation. Does not have to be unique, and it's changeable.
+    # **[Required]** The name you assign to the secret key during creation. Does not have to be unique, and it's changeable.
     # 
     # @return [String]
     attr_accessor :display_name
@@ -12,6 +12,7 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :displayName The value to assign to the {#display_name} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

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

@@ -0,0 +1,160 @@
+# Copyright (c) 2016, 2018, Oracle and/or its affiliates. All rights reserved.
+
+require 'date'
+
+module OCI
+  # Properties for creating a dynamic group
+  class Identity::Models::CreateDynamicGroupDetails
+    # **[Required]** The OCID of the tenancy containing the group.
+    # @return [String]
+    attr_accessor :compartment_id
+
+    # **[Required]** The name you assign to the group during creation. The name must be unique across all groups
+    # in the tenancy and cannot be changed.
+    # 
+    # @return [String]
+    attr_accessor :name
+
+    # **[Required]** The matching rule to dynamically match an instance certificate to this dynamic group
+    # @return [String]
+    attr_accessor :matching_rule
+
+    # **[Required]** The description you assign to the group during creation. Does not have to be unique, and it's changeable.
+    # @return [String]
+    attr_accessor :description
+
+
+    # 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] :name The value to assign to the {#name} property
+    # @option attributes [String] :matchingRule The value to assign to the {#matching_rule} property
+    # @option attributes [String] :description The value to assign to the {#description} 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[:'compartmentId']
+        self.compartment_id = attributes[:'compartmentId']
+      end
+
+      if attributes[:'name']
+        self.name = attributes[:'name']
+      end
+
+      if attributes[:'matchingRule']
+        self.matching_rule = attributes[:'matchingRule']
+      end
+
+      if attributes[:'description']
+        self.description = attributes[:'description']
+      end
+
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] other_object to be compared
+    def ==(other_object)
+      return true if self.equal?(other_object)
+      self.class == other_object.class &&
+          compartment_id == other_object.compartment_id &&
+          name == other_object.name &&
+          matching_rule == other_object.matching_rule &&
+          description == other_object.description
+    end
+
+    # @see the `==` method
+    # @param [Object] other_object to be compared
+    def eql?(other_object)
+      self == other_object
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [compartment_id, name, matching_rule, description].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /^Array<(.*)>/i
+          # check to ensure the input is an array given that the the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.public_method("#{key}=").call(attributes[self.class.attribute_map[key]].map{ |v| OCI::Internal::Util.convert_to_type($1, v) } )
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.public_method("#{key}=").call(OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = public_method(attr).call
+        next if value.nil? && !instance_variable_defined?("@#{attr}")
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    private
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value 
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map{ |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      { 
+        :'compartment_id' => :'compartmentId',
+        :'name' => :'name',
+        :'matching_rule' => :'matchingRule',
+        :'description' => :'description'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      { 
+        :'compartment_id' => :'String',
+        :'name' => :'String',
+        :'matching_rule' => :'String',
+        :'description' => :'String'
+      }
+    end
+  end
+end

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

@@ -4,28 +4,30 @@ require 'date'
 
 module OCI
   class Identity::Models::CreateGroupDetails
-    # The OCID of the tenancy containing the group.
+    # **[Required]** The OCID of the tenancy containing the group.
     # @return [String]
     attr_accessor :compartment_id
 
-    # The name you assign to the group during creation. The name must be unique across all groups
+    # **[Required]** The name you assign to the group during creation. The name must be unique across all groups
     # in the tenancy and cannot be changed.
     # 
     # @return [String]
     attr_accessor :name
 
-    # The description you assign to the group during creation. Does not have to be unique, and it's changeable.
+    # **[Required]** The description you assign to the group during creation. Does not have to be unique, and it's changeable.
     # @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
@@ -33,6 +35,11 @@ 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] :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
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)