class OCI::Mysql::ChannelsClient
The API for the MySQL Database
Service
Attributes
Client used to make HTTP requests. @return [OCI::ApiClient]
Fully qualified endpoint URL @return [String]
The region, which will usually correspond to a value in {OCI::Regions::REGION_ENUM}. @return [String]
The default retry configuration to apply to all operations in this service client. This can be overridden on a per-operation basis. The default retry configuration value is `nil`, which means that an operation will not perform any retries @return [OCI::Retry::RetryConfig]
Public Class Methods
Creates a new ChannelsClient
. Notes:
If a config is not specified, then the global OCI.config will be used. This client is not thread-safe Either a region or an endpoint must be specified. If an endpoint is specified, it will be used instead of the region. A region may be specified in the config or via or the region parameter. If specified in both, then the region parameter will be used.
@param [Config] config A Config
object. @param [String] region A region used to determine the service endpoint. This will usually
correspond to a value in {OCI::Regions::REGION_ENUM}, but may be an arbitrary string.
@param [String] endpoint The fully qualified endpoint URL @param [OCI::BaseSigner] signer A signer implementation which can be used by this client. If this is not provided then
a signer will be constructed via the provided config. One use case of this parameter is instance principals authentication, so that the instance principals signer can be provided to the client
@param [OCI::ApiClientProxySettings] proxy_settings If your environment requires you to use a proxy server for outgoing HTTP requests
the details for the proxy can be provided in this parameter
@param [OCI::Retry::RetryConfig] retry_config
The retry configuration for this service client. This represents the default retry configuration to
apply across all operations. This can be overridden on a per-operation basis. The default retry configuration value is `nil`, which means that an operation will not perform any retries
# File lib/oci/mysql/channels_client.rb, line 53 def initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) # If the signer is an InstancePrincipalsSecurityTokenSigner or SecurityTokenSigner and no config was supplied (they are self-sufficient signers) # then create a dummy config to pass to the ApiClient constructor. If customers wish to create a client which uses instance principals # and has config (either populated programmatically or loaded from a file), they must construct that config themselves and then # pass it to this constructor. # # If there is no signer (or the signer is not an instance principals signer) and no config was supplied, this is not valid # so try and load the config from the default file. config = OCI::Config.validate_and_build_config_with_signer(config, signer) signer = OCI::Signer.config_file_auth_builder(config) if signer.nil? @api_client = OCI::ApiClient.new(config, signer, proxy_settings: proxy_settings) @retry_config = retry_config if endpoint @endpoint = endpoint + '/20190415' else region ||= config.region region ||= signer.region if signer.respond_to?(:region) self.region = region end logger.info "ChannelsClient endpoint set to '#{@endpoint}'." if logger end
Public Instance Methods
Creates a Channel to establish replication from a source to a target.
@param [OCI::Mysql::Models::CreateChannelDetails] create_channel_details The parameters of the request to create the Channel. @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
@option opts [String] :opc_request_id Customer-defined unique identifier for the request. If you need to
contact Oracle about a specific request, please provide the request ID that you supplied in this header with the request.
@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::Mysql::Models::Channel Channel} @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/mysql/create_channel.rb.html) to see an example of how to use create_channel
API.
# File lib/oci/mysql/channels_client.rb, line 120 def create_channel(create_channel_details, opts = {}) logger.debug 'Calling operation ChannelsClient#create_channel.' if logger raise "Missing the required parameter 'create_channel_details' when calling create_channel." if create_channel_details.nil? path = '/channels' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_channel_details) # rubocop:disable Metrics/BlockLength OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ChannelsClient#create_channel') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Mysql::Models::Channel' ) end # rubocop:enable Metrics/BlockLength end
Deletes the specified Channel. @param [String] channel_id The Channel [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm). @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
@option opts [String] :if_match For optimistic concurrency control. In the PUT or DELETE call for a
resource, set the `If-Match` header 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.
@option opts [String] :opc_request_id Customer-defined unique identifier for the request. If you need to
contact Oracle about a specific request, please provide the request ID that you supplied in this header with the request.
@return [Response] A Response
object with data of type nil @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/mysql/delete_channel.rb.html) to see an example of how to use delete_channel
API.
# File lib/oci/mysql/channels_client.rb, line 184 def delete_channel(channel_id, opts = {}) logger.debug 'Calling operation ChannelsClient#delete_channel.' if logger raise "Missing the required parameter 'channel_id' when calling delete_channel." if channel_id.nil? raise "Parameter value for 'channel_id' must not be blank" if OCI::Internal::Util.blank_string?(channel_id) path = '/channels/{channelId}'.sub('{channelId}', channel_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ChannelsClient#delete_channel') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end
Gets the full details of the specified Channel, including the user-specified configuration parameters (passwords are omitted), as well as information about the state of the Channel, its sources and targets.
@param [String] channel_id The Channel [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm). @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
@option opts [String] :opc_request_id Customer-defined unique identifier for the request. If you need to
contact Oracle about a specific request, please provide the request ID that you supplied in this header with the request.
@option opts [String] :if_none_match For conditional requests. In the GET call for a resource, set the
`If-None-Match` header to the value of the ETag from a previous GET (or POST or PUT) response for that resource. The server will return with either a 304 Not Modified response if the resource has not changed, or a 200 OK response with the updated representation.
@return [Response] A Response
object with data of type {OCI::Mysql::Models::Channel Channel} @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/mysql/get_channel.rb.html) to see an example of how to use get_channel
API.
# File lib/oci/mysql/channels_client.rb, line 250 def get_channel(channel_id, opts = {}) logger.debug 'Calling operation ChannelsClient#get_channel.' if logger raise "Missing the required parameter 'channel_id' when calling get_channel." if channel_id.nil? raise "Parameter value for 'channel_id' must not be blank" if OCI::Internal::Util.blank_string?(channel_id) path = '/channels/{channelId}'.sub('{channelId}', channel_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'if-none-match'] = opts[:if_none_match] if opts[:if_none_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ChannelsClient#get_channel') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Mysql::Models::Channel' ) end # rubocop:enable Metrics/BlockLength end
Lists all the Channels that match the specified filters. @param [String] compartment_id The compartment [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm). @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
@option opts [String] :opc_request_id Customer-defined unique identifier for the request. If you need to
contact Oracle about a specific request, please provide the request ID that you supplied in this header with the request.
@option opts [String] :db_system_id The DB System [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm). @option opts [String] :channel_id The OCID of the Channel. @option opts [String] :display_name A filter to return only the resource matching the given display name exactly. @option opts [String] :lifecycle_state The LifecycleState of the Channel. @option opts [BOOLEAN] :is_enabled If true, returns only Channels that are enabled. If false, returns only
Channels that are disabled.
@option opts [String] :sort_by The field to sort by. Only one sort order may be provided. Time fields are default ordered as descending. Display name is default ordered as ascending.
(default to timeCreated) Allowed values are: displayName, timeCreated
@option opts [String] :sort_order The sort order to use (ASC or DESC). (default to ASC)
Allowed values are: ASC, DESC
@option opts [Integer] :limit The maximum number of items to return in a paginated list call. For information about pagination, see
[List Pagination](https://docs.cloud.oracle.com/#API/Concepts/usingapi.htm#List_Pagination). (default to 100)
@option opts [String] :page The value of the `opc-next-page` or `opc-prev-page` response header from
the previous list call. For information about pagination, see [List 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::ChannelSummary ChannelSummary}> @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/mysql/list_channels.rb.html) to see an example of how to use list_channels
API.
# File lib/oci/mysql/channels_client.rb, line 327 def list_channels(compartment_id, opts = {}) logger.debug 'Calling operation ChannelsClient#list_channels.' if logger raise "Missing the required parameter 'compartment_id' when calling list_channels." if compartment_id.nil? if opts[:lifecycle_state] && !OCI::Mysql::Models::Channel::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Mysql::Models::Channel::LIFECYCLE_STATE_ENUM.' end if opts[:sort_by] && !%w[displayName timeCreated].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of displayName, timeCreated.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end path = '/channels' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:dbSystemId] = opts[:db_system_id] if opts[:db_system_id] query_params[:channelId] = opts[:channel_id] if opts[:channel_id] query_params[:displayName] = opts[:display_name] if opts[:display_name] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] query_params[:isEnabled] = opts[:is_enabled] if !opts[:is_enabled].nil? 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] query_params[:page] = opts[:page] if opts[:page] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ChannelsClient#list_channels') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Mysql::Models::ChannelSummary>' ) end # rubocop:enable Metrics/BlockLength end
@return [Logger] The logger for this client. May be nil.
# File lib/oci/mysql/channels_client.rb, line 92 def logger @api_client.config.logger end
Set the region that will be used to determine the service endpoint. This will usually correspond to a value in {OCI::Regions::REGION_ENUM}, but may be an arbitrary string.
# File lib/oci/mysql/channels_client.rb, line 82 def region=(new_region) @region = new_region raise 'A region must be specified.' unless @region @endpoint = OCI::Regions.get_service_endpoint_for_template(@region, 'https://mysql.{region}.ocp.{secondLevelDomain}') + '/20190415' logger.info "ChannelsClient endpoint set to '#{@endpoint} from region #{@region}'." if logger end
Resets the specified Channel by purging its cached information, leaving the Channel as if it had just been created. This operation is only accepted in Inactive Channels.
@param [String] channel_id The Channel [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm). @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
@option opts [String] :if_match For optimistic concurrency control. In the PUT or DELETE call for a
resource, set the `If-Match` header 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.
@option opts [String] :opc_request_id Customer-defined unique identifier for the request. If you need to
contact Oracle about a specific request, please provide the request ID that you supplied in this header with the request.
@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 nil @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/mysql/reset_channel.rb.html) to see an example of how to use reset_channel
API.
# File lib/oci/mysql/channels_client.rb, line 420 def reset_channel(channel_id, opts = {}) logger.debug 'Calling operation ChannelsClient#reset_channel.' if logger raise "Missing the required parameter 'channel_id' when calling reset_channel." if channel_id.nil? raise "Parameter value for 'channel_id' must not be blank" if OCI::Internal::Util.blank_string?(channel_id) path = '/channels/{channelId}/actions/reset'.sub('{channelId}', channel_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ChannelsClient#reset_channel') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end
Resumes an enabled Channel that has become Inactive due to an error. The resume operation requires that the error that cause the Channel to become Inactive has already been fixed, otherwise the operation may fail.
@param [String] channel_id The Channel [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm). @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
@option opts [String] :if_match For optimistic concurrency control. In the PUT or DELETE call for a
resource, set the `If-Match` header 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.
@option opts [String] :opc_request_id Customer-defined unique identifier for the request. If you need to
contact Oracle about a specific request, please provide the request ID that you supplied in this header with the request.
@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 nil @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/mysql/resume_channel.rb.html) to see an example of how to use resume_channel
API.
# File lib/oci/mysql/channels_client.rb, line 495 def resume_channel(channel_id, opts = {}) logger.debug 'Calling operation ChannelsClient#resume_channel.' if logger raise "Missing the required parameter 'channel_id' when calling resume_channel." if channel_id.nil? raise "Parameter value for 'channel_id' must not be blank" if OCI::Internal::Util.blank_string?(channel_id) path = '/channels/{channelId}/actions/resume'.sub('{channelId}', channel_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ChannelsClient#resume_channel') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end
Updates the properties of the specified Channel. If the Channel is Active the Update operation will asynchronously apply the new configuration parameters to the Channel and the Channel may become temporarily unavailable. Otherwise, the new configuration will be applied the next time the Channel becomes Active.
@param [String] channel_id The Channel [OCID](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 [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
@option opts [String] :if_match For optimistic concurrency control. In the PUT or DELETE call for a
resource, set the `If-Match` header 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.
@option opts [String] :opc_request_id Customer-defined unique identifier for the request. If you need to
contact Oracle about a specific request, please provide the request ID that you supplied in this header with the request.
@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 nil @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/mysql/update_channel.rb.html) to see an example of how to use update_channel
API.
# File lib/oci/mysql/channels_client.rb, line 572 def update_channel(channel_id, update_channel_details, opts = {}) logger.debug 'Calling operation ChannelsClient#update_channel.' if logger raise "Missing the required parameter 'channel_id' when calling update_channel." if channel_id.nil? raise "Missing the required parameter 'update_channel_details' when calling update_channel." if update_channel_details.nil? raise "Parameter value for 'channel_id' must not be blank" if OCI::Internal::Util.blank_string?(channel_id) path = '/channels/{channelId}'.sub('{channelId}', channel_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(update_channel_details) # rubocop:disable Metrics/BlockLength OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ChannelsClient#update_channel') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end
Private Instance Methods
rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity rubocop:enable Style/IfUnlessModifier, Metrics/ParameterLists rubocop:enable Metrics/MethodLength, Layout/EmptyLines
# File lib/oci/mysql/channels_client.rb, line 618 def applicable_retry_config(opts = {}) return @retry_config unless opts.key?(:retry_config) opts[:retry_config] end