oci 2.11.0 → 2.12.0

data/lib/oci/mysql/channels_client_composite_operations.rb

@@ -0,0 +1,271 @@
+# 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::Mysql::ChannelsClient} 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 Mysql::ChannelsClientCompositeOperations
+    # The {OCI::Mysql::ChannelsClient} used to communicate with the service_client
+    #
+    # @return [OCI::Mysql::ChannelsClient]
+    attr_reader :service_client
+
+    # Initializes a new ChannelsClientCompositeOperations
+    #
+    # @param [OCI::Mysql::ChannelsClient] service_client The client used to communicate with the service.
+    #   Defaults to a new service client created via {OCI::Mysql::ChannelsClient#initialize} with no arguments
+    def initialize(service_client = OCI::Mysql::ChannelsClient.new)
+      @service_client = service_client
+    end
+
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/ParameterLists, Metrics/PerceivedComplexity
+    # rubocop:disable Layout/EmptyLines
+
+
+    # Calls {OCI::Mysql::ChannelsClient#create_channel} and then waits for the {OCI::Mysql::Models::WorkRequest}
+    # to enter the given state(s).
+    #
+    # @param [OCI::Mysql::Models::CreateChannelDetails] create_channel_details The parameters of the request to create the Channel.
+    # @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::Mysql::Models::WorkRequest#status}
+    # @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::Mysql::ChannelsClient#create_channel}
+    # @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::Mysql::Models::WorkRequest}
+    def create_channel_and_wait_for_state(create_channel_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
+      operation_result = @service_client.create_channel(create_channel_details, base_operation_opts)
+      use_util = OCI::Mysql::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::Mysql::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::Mysql::ChannelsClient#delete_channel} and then waits for the {OCI::Mysql::Models::WorkRequest}
+    # to enter the given state(s).
+    #
+    # @param [String] channel_id The Channel [OCID](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
+    # @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::Mysql::Models::WorkRequest#status}
+    # @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::Mysql::ChannelsClient#delete_channel}
+    # @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::Mysql::Models::WorkRequest}
+    def delete_channel_and_wait_for_state(channel_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
+      operation_result = @service_client.delete_channel(channel_id, base_operation_opts)
+      use_util = OCI::Mysql::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::Mysql::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::Mysql::ChannelsClient#reset_channel} and then waits for the {OCI::Mysql::Models::WorkRequest}
+    # to enter the given state(s).
+    #
+    # @param [String] channel_id The Channel [OCID](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
+    # @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::Mysql::Models::WorkRequest#status}
+    # @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::Mysql::ChannelsClient#reset_channel}
+    # @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::Mysql::Models::WorkRequest}
+    def reset_channel_and_wait_for_state(channel_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
+      operation_result = @service_client.reset_channel(channel_id, base_operation_opts)
+      use_util = OCI::Mysql::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::Mysql::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::Mysql::ChannelsClient#resume_channel} and then waits for the {OCI::Mysql::Models::WorkRequest}
+    # to enter the given state(s).
+    #
+    # @param [String] channel_id The Channel [OCID](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
+    # @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::Mysql::Models::WorkRequest#status}
+    # @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::Mysql::ChannelsClient#resume_channel}
+    # @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::Mysql::Models::WorkRequest}
+    def resume_channel_and_wait_for_state(channel_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
+      operation_result = @service_client.resume_channel(channel_id, base_operation_opts)
+      use_util = OCI::Mysql::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::Mysql::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::Mysql::ChannelsClient#update_channel} and then waits for the {OCI::Mysql::Models::WorkRequest}
+    # to enter the given state(s).
+    #
+    # @param [String] channel_id The Channel [OCID](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
+    # @param [OCI::Mysql::Models::UpdateChannelDetails] update_channel_details The parameters of the request to update the Channel.
+    # @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::Mysql::Models::WorkRequest#status}
+    # @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::Mysql::ChannelsClient#update_channel}
+    # @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::Mysql::Models::WorkRequest}
+    def update_channel_and_wait_for_state(channel_id, update_channel_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
+      operation_result = @service_client.update_channel(channel_id, update_channel_details, base_operation_opts)
+      use_util = OCI::Mysql::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::Mysql::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
+  end
+end
+# rubocop:enable Lint/UnneededCopDisableDirective, Metrics/LineLength

data/lib/oci/mysql/db_backups_client.rb

@@ -116,6 +116,7 @@ module OCI
     #   creation request may be rejected).
     #
     # @return [Response] A Response object with data of type {OCI::Mysql::Models::Backup Backup}
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/mysql/create_backup.rb.html) to see an example of how to use create_backup API.
     def create_backup(create_backup_details, opts = {})
       logger.debug 'Calling operation DbBackupsClient#create_backup.' if logger
 
@@ -180,6 +181,7 @@ module OCI
     #   ID that you supplied in this header with the request.
     #
     # @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/mysql/delete_backup.rb.html) to see an example of how to use delete_backup API.
     def delete_backup(backup_id, opts = {})
       logger.debug 'Calling operation DbBackupsClient#delete_backup.' if logger
 
@@ -242,6 +244,7 @@ module OCI
     #   200 OK response with the updated representation.
     #
     # @return [Response] A Response object with data of type {OCI::Mysql::Models::Backup Backup}
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/mysql/get_backup.rb.html) to see an example of how to use get_backup API.
     def get_backup(backup_id, opts = {})
       logger.debug 'Calling operation DbBackupsClient#get_backup.' if logger
 
@@ -303,6 +306,7 @@ module OCI
     # @option opts [String] :lifecycle_state Backup Lifecycle State (default to AVAILABLE)
     # @option opts [String] :db_system_id The DB System [OCID](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
     # @option opts [String] :display_name A filter to return only the resource matching the given display name exactly.
+    # @option opts [String] :creation_type Backup creationType
     # @option opts [String] :sort_by The field to sort by. Only one sort order may be provided. Time fields are default ordered as descending.
     #    (default to timeCreated)
     #   Allowed values are: timeCreated, timeUpdated, displayName
@@ -316,6 +320,7 @@ module OCI
     #   Pagination](https://docs.cloud.oracle.com/#API/Concepts/usingapi.htm#List_Pagination).
     #
     # @return [Response] A Response object with data of type Array<{OCI::Mysql::Models::BackupSummary BackupSummary}>
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/mysql/list_backups.rb.html) to see an example of how to use list_backups API.
     def list_backups(compartment_id, opts = {})
       logger.debug 'Calling operation DbBackupsClient#list_backups.' if logger
 
@@ -325,6 +330,10 @@ module OCI
         raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Mysql::Models::Backup::LIFECYCLE_STATE_ENUM.'
       end
 
+      if opts[:creation_type] && !OCI::Mysql::Models::Backup::CREATION_TYPE_ENUM.include?(opts[:creation_type])
+        raise 'Invalid value for "creation_type", must be one of the values in OCI::Mysql::Models::Backup::CREATION_TYPE_ENUM.'
+      end
+
       if opts[:sort_by] && !%w[timeCreated timeUpdated displayName].include?(opts[:sort_by])
         raise 'Invalid value for "sort_by", must be one of timeCreated, timeUpdated, displayName.'
       end
@@ -344,6 +353,7 @@ module OCI
       query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
       query_params[:dbSystemId] = opts[:db_system_id] if opts[:db_system_id]
       query_params[:displayName] = opts[:display_name] if opts[:display_name]
+      query_params[:creationType] = opts[:creation_type] if opts[:creation_type]
       query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
       query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
       query_params[:limit] = opts[:limit] if opts[:limit]
@@ -399,6 +409,7 @@ module OCI
     #   ID that you supplied in this header with the request.
     #
     # @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/mysql/update_backup.rb.html) to see an example of how to use update_backup API.
     def update_backup(backup_id, update_backup_details, opts = {})
       logger.debug 'Calling operation DbBackupsClient#update_backup.' if logger
 

data/lib/oci/mysql/db_system_client.rb

@@ -123,6 +123,7 @@ module OCI
     #   creation request may be rejected).
     #
     # @return [Response] A Response object with data of type {OCI::Mysql::Models::AnalyticsCluster AnalyticsCluster}
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/mysql/add_analytics_cluster.rb.html) to see an example of how to use add_analytics_cluster API.
     def add_analytics_cluster(db_system_id, add_analytics_cluster_details, opts = {})
       logger.debug 'Calling operation DbSystemClient#add_analytics_cluster.' if logger
 
@@ -191,6 +192,7 @@ module OCI
     #   creation request may be rejected).
     #
     # @return [Response] A Response object with data of type {OCI::Mysql::Models::DbSystem DbSystem}
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/mysql/create_db_system.rb.html) to see an example of how to use create_db_system API.
     def create_db_system(create_db_system_details, opts = {})
       logger.debug 'Calling operation DbSystemClient#create_db_system.' if logger
 
@@ -256,6 +258,7 @@ module OCI
     #   ID that you supplied in this header with the request.
     #
     # @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/mysql/delete_analytics_cluster.rb.html) to see an example of how to use delete_analytics_cluster API.
     def delete_analytics_cluster(db_system_id, opts = {})
       logger.debug 'Calling operation DbSystemClient#delete_analytics_cluster.' if logger
 
@@ -320,6 +323,7 @@ module OCI
     #   ID that you supplied in this header with the request.
     #
     # @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/mysql/delete_db_system.rb.html) to see an example of how to use delete_db_system API.
     def delete_db_system(db_system_id, opts = {})
       logger.debug 'Calling operation DbSystemClient#delete_db_system.' if logger
 
@@ -384,6 +388,7 @@ module OCI
     #   creation request may be rejected).
     #
     # @return [Response] A Response object with data of type {OCI::Mysql::Models::AnalyticsClusterMemoryEstimate AnalyticsClusterMemoryEstimate}
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/mysql/generate_analytics_cluster_memory_estimate.rb.html) to see an example of how to use generate_analytics_cluster_memory_estimate API.
     def generate_analytics_cluster_memory_estimate(db_system_id, opts = {})
       logger.debug 'Calling operation DbSystemClient#generate_analytics_cluster_memory_estimate.' if logger
 
@@ -448,6 +453,7 @@ module OCI
     #   200 OK response with the updated representation.
     #
     # @return [Response] A Response object with data of type {OCI::Mysql::Models::AnalyticsCluster AnalyticsCluster}
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/mysql/get_analytics_cluster.rb.html) to see an example of how to use get_analytics_cluster API.
     def get_analytics_cluster(db_system_id, opts = {})
       logger.debug 'Calling operation DbSystemClient#get_analytics_cluster.' if logger
 
@@ -507,6 +513,7 @@ module OCI
     #   ID that you supplied in this header with the request.
     #
     # @return [Response] A Response object with data of type {OCI::Mysql::Models::AnalyticsClusterMemoryEstimate AnalyticsClusterMemoryEstimate}
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/mysql/get_analytics_cluster_memory_estimate.rb.html) to see an example of how to use get_analytics_cluster_memory_estimate API.
     def get_analytics_cluster_memory_estimate(db_system_id, opts = {})
       logger.debug 'Calling operation DbSystemClient#get_analytics_cluster_memory_estimate.' if logger
 
@@ -569,6 +576,7 @@ module OCI
     #   200 OK response with the updated representation.
     #
     # @return [Response] A Response object with data of type {OCI::Mysql::Models::DbSystem DbSystem}
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/mysql/get_db_system.rb.html) to see an example of how to use get_db_system API.
     def get_db_system(db_system_id, opts = {})
       logger.debug 'Calling operation DbSystemClient#get_db_system.' if logger
 
@@ -651,6 +659,7 @@ module OCI
     #   Pagination](https://docs.cloud.oracle.com/#API/Concepts/usingapi.htm#List_Pagination).
     #
     # @return [Response] A Response object with data of type Array<{OCI::Mysql::Models::DbSystemSummary DbSystemSummary}>
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/mysql/list_db_systems.rb.html) to see an example of how to use list_db_systems API.
     def list_db_systems(compartment_id, opts = {})
       logger.debug 'Calling operation DbSystemClient#list_db_systems.' if logger
 
@@ -742,6 +751,7 @@ module OCI
     #   creation request may be rejected).
     #
     # @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/mysql/restart_analytics_cluster.rb.html) to see an example of how to use restart_analytics_cluster API.
     def restart_analytics_cluster(db_system_id, opts = {})
       logger.debug 'Calling operation DbSystemClient#restart_analytics_cluster.' if logger
 
@@ -814,6 +824,7 @@ module OCI
     #   creation request may be rejected).
     #
     # @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/mysql/restart_db_system.rb.html) to see an example of how to use restart_db_system API.
     def restart_db_system(db_system_id, restart_db_system_details, opts = {})
       logger.debug 'Calling operation DbSystemClient#restart_db_system.' if logger
 
@@ -886,6 +897,7 @@ module OCI
     #   creation request may be rejected).
     #
     # @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/mysql/start_analytics_cluster.rb.html) to see an example of how to use start_analytics_cluster API.
     def start_analytics_cluster(db_system_id, opts = {})
       logger.debug 'Calling operation DbSystemClient#start_analytics_cluster.' if logger
 
@@ -957,6 +969,7 @@ module OCI
     #   creation request may be rejected).
     #
     # @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/mysql/start_db_system.rb.html) to see an example of how to use start_db_system API.
     def start_db_system(db_system_id, opts = {})
       logger.debug 'Calling operation DbSystemClient#start_db_system.' if logger
 
@@ -1028,6 +1041,7 @@ module OCI
     #   creation request may be rejected).
     #
     # @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/mysql/stop_analytics_cluster.rb.html) to see an example of how to use stop_analytics_cluster API.
     def stop_analytics_cluster(db_system_id, opts = {})
       logger.debug 'Calling operation DbSystemClient#stop_analytics_cluster.' if logger
 
@@ -1103,6 +1117,7 @@ module OCI
     #   creation request may be rejected).
     #
     # @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/mysql/stop_db_system.rb.html) to see an example of how to use stop_db_system API.
     def stop_db_system(db_system_id, stop_db_system_details, opts = {})
       logger.debug 'Calling operation DbSystemClient#stop_db_system.' if logger
 
@@ -1170,6 +1185,7 @@ module OCI
     #   ID that you supplied in this header with the request.
     #
     # @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/mysql/update_analytics_cluster.rb.html) to see an example of how to use update_analytics_cluster API.
     def update_analytics_cluster(db_system_id, update_analytics_cluster_details, opts = {})
       logger.debug 'Calling operation DbSystemClient#update_analytics_cluster.' if logger
 
@@ -1242,6 +1258,7 @@ module OCI
     #   ID that you supplied in this header with the request.
     #
     # @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/mysql/update_db_system.rb.html) to see an example of how to use update_db_system API.
     def update_db_system(db_system_id, update_db_system_details, opts = {})
       logger.debug 'Calling operation DbSystemClient#update_db_system.' if logger