Class: OCI::Mysql::ChannelsClient
- Inherits:
-
Object
- Object
- OCI::Mysql::ChannelsClient
- Defined in:
- lib/oci/mysql/channels_client.rb
Overview
The API for the MySQL Database Service
Instance Attribute Summary collapse
-
#api_client ⇒ OCI::ApiClient
readonly
Client used to make HTTP requests.
-
#endpoint ⇒ String
readonly
Fully qualified endpoint URL.
-
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
-
#retry_config ⇒ OCI::Retry::RetryConfig
readonly
The default retry configuration to apply to all operations in this service client.
Instance Method Summary collapse
-
#create_channel(create_channel_details, opts = {}) ⇒ Response
Creates a Channel to establish replication from a source to a target.
-
#delete_channel(channel_id, opts = {}) ⇒ Response
Deletes the specified Channel.
-
#get_channel(channel_id, opts = {}) ⇒ Response
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.
-
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ ChannelsClient
constructor
Creates a new ChannelsClient.
-
#list_channels(compartment_id, opts = {}) ⇒ Response
Lists all the Channels that match the specified filters.
-
#logger ⇒ Logger
The logger for this client.
-
#reset_channel(channel_id, opts = {}) ⇒ Response
Resets the specified Channel by purging its cached information, leaving the Channel as if it had just been created.
-
#resume_channel(channel_id, opts = {}) ⇒ Response
Resumes an enabled Channel that has become Inactive due to an error.
-
#update_channel(channel_id, update_channel_details, opts = {}) ⇒ Response
Updates the properties of the specified Channel.
Constructor Details
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ ChannelsClient
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.
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 |
# File 'lib/oci/mysql/channels_client.rb', line 55 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 |
Instance Attribute Details
#api_client ⇒ OCI::ApiClient (readonly)
Client used to make HTTP requests.
15 16 17 |
# File 'lib/oci/mysql/channels_client.rb', line 15 def api_client @api_client end |
#endpoint ⇒ String (readonly)
Fully qualified endpoint URL
19 20 21 |
# File 'lib/oci/mysql/channels_client.rb', line 19 def endpoint @endpoint end |
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
29 30 31 |
# File 'lib/oci/mysql/channels_client.rb', line 29 def region @region end |
#retry_config ⇒ OCI::Retry::RetryConfig (readonly)
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
25 26 27 |
# File 'lib/oci/mysql/channels_client.rb', line 25 def retry_config @retry_config end |
Instance Method Details
#create_channel(create_channel_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_channel API.
Creates a Channel to establish replication from a source to a target.
122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 |
# File 'lib/oci/mysql/channels_client.rb', line 122 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.(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 |
#delete_channel(channel_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_channel API.
Deletes the specified Channel.
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 |
# File 'lib/oci/mysql/channels_client.rb', line 186 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.(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 |
#get_channel(channel_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_channel API.
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.
252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 |
# File 'lib/oci/mysql/channels_client.rb', line 252 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.(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 |
#list_channels(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_channels API.
Lists all the Channels that match the specified filters. Allowed values are: displayName, timeCreated
329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 |
# File 'lib/oci/mysql/channels_client.rb', line 329 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.(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 |
#logger ⇒ Logger
Returns The logger for this client. May be nil.
94 95 96 |
# File 'lib/oci/mysql/channels_client.rb', line 94 def logger @api_client.config.logger end |
#reset_channel(channel_id, opts = {}) ⇒ Response
Click here to see an example of how to use reset_channel API.
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.
422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 |
# File 'lib/oci/mysql/channels_client.rb', line 422 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.(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 |
#resume_channel(channel_id, opts = {}) ⇒ Response
Click here to see an example of how to use resume_channel API.
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.
497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 |
# File 'lib/oci/mysql/channels_client.rb', line 497 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.(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 |
#update_channel(channel_id, update_channel_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_channel API.
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.
574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 |
# File 'lib/oci/mysql/channels_client.rb', line 574 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.(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 |