oci 2.14.0 → 2.15.0

data/lib/oci/bds/models/work_request.rb

@@ -6,7 +6,7 @@ require 'logger'
 
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # A description of workrequest status
+  # Description of the work request status.
   class Bds::Models::WorkRequest
     OPERATION_TYPE_ENUM = [
       OPERATION_TYPE_CREATE_BDS = 'CREATE_BDS'.freeze,
@@ -35,23 +35,20 @@ module OCI
       STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
     ].freeze
 
-    # **[Required]** The id of the work request.
+    # **[Required]** The ID of the work request.
     # @return [String]
     attr_accessor :id
 
-    # **[Required]** The ocid of the compartment that contains the work request. Work requests should be scoped to
-    # the same compartment as the resource the work request affects. If the work request affects multiple resources,
-    # and those resources are not in the same compartment, it is up to the service team to pick the primary
-    # resource whose compartment should be used
+    # **[Required]** The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request affects multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used.
     #
     # @return [String]
     attr_accessor :compartment_id
 
-    # **[Required]** Type of the work request
+    # **[Required]** The type of this work request.
     # @return [String]
     attr_reader :operation_type
 
-    # **[Required]** Status of current work request.
+    # **[Required]** The status of this work request.
     # @return [String]
     attr_reader :status
 
@@ -59,23 +56,21 @@ module OCI
     # @return [Array<OCI::Bds::Models::WorkRequestResource>]
     attr_accessor :resources
 
-    # **[Required]** Percentage of the request completed.
+    # **[Required]** Percentage of this work request completed.
     # @return [Float]
     attr_accessor :percent_complete
 
-    # **[Required]** The date and time the request was created, as described in
-    # [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29.
+    # **[Required]** The date and time the request was created, shown as an RFC 3339 formatted datetime string.
     #
     # @return [DateTime]
     attr_accessor :time_accepted
 
-    # The date and time the request was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339),
-    # section 14.29.
+    # The time the request was started, shown as an RFC 3339 formatted datetime string.
     #
     # @return [DateTime]
     attr_accessor :time_started
 
-    # The date and time the object was finished, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339).
+    # The time the object was finished, shown as an RFC 3339 formatted datetime string.
     #
     # @return [DateTime]
     attr_accessor :time_finished

data/lib/oci/bds/models/work_request_error.rb

@@ -8,8 +8,7 @@ require 'logger'
 module OCI
   # An error encountered while executing a work request.
   class Bds::Models::WorkRequestError
-    # **[Required]** A machine-usable code for the error that occured. Error codes are listed on
-    # (https://docs.cloud.oracle.com/Content/API/References/apierrors.htm)
+    # **[Required]** A machine-usable code for the error that occured. Error codes are listed on (https://docs.oracle.com/en-us/iaas/Content/API/References/apierrors.htm).
     #
     # @return [String]
     attr_accessor :code
@@ -18,7 +17,7 @@ module OCI
     # @return [String]
     attr_accessor :message
 
-    # **[Required]** The time the error occured. An RFC3339 formatted datetime string.
+    # **[Required]** The time the error occured, shown as an RFC 3339 formatted datetime string.
     # @return [DateTime]
     attr_accessor :timestamp
 

data/lib/oci/bds/models/work_request_log_entry.rb

@@ -11,7 +11,7 @@ module OCI
     # @return [String]
     attr_accessor :message
 
-    # **[Required]** The time the log message was written. An RFC3339 formatted datetime string
+    # **[Required]** The time the log message was written, shown as an RFC 3339 formatted datetime string.
     # @return [DateTime]
     attr_accessor :timestamp
 

data/lib/oci/bds/models/work_request_resource.rb

@@ -21,10 +21,7 @@ module OCI
     # @return [String]
     attr_accessor :entity_type
 
-    # **[Required]** The way in which this resource is affected by the work tracked in the work request.
-    # A resource being created, updated, or deleted will remain in the IN_PROGRESS state until
-    # work is complete for that resource at which point it will transition to CREATED, UPDATED,
-    # or DELETED, respectively.
+    # **[Required]** The way in which this resource is affected by the work tracked in the work request. A resource being created, updated, or deleted remains in the IN_PROGRESS state until work is complete for that resource, at which point it will transition to CREATED, UPDATED, or DELETED, respectively.
     #
     # @return [String]
     attr_reader :action_type
@@ -33,7 +30,7 @@ module OCI
     # @return [String]
     attr_accessor :identifier
 
-    # The URI path that the user can do a GET on to access the resource metadata
+    # The URI path that the user can do a GET on to access the resource metadata.
     # @return [String]
     attr_accessor :entity_uri
 

data/lib/oci/container_engine/container_engine.rb

@@ -19,6 +19,8 @@ require 'oci/container_engine/models/cluster_endpoint_config'
 require 'oci/container_engine/models/cluster_endpoints'
 require 'oci/container_engine/models/cluster_lifecycle_state'
 require 'oci/container_engine/models/cluster_metadata'
+require 'oci/container_engine/models/cluster_migrate_to_native_vcn_details'
+require 'oci/container_engine/models/cluster_migrate_to_native_vcn_status'
 require 'oci/container_engine/models/cluster_options'
 require 'oci/container_engine/models/cluster_summary'
 require 'oci/container_engine/models/create_cluster_details'

data/lib/oci/container_engine/container_engine_client.rb

@@ -100,6 +100,68 @@ module OCI
     # rubocop:disable Metrics/MethodLength, Layout/EmptyLines
 
 
+    # Initiates cluster migration to use native VCN.
+    # @param [String] cluster_id The OCID of the cluster.
+    # @param [OCI::ContainerEngine::Models::ClusterMigrateToNativeVcnDetails] cluster_migrate_to_native_vcn_details The details for the cluster's migration to native VCN.
+    # @param [Hash] opts the optional parameters
+    # @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
+    #   retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
+    # @option opts [String] :if_match For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
+    #   parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
+    #   will be updated or deleted only if the etag you provide matches the resource's current etag value.
+    #
+    # @option opts [String] :opc_request_id Unique Oracle-assigned identifier for the request. If you need to contact
+    #   Oracle about a particular request, please provide the request ID.
+    #
+    # @return [Response] A Response object with data of type nil
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/containerengine/cluster_migrate_to_native_vcn.rb.html) to see an example of how to use cluster_migrate_to_native_vcn API.
+    def cluster_migrate_to_native_vcn(cluster_id, cluster_migrate_to_native_vcn_details, opts = {})
+      logger.debug 'Calling operation ContainerEngineClient#cluster_migrate_to_native_vcn.' if logger
+
+      raise "Missing the required parameter 'cluster_id' when calling cluster_migrate_to_native_vcn." if cluster_id.nil?
+      raise "Missing the required parameter 'cluster_migrate_to_native_vcn_details' when calling cluster_migrate_to_native_vcn." if cluster_migrate_to_native_vcn_details.nil?
+      raise "Parameter value for 'cluster_id' must not be blank" if OCI::Internal::Util.blank_string?(cluster_id)
+
+      path = '/clusters/{clusterId}/actions/migrateToNativeVcn'.sub('{clusterId}', cluster_id.to_s)
+      operation_signing_strategy = :standard
+
+      # rubocop:disable Style/NegatedIf
+      # Query Params
+      query_params = {}
+
+      # Header Params
+      header_params = {}
+      header_params[:accept] = 'application/json'
+      header_params[:'content-type'] = 'application/json'
+      header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
+      header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
+      # rubocop:enable Style/NegatedIf
+
+      post_body = @api_client.object_to_http_body(cluster_migrate_to_native_vcn_details)
+
+      # rubocop:disable Metrics/BlockLength
+      OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ContainerEngineClient#cluster_migrate_to_native_vcn') do
+        @api_client.call_api(
+          :POST,
+          path,
+          endpoint,
+          header_params: header_params,
+          query_params: query_params,
+          operation_signing_strategy: operation_signing_strategy,
+          body: post_body
+        )
+      end
+      # rubocop:enable Metrics/BlockLength
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
+    # rubocop:enable Style/IfUnlessModifier, Metrics/ParameterLists
+    # rubocop:enable Metrics/MethodLength, Layout/EmptyLines
+
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
+    # rubocop:disable Style/IfUnlessModifier, Metrics/ParameterLists
+    # rubocop:disable Metrics/MethodLength, Layout/EmptyLines
+
+
     # Create a new cluster.
     # @param [OCI::ContainerEngine::Models::CreateClusterDetails] create_cluster_details The details of the cluster to create.
     # @param [Hash] opts the optional parameters
@@ -557,6 +619,62 @@ module OCI
     # rubocop:disable Metrics/MethodLength, Layout/EmptyLines
 
 
+    # Get details on a cluster's migration to native VCN.
+    # @param [String] cluster_id The OCID of the cluster.
+    # @param [Hash] opts the optional parameters
+    # @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
+    #   retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
+    # @option opts [String] :opc_request_id Unique Oracle-assigned identifier for the request. If you need to contact
+    #   Oracle about a particular request, please provide the request ID.
+    #
+    # @return [Response] A Response object with data of type {OCI::ContainerEngine::Models::ClusterMigrateToNativeVcnStatus ClusterMigrateToNativeVcnStatus}
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/containerengine/get_cluster_migrate_to_native_vcn_status.rb.html) to see an example of how to use get_cluster_migrate_to_native_vcn_status API.
+    def get_cluster_migrate_to_native_vcn_status(cluster_id, opts = {})
+      logger.debug 'Calling operation ContainerEngineClient#get_cluster_migrate_to_native_vcn_status.' if logger
+
+      raise "Missing the required parameter 'cluster_id' when calling get_cluster_migrate_to_native_vcn_status." if cluster_id.nil?
+      raise "Parameter value for 'cluster_id' must not be blank" if OCI::Internal::Util.blank_string?(cluster_id)
+
+      path = '/clusters/{clusterId}/migrateToNativeVcnStatus'.sub('{clusterId}', cluster_id.to_s)
+      operation_signing_strategy = :standard
+
+      # rubocop:disable Style/NegatedIf
+      # Query Params
+      query_params = {}
+
+      # Header Params
+      header_params = {}
+      header_params[:accept] = 'application/json'
+      header_params[:'content-type'] = 'application/json'
+      header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
+      # rubocop:enable Style/NegatedIf
+
+      post_body = nil
+
+      # rubocop:disable Metrics/BlockLength
+      OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ContainerEngineClient#get_cluster_migrate_to_native_vcn_status') do
+        @api_client.call_api(
+          :GET,
+          path,
+          endpoint,
+          header_params: header_params,
+          query_params: query_params,
+          operation_signing_strategy: operation_signing_strategy,
+          body: post_body,
+          return_type: 'OCI::ContainerEngine::Models::ClusterMigrateToNativeVcnStatus'
+        )
+      end
+      # rubocop:enable Metrics/BlockLength
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
+    # rubocop:enable Style/IfUnlessModifier, Metrics/ParameterLists
+    # rubocop:enable Metrics/MethodLength, Layout/EmptyLines
+
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
+    # rubocop:disable Style/IfUnlessModifier, Metrics/ParameterLists
+    # rubocop:disable Metrics/MethodLength, Layout/EmptyLines
+
+
     # Get options available for clusters.
     # @param [String] cluster_option_id The id of the option set to retrieve. Use \"all\" get all options, or use a cluster ID to get options specific to the provided cluster.
     # @param [Hash] opts the optional parameters

data/lib/oci/container_engine/container_engine_client_composite_operations.rb

@@ -25,6 +25,56 @@ module OCI
     # rubocop:disable Layout/EmptyLines
 
 
+    # Calls {OCI::ContainerEngine::ContainerEngineClient#cluster_migrate_to_native_vcn} and then waits for the {OCI::ContainerEngine::Models::WorkRequest}
+    # to enter the given state(s).
+    #
+    # @param [String] cluster_id The OCID of the cluster.
+    # @param [OCI::ContainerEngine::Models::ClusterMigrateToNativeVcnDetails] cluster_migrate_to_native_vcn_details The details for the cluster's migration to native VCN.
+    # @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::ContainerEngine::Models::WorkRequest#status}
+    # @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::ContainerEngine::ContainerEngineClient#cluster_migrate_to_native_vcn}
+    # @param [Hash] waiter_opts Optional arguments for the waiter. Keys should be symbols, and the following keys are supported:
+    #   * max_interval_seconds: The maximum interval between queries, in seconds.
+    #   * max_wait_seconds The maximum time to wait, in seconds
+    #
+    # @return [OCI::Response] A {OCI::Response} object containing the completed {OCI::ContainerEngine::Models::WorkRequest}
+    def cluster_migrate_to_native_vcn_and_wait_for_state(cluster_id, cluster_migrate_to_native_vcn_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
+      operation_result = @service_client.cluster_migrate_to_native_vcn(cluster_id, cluster_migrate_to_native_vcn_details, base_operation_opts)
+      use_util = OCI::ContainerEngine::Util.respond_to?(:wait_on_work_request)
+
+      return operation_result if wait_for_states.empty? && !use_util
+
+      lowered_wait_for_states = wait_for_states.map(&:downcase)
+      wait_for_resource_id = operation_result.headers['opc-work-request-id']
+
+      begin
+        if use_util
+          waiter_result = OCI::ContainerEngine::Util.wait_on_work_request(
+            @service_client,
+            wait_for_resource_id,
+            max_interval_seconds: waiter_opts.key?(:max_interval_seconds) ? waiter_opts[:max_interval_seconds] : 30,
+            max_wait_seconds: waiter_opts.key?(:max_wait_seconds) ? waiter_opts[:max_wait_seconds] : 1200
+          )
+        else
+          waiter_result = @service_client.get_work_request(wait_for_resource_id).wait_until(
+            eval_proc: ->(response) { response.data.respond_to?(:status) && lowered_wait_for_states.include?(response.data.status.downcase) },
+            max_interval_seconds: waiter_opts.key?(:max_interval_seconds) ? waiter_opts[:max_interval_seconds] : 30,
+            max_wait_seconds: waiter_opts.key?(:max_wait_seconds) ? waiter_opts[:max_wait_seconds] : 1200
+          )
+        end
+        result_to_return = waiter_result
+
+        return result_to_return
+      rescue StandardError
+        raise OCI::Errors::CompositeOperationError.new(partial_results: [operation_result])
+      end
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/ParameterLists, Metrics/PerceivedComplexity
+    # rubocop:enable Layout/EmptyLines
+
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/ParameterLists, Metrics/PerceivedComplexity
+    # rubocop:disable Layout/EmptyLines
+
+
     # Calls {OCI::ContainerEngine::ContainerEngineClient#create_cluster} and then waits for the {OCI::ContainerEngine::Models::WorkRequest}
     # to enter the given state(s).
     #

data/lib/oci/container_engine/models/cluster_migrate_to_native_vcn_details.rb

@@ -0,0 +1,169 @@
+# Copyright (c) 2016, 2021, Oracle and/or its affiliates.  All rights reserved.
+# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
+
+require 'date'
+
+# rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
+module OCI
+  # The properties that define a request to migrate a cluster to Native VCN.
+  class ContainerEngine::Models::ClusterMigrateToNativeVcnDetails
+    # **[Required]** The network configuration for access to the Cluster control plane.
+    #
+    # @return [OCI::ContainerEngine::Models::ClusterEndpointConfig]
+    attr_accessor :endpoint_config
+
+    # The optional override of the non-native endpoint decommission time after migration is complete. Defaults to 30 days.
+    # @return [String]
+    attr_accessor :decommission_delay_duration
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        # rubocop:disable Style/SymbolLiteral
+        'endpoint_config': :'endpointConfig',
+        'decommission_delay_duration': :'decommissionDelayDuration'
+        # rubocop:enable Style/SymbolLiteral
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        # rubocop:disable Style/SymbolLiteral
+        'endpoint_config': :'OCI::ContainerEngine::Models::ClusterEndpointConfig',
+        'decommission_delay_duration': :'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
+    # @option attributes [OCI::ContainerEngine::Models::ClusterEndpointConfig] :endpoint_config The value to assign to the {#endpoint_config} property
+    # @option attributes [String] :decommission_delay_duration The value to assign to the {#decommission_delay_duration} 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.endpoint_config = attributes[:'endpointConfig'] if attributes[:'endpointConfig']
+
+      raise 'You cannot provide both :endpointConfig and :endpoint_config' if attributes.key?(:'endpointConfig') && attributes.key?(:'endpoint_config')
+
+      self.endpoint_config = attributes[:'endpoint_config'] if attributes[:'endpoint_config']
+
+      self.decommission_delay_duration = attributes[:'decommissionDelayDuration'] if attributes[:'decommissionDelayDuration']
+
+      raise 'You cannot provide both :decommissionDelayDuration and :decommission_delay_duration' if attributes.key?(:'decommissionDelayDuration') && attributes.key?(:'decommission_delay_duration')
+
+      self.decommission_delay_duration = attributes[:'decommission_delay_duration'] if attributes[:'decommission_delay_duration']
+    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 &&
+        endpoint_config == other.endpoint_config &&
+        decommission_delay_duration == other.decommission_delay_duration
+    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
+      [endpoint_config, decommission_delay_duration].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