oci 2.6.0 → 2.7.0

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

@@ -0,0 +1,200 @@
+# Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved.
+
+require 'date'
+require 'logger'
+
+# rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
+module OCI
+  # Validates a definedTag value. Each validator performs validation steps in addition to the standard validation
+  # for definedTag values (See [Limits on Tags](https://docs.cloud.oracle.com/Content/Identity/Concepts/taggingoverview.htm#Limits).
+  #
+  # If a validator is defined after a value has been set for a definedTag, then any UPDATE operation that attempts
+  # to change the value must pass the additional validation defined by this rule. Previously set values, that would
+  # fail validation, are not updated and it is possible to update other attributes of an OCI resource that contains
+  # a non-valid definedTag.
+  #
+  # To clear the validator call the UPDATE operation with DefaultTagDefinitionValidator.
+  #
+  # 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 Identity::Models::BaseTagDefinitionValidator
+    VALIDATOR_TYPE_ENUM = [
+      VALIDATOR_TYPE_ENUM = 'ENUM'.freeze,
+      VALIDATOR_TYPE_DEFAULT = 'DEFAULT'.freeze,
+      VALIDATOR_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
+    ].freeze
+
+    # **[Required]** The primitive that any value set for this definedTag must be parseable as.
+    #
+    # @return [String]
+    attr_reader :validator_type
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        # rubocop:disable Style/SymbolLiteral
+        'validator_type': :'validatorType'
+        # rubocop:enable Style/SymbolLiteral
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        # rubocop:disable Style/SymbolLiteral
+        'validator_type': :'String'
+        # rubocop:enable Style/SymbolLiteral
+      }
+    end
+
+    # rubocop:disable Metrics/CyclomaticComplexity, Layout/EmptyLines, Metrics/PerceivedComplexity, Metrics/AbcSize
+
+
+    # Given the hash representation of a subtype of this class,
+    # use the info in the hash to return the class of the subtype.
+    def self.get_subtype(object_hash)
+      type = object_hash[:'validatorType'] # rubocop:disable Style/SymbolLiteral
+
+      return 'OCI::Identity::Models::DefaultTagDefinitionValidator' if type == 'DEFAULT'
+      return 'OCI::Identity::Models::EnumTagDefinitionValidator' if type == 'ENUM'
+
+      # TODO: Log a warning when the subtype is not found.
+      'OCI::Identity::Models::BaseTagDefinitionValidator'
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity, Layout/EmptyLines, Metrics/PerceivedComplexity, Metrics/AbcSize
+
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
+    # rubocop:disable Metrics/MethodLength, Layout/EmptyLines, Style/SymbolLiteral
+
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :validator_type The value to assign to the {#validator_type} 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 }
+
+      self.validator_type = attributes[:'validatorType'] if attributes[:'validatorType']
+
+      raise 'You cannot provide both :validatorType and :validator_type' if attributes.key?(:'validatorType') && attributes.key?(:'validator_type')
+
+      self.validator_type = attributes[:'validator_type'] if attributes[:'validator_type']
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
+    # rubocop:enable Metrics/MethodLength, Layout/EmptyLines, Style/SymbolLiteral
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] validator_type Object to be assigned
+    def validator_type=(validator_type)
+      # rubocop:disable Style/ConditionalAssignment
+      if validator_type && !VALIDATOR_TYPE_ENUM.include?(validator_type)
+        OCI.logger.debug("Unknown value for 'validator_type' [" + validator_type + "]. Mapping to 'VALIDATOR_TYPE_UNKNOWN_ENUM_VALUE'") if OCI.logger
+        @validator_type = VALIDATOR_TYPE_UNKNOWN_ENUM_VALUE
+      else
+        @validator_type = validator_type
+      end
+      # rubocop:enable Style/ConditionalAssignment
+    end
+
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity, Layout/EmptyLines
+
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] other the other object to be compared
+    def ==(other)
+      return true if equal?(other)
+
+      self.class == other.class &&
+        validator_type == other.validator_type
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity, Layout/EmptyLines
+
+    # @see the `==` method
+    # @param [Object] other the other object to be compared
+    def eql?(other)
+      self == other
+    end
+
+    # rubocop:disable Metrics/AbcSize, Layout/EmptyLines
+
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [validator_type].hash
+    end
+    # rubocop:enable Metrics/AbcSize, Layout/EmptyLines
+
+    # rubocop:disable Metrics/AbcSize, Layout/EmptyLines
+
+
+    # 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)
+            public_method("#{key}=").call(
+              attributes[self.class.attribute_map[key]]
+                .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
+            )
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          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
+    # rubocop:enable Metrics/AbcSize, Layout/EmptyLines
+
+    # 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
+  end
+end
+# rubocop:enable Lint/UnneededCopDisableDirective, Metrics/LineLength

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

@@ -22,6 +22,9 @@ module OCI
   # 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.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm).
   #
+  # **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values
+  # using the API.
+  #
   class Identity::Models::Compartment
     LIFECYCLE_STATE_ENUM = [
       LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,

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

@@ -13,6 +13,9 @@ module OCI
     # - `IAD`
     # - `FRA`
     # - `LHR`
+    # - `YYZ`
+    # - `NRT`
+    # - `ICN`
     #
     # Example: `PHX`
     #

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

@@ -21,13 +21,26 @@ module OCI
     # @return [String]
     attr_accessor :value
 
+    # If you specify that a value is required, a value is set during resource creation (either by
+    # the user creating the resource or another tag defualt). If no value is set, resource
+    # creation is blocked.
+    #
+    # * If the `isRequired` flag is set to \"true\", the value is set during resource creation.
+    # * If the `isRequired` flag is set to \"false\", the value you enter is set during resource creation.
+    #
+    # Example: `false`
+    #
+    # @return [BOOLEAN]
+    attr_accessor :is_required
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         # rubocop:disable Style/SymbolLiteral
         'compartment_id': :'compartmentId',
         'tag_definition_id': :'tagDefinitionId',
-        'value': :'value'
+        'value': :'value',
+        'is_required': :'isRequired'
         # rubocop:enable Style/SymbolLiteral
       }
     end
@@ -38,7 +51,8 @@ module OCI
         # rubocop:disable Style/SymbolLiteral
         'compartment_id': :'String',
         'tag_definition_id': :'String',
-        'value': :'String'
+        'value': :'String',
+        'is_required': :'BOOLEAN'
         # rubocop:enable Style/SymbolLiteral
       }
     end
@@ -52,6 +66,7 @@ module OCI
     # @option attributes [String] :compartment_id The value to assign to the {#compartment_id} property
     # @option attributes [String] :tag_definition_id The value to assign to the {#tag_definition_id} property
     # @option attributes [String] :value The value to assign to the {#value} property
+    # @option attributes [BOOLEAN] :is_required The value to assign to the {#is_required} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 
@@ -71,6 +86,12 @@ module OCI
       self.tag_definition_id = attributes[:'tag_definition_id'] if attributes[:'tag_definition_id']
 
       self.value = attributes[:'value'] if attributes[:'value']
+
+      self.is_required = attributes[:'isRequired'] unless attributes[:'isRequired'].nil?
+
+      raise 'You cannot provide both :isRequired and :is_required' if attributes.key?(:'isRequired') && attributes.key?(:'is_required')
+
+      self.is_required = attributes[:'is_required'] unless attributes[:'is_required'].nil?
     end
     # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
     # rubocop:enable Metrics/MethodLength, Layout/EmptyLines, Style/SymbolLiteral
@@ -86,7 +107,8 @@ module OCI
       self.class == other.class &&
         compartment_id == other.compartment_id &&
         tag_definition_id == other.tag_definition_id &&
-        value == other.value
+        value == other.value &&
+        is_required == other.is_required
     end
     # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity, Layout/EmptyLines
 
@@ -102,7 +124,7 @@ module OCI
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [compartment_id, tag_definition_id, value].hash
+      [compartment_id, tag_definition_id, value, is_required].hash
     end
     # rubocop:enable Metrics/AbcSize, Layout/EmptyLines
 

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

@@ -6,7 +6,8 @@ require 'date'
 module OCI
   # CreateTagDetails model.
   class Identity::Models::CreateTagDetails
-    # **[Required]** The name you assign to the tag during creation. The name must be unique within the tag namespace and cannot be changed.
+    # **[Required]** The name you assign to the tag during creation. This is the tag key definition.
+    # The name must be unique within the tag namespace and cannot be changed.
     #
     # @return [String]
     attr_accessor :name
@@ -34,6 +35,15 @@ module OCI
     # @return [BOOLEAN]
     attr_accessor :is_cost_tracking
 
+    # Additional validation rule for values specified for the tag definition.
+    #
+    # If no validator is defined for a tag definition, then any (valid) value will be accepted.
+    #
+    # The default value for `validator` is an empty map (no additional validation).
+    #
+    # @return [OCI::Identity::Models::BaseTagDefinitionValidator]
+    attr_accessor :validator
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -42,7 +52,8 @@ module OCI
         'description': :'description',
         'freeform_tags': :'freeformTags',
         'defined_tags': :'definedTags',
-        'is_cost_tracking': :'isCostTracking'
+        'is_cost_tracking': :'isCostTracking',
+        'validator': :'validator'
         # rubocop:enable Style/SymbolLiteral
       }
     end
@@ -55,7 +66,8 @@ module OCI
         'description': :'String',
         'freeform_tags': :'Hash<String, String>',
         'defined_tags': :'Hash<String, Hash<String, Object>>',
-        'is_cost_tracking': :'BOOLEAN'
+        'is_cost_tracking': :'BOOLEAN',
+        'validator': :'OCI::Identity::Models::BaseTagDefinitionValidator'
         # rubocop:enable Style/SymbolLiteral
       }
     end
@@ -71,6 +83,7 @@ module OCI
     # @option attributes [Hash<String, String>] :freeform_tags The value to assign to the {#freeform_tags} property
     # @option attributes [Hash<String, Hash<String, Object>>] :defined_tags The value to assign to the {#defined_tags} property
     # @option attributes [BOOLEAN] :is_cost_tracking The value to assign to the {#is_cost_tracking} property
+    # @option attributes [OCI::Identity::Models::BaseTagDefinitionValidator] :validator The value to assign to the {#validator} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 
@@ -98,6 +111,8 @@ module OCI
       raise 'You cannot provide both :isCostTracking and :is_cost_tracking' if attributes.key?(:'isCostTracking') && attributes.key?(:'is_cost_tracking')
 
       self.is_cost_tracking = attributes[:'is_cost_tracking'] unless attributes[:'is_cost_tracking'].nil?
+
+      self.validator = attributes[:'validator'] if attributes[:'validator']
     end
     # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
     # rubocop:enable Metrics/MethodLength, Layout/EmptyLines, Style/SymbolLiteral
@@ -115,7 +130,8 @@ module OCI
         description == other.description &&
         freeform_tags == other.freeform_tags &&
         defined_tags == other.defined_tags &&
-        is_cost_tracking == other.is_cost_tracking
+        is_cost_tracking == other.is_cost_tracking &&
+        validator == other.validator
     end
     # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity, Layout/EmptyLines
 
@@ -131,7 +147,7 @@ module OCI
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [name, description, freeform_tags, defined_tags, is_cost_tracking].hash
+      [name, description, freeform_tags, defined_tags, is_cost_tracking, validator].hash
     end
     # rubocop:enable Metrics/AbcSize, Layout/EmptyLines
 

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

@@ -0,0 +1,146 @@
+# Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved.
+
+require 'date'
+require_relative 'base_tag_definition_validator'
+
+# rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
+module OCI
+  # This is the default validatorType for definedTag. This is same as not setting any value on the validator field.
+  # By default only string value can be set for this definedTag.
+  #
+  class Identity::Models::DefaultTagDefinitionValidator < Identity::Models::BaseTagDefinitionValidator
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        # rubocop:disable Style/SymbolLiteral
+        'validator_type': :'validatorType'
+        # rubocop:enable Style/SymbolLiteral
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        # rubocop:disable Style/SymbolLiteral
+        'validator_type': :'String'
+        # rubocop:enable Style/SymbolLiteral
+      }
+    end
+
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
+    # rubocop:disable Metrics/MethodLength, Layout/EmptyLines, Style/SymbolLiteral
+
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      attributes['validatorType'] = 'DEFAULT'
+
+      super(attributes)
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
+    # rubocop:enable Metrics/MethodLength, Layout/EmptyLines, Style/SymbolLiteral
+
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity, Layout/EmptyLines
+
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] other the other object to be compared
+    def ==(other)
+      return true if equal?(other)
+
+      self.class == other.class &&
+        validator_type == other.validator_type
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity, Layout/EmptyLines
+
+    # @see the `==` method
+    # @param [Object] other the other object to be compared
+    def eql?(other)
+      self == other
+    end
+
+    # rubocop:disable Metrics/AbcSize, Layout/EmptyLines
+
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [validator_type].hash
+    end
+    # rubocop:enable Metrics/AbcSize, Layout/EmptyLines
+
+    # rubocop:disable Metrics/AbcSize, Layout/EmptyLines
+
+
+    # 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)
+            public_method("#{key}=").call(
+              attributes[self.class.attribute_map[key]]
+                .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
+            )
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          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
+    # rubocop:enable Metrics/AbcSize, Layout/EmptyLines
+
+    # 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
+  end
+end
+# rubocop:enable Lint/UnneededCopDisableDirective, Metrics/LineLength