lib/oci/streaming/stream_admin_client.rb
# Deletes a connect harness and its content. Connect harness contents are deleted immediately. The service retains records of the connect harness itself for 90 days after deletion.
# The `lifecycleState` parameter of the `ConnectHarness` object changes to `DELETING` and the connect harness becomes inaccessible for read or write operations.
# To verify that a connect harness has been deleted, make a {#get_connect_harness get_connect_harness} request. If the call returns the connect harness's
# lifecycle state as `DELETED`, then the connect harness has been deleted. If the call returns a \"404 Not Found\" error, that means all records of the
# connect harness have been deleted.
#
# @param [String] connect_harness_id The OCID of the connect harness.
#
# @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 The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
#   particular request, please provide the request ID.
#
# @option opts [String] :if_match For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter 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.
# @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/streaming/delete_connect_harness.rb.html) to see an example of how to use delete_connect_harness API.
Deletes a connect harness and its content. Connect harness contents are deleted immediately. The service retains records of the connect harness itself for 90 days after deletion.
Deletes a connect harness and its content . Connect harness contents are deleted immediately . The service retains records of the connect harness itself for 90 days after deletion .
def delete_connect_harness(connect_harness_id, opts = {})
      logger.debug 'Calling operation StreamAdminClient#delete_connect_harness.' if logger
      raise "Missing the required parameter 'connect_harness_id' when calling delete_connect_harness." if connect_harness_id.nil?
      raise "Parameter value for 'connect_harness_id' must not be blank" if OCI::Internal::Util.blank_string?(connect_harness_id)
      path = '/connectharnesses/{connectHarnessId}'.sub('{connectHarnessId}', connect_harness_id.to_s)
      operation_signing_strategy = :standard
      query_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-match'] = opts[:if_match] if opts[:if_match]
      post_body = nil
      OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'StreamAdminClient#delete_connect_harness') 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
    end
def delete_connect_harness ( connect_harness_id , opts = { } ) logger . debug 'Calling operation StreamAdminClient#delete_connect_harness.' if logger raise "Missing the required parameter 'connect_harness_id' when calling delete_connect_harness." if connect_harness_id . nil? raise "Parameter value for 'connect_harness_id' must not be blank" if OCI :: Internal :: Util . blank_string? ( connect_harness_id ) path = '/connectharnesses/{connectHarnessId}' . sub ( '{connectHarnessId}' , connect_harness_id . to_s ) operation_signing_strategy = :standard query_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-match ' ] = opts [ :if_match ] if opts [ :if_match ] post_body = nil OCI :: Retry . make_retrying_call ( applicable_retry_config ( opts ) , call_name : 'StreamAdminClient#delete_connect_harness' ) 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 end
Deletes a connect harness and its content.
Deletes a connect harness and its content .
# 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
connect_harness_id
opts
:if_match For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter 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.
: if_match For optimistic concurrency control . In the PUT or DELETE call for a resource set the if - match parameter 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 .
opts the optional parameters
opts the optional parameters
note
Click [here] to see an example of how to use delete_connect_harness API.
Click [ here ] to see an example of how to use delete_connect_harness API .