oci 2.5.10 → 2.5.11

data/lib/oci/ons/notification_data_plane_client.rb

@@ -5,8 +5,8 @@ require 'logger'
 
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # Use the Notification API to broadcast messages to distributed components by topic, using a publish-subscribe pattern.
-  # For information about managing topics, subscriptions, and messages, see [Notification Overview](/iaas/Content/Notification/Concepts/notificationoverview.htm).
+  # Use the Notifications API to broadcast messages to distributed components by topic, using a publish-subscribe pattern.
+  # For information about managing topics, subscriptions, and messages, see [Notifications Overview](/iaas/Content/Notification/Concepts/notificationoverview.htm).
   class Ons::NotificationDataPlaneClient
     # Client used to make HTTP requests.
     # @return [OCI::ApiClient]
@@ -95,7 +95,7 @@ module OCI
 
       raise 'A region must be specified.' unless @region
 
-      @endpoint = OCI::Regions.get_service_endpoint(@region, :NotificationDataPlaneClient) + '/20181201'
+      @endpoint = OCI::Regions.get_service_endpoint_for_template(@region, 'https://notification.{region}.oraclecloud.com') + '/20181201'
       logger.info "NotificationDataPlaneClient endpoint set to '#{@endpoint} from region #{@region}'." if logger
     end
 
@@ -109,8 +109,85 @@ module OCI
     # rubocop:disable Metrics/MethodLength, Layout/EmptyLines
 
 
+    # Moves a subscription into a different compartment within the same tenancy. For information about moving
+    # resources between compartments, see
+    # [Moving Resources to a Different Compartment](https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
+    #
+    # Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
+    #
+    # @param [String] subscription_id The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription to move.
+    #
+    # @param [OCI::Ons::Models::ChangeCompartmentDetails] change_subscription_compartment_details The configuration details for the move operation.
+    # @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_retry_token A token that uniquely identifies a request so it can be retried in case of a timeout or
+    #   server error without risk of executing that same action again. Retry tokens expire after 24
+    #   hours, but can be invalidated before that due to conflicting operations (for example, if a resource
+    #   has been deleted and purged from the system, then a retry of the original creation request
+    #   may be rejected).
+    #
+    # @option opts [String] :opc_request_id The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
+    #   particular request, please provide the request ID.
+    #
+    # @option opts [String] :if_match Used 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.
+    #
+    # @return [Response] A Response object with data of type nil
+    def change_subscription_compartment(subscription_id, change_subscription_compartment_details, opts = {})
+      logger.debug 'Calling operation NotificationDataPlaneClient#change_subscription_compartment.' if logger
+
+      raise "Missing the required parameter 'subscription_id' when calling change_subscription_compartment." if subscription_id.nil?
+      raise "Missing the required parameter 'change_subscription_compartment_details' when calling change_subscription_compartment." if change_subscription_compartment_details.nil?
+      raise "Parameter value for 'subscription_id' must not be blank" if OCI::Internal::Util.blank_string?(subscription_id)
+
+      path = '/subscriptions/{subscriptionId}/actions/changeCompartment'.sub('{subscriptionId}', subscription_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-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
+      header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
+      header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
+      # rubocop:enable Style/NegatedIf
+      header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token
+
+      post_body = @api_client.object_to_http_body(change_subscription_compartment_details)
+
+      # rubocop:disable Metrics/BlockLength
+      OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NotificationDataPlaneClient#change_subscription_compartment') 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
+
+
     # Creates a subscription for the specified topic.
     #
+    # Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
+    #
     # @param [OCI::Ons::Models::CreateSubscriptionDetails] create_subscription_details The subscription to create.
     # @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
@@ -174,6 +251,8 @@ module OCI
 
     # Deletes the specified subscription.
     #
+    # Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
+    #
     # @param [String] subscription_id The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription to delete.
     #
     # @param [Hash] opts the optional parameters
@@ -235,7 +314,9 @@ module OCI
 
     # Gets the confirmation details for the specified subscription.
     #
-    # @param [String] id The subscription ID.
+    # Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
+    #
+    # @param [String] id The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription to get the confirmation details for.
     #
     # @param [String] token The subscription confirmation token.
     # @param [String] protocol The subscription protocol. Valid values: EMAIL, HTTPS.
@@ -299,6 +380,8 @@ module OCI
 
     # Gets the specified subscription's configuration information.
     #
+    # Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
+    #
     # @param [String] subscription_id The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription to retrieve.
     #
     # @param [Hash] opts the optional parameters
@@ -356,6 +439,8 @@ module OCI
 
     # Gets the unsubscription details for the specified subscription.
     #
+    # Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
+    #
     # @param [String] id The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription to unsubscribe from.
     #
     # @param [String] token The subscription confirmation token.
@@ -420,6 +505,8 @@ module OCI
 
     # Lists the subscriptions in the specified compartment or topic.
     #
+    # Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
+    #
     # @param [String] compartment_id The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
     #
     # @param [Hash] opts the optional parameters
@@ -427,9 +514,11 @@ module OCI
     #   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] :topic_id Return all subscriptions that are subscribed to the given topic OCID. Either this query parameter or the compartmentId query parameter must be set.
     #
-    # @option opts [String] :page For list pagination. The value of the opc-next-page response header from the previous \"List\" call. For important details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
+    # @option opts [String] :page For list pagination. The value of the opc-next-page response header from the previous \"List\" call.
+    #   For important details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
     #
-    # @option opts [Integer] :limit For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
+    # @option opts [Integer] :limit For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call.
+    #   For important details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
     #    (default to 10)
     # @option opts [String] :opc_request_id The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
     #   particular request, please provide the request ID.
@@ -484,7 +573,15 @@ module OCI
     # rubocop:disable Metrics/MethodLength, Layout/EmptyLines
 
 
-    # Publishes a message to the specified topic. For more information about publishing messages, see [Publishing Messages](https://docs.cloud.oracle.com/iaas/Content/Notification/Tasks/publishingmessages.htm).
+    # Publishes a message to the specified topic. Limits information follows.
+    #
+    # Message size limit per request: 64KB.
+    #
+    # Message delivery rate limit per endpoint: 60 messages per minute for HTTPS (PagerDuty) protocol, 10 messages per minute for Email protocol.
+    #
+    # Transactions Per Minute (TPM) per-tenancy limit for this operation: 60 per topic.
+    #
+    # For more information about publishing messages, see [Publishing Messages](https://docs.cloud.oracle.com/iaas/Content/Notification/Tasks/publishingmessages.htm).
     #
     # @param [String] topic_id The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic.
     #
@@ -495,7 +592,7 @@ module OCI
     # @option opts [String] :opc_request_id The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
     #   particular request, please provide the request ID.
     #
-    # @option opts [String] :message_type Type of message body in the request. Default value: JSON.
+    # @option opts [String] :message_type Type of message body in the request.
     #    (default to JSON)
     #   Allowed values are: JSON, RAW_TEXT
     # @return [Response] A Response object with data of type {OCI::Ons::Models::PublishResult PublishResult}
@@ -553,6 +650,8 @@ module OCI
 
     # Resends the confirmation details for the specified subscription.
     #
+    # Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
+    #
     # @param [String] id The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription to resend the confirmation for.
     #
     # @param [Hash] opts the optional parameters
@@ -610,6 +709,8 @@ module OCI
 
     # Updates the specified subscription's configuration.
     #
+    # Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
+    #
     # @param [String] subscription_id The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription to update.
     #
     # @param [OCI::Ons::Models::UpdateSubscriptionDetails] update_subscription_details The configuration details for updating the subscription.

data/lib/oci/ons/ons.rb

@@ -11,6 +11,7 @@ end
 
 # Require models
 require 'oci/ons/models/backoff_retry_policy'
+require 'oci/ons/models/change_compartment_details'
 require 'oci/ons/models/confirmation_result'
 require 'oci/ons/models/create_subscription_details'
 require 'oci/ons/models/create_topic_details'

data/lib/oci/regions.rb

@@ -6,6 +6,7 @@ module OCI
   # Module defining available regions and helper methods to get value service endpoints
   module Regions
     REGION_ENUM = [
+      REGION_AP_MUMBAI_1 = 'ap-mumbai-1'.freeze,
       REGION_AP_SEOUL_1 = 'ap-seoul-1'.freeze,
       REGION_AP_TOKYO_1 = 'ap-tokyo-1'.freeze,
       REGION_CA_TORONTO_1 = 'ca-toronto-1'.freeze,
@@ -21,6 +22,7 @@ module OCI
     ].freeze
 
     REGION_SHORT_NAMES_TO_LONG_NAMES = {
+      'bom': REGION_AP_MUMBAI_1,
       'icn': REGION_AP_SEOUL_1,
       'nrt': REGION_AP_TOKYO_1,
       'yyz': REGION_CA_TORONTO_1,
@@ -32,6 +34,7 @@ module OCI
 
     # --- Start of region realm mapping ---
     REGION_REALM_MAPPING = {
+      'ap-mumbai-1': 'oc1'.freeze,
       'ap-seoul-1': 'oc1'.freeze,
       'ap-tokyo-1': 'oc1'.freeze,
       'ca-toronto-1': 'oc1'.freeze,

data/lib/oci/streaming/models/change_stream_compartment_details.rb

@@ -0,0 +1,155 @@
+# Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved.
+
+require 'date'
+
+# rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
+module OCI
+  # Detailed representation of a change stream compartment operation.
+  class Streaming::Models::ChangeStreamCompartmentDetails
+    # **[Required]** The [OCID](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment
+    # into which the resource should be moved.
+    #
+    # @return [String]
+    attr_accessor :compartment_id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        # rubocop:disable Style/SymbolLiteral
+        'compartment_id': :'compartmentId'
+        # rubocop:enable Style/SymbolLiteral
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        # rubocop:disable Style/SymbolLiteral
+        'compartment_id': :'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 [String] :compartment_id The value to assign to the {#compartment_id} 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.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']
+    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 &&
+        compartment_id == other.compartment_id
+    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
+      [compartment_id].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/streaming/stream_admin_client.rb

@@ -108,6 +108,64 @@ module OCI
     # rubocop:disable Metrics/MethodLength, Layout/EmptyLines
 
 
+    # Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.
+    # @param [String] stream_id The OCID of the stream to change compatment for.
+    # @param [OCI::Streaming::Models::ChangeStreamCompartmentDetails] change_stream_compartment_details The stream will be moved into the compartment specified within this entity.
+    # @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 The 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
+    def change_stream_compartment(stream_id, change_stream_compartment_details, opts = {})
+      logger.debug 'Calling operation StreamAdminClient#change_stream_compartment.' if logger
+
+      raise "Missing the required parameter 'stream_id' when calling change_stream_compartment." if stream_id.nil?
+      raise "Missing the required parameter 'change_stream_compartment_details' when calling change_stream_compartment." if change_stream_compartment_details.nil?
+      raise "Parameter value for 'stream_id' must not be blank" if OCI::Internal::Util.blank_string?(stream_id)
+
+      path = '/streams/{streamId}/actions/changeCompartment'.sub('{streamId}', stream_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(change_stream_compartment_details)
+
+      # rubocop:disable Metrics/BlockLength
+      OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'StreamAdminClient#change_stream_compartment') 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
+
+
     # Starts the provisioning of a new stream.
     # To track the progress of the provisioning, you can periodically call {#get_stream get_stream}.
     # In the response, the `lifecycleState` parameter of the {Stream} object tells you its current state.