oci 2.11.0 → 2.12.0

data/lib/oci/rover/rover_node_client_composite_operations.rb

@@ -0,0 +1,144 @@
+# Copyright (c) 2016, 2020, 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.
+
+# rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
+module OCI
+  # This class provides a wrapper around {OCI::Rover::RoverNodeClient} 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 Rover::RoverNodeClientCompositeOperations
+    # The {OCI::Rover::RoverNodeClient} used to communicate with the service_client
+    #
+    # @return [OCI::Rover::RoverNodeClient]
+    attr_reader :service_client
+
+    # Initializes a new RoverNodeClientCompositeOperations
+    #
+    # @param [OCI::Rover::RoverNodeClient] service_client The client used to communicate with the service.
+    #   Defaults to a new service client created via {OCI::Rover::RoverNodeClient#initialize} with no arguments
+    def initialize(service_client = OCI::Rover::RoverNodeClient.new)
+      @service_client = service_client
+    end
+
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/ParameterLists, Metrics/PerceivedComplexity
+    # rubocop:disable Layout/EmptyLines
+
+
+    # Calls {OCI::Rover::RoverNodeClient#create_rover_node} and then waits for the {OCI::Rover::Models::RoverNode} acted upon
+    # to enter the given state(s).
+    #
+    # @param [OCI::Rover::Models::CreateRoverNodeDetails] create_rover_node_details Details for the new RoverNode.
+    # @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::Rover::Models::RoverNode#lifecycle_state}
+    # @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::Rover::RoverNodeClient#create_rover_node}
+    # @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::Rover::Models::RoverNode}
+    def create_rover_node_and_wait_for_state(create_rover_node_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
+      operation_result = @service_client.create_rover_node(create_rover_node_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_rover_node(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
+
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/ParameterLists, Metrics/PerceivedComplexity
+    # rubocop:disable Layout/EmptyLines
+
+
+    # Calls {OCI::Rover::RoverNodeClient#delete_rover_node} and then waits for the {OCI::Rover::Models::RoverNode} acted upon
+    # to enter the given state(s).
+    #
+    # @param [String] rover_node_id Unique RoverNode identifier
+    # @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::Rover::Models::RoverNode#lifecycle_state}
+    # @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::Rover::RoverNodeClient#delete_rover_node}
+    # @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 nil
+    def delete_rover_node_and_wait_for_state(rover_node_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
+      initial_get_result = @service_client.get_rover_node(rover_node_id)
+      operation_result = @service_client.delete_rover_node(rover_node_id, base_operation_opts)
+
+      return operation_result if wait_for_states.empty?
+
+      lowered_wait_for_states = wait_for_states.map(&:downcase)
+
+      begin
+        waiter_result = initial_get_result.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,
+          succeed_on_not_found: true
+        )
+        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::Rover::RoverNodeClient#update_rover_node} and then waits for the {OCI::Rover::Models::RoverNode} acted upon
+    # to enter the given state(s).
+    #
+    # @param [String] rover_node_id Unique RoverNode identifier
+    # @param [OCI::Rover::Models::UpdateRoverNodeDetails] update_rover_node_details The information to be updated.
+    # @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::Rover::Models::RoverNode#lifecycle_state}
+    # @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::Rover::RoverNodeClient#update_rover_node}
+    # @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::Rover::Models::RoverNode}
+    def update_rover_node_and_wait_for_state(rover_node_id, update_rover_node_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
+      operation_result = @service_client.update_rover_node(rover_node_id, update_rover_node_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_rover_node(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/rover/util.rb

@@ -0,0 +1,3 @@
+# Copyright (c) 2016, 2020, 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.
+

data/lib/oci/sch/service_connector_client.rb

@@ -129,6 +129,7 @@ module OCI
     #   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/sch/activate_service_connector.rb.html) to see an example of how to use activate_service_connector API.
     def activate_service_connector(service_connector_id, opts = {})
       logger.debug 'Calling operation ServiceConnectorClient#activate_service_connector.' if logger
 
@@ -200,6 +201,7 @@ module OCI
     #   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/sch/change_service_connector_compartment.rb.html) to see an example of how to use change_service_connector_compartment API.
     def change_service_connector_compartment(service_connector_id, change_service_connector_compartment_details, opts = {})
       logger.debug 'Calling operation ServiceConnectorClient#change_service_connector_compartment.' if logger
 
@@ -281,6 +283,7 @@ module OCI
     #   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/sch/create_service_connector.rb.html) to see an example of how to use create_service_connector API.
     def create_service_connector(create_service_connector_details, opts = {})
       logger.debug 'Calling operation ServiceConnectorClient#create_service_connector.' if logger
 
@@ -355,6 +358,7 @@ module OCI
     #   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/sch/deactivate_service_connector.rb.html) to see an example of how to use deactivate_service_connector API.
     def deactivate_service_connector(service_connector_id, opts = {})
       logger.debug 'Calling operation ServiceConnectorClient#deactivate_service_connector.' if logger
 
@@ -423,6 +427,7 @@ module OCI
     #   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/sch/delete_service_connector.rb.html) to see an example of how to use delete_service_connector API.
     def delete_service_connector(service_connector_id, opts = {})
       logger.debug 'Calling operation ServiceConnectorClient#delete_service_connector.' if logger
 
@@ -480,6 +485,7 @@ module OCI
     #   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::Sch::Models::ServiceConnector ServiceConnector}
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/sch/get_service_connector.rb.html) to see an example of how to use get_service_connector API.
     def get_service_connector(service_connector_id, opts = {})
       logger.debug 'Calling operation ServiceConnectorClient#get_service_connector.' if logger
 
@@ -537,6 +543,7 @@ module OCI
     #   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::Sch::Models::WorkRequest WorkRequest}
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/sch/get_work_request.rb.html) to see an example of how to use get_work_request API.
     def get_work_request(work_request_id, opts = {})
       logger.debug 'Calling operation ServiceConnectorClient#get_work_request.' if logger
 
@@ -616,6 +623,7 @@ module OCI
     #   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::Sch::Models::ServiceConnectorCollection ServiceConnectorCollection}
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/sch/list_service_connectors.rb.html) to see an example of how to use list_service_connectors API.
     def list_service_connectors(compartment_id, opts = {})
       logger.debug 'Calling operation ServiceConnectorClient#list_service_connectors.' if logger
 
@@ -699,6 +707,7 @@ module OCI
     #   [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
     #    (default to 10)
     # @return [Response] A Response object with data of type {OCI::Sch::Models::WorkRequestErrorCollection WorkRequestErrorCollection}
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/sch/list_work_request_errors.rb.html) to see an example of how to use list_work_request_errors API.
     def list_work_request_errors(work_request_id, opts = {})
       logger.debug 'Calling operation ServiceConnectorClient#list_work_request_errors.' if logger
 
@@ -766,6 +775,7 @@ module OCI
     #   [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
     #    (default to 10)
     # @return [Response] A Response object with data of type {OCI::Sch::Models::WorkRequestLogEntryCollection WorkRequestLogEntryCollection}
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/sch/list_work_request_logs.rb.html) to see an example of how to use list_work_request_logs API.
     def list_work_request_logs(work_request_id, opts = {})
       logger.debug 'Calling operation ServiceConnectorClient#list_work_request_logs.' if logger
 
@@ -833,6 +843,7 @@ module OCI
     #   [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
     #    (default to 10)
     # @return [Response] A Response object with data of type {OCI::Sch::Models::WorkRequestCollection WorkRequestCollection}
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/sch/list_work_requests.rb.html) to see an example of how to use list_work_requests API.
     def list_work_requests(compartment_id, opts = {})
       logger.debug 'Calling operation ServiceConnectorClient#list_work_requests.' if logger
 
@@ -904,6 +915,7 @@ module OCI
     #   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/sch/update_service_connector.rb.html) to see an example of how to use update_service_connector API.
     def update_service_connector(service_connector_id, update_service_connector_details, opts = {})
       logger.debug 'Calling operation ServiceConnectorClient#update_service_connector.' if logger
 

data/lib/oci/secrets/secrets_client.rb

@@ -111,6 +111,7 @@ module OCI
     # @option opts [String] :stage The rotation state of the secret version.
     #   Allowed values are: CURRENT, PENDING, LATEST, PREVIOUS, DEPRECATED
     # @return [Response] A Response object with data of type {OCI::Secrets::Models::SecretBundle SecretBundle}
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/secrets/get_secret_bundle.rb.html) to see an example of how to use get_secret_bundle API.
     def get_secret_bundle(secret_id, opts = {})
       logger.debug 'Calling operation SecretsClient#get_secret_bundle.' if logger
 
@@ -184,6 +185,7 @@ module OCI
     #    (default to ASC)
     #   Allowed values are: ASC, DESC
     # @return [Response] A Response object with data of type Array<{OCI::Secrets::Models::SecretBundleVersionSummary SecretBundleVersionSummary}>
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/secrets/list_secret_bundle_versions.rb.html) to see an example of how to use list_secret_bundle_versions API.
     def list_secret_bundle_versions(secret_id, opts = {})
       logger.debug 'Calling operation SecretsClient#list_secret_bundle_versions.' if logger
 

data/lib/oci/streaming/stream_admin_client.rb

@@ -110,6 +110,7 @@ module OCI
     #   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/streaming/change_connect_harness_compartment.rb.html) to see an example of how to use change_connect_harness_compartment API.
     def change_connect_harness_compartment(connect_harness_id, change_connect_harness_compartment_details, opts = {})
       logger.debug 'Calling operation StreamAdminClient#change_connect_harness_compartment.' if logger
 
@@ -172,6 +173,7 @@ module OCI
     #   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/streaming/change_stream_compartment.rb.html) to see an example of how to use change_stream_compartment API.
     def change_stream_compartment(stream_id, change_stream_compartment_details, opts = {})
       logger.debug 'Calling operation StreamAdminClient#change_stream_compartment.' if logger
 
@@ -231,6 +233,7 @@ module OCI
     #   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/streaming/change_stream_pool_compartment.rb.html) to see an example of how to use change_stream_pool_compartment API.
     def change_stream_pool_compartment(stream_pool_id, change_stream_pool_compartment_details, opts = {})
       logger.debug 'Calling operation StreamAdminClient#change_stream_pool_compartment.' if logger
 
@@ -290,6 +293,7 @@ module OCI
     #
     # @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 then 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).
     # @return [Response] A Response object with data of type {OCI::Streaming::Models::ConnectHarness ConnectHarness}
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/streaming/create_connect_harness.rb.html) to see an example of how to use create_connect_harness API.
     def create_connect_harness(create_connect_harness_details, opts = {})
       logger.debug 'Calling operation StreamAdminClient#create_connect_harness.' if logger
 
@@ -351,6 +355,7 @@ module OCI
     #   particular request, please provide the request ID.
     #
     # @return [Response] A Response object with data of type {OCI::Streaming::Models::Stream Stream}
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/streaming/create_stream.rb.html) to see an example of how to use create_stream API.
     def create_stream(create_stream_details, opts = {})
       logger.debug 'Calling operation StreamAdminClient#create_stream.' if logger
 
@@ -409,6 +414,7 @@ module OCI
     #
     # @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 then 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).
     # @return [Response] A Response object with data of type {OCI::Streaming::Models::StreamPool StreamPool}
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/streaming/create_stream_pool.rb.html) to see an example of how to use create_stream_pool API.
     def create_stream_pool(create_stream_pool_details, opts = {})
       logger.debug 'Calling operation StreamAdminClient#create_stream_pool.' if logger
 
@@ -472,6 +478,7 @@ module OCI
     #
     # @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.
     # @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/streaming/delete_connect_harness.rb.html) to see an example of how to use delete_connect_harness API.
     def delete_connect_harness(connect_harness_id, opts = {})
       logger.debug 'Calling operation StreamAdminClient#delete_connect_harness.' if logger
 
@@ -534,6 +541,7 @@ module OCI
     #
     # @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.
     # @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/streaming/delete_stream.rb.html) to see an example of how to use delete_stream API.
     def delete_stream(stream_id, opts = {})
       logger.debug 'Calling operation StreamAdminClient#delete_stream.' if logger
 
@@ -593,6 +601,7 @@ module OCI
     #
     # @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.
     # @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/streaming/delete_stream_pool.rb.html) to see an example of how to use delete_stream_pool API.
     def delete_stream_pool(stream_pool_id, opts = {})
       logger.debug 'Calling operation StreamAdminClient#delete_stream_pool.' if logger
 
@@ -649,6 +658,7 @@ module OCI
     #   particular request, please provide the request ID.
     #
     # @return [Response] A Response object with data of type {OCI::Streaming::Models::ConnectHarness ConnectHarness}
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/streaming/get_connect_harness.rb.html) to see an example of how to use get_connect_harness API.
     def get_connect_harness(connect_harness_id, opts = {})
       logger.debug 'Calling operation StreamAdminClient#get_connect_harness.' if logger
 
@@ -705,6 +715,7 @@ module OCI
     #   particular request, please provide the request ID.
     #
     # @return [Response] A Response object with data of type {OCI::Streaming::Models::Stream Stream}
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/streaming/get_stream.rb.html) to see an example of how to use get_stream API.
     def get_stream(stream_id, opts = {})
       logger.debug 'Calling operation StreamAdminClient#get_stream.' if logger
 
@@ -761,6 +772,7 @@ module OCI
     #   particular request, please provide the request ID.
     #
     # @return [Response] A Response object with data of type {OCI::Streaming::Models::StreamPool StreamPool}
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/streaming/get_stream_pool.rb.html) to see an example of how to use get_stream_pool API.
     def get_stream_pool(stream_pool_id, opts = {})
       logger.debug 'Calling operation StreamAdminClient#get_stream_pool.' if logger
 
@@ -830,6 +842,7 @@ module OCI
     #   particular request, please provide the request ID.
     #
     # @return [Response] A Response object with data of type Array<{OCI::Streaming::Models::ConnectHarnessSummary ConnectHarnessSummary}>
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/streaming/list_connect_harnesses.rb.html) to see an example of how to use list_connect_harnesses API.
     def list_connect_harnesses(compartment_id, opts = {})
       logger.debug 'Calling operation StreamAdminClient#list_connect_harnesses.' if logger
 
@@ -918,6 +931,7 @@ module OCI
     #   particular request, please provide the request ID.
     #
     # @return [Response] A Response object with data of type Array<{OCI::Streaming::Models::StreamPoolSummary StreamPoolSummary}>
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/streaming/list_stream_pools.rb.html) to see an example of how to use list_stream_pools API.
     def list_stream_pools(compartment_id, opts = {})
       logger.debug 'Calling operation StreamAdminClient#list_stream_pools.' if logger
 
@@ -1011,6 +1025,7 @@ module OCI
     #   particular request, please provide the request ID.
     #
     # @return [Response] A Response object with data of type Array<{OCI::Streaming::Models::StreamSummary StreamSummary}>
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/streaming/list_streams.rb.html) to see an example of how to use list_streams API.
     def list_streams(opts = {})
       logger.debug 'Calling operation StreamAdminClient#list_streams.' if logger
 
@@ -1089,6 +1104,7 @@ module OCI
     #
     # @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.
     # @return [Response] A Response object with data of type {OCI::Streaming::Models::ConnectHarness ConnectHarness}
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/streaming/update_connect_harness.rb.html) to see an example of how to use update_connect_harness API.
     def update_connect_harness(connect_harness_id, update_connect_harness_details, opts = {})
       logger.debug 'Calling operation StreamAdminClient#update_connect_harness.' if logger
 
@@ -1150,6 +1166,7 @@ module OCI
     #
     # @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.
     # @return [Response] A Response object with data of type {OCI::Streaming::Models::Stream Stream}
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/streaming/update_stream.rb.html) to see an example of how to use update_stream API.
     def update_stream(stream_id, update_stream_details, opts = {})
       logger.debug 'Calling operation StreamAdminClient#update_stream.' if logger
 
@@ -1211,6 +1228,7 @@ module OCI
     #
     # @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.
     # @return [Response] A Response object with data of type {OCI::Streaming::Models::StreamPool StreamPool}
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/streaming/update_stream_pool.rb.html) to see an example of how to use update_stream_pool API.
     def update_stream_pool(stream_pool_id, update_stream_pool_details, opts = {})
       logger.debug 'Calling operation StreamAdminClient#update_stream_pool.' if logger
 

data/lib/oci/streaming/stream_client.rb

@@ -86,6 +86,7 @@ module OCI
     #   particular request, please provide the request ID.
     #
     # @return [Response] A Response object with data of type {OCI::Streaming::Models::Cursor Cursor}
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/streaming/consumer_commit.rb.html) to see an example of how to use consumer_commit API.
     def consumer_commit(stream_id, cursor, opts = {})
       logger.debug 'Calling operation StreamClient#consumer_commit.' if logger
 
@@ -147,6 +148,7 @@ module OCI
     #   particular request, please provide the request ID.
     #
     # @return [Response] A Response object with data of type {OCI::Streaming::Models::Cursor Cursor}
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/streaming/consumer_heartbeat.rb.html) to see an example of how to use consumer_heartbeat API.
     def consumer_heartbeat(stream_id, cursor, opts = {})
       logger.debug 'Calling operation StreamClient#consumer_heartbeat.' if logger
 
@@ -211,6 +213,7 @@ module OCI
     #   particular request, please provide the request ID.
     #
     # @return [Response] A Response object with data of type {OCI::Streaming::Models::Cursor Cursor}
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/streaming/create_cursor.rb.html) to see an example of how to use create_cursor API.
     def create_cursor(stream_id, create_cursor_details, opts = {})
       logger.debug 'Calling operation StreamClient#create_cursor.' if logger
 
@@ -270,6 +273,7 @@ module OCI
     #   particular request, please provide the request ID.
     #
     # @return [Response] A Response object with data of type {OCI::Streaming::Models::Cursor Cursor}
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/streaming/create_group_cursor.rb.html) to see an example of how to use create_group_cursor API.
     def create_group_cursor(stream_id, create_group_cursor_details, opts = {})
       logger.debug 'Calling operation StreamClient#create_group_cursor.' if logger
 
@@ -329,6 +333,7 @@ module OCI
     #   particular request, please provide the request ID.
     #
     # @return [Response] A Response object with data of type {OCI::Streaming::Models::Group Group}
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/streaming/get_group.rb.html) to see an example of how to use get_group API.
     def get_group(stream_id, group_name, opts = {})
       logger.debug 'Calling operation StreamClient#get_group.' if logger
 
@@ -395,6 +400,7 @@ module OCI
     #   particular request, please provide the request ID.
     #
     # @return [Response] A Response object with data of type Array<{OCI::Streaming::Models::Message Message}>
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/streaming/get_messages.rb.html) to see an example of how to use get_messages API.
     def get_messages(stream_id, cursor, opts = {})
       logger.debug 'Calling operation StreamClient#get_messages.' if logger
 
@@ -459,6 +465,7 @@ module OCI
     #   particular request, please provide the request ID.
     #
     # @return [Response] A Response object with data of type {OCI::Streaming::Models::PutMessagesResult PutMessagesResult}
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/streaming/put_messages.rb.html) to see an example of how to use put_messages API.
     def put_messages(stream_id, put_messages_details, opts = {})
       logger.debug 'Calling operation StreamClient#put_messages.' if logger
 
@@ -519,6 +526,7 @@ module OCI
     #   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/streaming/update_group.rb.html) to see an example of how to use update_group API.
     def update_group(stream_id, group_name, update_group_details, opts = {})
       logger.debug 'Calling operation StreamClient#update_group.' if logger