lib/oci/mysql/channels_client.rb
# 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](https://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](https://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.
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.
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 .
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
      query_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]
      header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token
      post_body = nil
      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
    end
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 query_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 ] header_params [ :' opc-retry-token ' ] ||= OCI :: Retry . generate_opc_retry_token post_body = nil 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 end
Resumes an enabled Channel that has become Inactive due to an error.
Resumes an enabled Channel that has become Inactive due to an error .
# rubocop:disable Style/NegatedIf # Query Params # Header Params # rubocop:enable Style/NegatedIf # rubocop:disable Metrics/BlockLength # rubocop:enable Metrics/BlockLength
A Response object with data of type nil
A Response object with data of type nil
Response
channel_id
opts
: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).
: 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 ) .
opts the optional parameters
opts the optional parameters
note
Click [here] to see an example of how to use resume_channel API.
Click [ here ] to see an example of how to use resume_channel API .