oci 2.6.0 → 2.7.0

data/lib/oci/oda/oda_client_composite_operations.rb

@@ -0,0 +1,212 @@
+# Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved.
+
+# rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
+module OCI
+  # This class provides a wrapper around {OCI::Oda::OdaClient} and offers convenience methods
+  # for operations that would otherwise need to be chained together. For example, instead of performing an action
+  # on a resource (e.g. launching an instance, creating a load balancer) and then using a waiter to wait for the resource
+  # to enter a given state, you can call a single method in this class to accomplish the same functionality
+  class Oda::OdaClientCompositeOperations
+    # The {OCI::Oda::OdaClient} used to communicate with the service_client
+    #
+    # @return [OCI::Oda::OdaClient]
+    attr_reader :service_client
+
+    # Initializes a new OdaClientCompositeOperations
+    #
+    # @param [OCI::Oda::OdaClient] service_client The client used to communicate with the service.
+    #   Defaults to a new service client created via {OCI::Oda::OdaClient#initialize} with no arguments
+    def initialize(service_client = OCI::Oda::OdaClient.new)
+      @service_client = service_client
+    end
+
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/ParameterLists, Metrics/PerceivedComplexity
+    # rubocop:disable Layout/EmptyLines
+
+
+    # Calls {OCI::Oda::OdaClient#change_oda_instance_compartment} and then waits for the {OCI::Oda::Models::WorkRequest}
+    # to enter the given state(s).
+    #
+    # @param [String] oda_instance_id Unique Digital Assistant instance identifier.
+    # @param [OCI::Oda::Models::ChangeOdaInstanceCompartmentDetails] change_oda_instance_compartment_details The compartment to which the Digital Assistant instance should be moved.
+    # @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::Oda::Models::WorkRequest#status}
+    # @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::Oda::OdaClient#change_oda_instance_compartment}
+    # @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::Oda::Models::WorkRequest}
+    def change_oda_instance_compartment_and_wait_for_state(oda_instance_id, change_oda_instance_compartment_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
+      operation_result = @service_client.change_oda_instance_compartment(oda_instance_id, change_oda_instance_compartment_details, base_operation_opts)
+      use_util = OCI::Oda::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::Oda::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::Oda::OdaClient#create_oda_instance} and then waits for the {OCI::Oda::Models::WorkRequest}
+    # to enter the given state(s).
+    #
+    # @param [OCI::Oda::Models::CreateOdaInstanceDetails] create_oda_instance_details Details for the new Digital Assistant instance.
+    # @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::Oda::Models::WorkRequest#status}
+    # @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::Oda::OdaClient#create_oda_instance}
+    # @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 with data of type {OCI::Oda::Models::OdaInstance}
+    def create_oda_instance_and_wait_for_state(create_oda_instance_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
+      operation_result = @service_client.create_oda_instance(create_oda_instance_details, base_operation_opts)
+      use_util = OCI::Oda::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::Oda::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 = @service_client.get_oda_instance(waiter_result.data.oda_instance_id)
+
+        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::Oda::OdaClient#delete_oda_instance} and then waits for the {OCI::Oda::Models::WorkRequest}
+    # to enter the given state(s).
+    #
+    # @param [String] oda_instance_id Unique Digital Assistant instance identifier.
+    # @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::Oda::Models::WorkRequest#status}
+    # @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::Oda::OdaClient#delete_oda_instance}
+    # @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::Oda::Models::WorkRequest}
+    def delete_oda_instance_and_wait_for_state(oda_instance_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
+      operation_result = @service_client.delete_oda_instance(oda_instance_id, base_operation_opts)
+      use_util = OCI::Oda::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::Oda::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::Oda::OdaClient#update_oda_instance} and then waits for the {OCI::Oda::Models::OdaInstance} acted upon
+    # to enter the given state(s).
+    #
+    # @param [String] oda_instance_id Unique Digital Assistant instance identifier.
+    # @param [OCI::Oda::Models::UpdateOdaInstanceDetails] update_oda_instance_details The information to update.
+    # @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::Oda::Models::OdaInstance#lifecycle_state}
+    # @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::Oda::OdaClient#update_oda_instance}
+    # @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 with data of type {OCI::Oda::Models::OdaInstance}
+    def update_oda_instance_and_wait_for_state(oda_instance_id, update_oda_instance_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
+      operation_result = @service_client.update_oda_instance(oda_instance_id, update_oda_instance_details, base_operation_opts)
+
+      return operation_result if wait_for_states.empty?
+
+      lowered_wait_for_states = wait_for_states.map(&:downcase)
+      wait_for_resource_id = operation_result.data.id
+
+      begin
+        waiter_result = @service_client.get_oda_instance(wait_for_resource_id).wait_until(
+          eval_proc: ->(response) { response.data.respond_to?(:lifecycle_state) && lowered_wait_for_states.include?(response.data.lifecycle_state.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
+        )
+        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
+  end
+end
+# rubocop:enable Lint/UnneededCopDisableDirective, Metrics/LineLength

data/lib/oci/oda/util.rb

@@ -0,0 +1,2 @@
+# Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved.
+

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

@@ -5,7 +5,8 @@ require 'logger'
 
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # The backoff retry portion of the subscription delivery policy.
+  # The backoff retry portion of the subscription delivery policy. For information about retry durations for subscriptions, see
+  # [How Notifications Works](https://docs.cloud.oracle.com/iaas/Content/Notification/Concepts/notificationoverview.htm#how).
   #
   class Ons::Models::BackoffRetryPolicy
     POLICY_TYPE_ENUM = [

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

@@ -5,6 +5,8 @@ require 'date'
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
   # The confirmation details for the specified subscription.
+  # For information about confirming subscriptions, see
+  # [To confirm a subscription](https://docs.cloud.oracle.com/iaas/Content/Notification/Tasks/managingtopicsandsubscriptions.htm#confirmSub).
   #
   class Ons::Models::ConfirmationResult
     # **[Required]** The name of the subscribed topic.
@@ -17,8 +19,8 @@ module OCI
     # @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.
+    # **[Required]** A locator that corresponds to the subscription protocol.
+    # For example, an email address for a subscription that uses the `EMAIL` protocol, or a URL for a subscription that uses an HTTP-based protocol.
     #
     # @return [String]
     attr_accessor :endpoint
@@ -31,7 +33,7 @@ module OCI
     # @return [String]
     attr_accessor :message
 
-    # The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription specified in the request.
+    # **[Required]** 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_subscription_details.rb

@@ -17,19 +17,34 @@ module OCI
     # @return [String]
     attr_accessor :compartment_id
 
-    # **[Required]** The protocol to use for delivering messages. Valid values: EMAIL, HTTPS.
+    # **[Required]** The protocol used for the subscription.
+    #
+    # Allowed values:
+    #   * `CUSTOM_HTTPS`
+    #   * `EMAIL`
+    #   * `HTTPS` (deprecated; for PagerDuty endpoints, use `PAGERDUTY`)
+    #   * `PAGERDUTY`
+    #   * `SLACK`
+    #
+    # For information about subscription protocols, see
+    # [To create a subscription](https://docs.cloud.oracle.com/iaas/Content/Notification/Tasks/managingtopicsandsubscriptions.htm#createSub).
     #
     # @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.
+    # **[Required]** A locator that corresponds to the subscription protocol.
+    # For example, an email address for a subscription that uses the `EMAIL` protocol, or a URL for a subscription that uses an HTTP-based protocol.
+    # HTTP-based protocols use URL endpoints that begin with \"http:\" or \"https:\".
+    # A URL cannot exceed 512 characters.
     # Avoid entering confidential information.
     #
+    # For protocol-specific endpoint formats and steps to get or create endpoints, see
+    # [To create a subscription](https://docs.cloud.oracle.com/iaas/Content/Notification/Tasks/managingtopicsandsubscriptions.htm#createSub).
+    #
     # @return [String]
     attr_accessor :endpoint
 
-    # Metadata for the subscription. Avoid entering confidential information.
+    # Metadata for the subscription.
     # @return [String]
     attr_accessor :metadata
 

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

@@ -5,7 +5,8 @@ require 'logger'
 
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # The properties that define a topic.
+  # The properties that define a topic. For general information about topics, see
+  # [Notifications Overview](https://docs.cloud.oracle.com/iaas/Content/Notification/Concepts/notificationoverview.htm).
   #
   class Ons::Models::NotificationTopic
     LIFECYCLE_STATE_ENUM = [

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

@@ -5,7 +5,8 @@ require 'logger'
 
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # The subscription's configuration.
+  # The subscription's configuration. For general information about subscriptions, see
+  # [Notifications Overview](https://docs.cloud.oracle.com/iaas/Content/Notification/Concepts/notificationoverview.htm).
   #
   class Ons::Models::Subscription
     LIFECYCLE_STATE_ENUM = [
@@ -25,11 +26,15 @@ module OCI
     # @return [String]
     attr_accessor :topic_id
 
+    # **[Required]** The protocol used for the subscription.
+    # For information about subscription protocols, see
+    # [To create a subscription](https://docs.cloud.oracle.com/iaas/Content/Notification/Tasks/managingtopicsandsubscriptions.htm#createSub).
+    #
     # @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.
+    # **[Required]** A locator that corresponds to the subscription protocol.
+    # For example, an email address for a subscription that uses the `EMAIL` protocol, or a URL for a subscription that uses an HTTP-based protocol.
     #
     # @return [String]
     attr_accessor :endpoint

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

@@ -25,13 +25,15 @@ module OCI
     # @return [String]
     attr_accessor :topic_id
 
-    # **[Required]** The protocol used for the subscription. Valid values: EMAIL, HTTPS.
+    # **[Required]** The protocol used for the subscription.
+    # For information about subscription protocols, see
+    # [To create a subscription](https://docs.cloud.oracle.com/iaas/Content/Notification/Tasks/managingtopicsandsubscriptions.htm#createSub).
     #
     # @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.
+    # **[Required]** A locator that corresponds to the subscription protocol.
+    # For example, an email address for a subscription that uses the `EMAIL` protocol, or a URL for a subscription that uses an HTTP-based protocol.
     #
     # @return [String]
     attr_accessor :endpoint

data/lib/oci/ons/notification_control_plane_client.rb

@@ -484,10 +484,10 @@ module OCI
     #
     # @param [String] topic_id The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic to update.
     #
+    # @param [OCI::Ons::Models::TopicAttributesDetails] topic_attributes_details TopicAttributes
     # @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 [OCI::Ons::Models::TopicAttributesDetails] :topic_attributes_details TopicAttributes
     # @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.
     #
@@ -496,10 +496,11 @@ module OCI
     #   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 {OCI::Ons::Models::NotificationTopic NotificationTopic}
-    def update_topic(topic_id, opts = {})
+    def update_topic(topic_id, topic_attributes_details, opts = {})
       logger.debug 'Calling operation NotificationControlPlaneClient#update_topic.' if logger
 
       raise "Missing the required parameter 'topic_id' when calling update_topic." if topic_id.nil?
+      raise "Missing the required parameter 'topic_attributes_details' when calling update_topic." if topic_attributes_details.nil?
       raise "Parameter value for 'topic_id' must not be blank" if OCI::Internal::Util.blank_string?(topic_id)
 
       path = '/topics/{topicId}'.sub('{topicId}', topic_id.to_s)
@@ -517,7 +518,7 @@ module OCI
       header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
       # rubocop:enable Style/NegatedIf
 
-      post_body = @api_client.object_to_http_body(opts[:topic_attributes_details])
+      post_body = @api_client.object_to_http_body(topic_attributes_details)
 
       # rubocop:disable Metrics/BlockLength
       OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NotificationControlPlaneClient#update_topic') do

data/lib/oci/ons/notification_data_plane_client.rb

@@ -184,7 +184,9 @@ module OCI
     # rubocop:disable Metrics/MethodLength, Layout/EmptyLines
 
 
-    # Creates a subscription for the specified topic.
+    # Creates a subscription for the specified topic and sends a subscription confirmation URL to the endpoint. The subscription remains in \"Pending\" status until it has been confirmed.
+    # For information about confirming subscriptions, see
+    # [To confirm a subscription](https://docs.cloud.oracle.com/iaas/Content/Notification/Tasks/managingtopicsandsubscriptions.htm#confirmSub).
     #
     # Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
     #
@@ -319,7 +321,17 @@ module OCI
     # @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.
+    # @param [String] protocol The protocol used for the subscription.
+    #
+    #   Allowed values:
+    #     * `CUSTOM_HTTPS`
+    #     * `EMAIL`
+    #     * `HTTPS` (deprecated; for PagerDuty endpoints, use `PAGERDUTY`)
+    #     * `PAGERDUTY`
+    #     * `SLACK`
+    #
+    #   For information about subscription protocols, see
+    #   [To create a subscription](https://docs.cloud.oracle.com/iaas/Content/Notification/Tasks/managingtopicsandsubscriptions.htm#createSub).
     #
     # @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
@@ -444,7 +456,17 @@ module OCI
     # @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.
-    # @param [String] protocol The subscription protocol. Valid values: EMAIL, HTTPS.
+    # @param [String] protocol The protocol used for the subscription.
+    #
+    #   Allowed values:
+    #     * `CUSTOM_HTTPS`
+    #     * `EMAIL`
+    #     * `HTTPS` (deprecated; for PagerDuty endpoints, use `PAGERDUTY`)
+    #     * `PAGERDUTY`
+    #     * `SLACK`
+    #
+    #   For information about subscription protocols, see
+    #   [To create a subscription](https://docs.cloud.oracle.com/iaas/Content/Notification/Tasks/managingtopicsandsubscriptions.htm#createSub).
     #
     # @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
@@ -577,11 +599,13 @@ module OCI
     #
     # 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.
+    # Message delivery rate limit per endpoint: 60 messages per minute for HTTP-based protocols, 10 messages per minute for the `EMAIL` protocol.
+    # HTTP-based protocols use URL endpoints that begin with \"http:\" or \"https:\".
     #
     # 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).
+    # For steps to request a limit increase, see [Requesting a Service Limit Increase](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/servicelimits.htm#three).
     #
     # @param [String] topic_id The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic.
     #