lib/oci/oda/oda_client.rb
# Starts an asynchronous job to create a Digital Assistant instance.
#
# To monitor the status of the job, take the `opc-work-request-id` response
# header value and use it to call `GET /workRequests/{workRequestID}`.
#
# @param [OCI::Oda::Models::CreateOdaInstanceDetails] create_oda_instance_details Details for the new Digital Assistant instance.
# @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 client request ID for tracing. This value is included in the opc-request-id response header.
# @option opts [String] :opc_retry_token A token that uniquely identifies a request so that you can retry the request if there's
#   a timeout or server error without the risk of executing that same action again.
#
#   Retry tokens expire after 24 hours, but they can become invalid before then if there are
#   conflicting operations. For example, if an instance was deleted and purged from the system,
#   then the service might reject a retry of the original creation request.
#
# @return [Response] A Response object with data of type {OCI::Oda::Models::OdaInstance OdaInstance}
# @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/oda/create_oda_instance.rb.html) to see an example of how to use create_oda_instance API.
Starts an asynchronous job to create a Digital Assistant instance.
To monitor the status of the job, take the `opc-work-request-id` response
header value and use it to call `GET /workRequests/{workRequestID}`.
Starts an asynchronous job to create a Digital Assistant instance . To monitor the status of the job take the ` opc - work - request - id ` response header value and use it to call ` GET / workRequests / { workRequestID } ` .
def create_oda_instance(create_oda_instance_details, opts = {})
      logger.debug 'Calling operation OdaClient#create_oda_instance.' if logger
      raise "Missing the required parameter 'create_oda_instance_details' when calling create_oda_instance." if create_oda_instance_details.nil?
      path = '/odaInstances'
      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[:'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 = @api_client.object_to_http_body(create_oda_instance_details)
      OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OdaClient#create_oda_instance') 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::Oda::Models::OdaInstance'
        )
      end
    end
def create_oda_instance ( create_oda_instance_details , opts = { } ) logger . debug 'Calling operation OdaClient#create_oda_instance.' if logger raise "Missing the required parameter 'create_oda_instance_details' when calling create_oda_instance." if create_oda_instance_details . nil? path = '/odaInstances' 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 [ :' 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 = @api_client . object_to_http_body ( create_oda_instance_details ) OCI :: Retry . make_retrying_call ( applicable_retry_config ( opts ) , call_name : 'OdaClient#create_oda_instance' ) 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::Oda::Models::OdaInstance' ) end end
Starts an asynchronous job to create a Digital Assistant instance.
Starts an asynchronous job to create a Digital Assistant instance .
# 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 {OCI::Oda::Models::OdaInstance OdaInstance}
A Response object with data of type { OCI :: Oda :: Models :: OdaInstance OdaInstance }
Response
create_oda_instance_details
<not_specific>
opts
:opc_retry_token A token that uniquely identifies a request so that you can retry the request if there's a timeout or server error without the risk of executing that same action again. Retry tokens expire after 24 hours, but they can become invalid before then if there are conflicting operations. For example, if an instance was deleted and purged from the system, then the service might reject a retry of the original creation request.
: opc_retry_token A token that uniquely identifies a request so that you can retry the request if there ' s a timeout or server error without the risk of executing that same action again . Retry tokens expire after 24 hours but they can become invalid before then if there are conflicting operations . For example if an instance was deleted and purged from the system then the service might reject a retry of the original creation request .
<not_specific>
opts the optional parameters
opts the optional parameters
note
Click [here] to see an example of how to use create_oda_instance API.
Click [ here ] to see an example of how to use create_oda_instance API .