oci 2.5.10 → 2.5.11

data/lib/oci/ons/models/confirmation_result.rb

@@ -4,7 +4,7 @@ require 'date'
 
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # The confirmation result.
+  # The confirmation details for the specified subscription.
   #
   class Ons::Models::ConfirmationResult
     # **[Required]** The name of the subscribed topic.
@@ -12,27 +12,26 @@ module OCI
     # @return [String]
     attr_accessor :topic_name
 
-    # **[Required]** The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic to delete.
+    # **[Required]** The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic associated with the specified subscription.
     #
     # @return [String]
     attr_accessor :topic_id
 
     # **[Required]** The endpoint of the subscription. Valid values depend on the protocol.
     # For EMAIL, only an email address is valid. For HTTPS, only a PagerDuty URL is valid. A URL cannot exceed 512 characters.
-    # Avoid entering confidential information.
     #
     # @return [String]
     attr_accessor :endpoint
 
-    # **[Required]** The URL user can use to unsubscribe the topic.
+    # **[Required]** The URL for unsubscribing from the topic.
     # @return [String]
     attr_accessor :unsubscribe_url
 
-    # **[Required]** Human readable text which tells the user if the confirmation succeeds.
+    # **[Required]** A human-readable string indicating the status of the subscription confirmation.
     # @return [String]
     attr_accessor :message
 
-    # The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription.
+    # The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription specified in the request.
     # @return [String]
     attr_accessor :subscription_id
 

data/lib/oci/ons/models/create_topic_details.rb

@@ -7,7 +7,7 @@ module OCI
   # The configuration details for creating the topic.
   #
   class Ons::Models::CreateTopicDetails
-    # **[Required]** The name of the topic being created. Avoid entering confidential information.
+    # **[Required]** The name of the topic being created. The topic name must be unique across the tenancy. Avoid entering confidential information.
     # @return [String]
     attr_accessor :name
 

data/lib/oci/ons/models/notification_topic.rb

@@ -15,7 +15,7 @@ module OCI
       LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
     ].freeze
 
-    # **[Required]** The name of the topic. Avoid entering confidential information.
+    # **[Required]** The name of the topic.
     # @return [String]
     attr_accessor :name
 
@@ -34,7 +34,7 @@ module OCI
     # @return [String]
     attr_reader :lifecycle_state
 
-    # The description of the topic. Avoid entering confidential information.
+    # The description of the topic.
     # @return [String]
     attr_accessor :description
 

data/lib/oci/ons/models/notification_topic_summary.rb

@@ -15,7 +15,7 @@ module OCI
       LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
     ].freeze
 
-    # **[Required]** The name of the topic. Avoid entering confidential information.
+    # **[Required]** The name of the topic.
     #
     # @return [String]
     attr_accessor :name
@@ -35,7 +35,7 @@ module OCI
     # @return [String]
     attr_reader :lifecycle_state
 
-    # The description of the topic. Avoid entering confidential information.
+    # The description of the topic.
     # @return [String]
     attr_accessor :description
 

data/lib/oci/ons/models/subscription.rb

@@ -20,22 +20,35 @@ module OCI
     # @return [String]
     attr_accessor :id
 
-    # **[Required]** The subscription protocol. Valid values: EMAIL, HTTPS.
+    # **[Required]** The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the associated topic.
     #
+    # @return [String]
+    attr_accessor :topic_id
+
     # @return [String]
     attr_accessor :protocol
 
     # **[Required]** The endpoint of the subscription. Valid values depend on the protocol.
     # For EMAIL, only an email address is valid. For HTTPS, only a PagerDuty URL is valid. A URL cannot exceed 512 characters.
-    # Avoid entering confidential information.
     #
     # @return [String]
     attr_accessor :endpoint
 
-    # **[Required]** The lifecycle state of the subscription.
+    # **[Required]** The lifecycle state of the subscription. The status of a new subscription is PENDING; when confirmed, the subscription status changes to ACTIVE.
+    #
     # @return [String]
     attr_reader :lifecycle_state
 
+    # **[Required]** The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment for the subscription.
+    #
+    # @return [String]
+    attr_accessor :compartment_id
+
+    # The time when this suscription was created.
+    #
+    # @return [Integer]
+    attr_accessor :created_time
+
     # The delivery policy of the subscription. Stored as a JSON string.
     # @return [String]
     attr_accessor :deliver_policy
@@ -64,9 +77,12 @@ module OCI
       {
         # rubocop:disable Style/SymbolLiteral
         'id': :'id',
+        'topic_id': :'topicId',
         'protocol': :'protocol',
         'endpoint': :'endpoint',
         'lifecycle_state': :'lifecycleState',
+        'compartment_id': :'compartmentId',
+        'created_time': :'createdTime',
         'deliver_policy': :'deliverPolicy',
         'etag': :'etag',
         'freeform_tags': :'freeformTags',
@@ -80,9 +96,12 @@ module OCI
       {
         # rubocop:disable Style/SymbolLiteral
         'id': :'String',
+        'topic_id': :'String',
         'protocol': :'String',
         'endpoint': :'String',
         'lifecycle_state': :'String',
+        'compartment_id': :'String',
+        'created_time': :'Integer',
         'deliver_policy': :'String',
         'etag': :'String',
         'freeform_tags': :'Hash<String, String>',
@@ -98,9 +117,12 @@ module OCI
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
     # @option attributes [String] :id The value to assign to the {#id} property
+    # @option attributes [String] :topic_id The value to assign to the {#topic_id} property
     # @option attributes [String] :protocol The value to assign to the {#protocol} property
     # @option attributes [String] :endpoint The value to assign to the {#endpoint} property
     # @option attributes [String] :lifecycle_state The value to assign to the {#lifecycle_state} property
+    # @option attributes [String] :compartment_id The value to assign to the {#compartment_id} property
+    # @option attributes [Integer] :created_time The value to assign to the {#created_time} property
     # @option attributes [String] :deliver_policy The value to assign to the {#deliver_policy} property
     # @option attributes [String] :etag The value to assign to the {#etag} property
     # @option attributes [Hash<String, String>] :freeform_tags The value to assign to the {#freeform_tags} property
@@ -113,6 +135,12 @@ module OCI
 
       self.id = attributes[:'id'] if attributes[:'id']
 
+      self.topic_id = attributes[:'topicId'] if attributes[:'topicId']
+
+      raise 'You cannot provide both :topicId and :topic_id' if attributes.key?(:'topicId') && attributes.key?(:'topic_id')
+
+      self.topic_id = attributes[:'topic_id'] if attributes[:'topic_id']
+
       self.protocol = attributes[:'protocol'] if attributes[:'protocol']
 
       self.endpoint = attributes[:'endpoint'] if attributes[:'endpoint']
@@ -125,6 +153,18 @@ module OCI
       self.lifecycle_state = attributes[:'lifecycle_state'] if attributes[:'lifecycle_state']
       self.lifecycle_state = "PENDING" if lifecycle_state.nil? && !attributes.key?(:'lifecycleState') && !attributes.key?(:'lifecycle_state') # rubocop:disable Style/StringLiterals
 
+      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.created_time = attributes[:'createdTime'] if attributes[:'createdTime']
+
+      raise 'You cannot provide both :createdTime and :created_time' if attributes.key?(:'createdTime') && attributes.key?(:'created_time')
+
+      self.created_time = attributes[:'created_time'] if attributes[:'created_time']
+
       self.deliver_policy = attributes[:'deliverPolicy'] if attributes[:'deliverPolicy']
 
       raise 'You cannot provide both :deliverPolicy and :deliver_policy' if attributes.key?(:'deliverPolicy') && attributes.key?(:'deliver_policy')
@@ -171,9 +211,12 @@ module OCI
 
       self.class == other.class &&
         id == other.id &&
+        topic_id == other.topic_id &&
         protocol == other.protocol &&
         endpoint == other.endpoint &&
         lifecycle_state == other.lifecycle_state &&
+        compartment_id == other.compartment_id &&
+        created_time == other.created_time &&
         deliver_policy == other.deliver_policy &&
         etag == other.etag &&
         freeform_tags == other.freeform_tags &&
@@ -193,7 +236,7 @@ module OCI
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, protocol, endpoint, lifecycle_state, deliver_policy, etag, freeform_tags, defined_tags].hash
+      [id, topic_id, protocol, endpoint, lifecycle_state, compartment_id, created_time, deliver_policy, etag, freeform_tags, defined_tags].hash
     end
     # rubocop:enable Metrics/AbcSize, Layout/EmptyLines
 

data/lib/oci/ons/models/subscription_summary.rb

@@ -32,16 +32,20 @@ module OCI
 
     # **[Required]** The endpoint of the subscription. Valid values depend on the protocol.
     # For EMAIL, only an email address is valid. For HTTPS, only a PagerDuty URL is valid. A URL cannot exceed 512 characters.
-    # Avoid entering confidential information.
     #
     # @return [String]
     attr_accessor :endpoint
 
-    # **[Required]** The lifecycle state of the subscription. Default value for a newly created subscription: PENDING.
+    # **[Required]** The lifecycle state of the subscription. The status of a new subscription is PENDING; when confirmed, the subscription status changes to ACTIVE.
     #
     # @return [String]
     attr_reader :lifecycle_state
 
+    # **[Required]** The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment for the subscription.
+    #
+    # @return [String]
+    attr_accessor :compartment_id
+
     # The time when this suscription was created.
     # @return [Integer]
     attr_accessor :created_time
@@ -77,6 +81,7 @@ module OCI
         'protocol': :'protocol',
         'endpoint': :'endpoint',
         'lifecycle_state': :'lifecycleState',
+        'compartment_id': :'compartmentId',
         'created_time': :'createdTime',
         'delivery_policy': :'deliveryPolicy',
         'etag': :'etag',
@@ -95,6 +100,7 @@ module OCI
         'protocol': :'String',
         'endpoint': :'String',
         'lifecycle_state': :'String',
+        'compartment_id': :'String',
         'created_time': :'Integer',
         'delivery_policy': :'OCI::Ons::Models::DeliveryPolicy',
         'etag': :'String',
@@ -115,6 +121,7 @@ module OCI
     # @option attributes [String] :protocol The value to assign to the {#protocol} property
     # @option attributes [String] :endpoint The value to assign to the {#endpoint} property
     # @option attributes [String] :lifecycle_state The value to assign to the {#lifecycle_state} property
+    # @option attributes [String] :compartment_id The value to assign to the {#compartment_id} property
     # @option attributes [Integer] :created_time The value to assign to the {#created_time} property
     # @option attributes [OCI::Ons::Models::DeliveryPolicy] :delivery_policy The value to assign to the {#delivery_policy} property
     # @option attributes [String] :etag The value to assign to the {#etag} property
@@ -139,10 +146,18 @@ module OCI
       self.endpoint = attributes[:'endpoint'] if attributes[:'endpoint']
 
       self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']
+      self.lifecycle_state = "PENDING" if lifecycle_state.nil? && !attributes.key?(:'lifecycleState') # rubocop:disable Style/StringLiterals
 
       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.lifecycle_state = "PENDING" if lifecycle_state.nil? && !attributes.key?(:'lifecycleState') && !attributes.key?(:'lifecycle_state') # rubocop:disable Style/StringLiterals
+
+      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.created_time = attributes[:'createdTime'] if attributes[:'createdTime']
 
@@ -200,6 +215,7 @@ module OCI
         protocol == other.protocol &&
         endpoint == other.endpoint &&
         lifecycle_state == other.lifecycle_state &&
+        compartment_id == other.compartment_id &&
         created_time == other.created_time &&
         delivery_policy == other.delivery_policy &&
         etag == other.etag &&
@@ -220,7 +236,7 @@ module OCI
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, topic_id, protocol, endpoint, lifecycle_state, created_time, delivery_policy, etag, freeform_tags, defined_tags].hash
+      [id, topic_id, protocol, endpoint, lifecycle_state, compartment_id, created_time, delivery_policy, etag, freeform_tags, defined_tags].hash
     end
     # rubocop:enable Metrics/AbcSize, Layout/EmptyLines
 

data/lib/oci/ons/notification_control_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::NotificationControlPlaneClient
     # 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, :NotificationControlPlaneClient) + '/20181201'
+      @endpoint = OCI::Regions.get_service_endpoint_for_template(@region, 'https://notification.{region}.oraclecloud.com') + '/20181201'
       logger.info "NotificationControlPlaneClient endpoint set to '#{@endpoint} from region #{@region}'." if logger
     end
 
@@ -109,6 +109,81 @@ module OCI
     # rubocop:disable Metrics/MethodLength, Layout/EmptyLines
 
 
+    # Moves a topic 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] topic_id The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic to move.
+    #
+    # @param [OCI::Ons::Models::ChangeCompartmentDetails] change_topic_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_topic_compartment(topic_id, change_topic_compartment_details, opts = {})
+      logger.debug 'Calling operation NotificationControlPlaneClient#change_topic_compartment.' if logger
+
+      raise "Missing the required parameter 'topic_id' when calling change_topic_compartment." if topic_id.nil?
+      raise "Missing the required parameter 'change_topic_compartment_details' when calling change_topic_compartment." if change_topic_compartment_details.nil?
+      raise "Parameter value for 'topic_id' must not be blank" if OCI::Internal::Util.blank_string?(topic_id)
+
+      path = '/topics/{topicId}/actions/changeCompartment'.sub('{topicId}', topic_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_topic_compartment_details)
+
+      # rubocop:disable Metrics/BlockLength
+      OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NotificationControlPlaneClient#change_topic_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 topic in the specified compartment. For general information about topics, see
     # [Managing Topics and Subscriptions](https://docs.cloud.oracle.com/iaas/Content/Notification/Tasks/managingtopicsandsubscriptions.htm).
     #
@@ -120,7 +195,9 @@ module OCI
     # All Oracle Cloud Infrastructure resources, including topics, get an Oracle-assigned, unique ID called an
     # Oracle Cloud Identifier (OCID). When you create a resource, you can find its OCID in the response. You can also
     # retrieve a resource's OCID by using a List API operation on that resource type, or by viewing the resource in the
-    # Console. Fore more information, see [Resource Identifiers](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
+    # Console. For more information, see [Resource Identifiers](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
+    #
+    # Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
     #
     # @param [OCI::Ons::Models::CreateTopicDetails] create_topic_details The topic to create.
     # @param [Hash] opts the optional parameters
@@ -185,6 +262,8 @@ module OCI
 
     # Deletes the specified topic.
     #
+    # Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
+    #
     # @param [String] topic_id The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic to delete.
     #
     # @param [Hash] opts the optional parameters
@@ -248,6 +327,8 @@ module OCI
     #
     # @param [String] topic_id The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic to retrieve.
     #
+    #   Transactions Per Minute (TPM) per-tenancy limit for this operation: 120.
+    #
     # @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
@@ -303,6 +384,8 @@ module OCI
 
     # Lists topics in the specified compartment.
     #
+    # Transactions Per Minute (TPM) per-tenancy limit for this operation: 120.
+    #
     # @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
@@ -312,14 +395,16 @@ module OCI
     #
     # @option opts [String] :name A filter to only return resources that match the given name exactly.
     #
-    # @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] :sort_by The field to sort by. Only one field can be selected for sorting. Default value: TIMECREATED.
+    # @option opts [String] :sort_by The field to sort by. Only one field can be selected for sorting.
     #    (default to TIMECREATED)
     #   Allowed values are: TIMECREATED, LIFECYCLESTATE
-    # @option opts [String] :sort_order The sort order to use (ascending or descending). Default value: ASC.
+    # @option opts [String] :sort_order The sort order to use (ascending or descending).
     #    (default to ASC)
     #   Allowed values are: ASC, DESC
     # @option opts [String] :lifecycle_state Filter returned list by specified lifecycle state. This parameter is case-insensitive.
@@ -395,6 +480,8 @@ module OCI
 
     # Updates the specified topic's configuration.
     #
+    # Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
+    #
     # @param [String] topic_id The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic to update.
     #
     # @param [Hash] opts the optional parameters