oci 2.11.0 → 2.12.0

data/lib/oci/mysql/models/update_channel_target_from_db_system_details.rb

@@ -0,0 +1,179 @@
+# 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.
+
+require 'date'
+require_relative 'update_channel_target_details'
+
+# rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
+module OCI
+  # Parameters detailing how to provision the target endpoint that is a DB System.
+  class Mysql::Models::UpdateChannelTargetFromDbSystemDetails < Mysql::Models::UpdateChannelTargetDetails
+    # The case-insensitive name that identifies the replication channel. Channel names
+    # must follow the rules defined for [MySQL identifiers](https://dev.mysql.com/doc/refman/8.0/en/identifiers.html).
+    # The names of non-Deleted Channels must be unique for each DB System.
+    #
+    # @return [String]
+    attr_accessor :channel_name
+
+    # The username for the replication applier of the target MySQL DB System.
+    # @return [String]
+    attr_accessor :applier_username
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        # rubocop:disable Style/SymbolLiteral
+        'target_type': :'targetType',
+        'channel_name': :'channelName',
+        'applier_username': :'applierUsername'
+        # rubocop:enable Style/SymbolLiteral
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        # rubocop:disable Style/SymbolLiteral
+        'target_type': :'String',
+        'channel_name': :'String',
+        'applier_username': :'String'
+        # rubocop:enable Style/SymbolLiteral
+      }
+    end
+
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
+    # rubocop:disable Metrics/MethodLength, Layout/EmptyLines, Style/SymbolLiteral
+
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :channel_name The value to assign to the {#channel_name} property
+    # @option attributes [String] :applier_username The value to assign to the {#applier_username} property
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      attributes['targetType'] = 'DBSYSTEM'
+
+      super(attributes)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      self.channel_name = attributes[:'channelName'] if attributes[:'channelName']
+
+      raise 'You cannot provide both :channelName and :channel_name' if attributes.key?(:'channelName') && attributes.key?(:'channel_name')
+
+      self.channel_name = attributes[:'channel_name'] if attributes[:'channel_name']
+
+      self.applier_username = attributes[:'applierUsername'] if attributes[:'applierUsername']
+
+      raise 'You cannot provide both :applierUsername and :applier_username' if attributes.key?(:'applierUsername') && attributes.key?(:'applier_username')
+
+      self.applier_username = attributes[:'applier_username'] if attributes[:'applier_username']
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
+    # rubocop:enable Metrics/MethodLength, Layout/EmptyLines, Style/SymbolLiteral
+
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity, Layout/EmptyLines
+
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] other the other object to be compared
+    def ==(other)
+      return true if equal?(other)
+
+      self.class == other.class &&
+        target_type == other.target_type &&
+        channel_name == other.channel_name &&
+        applier_username == other.applier_username
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity, Layout/EmptyLines
+
+    # @see the `==` method
+    # @param [Object] other the other object to be compared
+    def eql?(other)
+      self == other
+    end
+
+    # rubocop:disable Metrics/AbcSize, Layout/EmptyLines
+
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [target_type, channel_name, applier_username].hash
+    end
+    # rubocop:enable Metrics/AbcSize, Layout/EmptyLines
+
+    # rubocop:disable Metrics/AbcSize, Layout/EmptyLines
+
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /^Array<(.*)>/i
+          # check to ensure the input is an array given that the the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            public_method("#{key}=").call(
+              attributes[self.class.attribute_map[key]]
+                .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
+            )
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          public_method("#{key}=").call(
+            OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
+          )
+        end
+        # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+    # rubocop:enable Metrics/AbcSize, Layout/EmptyLines
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = public_method(attr).call
+        next if value.nil? && !instance_variable_defined?("@#{attr}")
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    private
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end
+# rubocop:enable Lint/UnneededCopDisableDirective, Metrics/LineLength

data/lib/oci/mysql/models/update_configuration_details.rb

@@ -16,13 +16,13 @@ module OCI
     # @return [String]
     attr_accessor :display_name
 
-    # Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only.
+    # Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
     # Example: `{\"bar-key\": \"value\"}`
     #
     # @return [Hash<String, String>]
     attr_accessor :freeform_tags
 
-    # Usage of predefined tag keys. These predefined keys are scoped to namespaces.
+    # Defined tags for this resource. Each key is predefined and scoped to a namespace.
     # Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`
     #
     # @return [Hash<String, Hash<String, Object>>]

data/lib/oci/mysql/mysql.rb

@@ -22,31 +22,52 @@ require 'oci/mysql/models/analytics_cluster_table_memory_estimate'
 require 'oci/mysql/models/backup'
 require 'oci/mysql/models/backup_policy'
 require 'oci/mysql/models/backup_summary'
+require 'oci/mysql/models/ca_certificate'
+require 'oci/mysql/models/channel'
+require 'oci/mysql/models/channel_source'
+require 'oci/mysql/models/channel_source_mysql'
+require 'oci/mysql/models/channel_summary'
+require 'oci/mysql/models/channel_target'
+require 'oci/mysql/models/channel_target_db_system'
 require 'oci/mysql/models/configuration'
 require 'oci/mysql/models/configuration_summary'
 require 'oci/mysql/models/configuration_variables'
 require 'oci/mysql/models/create_backup_details'
 require 'oci/mysql/models/create_backup_policy_details'
+require 'oci/mysql/models/create_channel_details'
+require 'oci/mysql/models/create_channel_source_details'
+require 'oci/mysql/models/create_channel_source_from_mysql_details'
+require 'oci/mysql/models/create_channel_target_details'
+require 'oci/mysql/models/create_channel_target_from_db_system_details'
 require 'oci/mysql/models/create_configuration_details'
 require 'oci/mysql/models/create_db_system_details'
 require 'oci/mysql/models/create_db_system_source_details'
 require 'oci/mysql/models/create_db_system_source_from_backup_details'
+require 'oci/mysql/models/create_db_system_source_from_none_details'
 require 'oci/mysql/models/create_db_system_source_import_from_url_details'
 require 'oci/mysql/models/create_maintenance_details'
 require 'oci/mysql/models/db_system'
 require 'oci/mysql/models/db_system_endpoint'
+require 'oci/mysql/models/db_system_snapshot'
 require 'oci/mysql/models/db_system_source'
 require 'oci/mysql/models/db_system_source_from_backup'
+require 'oci/mysql/models/db_system_source_from_none'
 require 'oci/mysql/models/db_system_source_import_from_url'
 require 'oci/mysql/models/db_system_summary'
 require 'oci/mysql/models/inno_db_shutdown_mode'
 require 'oci/mysql/models/maintenance_details'
+require 'oci/mysql/models/pem_ca_certificate'
 require 'oci/mysql/models/restart_db_system_details'
 require 'oci/mysql/models/shape_summary'
 require 'oci/mysql/models/stop_db_system_details'
 require 'oci/mysql/models/update_analytics_cluster_details'
 require 'oci/mysql/models/update_backup_details'
 require 'oci/mysql/models/update_backup_policy_details'
+require 'oci/mysql/models/update_channel_details'
+require 'oci/mysql/models/update_channel_source_details'
+require 'oci/mysql/models/update_channel_source_from_mysql_details'
+require 'oci/mysql/models/update_channel_target_details'
+require 'oci/mysql/models/update_channel_target_from_db_system_details'
 require 'oci/mysql/models/update_configuration_details'
 require 'oci/mysql/models/update_db_system_details'
 require 'oci/mysql/models/update_maintenance_details'
@@ -62,6 +83,8 @@ require 'oci/mysql/models/work_request_resource_action_type'
 require 'oci/mysql/models/work_request_summary'
 
 # Require generated clients
+require 'oci/mysql/channels_client'
+require 'oci/mysql/channels_client_composite_operations'
 require 'oci/mysql/db_backups_client'
 require 'oci/mysql/db_backups_client_composite_operations'
 require 'oci/mysql/db_system_client'

data/lib/oci/mysql/mysqlaas_client.rb

@@ -115,6 +115,7 @@ module OCI
     #   creation request may be rejected).
     #
     # @return [Response] A Response object with data of type {OCI::Mysql::Models::Configuration Configuration}
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/mysql/create_configuration.rb.html) to see an example of how to use create_configuration API.
     def create_configuration(create_configuration_details, opts = {})
       logger.debug 'Calling operation MysqlaasClient#create_configuration.' 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_configuration.rb.html) to see an example of how to use delete_configuration API.
     def delete_configuration(configuration_id, opts = {})
       logger.debug 'Calling operation MysqlaasClient#delete_configuration.' if logger
 
@@ -243,6 +245,7 @@ module OCI
     #   200 OK response with the updated representation.
     #
     # @return [Response] A Response object with data of type {OCI::Mysql::Models::Configuration Configuration}
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/mysql/get_configuration.rb.html) to see an example of how to use get_configuration API.
     def get_configuration(configuration_id, opts = {})
       logger.debug 'Calling operation MysqlaasClient#get_configuration.' if logger
 
@@ -326,6 +329,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::ConfigurationSummary ConfigurationSummary}>
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/mysql/list_configurations.rb.html) to see an example of how to use list_configurations API.
     def list_configurations(compartment_id, opts = {})
       logger.debug 'Calling operation MysqlaasClient#list_configurations.' if logger
 
@@ -422,6 +426,7 @@ module OCI
     # @option opts [String] :availability_domain The name of the Availability Domain.
     # @option opts [String] :name Name
     # @return [Response] A Response object with data of type Array<{OCI::Mysql::Models::ShapeSummary ShapeSummary}>
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/mysql/list_shapes.rb.html) to see an example of how to use list_shapes API.
     def list_shapes(compartment_id, opts = {})
       logger.debug 'Calling operation MysqlaasClient#list_shapes.' if logger
 
@@ -494,6 +499,7 @@ module OCI
     #   ID that you supplied in this header with the request.
     #
     # @return [Response] A Response object with data of type Array<{OCI::Mysql::Models::VersionSummary VersionSummary}>
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/mysql/list_versions.rb.html) to see an example of how to use list_versions API.
     def list_versions(compartment_id, opts = {})
       logger.debug 'Calling operation MysqlaasClient#list_versions.' if logger
 
@@ -557,6 +563,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::Configuration Configuration}
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/mysql/update_configuration.rb.html) to see an example of how to use update_configuration API.
     def update_configuration(configuration_id, update_configuration_details, opts = {})
       logger.debug 'Calling operation MysqlaasClient#update_configuration.' if logger
 

data/lib/oci/mysql/work_requests_client.rb

@@ -114,6 +114,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::WorkRequest WorkRequest}
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/mysql/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 WorkRequestsClient#get_work_request.' if logger
 
@@ -179,6 +180,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::WorkRequestError WorkRequestError}>
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/mysql/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 WorkRequestsClient#list_work_request_errors.' if logger
 
@@ -245,6 +247,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::WorkRequestLogEntry WorkRequestLogEntry}>
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/mysql/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 WorkRequestsClient#list_work_request_logs.' if logger
 
@@ -315,6 +318,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::WorkRequestSummary WorkRequestSummary}>
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/mysql/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 WorkRequestsClient#list_work_requests.' if logger
 

data/lib/oci/nosql/nosql_client.rb

@@ -123,6 +123,7 @@ module OCI
     #    (default to false)
     # @option opts [String] :opc_request_id The client request ID for tracing.
     # @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/nosql/change_table_compartment.rb.html) to see an example of how to use change_table_compartment API.
     def change_table_compartment(table_name_or_id, change_table_compartment_details, opts = {})
       logger.debug 'Calling operation NosqlClient#change_table_compartment.' if logger
 
@@ -188,6 +189,7 @@ module OCI
     #
     # @option opts [String] :opc_request_id The client request ID for tracing.
     # @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/nosql/create_index.rb.html) to see an example of how to use create_index API.
     def create_index(table_name_or_id, create_index_details, opts = {})
       logger.debug 'Calling operation NosqlClient#create_index.' if logger
 
@@ -251,6 +253,7 @@ module OCI
     #
     # @option opts [String] :opc_request_id The client request ID for tracing.
     # @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/nosql/create_table.rb.html) to see an example of how to use create_table API.
     def create_table(create_table_details, opts = {})
       logger.debug 'Calling operation NosqlClient#create_table.' if logger
 
@@ -316,6 +319,7 @@ module OCI
     #    (default to false)
     # @option opts [String] :opc_request_id The client request ID for tracing.
     # @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/nosql/delete_index.rb.html) to see an example of how to use delete_index API.
     def delete_index(table_name_or_id, index_name, opts = {})
       logger.debug 'Calling operation NosqlClient#delete_index.' if logger
 
@@ -390,6 +394,7 @@ module OCI
     #    (default to false)
     # @option opts [String] :opc_request_id The client request ID for tracing.
     # @return [Response] A Response object with data of type {OCI::Nosql::Models::DeleteRowResult DeleteRowResult}
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/nosql/delete_row.rb.html) to see an example of how to use delete_row API.
     def delete_row(table_name_or_id, key, opts = {})
       logger.debug 'Calling operation NosqlClient#delete_row.' if logger
 
@@ -460,6 +465,7 @@ module OCI
     #    (default to false)
     # @option opts [String] :opc_request_id The client request ID for tracing.
     # @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/nosql/delete_table.rb.html) to see an example of how to use delete_table API.
     def delete_table(table_name_or_id, opts = {})
       logger.debug 'Calling operation NosqlClient#delete_table.' if logger
 
@@ -521,6 +527,7 @@ module OCI
     #    (default to false)
     # @option opts [String] :opc_request_id The client request ID for tracing.
     # @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/nosql/delete_work_request.rb.html) to see an example of how to use delete_work_request API.
     def delete_work_request(work_request_id, opts = {})
       logger.debug 'Calling operation NosqlClient#delete_work_request.' if logger
 
@@ -579,6 +586,7 @@ module OCI
     #
     # @option opts [String] :opc_request_id The client request ID for tracing.
     # @return [Response] A Response object with data of type {OCI::Nosql::Models::Index Index}
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/nosql/get_index.rb.html) to see an example of how to use get_index API.
     def get_index(table_name_or_id, index_name, opts = {})
       logger.debug 'Calling operation NosqlClient#get_index.' if logger
 
@@ -645,6 +653,7 @@ module OCI
     # @option opts [Integer] :timeout_in_ms Timeout setting for this operation. (default to 5000)
     # @option opts [String] :opc_request_id The client request ID for tracing.
     # @return [Response] A Response object with data of type {OCI::Nosql::Models::Row Row}
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/nosql/get_row.rb.html) to see an example of how to use get_row API.
     def get_row(table_name_or_id, key, opts = {})
       logger.debug 'Calling operation NosqlClient#get_row.' if logger
 
@@ -711,6 +720,7 @@ module OCI
     #
     # @option opts [String] :opc_request_id The client request ID for tracing.
     # @return [Response] A Response object with data of type {OCI::Nosql::Models::Table Table}
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/nosql/get_table.rb.html) to see an example of how to use get_table API.
     def get_table(table_name_or_id, opts = {})
       logger.debug 'Calling operation NosqlClient#get_table.' if logger
 
@@ -765,6 +775,7 @@ module OCI
     #   retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
     # @option opts [String] :opc_request_id The client request ID for tracing.
     # @return [Response] A Response object with data of type {OCI::Nosql::Models::WorkRequest WorkRequest}
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/nosql/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 NosqlClient#get_work_request.' if logger
 
@@ -838,6 +849,7 @@ module OCI
     #   Allowed values are: timeCreated, name
     # @option opts [String] :opc_request_id The client request ID for tracing.
     # @return [Response] A Response object with data of type {OCI::Nosql::Models::IndexCollection IndexCollection}
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/nosql/list_indexes.rb.html) to see an example of how to use list_indexes API.
     def list_indexes(table_name_or_id, opts = {})
       logger.debug 'Calling operation NosqlClient#list_indexes.' if logger
 
@@ -924,6 +936,7 @@ module OCI
     #   list call.
     #
     # @return [Response] A Response object with data of type {OCI::Nosql::Models::TableUsageCollection TableUsageCollection}
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/nosql/list_table_usage.rb.html) to see an example of how to use list_table_usage API.
     def list_table_usage(table_name_or_id, opts = {})
       logger.debug 'Calling operation NosqlClient#list_table_usage.' if logger
 
@@ -998,6 +1011,7 @@ module OCI
     # @option opts [String] :lifecycle_state Filter list by the lifecycle state of the item. (default to ALL)
     #   Allowed values are: ALL, CREATING, UPDATING, ACTIVE, DELETING, DELETED, FAILED, INACTIVE
     # @return [Response] A Response object with data of type {OCI::Nosql::Models::TableCollection TableCollection}
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/nosql/list_tables.rb.html) to see an example of how to use list_tables API.
     def list_tables(compartment_id, opts = {})
       logger.debug 'Calling operation NosqlClient#list_tables.' if logger
 
@@ -1075,6 +1089,7 @@ module OCI
     #
     # @option opts [Integer] :limit The maximum number of items to return. (default to 1000)
     # @return [Response] A Response object with data of type {OCI::Nosql::Models::WorkRequestErrorCollection WorkRequestErrorCollection}
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/nosql/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 NosqlClient#list_work_request_errors.' if logger
 
@@ -1136,6 +1151,7 @@ module OCI
     #
     # @option opts [Integer] :limit The maximum number of items to return. (default to 1000)
     # @return [Response] A Response object with data of type {OCI::Nosql::Models::WorkRequestLogEntryCollection WorkRequestLogEntryCollection}
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/nosql/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 NosqlClient#list_work_request_logs.' if logger
 
@@ -1196,6 +1212,7 @@ module OCI
     #
     # @option opts [Integer] :limit The maximum number of items to return. (default to 1000)
     # @return [Response] A Response object with data of type {OCI::Nosql::Models::WorkRequestCollection WorkRequestCollection}
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/nosql/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 NosqlClient#list_work_requests.' if logger
 
@@ -1253,6 +1270,7 @@ module OCI
     #   retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
     # @option opts [String] :opc_request_id The client request ID for tracing.
     # @return [Response] A Response object with data of type {OCI::Nosql::Models::PreparedStatement PreparedStatement}
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/nosql/prepare_statement.rb.html) to see an example of how to use prepare_statement API.
     def prepare_statement(compartment_id, statement, opts = {})
       logger.debug 'Calling operation NosqlClient#prepare_statement.' if logger
 
@@ -1313,6 +1331,7 @@ module OCI
     #
     # @option opts [String] :opc_request_id The client request ID for tracing.
     # @return [Response] A Response object with data of type {OCI::Nosql::Models::QueryResultCollection QueryResultCollection}
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/nosql/query.rb.html) to see an example of how to use query API.
     def query(query_details, opts = {})
       logger.debug 'Calling operation NosqlClient#query.' if logger
 
@@ -1369,6 +1388,7 @@ module OCI
     #   retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
     # @option opts [String] :opc_request_id The client request ID for tracing.
     # @return [Response] A Response object with data of type {OCI::Nosql::Models::StatementSummary StatementSummary}
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/nosql/summarize_statement.rb.html) to see an example of how to use summarize_statement API.
     def summarize_statement(compartment_id, statement, opts = {})
       logger.debug 'Calling operation NosqlClient#summarize_statement.' if logger
 
@@ -1431,6 +1451,7 @@ module OCI
     #    (default to false)
     # @option opts [String] :opc_request_id The client request ID for tracing.
     # @return [Response] A Response object with data of type {OCI::Nosql::Models::UpdateRowResult UpdateRowResult}
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/nosql/update_row.rb.html) to see an example of how to use update_row API.
     def update_row(table_name_or_id, update_row_details, opts = {})
       logger.debug 'Calling operation NosqlClient#update_row.' if logger
 
@@ -1495,6 +1516,7 @@ module OCI
     #    (default to false)
     # @option opts [String] :opc_request_id The client request ID for tracing.
     # @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/nosql/update_table.rb.html) to see an example of how to use update_table API.
     def update_table(table_name_or_id, update_table_details, opts = {})
       logger.debug 'Calling operation NosqlClient#update_table.' if logger