oci 2.5.11 → 2.6.0

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

@@ -0,0 +1,325 @@
+# Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved.
+
+require 'date'
+require 'logger'
+
+# rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
+module OCI
+  # A dedicated virtual machine (VM) host that enables you to host multiple instances on a dedicated host instance that is not shared with other tenancies.
+  #
+  class Core::Models::DedicatedVmHostSummary
+    LIFECYCLE_STATE_ENUM = [
+      LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
+      LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
+      LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
+      LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
+      LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
+      LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
+      LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
+    ].freeze
+
+    # **[Required]** The availability domain the dedicated VM host is running in.
+    #
+    # Example: `Uocm:PHX-AD-1`
+    #
+    # @return [String]
+    attr_accessor :availability_domain
+
+    # **[Required]** The OCID of the compartment that contains the dedicated VM host.
+    #
+    # @return [String]
+    attr_accessor :compartment_id
+
+    # **[Required]** The shape of the dedicated VM host. The shape determines the number of CPUs and
+    # other resources available for VMs.
+    #
+    # @return [String]
+    attr_accessor :dedicated_vm_host_shape
+
+    # **[Required]** A user-friendly name. Does not have to be unique, and it's changeable.
+    # Avoid entering confidential information.
+    #
+    # Example: `My DVH`
+    #
+    # @return [String]
+    attr_accessor :display_name
+
+    # The fault domain for the dedicated VM host's assigned instances. For more information, see Fault Domains.
+    #
+    # If you do not specify the fault domain, the system selects one for you. To change the fault domain for a dedicated VM host,
+    # delete it and create a new dedicated VM host in the preferred fault domain.
+    #
+    # To get a list of fault domains, use the ListFaultDomains operation in the Identity and Access Management Service API.
+    #
+    # Example: `FAULT-DOMAIN-1`
+    #
+    # @return [String]
+    attr_accessor :fault_domain
+
+    # **[Required]** The OCID of the dedicated VM host.
+    #
+    # @return [String]
+    attr_accessor :id
+
+    # **[Required]** The current state of the dedicated VM host.
+    #
+    # @return [String]
+    attr_reader :lifecycle_state
+
+    # **[Required]** The date and time the dedicated VM host was created, in the format defined by RFC3339.
+    #
+    # Example: `2016-08-25T21:10:29.600Z`
+    #
+    # @return [DateTime]
+    attr_accessor :time_created
+
+    # **[Required]** The current available OCPUs of the dedicated VM host.
+    #
+    # @return [Float]
+    attr_accessor :remaining_ocpus
+
+    # **[Required]** The current total OCPUs of the dedicated VM host.
+    #
+    # @return [Float]
+    attr_accessor :total_ocpus
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        # rubocop:disable Style/SymbolLiteral
+        'availability_domain': :'availabilityDomain',
+        'compartment_id': :'compartmentId',
+        'dedicated_vm_host_shape': :'dedicatedVmHostShape',
+        'display_name': :'displayName',
+        'fault_domain': :'faultDomain',
+        'id': :'id',
+        'lifecycle_state': :'lifecycleState',
+        'time_created': :'timeCreated',
+        'remaining_ocpus': :'remainingOcpus',
+        'total_ocpus': :'totalOcpus'
+        # rubocop:enable Style/SymbolLiteral
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        # rubocop:disable Style/SymbolLiteral
+        'availability_domain': :'String',
+        'compartment_id': :'String',
+        'dedicated_vm_host_shape': :'String',
+        'display_name': :'String',
+        'fault_domain': :'String',
+        'id': :'String',
+        'lifecycle_state': :'String',
+        'time_created': :'DateTime',
+        'remaining_ocpus': :'Float',
+        'total_ocpus': :'Float'
+        # 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
+    # @option attributes [String] :availability_domain The value to assign to the {#availability_domain} property
+    # @option attributes [String] :compartment_id The value to assign to the {#compartment_id} property
+    # @option attributes [String] :dedicated_vm_host_shape The value to assign to the {#dedicated_vm_host_shape} property
+    # @option attributes [String] :display_name The value to assign to the {#display_name} property
+    # @option attributes [String] :fault_domain The value to assign to the {#fault_domain} property
+    # @option attributes [String] :id The value to assign to the {#id} property
+    # @option attributes [String] :lifecycle_state The value to assign to the {#lifecycle_state} property
+    # @option attributes [DateTime] :time_created The value to assign to the {#time_created} property
+    # @option attributes [Float] :remaining_ocpus The value to assign to the {#remaining_ocpus} property
+    # @option attributes [Float] :total_ocpus The value to assign to the {#total_ocpus} 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.availability_domain = attributes[:'availabilityDomain'] if attributes[:'availabilityDomain']
+
+      raise 'You cannot provide both :availabilityDomain and :availability_domain' if attributes.key?(:'availabilityDomain') && attributes.key?(:'availability_domain')
+
+      self.availability_domain = attributes[:'availability_domain'] if attributes[:'availability_domain']
+
+      self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']
+
+      raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id')
+
+      self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_id']
+
+      self.dedicated_vm_host_shape = attributes[:'dedicatedVmHostShape'] if attributes[:'dedicatedVmHostShape']
+
+      raise 'You cannot provide both :dedicatedVmHostShape and :dedicated_vm_host_shape' if attributes.key?(:'dedicatedVmHostShape') && attributes.key?(:'dedicated_vm_host_shape')
+
+      self.dedicated_vm_host_shape = attributes[:'dedicated_vm_host_shape'] if attributes[:'dedicated_vm_host_shape']
+
+      self.display_name = attributes[:'displayName'] if attributes[:'displayName']
+
+      raise 'You cannot provide both :displayName and :display_name' if attributes.key?(:'displayName') && attributes.key?(:'display_name')
+
+      self.display_name = attributes[:'display_name'] if attributes[:'display_name']
+
+      self.fault_domain = attributes[:'faultDomain'] if attributes[:'faultDomain']
+
+      raise 'You cannot provide both :faultDomain and :fault_domain' if attributes.key?(:'faultDomain') && attributes.key?(:'fault_domain')
+
+      self.fault_domain = attributes[:'fault_domain'] if attributes[:'fault_domain']
+
+      self.id = attributes[:'id'] if attributes[:'id']
+
+      self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']
+
+      raise 'You cannot provide both :lifecycleState and :lifecycle_state' if attributes.key?(:'lifecycleState') && attributes.key?(:'lifecycle_state')
+
+      self.lifecycle_state = attributes[:'lifecycle_state'] if attributes[:'lifecycle_state']
+
+      self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']
+
+      raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created')
+
+      self.time_created = attributes[:'time_created'] if attributes[:'time_created']
+
+      self.remaining_ocpus = attributes[:'remainingOcpus'] if attributes[:'remainingOcpus']
+
+      raise 'You cannot provide both :remainingOcpus and :remaining_ocpus' if attributes.key?(:'remainingOcpus') && attributes.key?(:'remaining_ocpus')
+
+      self.remaining_ocpus = attributes[:'remaining_ocpus'] if attributes[:'remaining_ocpus']
+
+      self.total_ocpus = attributes[:'totalOcpus'] if attributes[:'totalOcpus']
+
+      raise 'You cannot provide both :totalOcpus and :total_ocpus' if attributes.key?(:'totalOcpus') && attributes.key?(:'total_ocpus')
+
+      self.total_ocpus = attributes[:'total_ocpus'] if attributes[:'total_ocpus']
+    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] lifecycle_state Object to be assigned
+    def lifecycle_state=(lifecycle_state)
+      # rubocop:disable Style/ConditionalAssignment
+      if lifecycle_state && !LIFECYCLE_STATE_ENUM.include?(lifecycle_state)
+        OCI.logger.debug("Unknown value for 'lifecycle_state' [" + lifecycle_state + "]. Mapping to 'LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE'") if OCI.logger
+        @lifecycle_state = LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE
+      else
+        @lifecycle_state = lifecycle_state
+      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 &&
+        availability_domain == other.availability_domain &&
+        compartment_id == other.compartment_id &&
+        dedicated_vm_host_shape == other.dedicated_vm_host_shape &&
+        display_name == other.display_name &&
+        fault_domain == other.fault_domain &&
+        id == other.id &&
+        lifecycle_state == other.lifecycle_state &&
+        time_created == other.time_created &&
+        remaining_ocpus == other.remaining_ocpus &&
+        total_ocpus == other.total_ocpus
+    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
+      [availability_domain, compartment_id, dedicated_vm_host_shape, display_name, fault_domain, id, lifecycle_state, time_created, remaining_ocpus, total_ocpus].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/core/models/drg_attachment.rb

@@ -42,9 +42,12 @@ module OCI
     # @return [String]
     attr_reader :lifecycle_state
 
-    # The OCID of the route table the DRG attachment is using. For information about why you
-    # would associate a route table with a DRG attachment, see
-    # [Advanced Scenario: Transit Routing](https://docs.cloud.oracle.com/Content/Network/Tasks/transitrouting.htm).
+    # The OCID of the route table the DRG attachment is using.
+    #
+    # For information about why you would associate a route table with a DRG attachment, see:
+    #
+    #   * [Transit Routing: Access to Multiple VCNs in Same Region](https://docs.cloud.oracle.com/Content/Network/Tasks/transitrouting.htm)
+    #   * [Transit Routing: Private Access to Oracle Services](https://docs.cloud.oracle.com/Content/Network/Tasks/transitroutingoracleservices.htm)
     #
     # @return [String]
     attr_accessor :route_table_id

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

@@ -19,6 +19,7 @@ module OCI
     # Allowed values:
     #
     #   * IP address range in CIDR notation. For example: `192.168.1.0/24` or `2001:0db8:0123:45::/56`
+    #     Note that IPv6 addressing is currently supported only in the Government Cloud.
     #
     #   * The `cidrBlock` value for a {Service}, if you're
     #     setting up a security list rule for traffic destined for a particular `Service` through

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

@@ -45,6 +45,7 @@ module OCI
 
     # **[Required]** Whether instances launched with this image can be used to create new images.
     # For example, you cannot create an image of an Oracle Database instance.
+    #
     # Example: `true`
     #
     # @return [BOOLEAN]
@@ -60,6 +61,7 @@ module OCI
 
     # A user-friendly name for the image. It does not have to be unique, and it's changeable.
     # Avoid entering confidential information.
+    #
     # You cannot use an Oracle-provided image name as a custom image name.
     #
     # Example: `My custom Oracle Linux image`

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

@@ -50,7 +50,8 @@ module OCI
     #
     # Allowed values:
     #
-    #   * IP address range in CIDR notation. For example: `192.168.1.0/24` or `2001:0db8:0123:45::/56`
+    #   * IP address range in CIDR notation. For example: `192.168.1.0/24` or `2001:0db8:0123:45::/56`.
+    #     Note that IPv6 addressing is currently supported only in the Government Cloud.
     #
     #   * The `cidrBlock` value for a {Service}, if you're
     #     setting up a security list rule for traffic coming from a particular `Service` through

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

@@ -50,6 +50,11 @@ module OCI
     # @return [String]
     attr_accessor :compartment_id
 
+    # The OCID of dedicated VM host.
+    #
+    # @return [String]
+    attr_accessor :dedicated_vm_host_id
+
     # Defined tags for this resource. Each key is predefined and scoped to a
     # namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
     #
@@ -197,6 +202,7 @@ module OCI
         # rubocop:disable Style/SymbolLiteral
         'availability_domain': :'availabilityDomain',
         'compartment_id': :'compartmentId',
+        'dedicated_vm_host_id': :'dedicatedVmHostId',
         'defined_tags': :'definedTags',
         'display_name': :'displayName',
         'extended_metadata': :'extendedMetadata',
@@ -225,6 +231,7 @@ module OCI
         # rubocop:disable Style/SymbolLiteral
         'availability_domain': :'String',
         'compartment_id': :'String',
+        'dedicated_vm_host_id': :'String',
         'defined_tags': :'Hash<String, Hash<String, Object>>',
         'display_name': :'String',
         'extended_metadata': :'Hash<String, Object>',
@@ -255,6 +262,7 @@ module OCI
     # @param [Hash] attributes Model attributes in the form of hash
     # @option attributes [String] :availability_domain The value to assign to the {#availability_domain} property
     # @option attributes [String] :compartment_id The value to assign to the {#compartment_id} property
+    # @option attributes [String] :dedicated_vm_host_id The value to assign to the {#dedicated_vm_host_id} property
     # @option attributes [Hash<String, Hash<String, Object>>] :defined_tags The value to assign to the {#defined_tags} property
     # @option attributes [String] :display_name The value to assign to the {#display_name} property
     # @option attributes [Hash<String, Object>] :extended_metadata The value to assign to the {#extended_metadata} property
@@ -291,6 +299,12 @@ module OCI
 
       self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_id']
 
+      self.dedicated_vm_host_id = attributes[:'dedicatedVmHostId'] if attributes[:'dedicatedVmHostId']
+
+      raise 'You cannot provide both :dedicatedVmHostId and :dedicated_vm_host_id' if attributes.key?(:'dedicatedVmHostId') && attributes.key?(:'dedicated_vm_host_id')
+
+      self.dedicated_vm_host_id = attributes[:'dedicated_vm_host_id'] if attributes[:'dedicated_vm_host_id']
+
       self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']
 
       raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags')
@@ -423,6 +437,7 @@ module OCI
       self.class == other.class &&
         availability_domain == other.availability_domain &&
         compartment_id == other.compartment_id &&
+        dedicated_vm_host_id == other.dedicated_vm_host_id &&
         defined_tags == other.defined_tags &&
         display_name == other.display_name &&
         extended_metadata == other.extended_metadata &&
@@ -456,7 +471,7 @@ module OCI
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [availability_domain, compartment_id, defined_tags, display_name, extended_metadata, fault_domain, freeform_tags, id, image_id, ipxe_script, launch_mode, launch_options, lifecycle_state, metadata, region, shape, source_details, time_created, agent_config, time_maintenance_reboot_due].hash
+      [availability_domain, compartment_id, dedicated_vm_host_id, defined_tags, display_name, extended_metadata, fault_domain, freeform_tags, id, image_id, ipxe_script, launch_mode, launch_options, lifecycle_state, metadata, region, shape, source_details, time_created, agent_config, time_maintenance_reboot_due].hash
     end
     # rubocop:enable Metrics/AbcSize, Layout/EmptyLines
 

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

@@ -4,12 +4,13 @@ require 'date'
 
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # An instance configuration is a template that defines the settings to use when creating Compute instances
-  # as part of an instance pool. For more information about instance pools and instance configurations, see
+  # An instance configuration is a template that defines the settings to use when creating Compute instances.
+  # For more information about instance configurations, see
   # [Managing Compute Instances](https://docs.cloud.oracle.com/Content/Compute/Concepts/instancemanagement.htm).
   #
   class Core::Models::InstanceConfiguration
-    # **[Required]** The OCID of the compartment containing the instance configuration.
+    # **[Required]** The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment
+    # containing the instance configuration.
     #
     # @return [String]
     attr_accessor :compartment_id
@@ -22,7 +23,7 @@ module OCI
     # @return [Hash<String, Hash<String, Object>>]
     attr_accessor :defined_tags
 
-    # A user-friendly name for the instance configuration
+    # A user-friendly name for the instance configuration.
     #
     # @return [String]
     attr_accessor :display_name
@@ -35,20 +36,22 @@ module OCI
     # @return [Hash<String, String>]
     attr_accessor :freeform_tags
 
-    # **[Required]** The OCID of the instance configuration
+    # **[Required]** The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the instance configuration.
     # @return [String]
     attr_accessor :id
 
     # @return [OCI::Core::Models::InstanceConfigurationInstanceDetails]
     attr_accessor :instance_details
 
-    # The required details when using the {#launch_instance_configuration launch_instance_configuration} operation.
-    # These attributes are optional when using the {#create_instance_configuration create_instance_configuration} operation.
+    # Parameters that were not specified when the instance configuration was created, but that
+    # are required to launch an instance from the instance configuration. See the
+    # {#launch_instance_configuration launch_instance_configuration} operation.
     #
     # @return [Array<String>]
     attr_accessor :deferred_fields
 
     # **[Required]** The date and time the instance configuration was created, in the format defined by RFC3339.
+    #
     # Example: `2016-08-25T21:10:29.600Z`
     #
     # @return [DateTime]