Class: OCI::Oda::ManagementClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/oda/management_client.rb

Overview

API to create and maintain Oracle Digital Assistant service instances.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ ManagementClient

Creates a new ManagementClient. 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.

Parameters:

  • config (Config) (defaults to: nil) —

    A Config object.

  • region (String) (defaults to: nil) —

    A region used to determine the service endpoint. This will usually correspond to a value in Regions::REGION_ENUM, but may be an arbitrary string.

  • endpoint (String) (defaults to: nil) —

    The fully qualified endpoint URL

  • signer (OCI::BaseSigner) (defaults to: nil) —

    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

  • proxy_settings (OCI::ApiClientProxySettings) (defaults to: nil) —

    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

  • retry_config (OCI::Retry::RetryConfig) (defaults to: nil) —

    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



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/oda/management_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 + '/20190506'
  else
    region ||= config.region
    region ||= signer.region if signer.respond_to?(:region)
    self.region = region
  end
  logger.info "ManagementClient endpoint set to '#{@endpoint}'." if logger
end

Instance Attribute Details

#api_client ⇒ OCI::ApiClient (readonly)

Client used to make HTTP requests.

Returns:



15
16
17
 
# File 'lib/oci/oda/management_client.rb', line 15

def api_client
  @api_client
end

#endpoint ⇒ String (readonly)

Fully qualified endpoint URL

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/oda/management_client.rb', line 19

def endpoint
  @endpoint
end

#region ⇒ String

The region, which will usually correspond to a value in Regions::REGION_ENUM.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/oda/management_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

Returns:



25
26
27
 
# File 'lib/oci/oda/management_client.rb', line 25

def retry_config
  @retry_config
end

Instance Method Details

#bulk_create_skill_entities(oda_instance_id, skill_id, bulk_create_skill_entities_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use bulk_create_skill_entities API.

Bulk create composite and value list entities into a skill.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • skill_id (String) —

    Unique Skill identifier.

  • bulk_create_skill_entities_details (OCI::Oda::Models::BulkCreateSkillEntitiesDetails) —

    Property values for bulk creating a list of skill entities.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

  • :opc_retry_token (String) —

    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.

Returns:

  • (Response) —

    A Response object with data of type nil



121
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
160
161
 
# File 'lib/oci/oda/management_client.rb', line 121

def bulk_create_skill_entities(oda_instance_id, skill_id, bulk_create_skill_entities_details, opts = {})
  logger.debug 'Calling operation ManagementClient#bulk_create_skill_entities.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling bulk_create_skill_entities." if oda_instance_id.nil?
  raise "Missing the required parameter 'skill_id' when calling bulk_create_skill_entities." if skill_id.nil?
  raise "Missing the required parameter 'bulk_create_skill_entities_details' when calling bulk_create_skill_entities." if bulk_create_skill_entities_details.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'skill_id' must not be blank" if OCI::Internal::Util.blank_string?(skill_id)

  path = '/odaInstances/{odaInstanceId}/skills/{skillId}/actions/bulkCreateEntities'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{skillId}', skill_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[:'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(bulk_create_skill_entities_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#bulk_create_skill_entities') 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

#cascading_delete_skill_custom_entities(oda_instance_id, skill_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use cascading_delete_skill_custom_entities API.

Cascading delete of the custom entities in a skill.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • skill_id (String) —

    Unique Skill identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :if_match (String) —

    For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the if-match query parameter to the value of the ETAG header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

  • :opc_retry_token (String) —

    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.

Returns:

  • (Response) —

    A Response object with data of type nil



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
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/oci/oda/management_client.rb', line 195

def cascading_delete_skill_custom_entities(oda_instance_id, skill_id, opts = {})
  logger.debug 'Calling operation ManagementClient#cascading_delete_skill_custom_entities.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling cascading_delete_skill_custom_entities." if oda_instance_id.nil?
  raise "Missing the required parameter 'skill_id' when calling cascading_delete_skill_custom_entities." if skill_id.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'skill_id' must not be blank" if OCI::Internal::Util.blank_string?(skill_id)

  path = '/odaInstances/{odaInstanceId}/skills/{skillId}/actions/cascadingDeleteCustomEntities'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{skillId}', skill_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: 'ManagementClient#cascading_delete_skill_custom_entities') 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

#change_oda_private_endpoint_compartment(oda_private_endpoint_id, change_oda_private_endpoint_compartment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_oda_private_endpoint_compartment API.

Starts an asynchronous job to move the specified ODA Private Endpoint into a different compartment.

To monitor the status of the job, take the opc-work-request-id response header value and use it to call GET /workRequests/{workRequestID}. When provided, If-Match is checked against ETag values of the resource.

Parameters:

  • oda_private_endpoint_id (String) —

    Unique ODA Private Endpoint identifier which is the OCID.

  • change_oda_private_endpoint_compartment_details (OCI::Oda::Models::ChangeOdaPrivateEndpointCompartmentDetails) —

    The compartment to which the Digital Assistant instance should be moved.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :if_match (String) —

    For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the if-match query parameter to the value of the ETAG header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

  • :opc_retry_token (String) —

    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.

Returns:

  • (Response) —

    A Response object with data of type nil



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/oci/oda/management_client.rb', line 273

def change_oda_private_endpoint_compartment(oda_private_endpoint_id, change_oda_private_endpoint_compartment_details, opts = {})
  logger.debug 'Calling operation ManagementClient#change_oda_private_endpoint_compartment.' if logger

  raise "Missing the required parameter 'oda_private_endpoint_id' when calling change_oda_private_endpoint_compartment." if oda_private_endpoint_id.nil?
  raise "Missing the required parameter 'change_oda_private_endpoint_compartment_details' when calling change_oda_private_endpoint_compartment." if change_oda_private_endpoint_compartment_details.nil?
  raise "Parameter value for 'oda_private_endpoint_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_private_endpoint_id)

  path = '/odaPrivateEndpoints/{odaPrivateEndpointId}/actions/changeCompartment'.sub('{odaPrivateEndpointId}', oda_private_endpoint_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(change_oda_private_endpoint_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#change_oda_private_endpoint_compartment') 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

#configure_digital_assistant_parameters(oda_instance_id, configure_digital_assistant_parameters_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use configure_digital_assistant_parameters API.

This will store the provided parameters in the Digital Assistant instance and update any Digital Assistants with matching parameters.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:

  • (Response) —

    A Response object with data of type nil



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
 
# File 'lib/oci/oda/management_client.rb', line 332

def configure_digital_assistant_parameters(oda_instance_id, configure_digital_assistant_parameters_details, opts = {})
  logger.debug 'Calling operation ManagementClient#configure_digital_assistant_parameters.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling configure_digital_assistant_parameters." if oda_instance_id.nil?
  raise "Missing the required parameter 'configure_digital_assistant_parameters_details' when calling configure_digital_assistant_parameters." if configure_digital_assistant_parameters_details.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)

  path = '/odaInstances/{odaInstanceId}/actions/configureDigitalAssistantParameters'.sub('{odaInstanceId}', oda_instance_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]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(configure_digital_assistant_parameters_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#configure_digital_assistant_parameters') 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

#create_authentication_provider(oda_instance_id, create_authentication_provider_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_authentication_provider API.

Creates a new Authentication Provider

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • create_authentication_provider_details (OCI::Oda::Models::CreateAuthenticationProviderDetails) —

    Property values required to create the new Authentication Provider.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

  • :opc_retry_token (String) —

    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.

Returns:



395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
 
# File 'lib/oci/oda/management_client.rb', line 395

def create_authentication_provider(oda_instance_id, create_authentication_provider_details, opts = {})
  logger.debug 'Calling operation ManagementClient#create_authentication_provider.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling create_authentication_provider." if oda_instance_id.nil?
  raise "Missing the required parameter 'create_authentication_provider_details' when calling create_authentication_provider." if create_authentication_provider_details.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)

  path = '/odaInstances/{odaInstanceId}/authenticationProviders'.sub('{odaInstanceId}', oda_instance_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[:'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_authentication_provider_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#create_authentication_provider') 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::AuthenticationProvider'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_channel(oda_instance_id, create_channel_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_channel API.

Creates a new Channel.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • create_channel_details (OCI::Oda::Models::CreateChannelDetails) —

    Property values for creating the new Channel.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

  • :opc_retry_token (String) —

    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.

Returns:



461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
 
# File 'lib/oci/oda/management_client.rb', line 461

def create_channel(oda_instance_id, create_channel_details, opts = {})
  logger.debug 'Calling operation ManagementClient#create_channel.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling create_channel." if oda_instance_id.nil?
  raise "Missing the required parameter 'create_channel_details' when calling create_channel." if create_channel_details.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)

  path = '/odaInstances/{odaInstanceId}/channels'.sub('{odaInstanceId}', oda_instance_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[:'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: 'ManagementClient#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::Oda::Models::CreateChannelResult'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_digital_assistant(oda_instance_id, create_digital_assistant_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_digital_assistant API.

Creates a new Digital Assistant.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • create_digital_assistant_details (OCI::Oda::Models::CreateDigitalAssistantDetails) —

    Property values for creating the new Digital Assistant.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

  • :opc_retry_token (String) —

    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.

Returns:

  • (Response) —

    A Response object with data of type nil



527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
 
# File 'lib/oci/oda/management_client.rb', line 527

def create_digital_assistant(oda_instance_id, create_digital_assistant_details, opts = {})
  logger.debug 'Calling operation ManagementClient#create_digital_assistant.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling create_digital_assistant." if oda_instance_id.nil?
  raise "Missing the required parameter 'create_digital_assistant_details' when calling create_digital_assistant." if create_digital_assistant_details.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)

  path = '/odaInstances/{odaInstanceId}/digitalAssistants'.sub('{odaInstanceId}', oda_instance_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[:'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_digital_assistant_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#create_digital_assistant') 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

#create_oda_private_endpoint(create_oda_private_endpoint_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_oda_private_endpoint API.

Starts an asynchronous job to create an ODA Private Endpoint.

To monitor the status of the job, take the opc-work-request-id response header value and use it to call GET /workRequests/{workRequestID}.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

  • :opc_retry_token (String) —

    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.

Returns:



594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
 
# File 'lib/oci/oda/management_client.rb', line 594

def create_oda_private_endpoint(create_oda_private_endpoint_details, opts = {})
  logger.debug 'Calling operation ManagementClient#create_oda_private_endpoint.' if logger

  raise "Missing the required parameter 'create_oda_private_endpoint_details' when calling create_oda_private_endpoint." if create_oda_private_endpoint_details.nil?

  path = '/odaPrivateEndpoints'
  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_oda_private_endpoint_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#create_oda_private_endpoint') 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::OdaPrivateEndpoint'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_oda_private_endpoint_attachment(create_oda_private_endpoint_attachment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_oda_private_endpoint_attachment API.

Starts an asynchronous job to create an ODA Private Endpoint Attachment.

To monitor the status of the job, take the opc-work-request-id response header value and use it to call GET /workRequests/{workRequestID}.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

  • :opc_retry_token (String) —

    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.

Returns:



660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
 
# File 'lib/oci/oda/management_client.rb', line 660

def create_oda_private_endpoint_attachment(create_oda_private_endpoint_attachment_details, opts = {})
  logger.debug 'Calling operation ManagementClient#create_oda_private_endpoint_attachment.' if logger

  raise "Missing the required parameter 'create_oda_private_endpoint_attachment_details' when calling create_oda_private_endpoint_attachment." if create_oda_private_endpoint_attachment_details.nil?

  path = '/odaPrivateEndpointAttachments'
  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_oda_private_endpoint_attachment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#create_oda_private_endpoint_attachment') 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::OdaPrivateEndpointAttachment'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_oda_private_endpoint_scan_proxy(create_oda_private_endpoint_scan_proxy_details, oda_private_endpoint_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_oda_private_endpoint_scan_proxy API.

Starts an asynchronous job to create an ODA Private Endpoint Scan Proxy.

To monitor the status of the job, take the opc-work-request-id response header value and use it to call GET /workRequests/{workRequestID}.

Parameters:

  • create_oda_private_endpoint_scan_proxy_details (OCI::Oda::Models::CreateOdaPrivateEndpointScanProxyDetails) —

    Details for the new ODA Private Endpoint Scan Proxy.

  • oda_private_endpoint_id (String) —

    Unique ODA Private Endpoint identifier which is the OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

  • :opc_retry_token (String) —

    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.

Returns:



727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
 
# File 'lib/oci/oda/management_client.rb', line 727

def create_oda_private_endpoint_scan_proxy(create_oda_private_endpoint_scan_proxy_details, oda_private_endpoint_id, opts = {})
  logger.debug 'Calling operation ManagementClient#create_oda_private_endpoint_scan_proxy.' if logger

  raise "Missing the required parameter 'create_oda_private_endpoint_scan_proxy_details' when calling create_oda_private_endpoint_scan_proxy." if create_oda_private_endpoint_scan_proxy_details.nil?
  raise "Missing the required parameter 'oda_private_endpoint_id' when calling create_oda_private_endpoint_scan_proxy." if oda_private_endpoint_id.nil?
  raise "Parameter value for 'oda_private_endpoint_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_private_endpoint_id)

  path = '/odaPrivateEndpoints/{odaPrivateEndpointId}/odaPrivateEndpointScanProxies'.sub('{odaPrivateEndpointId}', oda_private_endpoint_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[:'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_oda_private_endpoint_scan_proxy_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#create_oda_private_endpoint_scan_proxy') 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::OdaPrivateEndpointScanProxy'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_skill(oda_instance_id, create_skill_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_skill API.

Creates a new Skill from scratch.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • create_skill_details (OCI::Oda::Models::CreateSkillDetails) —

    Property values for creating the Skill.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

  • :opc_retry_token (String) —

    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.

Returns:

  • (Response) —

    A Response object with data of type nil



793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
 
# File 'lib/oci/oda/management_client.rb', line 793

def create_skill(oda_instance_id, create_skill_details, opts = {})
  logger.debug 'Calling operation ManagementClient#create_skill.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling create_skill." if oda_instance_id.nil?
  raise "Missing the required parameter 'create_skill_details' when calling create_skill." if create_skill_details.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)

  path = '/odaInstances/{odaInstanceId}/skills'.sub('{odaInstanceId}', oda_instance_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[:'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_skill_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#create_skill') 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

#create_skill_parameter(oda_instance_id, skill_id, create_skill_parameter_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_skill_parameter API.

Creates a new Skill Parameter.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • skill_id (String) —

    Unique Skill identifier.

  • create_skill_parameter_details (OCI::Oda::Models::CreateSkillParameterDetails) —

    Property values for creating the new Skill Parameter.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

  • :opc_retry_token (String) —

    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.

Returns:



859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
 
# File 'lib/oci/oda/management_client.rb', line 859

def create_skill_parameter(oda_instance_id, skill_id, create_skill_parameter_details, opts = {})
  logger.debug 'Calling operation ManagementClient#create_skill_parameter.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling create_skill_parameter." if oda_instance_id.nil?
  raise "Missing the required parameter 'skill_id' when calling create_skill_parameter." if skill_id.nil?
  raise "Missing the required parameter 'create_skill_parameter_details' when calling create_skill_parameter." if create_skill_parameter_details.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'skill_id' must not be blank" if OCI::Internal::Util.blank_string?(skill_id)

  path = '/odaInstances/{odaInstanceId}/skills/{skillId}/parameters'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{skillId}', skill_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[:'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_skill_parameter_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#create_skill_parameter') 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::SkillParameter'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_translator(oda_instance_id, create_translator_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_translator API.

Creates a new Translator

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • create_translator_details (OCI::Oda::Models::CreateTranslatorDetails) —

    Property values to create the new Translator.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

  • :opc_retry_token (String) —

    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.

Returns:



927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
 
# File 'lib/oci/oda/management_client.rb', line 927

def create_translator(oda_instance_id, create_translator_details, opts = {})
  logger.debug 'Calling operation ManagementClient#create_translator.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling create_translator." if oda_instance_id.nil?
  raise "Missing the required parameter 'create_translator_details' when calling create_translator." if create_translator_details.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)

  path = '/odaInstances/{odaInstanceId}/translators'.sub('{odaInstanceId}', oda_instance_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[:'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_translator_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#create_translator') 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::Translator'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_authentication_provider(oda_instance_id, authentication_provider_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_authentication_provider API.

Delete the specified Authentication Provider.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • authentication_provider_id (String) —

    Unique Authentication Provider identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :if_match (String) —

    For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the if-match query parameter to the value of the ETAG header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:

  • (Response) —

    A Response object with data of type nil



992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
 
# File 'lib/oci/oda/management_client.rb', line 992

def delete_authentication_provider(oda_instance_id, authentication_provider_id, opts = {})
  logger.debug 'Calling operation ManagementClient#delete_authentication_provider.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling delete_authentication_provider." if oda_instance_id.nil?
  raise "Missing the required parameter 'authentication_provider_id' when calling delete_authentication_provider." if authentication_provider_id.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'authentication_provider_id' must not be blank" if OCI::Internal::Util.blank_string?(authentication_provider_id)

  path = '/odaInstances/{odaInstanceId}/authenticationProviders/{authenticationProviderId}'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{authenticationProviderId}', authentication_provider_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: 'ManagementClient#delete_authentication_provider') 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

#delete_channel(oda_instance_id, channel_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_channel API.

Delete the specified Channel.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • channel_id (String) —

    Unique Channel identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :if_match (String) —

    For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the if-match query parameter to the value of the ETAG header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:

  • (Response) —

    A Response object with data of type nil



1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
 
# File 'lib/oci/oda/management_client.rb', line 1056

def delete_channel(oda_instance_id, channel_id, opts = {})
  logger.debug 'Calling operation ManagementClient#delete_channel.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling delete_channel." if oda_instance_id.nil?
  raise "Missing the required parameter 'channel_id' when calling delete_channel." if channel_id.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'channel_id' must not be blank" if OCI::Internal::Util.blank_string?(channel_id)

  path = '/odaInstances/{odaInstanceId}/channels/{channelId}'.sub('{odaInstanceId}', oda_instance_id.to_s).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: 'ManagementClient#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

#delete_digital_assistant(oda_instance_id, digital_assistant_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_digital_assistant API.

Delete the specified Digital Assistant.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • digital_assistant_id (String) —

    Unique Digital Assistant identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :if_match (String) —

    For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the if-match query parameter to the value of the ETAG header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:

  • (Response) —

    A Response object with data of type nil



1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
 
# File 'lib/oci/oda/management_client.rb', line 1121

def delete_digital_assistant(oda_instance_id, digital_assistant_id, opts = {})
  logger.debug 'Calling operation ManagementClient#delete_digital_assistant.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling delete_digital_assistant." if oda_instance_id.nil?
  raise "Missing the required parameter 'digital_assistant_id' when calling delete_digital_assistant." if digital_assistant_id.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'digital_assistant_id' must not be blank" if OCI::Internal::Util.blank_string?(digital_assistant_id)

  path = '/odaInstances/{odaInstanceId}/digitalAssistants/{digitalAssistantId}'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{digitalAssistantId}', digital_assistant_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: 'ManagementClient#delete_digital_assistant') 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

#delete_oda_private_endpoint(oda_private_endpoint_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_oda_private_endpoint API.

Starts an asynchronous job to delete the specified ODA Private Endpoint. To monitor the status of the job, take the opc-work-request-id response header value and use it to call GET /workRequests/{workRequestID}.

Parameters:

  • oda_private_endpoint_id (String) —

    Unique ODA Private Endpoint identifier which is the OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :if_match (String) —

    For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the if-match query parameter to the value of the ETAG header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:

  • (Response) —

    A Response object with data of type nil



1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
 
# File 'lib/oci/oda/management_client.rb', line 1185

def delete_oda_private_endpoint(oda_private_endpoint_id, opts = {})
  logger.debug 'Calling operation ManagementClient#delete_oda_private_endpoint.' if logger

  raise "Missing the required parameter 'oda_private_endpoint_id' when calling delete_oda_private_endpoint." if oda_private_endpoint_id.nil?
  raise "Parameter value for 'oda_private_endpoint_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_private_endpoint_id)

  path = '/odaPrivateEndpoints/{odaPrivateEndpointId}'.sub('{odaPrivateEndpointId}', oda_private_endpoint_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: 'ManagementClient#delete_oda_private_endpoint') 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

#delete_oda_private_endpoint_attachment(oda_private_endpoint_attachment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_oda_private_endpoint_attachment API.

Starts an asynchronous job to delete the specified ODA Private Endpoint Attachment. To monitor the status of the job, take the opc-work-request-id response header value and use it to call GET /workRequests/{workRequestID}.

Parameters:

  • oda_private_endpoint_attachment_id (String) —

    The OCID of ODA Private Endpoint Attachment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :if_match (String) —

    For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the if-match query parameter to the value of the ETAG header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:

  • (Response) —

    A Response object with data of type nil



1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
 
# File 'lib/oci/oda/management_client.rb', line 1247

def delete_oda_private_endpoint_attachment(oda_private_endpoint_attachment_id, opts = {})
  logger.debug 'Calling operation ManagementClient#delete_oda_private_endpoint_attachment.' if logger

  raise "Missing the required parameter 'oda_private_endpoint_attachment_id' when calling delete_oda_private_endpoint_attachment." if oda_private_endpoint_attachment_id.nil?
  raise "Parameter value for 'oda_private_endpoint_attachment_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_private_endpoint_attachment_id)

  path = '/odaPrivateEndpointAttachments/{odaPrivateEndpointAttachmentId}'.sub('{odaPrivateEndpointAttachmentId}', oda_private_endpoint_attachment_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: 'ManagementClient#delete_oda_private_endpoint_attachment') 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

#delete_oda_private_endpoint_scan_proxy(oda_private_endpoint_scan_proxy_id, oda_private_endpoint_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_oda_private_endpoint_scan_proxy API.

Starts an asynchronous job to delete the specified ODA Private Endpoint Scan Proxy. To monitor the status of the job, take the opc-work-request-id response header value and use it to call GET /workRequests/{workRequestID}.

Parameters:

  • oda_private_endpoint_scan_proxy_id (String) —

    Unique ODA Private Endpoint Scan Proxy identifier.

  • oda_private_endpoint_id (String) —

    Unique ODA Private Endpoint identifier which is the OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :if_match (String) —

    For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the if-match query parameter to the value of the ETAG header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:

  • (Response) —

    A Response object with data of type nil



1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
 
# File 'lib/oci/oda/management_client.rb', line 1310

def delete_oda_private_endpoint_scan_proxy(oda_private_endpoint_scan_proxy_id, oda_private_endpoint_id, opts = {})
  logger.debug 'Calling operation ManagementClient#delete_oda_private_endpoint_scan_proxy.' if logger

  raise "Missing the required parameter 'oda_private_endpoint_scan_proxy_id' when calling delete_oda_private_endpoint_scan_proxy." if oda_private_endpoint_scan_proxy_id.nil?
  raise "Missing the required parameter 'oda_private_endpoint_id' when calling delete_oda_private_endpoint_scan_proxy." if oda_private_endpoint_id.nil?
  raise "Parameter value for 'oda_private_endpoint_scan_proxy_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_private_endpoint_scan_proxy_id)
  raise "Parameter value for 'oda_private_endpoint_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_private_endpoint_id)

  path = '/odaPrivateEndpoints/{odaPrivateEndpointId}/odaPrivateEndpointScanProxies/{odaPrivateEndpointScanProxyId}'.sub('{odaPrivateEndpointScanProxyId}', oda_private_endpoint_scan_proxy_id.to_s).sub('{odaPrivateEndpointId}', oda_private_endpoint_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: 'ManagementClient#delete_oda_private_endpoint_scan_proxy') 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

#delete_skill(oda_instance_id, skill_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_skill API.

Delete the specified Skill.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • skill_id (String) —

    Unique Skill identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :if_match (String) —

    For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the if-match query parameter to the value of the ETAG header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:

  • (Response) —

    A Response object with data of type nil



1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
 
# File 'lib/oci/oda/management_client.rb', line 1375

def delete_skill(oda_instance_id, skill_id, opts = {})
  logger.debug 'Calling operation ManagementClient#delete_skill.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling delete_skill." if oda_instance_id.nil?
  raise "Missing the required parameter 'skill_id' when calling delete_skill." if skill_id.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'skill_id' must not be blank" if OCI::Internal::Util.blank_string?(skill_id)

  path = '/odaInstances/{odaInstanceId}/skills/{skillId}'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{skillId}', skill_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: 'ManagementClient#delete_skill') 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

#delete_skill_parameter(oda_instance_id, skill_id, parameter_name, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_skill_parameter API.

Delete the specified Skill Parameter.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • skill_id (String) —

    Unique Skill identifier.

  • parameter_name (String) —

    The name of a Skill Parameter.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :if_match (String) —

    For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the if-match query parameter to the value of the ETAG header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:

  • (Response) —

    A Response object with data of type nil



1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
 
# File 'lib/oci/oda/management_client.rb', line 1441

def delete_skill_parameter(oda_instance_id, skill_id, parameter_name, opts = {})
  logger.debug 'Calling operation ManagementClient#delete_skill_parameter.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling delete_skill_parameter." if oda_instance_id.nil?
  raise "Missing the required parameter 'skill_id' when calling delete_skill_parameter." if skill_id.nil?
  raise "Missing the required parameter 'parameter_name' when calling delete_skill_parameter." if parameter_name.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'skill_id' must not be blank" if OCI::Internal::Util.blank_string?(skill_id)
  raise "Parameter value for 'parameter_name' must not be blank" if OCI::Internal::Util.blank_string?(parameter_name)

  path = '/odaInstances/{odaInstanceId}/skills/{skillId}/parameters/{parameterName}'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{skillId}', skill_id.to_s).sub('{parameterName}', parameter_name.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: 'ManagementClient#delete_skill_parameter') 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

#delete_translator(oda_instance_id, translator_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_translator API.

Delete the specified Translator.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • translator_id (String) —

    Unique Translator identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :if_match (String) —

    For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the if-match query parameter to the value of the ETAG header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:

  • (Response) —

    A Response object with data of type nil



1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
 
# File 'lib/oci/oda/management_client.rb', line 1507

def delete_translator(oda_instance_id, translator_id, opts = {})
  logger.debug 'Calling operation ManagementClient#delete_translator.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling delete_translator." if oda_instance_id.nil?
  raise "Missing the required parameter 'translator_id' when calling delete_translator." if translator_id.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'translator_id' must not be blank" if OCI::Internal::Util.blank_string?(translator_id)

  path = '/odaInstances/{odaInstanceId}/translators/{translatorId}'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{translatorId}', translator_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: 'ManagementClient#delete_translator') 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

#export_digital_assistant(oda_instance_id, digital_assistant_id, export_digital_assistant_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use export_digital_assistant API.

Exports the specified Digital Assistant as an archive to Object Storage.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • digital_assistant_id (String) —

    Unique Digital Assistant identifier.

  • export_digital_assistant_details (OCI::Oda::Models::ExportDigitalAssistantDetails) —

    Where in Object Storage to export the Digital Assistant to.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:

  • (Response) —

    A Response object with data of type nil



1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
 
# File 'lib/oci/oda/management_client.rb', line 1565

def export_digital_assistant(oda_instance_id, digital_assistant_id, export_digital_assistant_details, opts = {})
  logger.debug 'Calling operation ManagementClient#export_digital_assistant.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling export_digital_assistant." if oda_instance_id.nil?
  raise "Missing the required parameter 'digital_assistant_id' when calling export_digital_assistant." if digital_assistant_id.nil?
  raise "Missing the required parameter 'export_digital_assistant_details' when calling export_digital_assistant." if export_digital_assistant_details.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'digital_assistant_id' must not be blank" if OCI::Internal::Util.blank_string?(digital_assistant_id)

  path = '/odaInstances/{odaInstanceId}/digitalAssistants/{digitalAssistantId}/actions/export'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{digitalAssistantId}', digital_assistant_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]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(export_digital_assistant_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#export_digital_assistant') 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

#export_skill(oda_instance_id, skill_id, export_skill_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use export_skill API.

Exports the specified Skill as an archive to Object Storage.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • skill_id (String) —

    Unique Skill identifier.

  • export_skill_details (OCI::Oda::Models::ExportSkillDetails) —

    Where in Object Storage to export the Skill to.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:

  • (Response) —

    A Response object with data of type nil



1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
 
# File 'lib/oci/oda/management_client.rb', line 1623

def export_skill(oda_instance_id, skill_id, export_skill_details, opts = {})
  logger.debug 'Calling operation ManagementClient#export_skill.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling export_skill." if oda_instance_id.nil?
  raise "Missing the required parameter 'skill_id' when calling export_skill." if skill_id.nil?
  raise "Missing the required parameter 'export_skill_details' when calling export_skill." if export_skill_details.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'skill_id' must not be blank" if OCI::Internal::Util.blank_string?(skill_id)

  path = '/odaInstances/{odaInstanceId}/skills/{skillId}/actions/export'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{skillId}', skill_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]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(export_skill_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#export_skill') 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

#get_authentication_provider(oda_instance_id, authentication_provider_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_authentication_provider API.

Gets the specified Authentication Provider.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • authentication_provider_id (String) —

    Unique Authentication Provider identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :if_none_match (String) —

    The If-None-Match HTTP request header makes the request conditional. For GET methods, the service will return the requested resource, with a 200 status, only if it doesn't have an ETag matching the given ones. When the condition fails for GET methods, then the service will return HTTP status code 304 (Not Modified).

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:



1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
 
# File 'lib/oci/oda/management_client.rb', line 1684

def get_authentication_provider(oda_instance_id, authentication_provider_id, opts = {})
  logger.debug 'Calling operation ManagementClient#get_authentication_provider.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling get_authentication_provider." if oda_instance_id.nil?
  raise "Missing the required parameter 'authentication_provider_id' when calling get_authentication_provider." if authentication_provider_id.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'authentication_provider_id' must not be blank" if OCI::Internal::Util.blank_string?(authentication_provider_id)

  path = '/odaInstances/{odaInstanceId}/authenticationProviders/{authenticationProviderId}'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{authenticationProviderId}', authentication_provider_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-none-match'] = opts[:if_none_match] if opts[:if_none_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: 'ManagementClient#get_authentication_provider') 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::Oda::Models::AuthenticationProvider'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_channel(oda_instance_id, channel_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_channel API.

Gets the specified Channel.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • channel_id (String) —

    Unique Channel identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :if_none_match (String) —

    The If-None-Match HTTP request header makes the request conditional. For GET methods, the service will return the requested resource, with a 200 status, only if it doesn't have an ETag matching the given ones. When the condition fails for GET methods, then the service will return HTTP status code 304 (Not Modified).

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:



1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
 
# File 'lib/oci/oda/management_client.rb', line 1746

def get_channel(oda_instance_id, channel_id, opts = {})
  logger.debug 'Calling operation ManagementClient#get_channel.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling get_channel." if oda_instance_id.nil?
  raise "Missing the required parameter 'channel_id' when calling get_channel." if channel_id.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'channel_id' must not be blank" if OCI::Internal::Util.blank_string?(channel_id)

  path = '/odaInstances/{odaInstanceId}/channels/{channelId}'.sub('{odaInstanceId}', oda_instance_id.to_s).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-none-match'] = opts[:if_none_match] if opts[:if_none_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: 'ManagementClient#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::Oda::Models::Channel'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_digital_assistant(oda_instance_id, digital_assistant_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_digital_assistant API.

Gets the specified Digital Assistant.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • digital_assistant_id (String) —

    Unique Digital Assistant identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :if_none_match (String) —

    The If-None-Match HTTP request header makes the request conditional. For GET methods, the service will return the requested resource, with a 200 status, only if it doesn't have an ETag matching the given ones. When the condition fails for GET methods, then the service will return HTTP status code 304 (Not Modified).

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:



1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
 
# File 'lib/oci/oda/management_client.rb', line 1808

def get_digital_assistant(oda_instance_id, digital_assistant_id, opts = {})
  logger.debug 'Calling operation ManagementClient#get_digital_assistant.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling get_digital_assistant." if oda_instance_id.nil?
  raise "Missing the required parameter 'digital_assistant_id' when calling get_digital_assistant." if digital_assistant_id.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'digital_assistant_id' must not be blank" if OCI::Internal::Util.blank_string?(digital_assistant_id)

  path = '/odaInstances/{odaInstanceId}/digitalAssistants/{digitalAssistantId}'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{digitalAssistantId}', digital_assistant_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-none-match'] = opts[:if_none_match] if opts[:if_none_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: 'ManagementClient#get_digital_assistant') 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::Oda::Models::DigitalAssistant'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_digital_assistant_parameter(oda_instance_id, digital_assistant_id, parameter_name, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_digital_assistant_parameter API.

Gets the specified Digital Assistant Parameter.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • digital_assistant_id (String) —

    Unique Digital Assistant identifier.

  • parameter_name (String) —

    The name of a Digital Assistant Parameter. This is unique with the Digital Assistant.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :if_none_match (String) —

    The If-None-Match HTTP request header makes the request conditional. For GET methods, the service will return the requested resource, with a 200 status, only if it doesn't have an ETag matching the given ones. When the condition fails for GET methods, then the service will return HTTP status code 304 (Not Modified).

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:



1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
 
# File 'lib/oci/oda/management_client.rb', line 1871

def get_digital_assistant_parameter(oda_instance_id, digital_assistant_id, parameter_name, opts = {})
  logger.debug 'Calling operation ManagementClient#get_digital_assistant_parameter.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling get_digital_assistant_parameter." if oda_instance_id.nil?
  raise "Missing the required parameter 'digital_assistant_id' when calling get_digital_assistant_parameter." if digital_assistant_id.nil?
  raise "Missing the required parameter 'parameter_name' when calling get_digital_assistant_parameter." if parameter_name.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'digital_assistant_id' must not be blank" if OCI::Internal::Util.blank_string?(digital_assistant_id)
  raise "Parameter value for 'parameter_name' must not be blank" if OCI::Internal::Util.blank_string?(parameter_name)

  path = '/odaInstances/{odaInstanceId}/digitalAssistants/{digitalAssistantId}/parameters/{parameterName}'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{digitalAssistantId}', digital_assistant_id.to_s).sub('{parameterName}', parameter_name.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-none-match'] = opts[:if_none_match] if opts[:if_none_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: 'ManagementClient#get_digital_assistant_parameter') 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::Oda::Models::DigitalAssistantParameter'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_oda_private_endpoint(oda_private_endpoint_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_oda_private_endpoint API.

Gets the specified ODA Private Endpoint.

Parameters:

  • oda_private_endpoint_id (String) —

    Unique ODA Private Endpoint identifier which is the OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:



1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
 
# File 'lib/oci/oda/management_client.rb', line 1930

def get_oda_private_endpoint(oda_private_endpoint_id, opts = {})
  logger.debug 'Calling operation ManagementClient#get_oda_private_endpoint.' if logger

  raise "Missing the required parameter 'oda_private_endpoint_id' when calling get_oda_private_endpoint." if oda_private_endpoint_id.nil?
  raise "Parameter value for 'oda_private_endpoint_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_private_endpoint_id)

  path = '/odaPrivateEndpoints/{odaPrivateEndpointId}'.sub('{odaPrivateEndpointId}', oda_private_endpoint_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]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#get_oda_private_endpoint') 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::Oda::Models::OdaPrivateEndpoint'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_oda_private_endpoint_attachment(oda_private_endpoint_attachment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_oda_private_endpoint_attachment API.

Gets the specified ODA Private Endpoint Attachment.

Parameters:

  • oda_private_endpoint_attachment_id (String) —

    The OCID of ODA Private Endpoint Attachment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:



1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
 
# File 'lib/oci/oda/management_client.rb', line 1984

def get_oda_private_endpoint_attachment(oda_private_endpoint_attachment_id, opts = {})
  logger.debug 'Calling operation ManagementClient#get_oda_private_endpoint_attachment.' if logger

  raise "Missing the required parameter 'oda_private_endpoint_attachment_id' when calling get_oda_private_endpoint_attachment." if oda_private_endpoint_attachment_id.nil?
  raise "Parameter value for 'oda_private_endpoint_attachment_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_private_endpoint_attachment_id)

  path = '/odaPrivateEndpointAttachments/{odaPrivateEndpointAttachmentId}'.sub('{odaPrivateEndpointAttachmentId}', oda_private_endpoint_attachment_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]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#get_oda_private_endpoint_attachment') 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::Oda::Models::OdaPrivateEndpointAttachment'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_oda_private_endpoint_scan_proxy(oda_private_endpoint_scan_proxy_id, oda_private_endpoint_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_oda_private_endpoint_scan_proxy API.

Gets the specified ODA Private Endpoint Scan Proxy.

Parameters:

  • oda_private_endpoint_scan_proxy_id (String) —

    Unique ODA Private Endpoint Scan Proxy identifier.

  • oda_private_endpoint_id (String) —

    Unique ODA Private Endpoint identifier which is the OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:



2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
 
# File 'lib/oci/oda/management_client.rb', line 2039

def get_oda_private_endpoint_scan_proxy(oda_private_endpoint_scan_proxy_id, oda_private_endpoint_id, opts = {})
  logger.debug 'Calling operation ManagementClient#get_oda_private_endpoint_scan_proxy.' if logger

  raise "Missing the required parameter 'oda_private_endpoint_scan_proxy_id' when calling get_oda_private_endpoint_scan_proxy." if oda_private_endpoint_scan_proxy_id.nil?
  raise "Missing the required parameter 'oda_private_endpoint_id' when calling get_oda_private_endpoint_scan_proxy." if oda_private_endpoint_id.nil?
  raise "Parameter value for 'oda_private_endpoint_scan_proxy_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_private_endpoint_scan_proxy_id)
  raise "Parameter value for 'oda_private_endpoint_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_private_endpoint_id)

  path = '/odaPrivateEndpoints/{odaPrivateEndpointId}/odaPrivateEndpointScanProxies/{odaPrivateEndpointScanProxyId}'.sub('{odaPrivateEndpointScanProxyId}', oda_private_endpoint_scan_proxy_id.to_s).sub('{odaPrivateEndpointId}', oda_private_endpoint_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]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#get_oda_private_endpoint_scan_proxy') 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::Oda::Models::OdaPrivateEndpointScanProxy'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_skill(oda_instance_id, skill_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_skill API.

Gets the specified Skill.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • skill_id (String) —

    Unique Skill identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :if_none_match (String) —

    The If-None-Match HTTP request header makes the request conditional. For GET methods, the service will return the requested resource, with a 200 status, only if it doesn't have an ETag matching the given ones. When the condition fails for GET methods, then the service will return HTTP status code 304 (Not Modified).

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:



2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
 
# File 'lib/oci/oda/management_client.rb', line 2100

def get_skill(oda_instance_id, skill_id, opts = {})
  logger.debug 'Calling operation ManagementClient#get_skill.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling get_skill." if oda_instance_id.nil?
  raise "Missing the required parameter 'skill_id' when calling get_skill." if skill_id.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'skill_id' must not be blank" if OCI::Internal::Util.blank_string?(skill_id)

  path = '/odaInstances/{odaInstanceId}/skills/{skillId}'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{skillId}', skill_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-none-match'] = opts[:if_none_match] if opts[:if_none_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: 'ManagementClient#get_skill') 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::Oda::Models::Skill'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_skill_parameter(oda_instance_id, skill_id, parameter_name, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_skill_parameter API.

Gets the specified Skill Parameter.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • skill_id (String) —

    Unique Skill identifier.

  • parameter_name (String) —

    The name of a Skill Parameter.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :if_none_match (String) —

    The If-None-Match HTTP request header makes the request conditional. For GET methods, the service will return the requested resource, with a 200 status, only if it doesn't have an ETag matching the given ones. When the condition fails for GET methods, then the service will return HTTP status code 304 (Not Modified).

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:



2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
 
# File 'lib/oci/oda/management_client.rb', line 2163

def get_skill_parameter(oda_instance_id, skill_id, parameter_name, opts = {})
  logger.debug 'Calling operation ManagementClient#get_skill_parameter.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling get_skill_parameter." if oda_instance_id.nil?
  raise "Missing the required parameter 'skill_id' when calling get_skill_parameter." if skill_id.nil?
  raise "Missing the required parameter 'parameter_name' when calling get_skill_parameter." if parameter_name.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'skill_id' must not be blank" if OCI::Internal::Util.blank_string?(skill_id)
  raise "Parameter value for 'parameter_name' must not be blank" if OCI::Internal::Util.blank_string?(parameter_name)

  path = '/odaInstances/{odaInstanceId}/skills/{skillId}/parameters/{parameterName}'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{skillId}', skill_id.to_s).sub('{parameterName}', parameter_name.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-none-match'] = opts[:if_none_match] if opts[:if_none_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: 'ManagementClient#get_skill_parameter') 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::Oda::Models::SkillParameter'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_translator(oda_instance_id, translator_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_translator API.

Gets the specified Translator.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • translator_id (String) —

    Unique Translator identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :if_none_match (String) —

    The If-None-Match HTTP request header makes the request conditional. For GET methods, the service will return the requested resource, with a 200 status, only if it doesn't have an ETag matching the given ones. When the condition fails for GET methods, then the service will return HTTP status code 304 (Not Modified).

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:



2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
 
# File 'lib/oci/oda/management_client.rb', line 2227

def get_translator(oda_instance_id, translator_id, opts = {})
  logger.debug 'Calling operation ManagementClient#get_translator.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling get_translator." if oda_instance_id.nil?
  raise "Missing the required parameter 'translator_id' when calling get_translator." if translator_id.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'translator_id' must not be blank" if OCI::Internal::Util.blank_string?(translator_id)

  path = '/odaInstances/{odaInstanceId}/translators/{translatorId}'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{translatorId}', translator_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-none-match'] = opts[:if_none_match] if opts[:if_none_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: 'ManagementClient#get_translator') 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::Oda::Models::Translator'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#import_bot(oda_instance_id, import_bot_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use import_bot API.

Import a Bot archive from Object Storage.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • import_bot_details (OCI::Oda::Models::ImportBotDetails) —

    Properties for where in Object Storage to import the Bot archive from.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

  • :opc_retry_token (String) —

    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.

Returns:

  • (Response) —

    A Response object with data of type nil



2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
 
# File 'lib/oci/oda/management_client.rb', line 2292

def import_bot(oda_instance_id, import_bot_details, opts = {})
  logger.debug 'Calling operation ManagementClient#import_bot.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling import_bot." if oda_instance_id.nil?
  raise "Missing the required parameter 'import_bot_details' when calling import_bot." if import_bot_details.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)

  path = '/odaInstances/{odaInstanceId}/actions/importBot'.sub('{odaInstanceId}', oda_instance_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[:'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(import_bot_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#import_bot') 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

#list_authentication_providers(oda_instance_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_authentication_providers API.

Returns a page of Authentication Providers that belong to the specified Digital Assistant instance.

If the opc-next-page header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the page query parameter.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :id (String) —

    Unique Authentication Provider identifier.

  • :identity_provider (String) —

    List only Authentication Providers for this Identity Provider.

  • :name (String) —

    List only the information for Authentication Providers with this name. Authentication Provider names are unique and may not change.

    Example: MyProvider

  • :lifecycle_state (String) —

    List only the resources that are in this lifecycle state.

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 100)

  • :page (String) —

    The page at which to start retrieving results.

    You get this value from the opc-next-page header in a previous list request. To retireve the first page, omit this query parameter.

    Example: MToxMA==

  • :sort_order (String) —

    Sort the results in this order, use either ASC (ascending) or DESC (descending). Allowed values are: ASC, DESC

  • :sort_by (String) —

    Sort on this field. You can specify one sort order only. The default sort field is timeCreated.

    The default sort order for timeCreated and timeUpdated is descending. For all other sort fields the default sort order is ascending. (default to timeCreated) Allowed values are: timeCreated, timeUpdated, name, identityProvider

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:



2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
 
# File 'lib/oci/oda/management_client.rb', line 2376

def list_authentication_providers(oda_instance_id, opts = {})
  logger.debug 'Calling operation ManagementClient#list_authentication_providers.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling list_authentication_providers." if oda_instance_id.nil?

  if opts[:identity_provider] && !OCI::Oda::Models::AUTHENTICATION_IDENTITY_PROVIDER_ENUM.include?(opts[:identity_provider])
    raise 'Invalid value for "identity_provider", must be one of the values in OCI::Oda::Models::AUTHENTICATION_IDENTITY_PROVIDER_ENUM.'
  end

  if opts[:lifecycle_state] && !OCI::Oda::Models::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Oda::Models::LIFECYCLE_STATE_ENUM.'
  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

  if opts[:sort_by] && !%w[timeCreated timeUpdated name identityProvider].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, timeUpdated, name, identityProvider.'
  end
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)

  path = '/odaInstances/{odaInstanceId}/authenticationProviders'.sub('{odaInstanceId}', oda_instance_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:identityProvider] = opts[:identity_provider] if opts[:identity_provider]
  query_params[:name] = opts[:name] if opts[:name]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # 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: 'ManagementClient#list_authentication_providers') 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::Oda::Models::AuthenticationProviderCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_channels(oda_instance_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_channels API.

Returns a page of Channels that belong to the specified Digital Assistant instance.

If the opc-next-page header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the page query parameter.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :id (String) —

    Unique Channel identifier.

  • :name (String) —

    List only the information for Channels with this name. Channels names are unique and may not change.

    Example: MyChannel

  • :category (String) —

    List only Channels with this category.

  • :type (String) —

    List only Channels of this type.

  • :lifecycle_state (String) —

    List only the resources that are in this lifecycle state.

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 100)

  • :page (String) —

    The page at which to start retrieving results.

    You get this value from the opc-next-page header in a previous list request. To retireve the first page, omit this query parameter.

    Example: MToxMA==

  • :sort_order (String) —

    Sort the results in this order, use either ASC (ascending) or DESC (descending). Allowed values are: ASC, DESC

  • :sort_by (String) —

    Sort on this field. You can specify one sort order only. The default sort field is timeCreated.

    The default sort order for timeCreated and timeUpdated is descending, and the default sort order for name is ascending. (default to timeCreated) Allowed values are: timeCreated, timeUpdated, name

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:



2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
 
# File 'lib/oci/oda/management_client.rb', line 2482

def list_channels(oda_instance_id, opts = {})
  logger.debug 'Calling operation ManagementClient#list_channels.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling list_channels." if oda_instance_id.nil?

  if opts[:category] && !OCI::Oda::Models::CHANNEL_CATEGORY_ENUM.include?(opts[:category])
    raise 'Invalid value for "category", must be one of the values in OCI::Oda::Models::CHANNEL_CATEGORY_ENUM.'
  end

  if opts[:type] && !OCI::Oda::Models::CHANNEL_TYPE_ENUM.include?(opts[:type])
    raise 'Invalid value for "type", must be one of the values in OCI::Oda::Models::CHANNEL_TYPE_ENUM.'
  end

  if opts[:lifecycle_state] && !OCI::Oda::Models::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Oda::Models::LIFECYCLE_STATE_ENUM.'
  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

  if opts[:sort_by] && !%w[timeCreated timeUpdated name].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, timeUpdated, name.'
  end
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)

  path = '/odaInstances/{odaInstanceId}/channels'.sub('{odaInstanceId}', oda_instance_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:name] = opts[:name] if opts[:name]
  query_params[:category] = opts[:category] if opts[:category]
  query_params[:type] = opts[:type] if opts[:type]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # 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: 'ManagementClient#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: 'OCI::Oda::Models::ChannelCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_digital_assistant_parameters(oda_instance_id, digital_assistant_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_digital_assistant_parameters API.

Returns a page of Parameters that belong to the specified Digital Assistant.

If the opc-next-page header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the page query parameter.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • digital_assistant_id (String) —

    Unique Digital Assistant identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :name (String) —

    List only Parameters with this name.

  • :lifecycle_state (String) —

    List only the resources that are in this lifecycle state.

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 100)

  • :page (String) —

    The page at which to start retrieving results.

    You get this value from the opc-next-page header in a previous list request. To retireve the first page, omit this query parameter.

    Example: MToxMA==

  • :sort_order (String) —

    Sort the results in this order, use either ASC (ascending) or DESC (descending). Allowed values are: ASC, DESC

  • :sort_by (String) —

    Sort on this field. You can specify one sort order only. The default sort field is name.

    The default sort order is ascending. (default to name) Allowed values are: name, displayName, type

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:



2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
 
# File 'lib/oci/oda/management_client.rb', line 2588

def list_digital_assistant_parameters(oda_instance_id, digital_assistant_id, opts = {})
  logger.debug 'Calling operation ManagementClient#list_digital_assistant_parameters.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling list_digital_assistant_parameters." if oda_instance_id.nil?
  raise "Missing the required parameter 'digital_assistant_id' when calling list_digital_assistant_parameters." if digital_assistant_id.nil?

  if opts[:lifecycle_state] && !OCI::Oda::Models::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Oda::Models::LIFECYCLE_STATE_ENUM.'
  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

  if opts[:sort_by] && !%w[name displayName type].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of name, displayName, type.'
  end
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'digital_assistant_id' must not be blank" if OCI::Internal::Util.blank_string?(digital_assistant_id)

  path = '/odaInstances/{odaInstanceId}/digitalAssistants/{digitalAssistantId}/parameters'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{digitalAssistantId}', digital_assistant_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:name] = opts[:name] if opts[:name]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # 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: 'ManagementClient#list_digital_assistant_parameters') 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::Oda::Models::DigitalAssistantParameterCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_digital_assistants(oda_instance_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_digital_assistants API.

Returns a page of Digital Assistants that belong to the specified Digital Assistant instance.

If the opc-next-page header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the page query parameter.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :id (String) —

    Unique Digital Assistant identifier.

  • :category (String) —

    List only Bot resources with this category.

  • :name (String) —

    List only Bot resources with this name. Names are unique and may not change.

    Example: MySkill

  • :version (String) —

    List only Bot resources with this version. Versions are unique and may not change.

    Example: 1.0

  • :namespace (String) —

    List only Bot resources with this namespace. Namespaces may not change.

    Example: MyNamespace

  • :platform_version (String) —

    List only Bot resources with this platform version.

  • :lifecycle_state (String) —

    List only the resources that are in this lifecycle state.

  • :lifecycle_details (String) —

    List only Bot resources with this lifecycle details.

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 100)

  • :page (String) —

    The page at which to start retrieving results.

    You get this value from the opc-next-page header in a previous list request. To retireve the first page, omit this query parameter.

    Example: MToxMA==

  • :sort_order (String) —

    Sort the results in this order, use either ASC (ascending) or DESC (descending). Allowed values are: ASC, DESC

  • :sort_by (String) —

    Sort on this field. You can specify one sort order only. The default sort field is timeCreated.

    The default sort order for timeCreated and timeUpdated is descending. For all other sort fields the default sort order is ascending. (default to timeCreated) Allowed values are: timeCreated, timeUpdated, name

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:



2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
 
# File 'lib/oci/oda/management_client.rb', line 2702

def list_digital_assistants(oda_instance_id, opts = {})
  logger.debug 'Calling operation ManagementClient#list_digital_assistants.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling list_digital_assistants." if oda_instance_id.nil?

  if opts[:lifecycle_state] && !OCI::Oda::Models::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Oda::Models::LIFECYCLE_STATE_ENUM.'
  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

  if opts[:sort_by] && !%w[timeCreated timeUpdated name].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, timeUpdated, name.'
  end
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)

  path = '/odaInstances/{odaInstanceId}/digitalAssistants'.sub('{odaInstanceId}', oda_instance_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:category] = opts[:category] if opts[:category]
  query_params[:name] = opts[:name] if opts[:name]
  query_params[:version] = opts[:version] if opts[:version]
  query_params[:namespace] = opts[:namespace] if opts[:namespace]
  query_params[:platformVersion] = opts[:platform_version] if opts[:platform_version]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:lifecycleDetails] = opts[:lifecycle_details] if opts[:lifecycle_details]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # 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: 'ManagementClient#list_digital_assistants') 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::Oda::Models::DigitalAssistantCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_oda_private_endpoint_attachments(oda_private_endpoint_id, compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_oda_private_endpoint_attachments API.

Returns a page of ODA Instances attached to this ODA Private Endpoint.

If the opc-next-page header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the page query parameter.

Parameters:

  • oda_private_endpoint_id (String) —

    The OCID of ODA Private Endpoint.

  • compartment_id (String) —

    List the ODA Private Endpoint Attachments that belong to this compartment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 100)

  • :page (String) —

    The page at which to start retrieving results.

    You get this value from the opc-next-page header in a previous list request. To retireve the first page, omit this query parameter.

    Example: MToxMA==

  • :lifecycle_state (String) —

    List only the ODA Private Endpoint Attachments that are in this lifecycle state.

  • :sort_order (String) —

    Sort the results in this order, use either ASC (ascending) or DESC (descending). Allowed values are: ASC, DESC

  • :sort_by (String) —

    Sort on this field. You can specify one sort order only. The default sort field is TIMECREATED.

    The default sort order for TIMECREATED is descending, and the default sort order for DISPLAYNAME is ascending. (default to TIMECREATED) Allowed values are: TIMECREATED, DISPLAYNAME

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:



2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
 
# File 'lib/oci/oda/management_client.rb', line 2802

def list_oda_private_endpoint_attachments(oda_private_endpoint_id, compartment_id, opts = {})
  logger.debug 'Calling operation ManagementClient#list_oda_private_endpoint_attachments.' if logger

  raise "Missing the required parameter 'oda_private_endpoint_id' when calling list_oda_private_endpoint_attachments." if oda_private_endpoint_id.nil?
  raise "Missing the required parameter 'compartment_id' when calling list_oda_private_endpoint_attachments." if compartment_id.nil?

  if opts[:lifecycle_state] && !OCI::Oda::Models::OdaPrivateEndpointAttachment::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Oda::Models::OdaPrivateEndpointAttachment::LIFECYCLE_STATE_ENUM.'
  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

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  path = '/odaPrivateEndpointAttachments'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:odaPrivateEndpointId] = oda_private_endpoint_id
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # 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: 'ManagementClient#list_oda_private_endpoint_attachments') 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::Oda::Models::OdaPrivateEndpointAttachmentCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_oda_private_endpoint_scan_proxies(oda_private_endpoint_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_oda_private_endpoint_scan_proxies API.

Returns a page of ODA Private Endpoint Scan Proxies that belong to the specified ODA Private Endpoint.

If the opc-next-page header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the page query parameter.

Parameters:

  • oda_private_endpoint_id (String) —

    Unique ODA Private Endpoint identifier which is the OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :lifecycle_state (String) —

    List only the ODA Private Endpoint Scan Proxies that are in this lifecycle state.

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 100)

  • :page (String) —

    The page at which to start retrieving results.

    You get this value from the opc-next-page header in a previous list request. To retireve the first page, omit this query parameter.

    Example: MToxMA==

  • :sort_order (String) —

    Sort the results in this order, use either ASC (ascending) or DESC (descending). Allowed values are: ASC, DESC

  • :sort_by (String) —

    Sort on this field. You can specify one sort order only. The default sort field is TIMECREATED.

    The default sort order for TIMECREATED is descending, and the default sort order for DISPLAYNAME is ascending. (default to TIMECREATED) Allowed values are: TIMECREATED, DISPLAYNAME

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:



2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
 
# File 'lib/oci/oda/management_client.rb', line 2897

def list_oda_private_endpoint_scan_proxies(oda_private_endpoint_id, opts = {})
  logger.debug 'Calling operation ManagementClient#list_oda_private_endpoint_scan_proxies.' if logger

  raise "Missing the required parameter 'oda_private_endpoint_id' when calling list_oda_private_endpoint_scan_proxies." if oda_private_endpoint_id.nil?

  if opts[:lifecycle_state] && !OCI::Oda::Models::OdaPrivateEndpointScanProxy::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Oda::Models::OdaPrivateEndpointScanProxy::LIFECYCLE_STATE_ENUM.'
  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

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end
  raise "Parameter value for 'oda_private_endpoint_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_private_endpoint_id)

  path = '/odaPrivateEndpoints/{odaPrivateEndpointId}/odaPrivateEndpointScanProxies'.sub('{odaPrivateEndpointId}', oda_private_endpoint_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # 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: 'ManagementClient#list_oda_private_endpoint_scan_proxies') 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::Oda::Models::OdaPrivateEndpointScanProxyCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_oda_private_endpoints(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_oda_private_endpoints API.

Returns a page of ODA Private Endpoints that belong to the specified compartment.

If the opc-next-page header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the page query parameter.

Parameters:

  • compartment_id (String) —

    List the ODA Private Endpoints that belong to this compartment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :display_name (String) —

    List only the information for the Digital Assistant instance with this user-friendly name. These names don't have to be unique and may change.

    Example: My new resource

  • :lifecycle_state (String) —

    List only the ODA Private Endpoints that are in this lifecycle state.

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 100)

  • :page (String) —

    The page at which to start retrieving results.

    You get this value from the opc-next-page header in a previous list request. To retireve the first page, omit this query parameter.

    Example: MToxMA==

  • :sort_order (String) —

    Sort the results in this order, use either ASC (ascending) or DESC (descending). Allowed values are: ASC, DESC

  • :sort_by (String) —

    Sort on this field. You can specify one sort order only. The default sort field is TIMECREATED.

    The default sort order for TIMECREATED is descending, and the default sort order for DISPLAYNAME is ascending. (default to TIMECREATED) Allowed values are: TIMECREATED, DISPLAYNAME

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:



2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
 
# File 'lib/oci/oda/management_client.rb', line 2994

def list_oda_private_endpoints(compartment_id, opts = {})
  logger.debug 'Calling operation ManagementClient#list_oda_private_endpoints.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_oda_private_endpoints." if compartment_id.nil?

  if opts[:lifecycle_state] && !OCI::Oda::Models::OdaPrivateEndpoint::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Oda::Models::OdaPrivateEndpoint::LIFECYCLE_STATE_ENUM.'
  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

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  path = '/odaPrivateEndpoints'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # 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: 'ManagementClient#list_oda_private_endpoints') 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::Oda::Models::OdaPrivateEndpointCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_skill_parameters(oda_instance_id, skill_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_skill_parameters API.

Returns a page of Skill Parameters that belong to the specified Skill.

If the opc-next-page header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the page query parameter.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • skill_id (String) —

    Unique Skill identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :name (String) —

    List only Parameters with this name.

  • :lifecycle_state (String) —

    List only the resources that are in this lifecycle state.

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 100)

  • :page (String) —

    The page at which to start retrieving results.

    You get this value from the opc-next-page header in a previous list request. To retireve the first page, omit this query parameter.

    Example: MToxMA==

  • :sort_order (String) —

    Sort the results in this order, use either ASC (ascending) or DESC (descending). Allowed values are: ASC, DESC

  • :sort_by (String) —

    Sort on this field. You can specify one sort order only. The default sort field is name.

    The default sort order is ascending. (default to name) Allowed values are: name, displayName, type

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:



3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
 
# File 'lib/oci/oda/management_client.rb', line 3089

def list_skill_parameters(oda_instance_id, skill_id, opts = {})
  logger.debug 'Calling operation ManagementClient#list_skill_parameters.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling list_skill_parameters." if oda_instance_id.nil?
  raise "Missing the required parameter 'skill_id' when calling list_skill_parameters." if skill_id.nil?

  if opts[:lifecycle_state] && !OCI::Oda::Models::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Oda::Models::LIFECYCLE_STATE_ENUM.'
  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

  if opts[:sort_by] && !%w[name displayName type].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of name, displayName, type.'
  end
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'skill_id' must not be blank" if OCI::Internal::Util.blank_string?(skill_id)

  path = '/odaInstances/{odaInstanceId}/skills/{skillId}/parameters'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{skillId}', skill_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:name] = opts[:name] if opts[:name]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # 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: 'ManagementClient#list_skill_parameters') 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::Oda::Models::SkillParameterCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_skills(oda_instance_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_skills API.

Returns a page of Skills that belong to the specified Digital Assistant instance.

If the opc-next-page header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the page query parameter.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :id (String) —

    Unique Skill identifier.

  • :category (String) —

    List only Bot resources with this category.

  • :name (String) —

    List only Bot resources with this name. Names are unique and may not change.

    Example: MySkill

  • :version (String) —

    List only Bot resources with this version. Versions are unique and may not change.

    Example: 1.0

  • :namespace (String) —

    List only Bot resources with this namespace. Namespaces may not change.

    Example: MyNamespace

  • :platform_version (String) —

    List only Bot resources with this platform version.

  • :lifecycle_state (String) —

    List only the resources that are in this lifecycle state.

  • :lifecycle_details (String) —

    List only Bot resources with this lifecycle details.

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 100)

  • :page (String) —

    The page at which to start retrieving results.

    You get this value from the opc-next-page header in a previous list request. To retireve the first page, omit this query parameter.

    Example: MToxMA==

  • :sort_order (String) —

    Sort the results in this order, use either ASC (ascending) or DESC (descending). Allowed values are: ASC, DESC

  • :sort_by (String) —

    Sort on this field. You can specify one sort order only. The default sort field is timeCreated.

    The default sort order for timeCreated and timeUpdated is descending. For all other sort fields the default sort order is ascending. (default to timeCreated) Allowed values are: timeCreated, timeUpdated, name

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:



3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
 
# File 'lib/oci/oda/management_client.rb', line 3203

def list_skills(oda_instance_id, opts = {})
  logger.debug 'Calling operation ManagementClient#list_skills.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling list_skills." if oda_instance_id.nil?

  if opts[:lifecycle_state] && !OCI::Oda::Models::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Oda::Models::LIFECYCLE_STATE_ENUM.'
  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

  if opts[:sort_by] && !%w[timeCreated timeUpdated name].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, timeUpdated, name.'
  end
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)

  path = '/odaInstances/{odaInstanceId}/skills'.sub('{odaInstanceId}', oda_instance_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:category] = opts[:category] if opts[:category]
  query_params[:name] = opts[:name] if opts[:name]
  query_params[:version] = opts[:version] if opts[:version]
  query_params[:namespace] = opts[:namespace] if opts[:namespace]
  query_params[:platformVersion] = opts[:platform_version] if opts[:platform_version]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:lifecycleDetails] = opts[:lifecycle_details] if opts[:lifecycle_details]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # 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: 'ManagementClient#list_skills') 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::Oda::Models::SkillCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_translators(oda_instance_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_translators API.

Returns a page of Translators that belong to the specified Digital Assistant instance.

If the opc-next-page header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the page query parameter.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :id (String) —

    Unique Translator identifier.

  • :type (String) —

    List only Translators of this type.

  • :name (String) —

    List only Translators with this name. Translator names are unique and may not change.

    Example: MyTranslator

  • :lifecycle_state (String) —

    List only the resources that are in this lifecycle state.

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 100)

  • :page (String) —

    The page at which to start retrieving results.

    You get this value from the opc-next-page header in a previous list request. To retireve the first page, omit this query parameter.

    Example: MToxMA==

  • :sort_order (String) —

    Sort the results in this order, use either ASC (ascending) or DESC (descending). Allowed values are: ASC, DESC

  • :sort_by (String) —

    Sort on this field. You can specify one sort order only. The default sort field is timeCreated.

    The default sort order for timeCreated and timeUpdated is descending. For all other sort fields the default sort order is ascending. (default to timeCreated) Allowed values are: timeCreated, timeUpdated, name, type

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:



3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
 
# File 'lib/oci/oda/management_client.rb', line 3309

def list_translators(oda_instance_id, opts = {})
  logger.debug 'Calling operation ManagementClient#list_translators.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling list_translators." if oda_instance_id.nil?

  if opts[:type] && !OCI::Oda::Models::TRANSLATION_SERVICE_ENUM.include?(opts[:type])
    raise 'Invalid value for "type", must be one of the values in OCI::Oda::Models::TRANSLATION_SERVICE_ENUM.'
  end

  if opts[:lifecycle_state] && !OCI::Oda::Models::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Oda::Models::LIFECYCLE_STATE_ENUM.'
  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

  if opts[:sort_by] && !%w[timeCreated timeUpdated name type].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, timeUpdated, name, type.'
  end
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)

  path = '/odaInstances/{odaInstanceId}/translators'.sub('{odaInstanceId}', oda_instance_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:type] = opts[:type] if opts[:type]
  query_params[:name] = opts[:name] if opts[:name]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # 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: 'ManagementClient#list_translators') 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::Oda::Models::TranslatorCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#logger ⇒ Logger

Returns The logger for this client. May be nil.

Returns:

  • (Logger) —

    The logger for this client. May be nil.



94
95
96
 
# File 'lib/oci/oda/management_client.rb', line 94

def logger
  @api_client.config.logger
end

#publish_digital_assistant(oda_instance_id, digital_assistant_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use publish_digital_assistant API.

Publish a draft Digital Assistant. Once published the Digital Assistant cannot be modified.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • digital_assistant_id (String) —

    Unique Digital Assistant identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :if_match (String) —

    For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the if-match query parameter to the value of the ETAG header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:



3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
 
# File 'lib/oci/oda/management_client.rb', line 3397

def publish_digital_assistant(oda_instance_id, digital_assistant_id, opts = {})
  logger.debug 'Calling operation ManagementClient#publish_digital_assistant.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling publish_digital_assistant." if oda_instance_id.nil?
  raise "Missing the required parameter 'digital_assistant_id' when calling publish_digital_assistant." if digital_assistant_id.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'digital_assistant_id' must not be blank" if OCI::Internal::Util.blank_string?(digital_assistant_id)

  path = '/odaInstances/{odaInstanceId}/digitalAssistants/{digitalAssistantId}/actions/publish'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{digitalAssistantId}', digital_assistant_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: 'ManagementClient#publish_digital_assistant') 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::DigitalAssistant'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#publish_skill(oda_instance_id, skill_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use publish_skill API.

Publish a draft Skill. Once published it cannot be modified.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • skill_id (String) —

    Unique Skill identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :if_match (String) —

    For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the if-match query parameter to the value of the ETAG header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:



3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
 
# File 'lib/oci/oda/management_client.rb', line 3464

def publish_skill(oda_instance_id, skill_id, opts = {})
  logger.debug 'Calling operation ManagementClient#publish_skill.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling publish_skill." if oda_instance_id.nil?
  raise "Missing the required parameter 'skill_id' when calling publish_skill." if skill_id.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'skill_id' must not be blank" if OCI::Internal::Util.blank_string?(skill_id)

  path = '/odaInstances/{odaInstanceId}/skills/{skillId}/actions/publish'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{skillId}', skill_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: 'ManagementClient#publish_skill') 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::Skill'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#rotate_channel_keys(oda_instance_id, channel_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use rotate_channel_keys API.

This will generate new keys for any generated keys in the Channel (eg. secretKey, verifyToken). If a Channel has no generated keys then no changes will be made. Ensure that you take note of the newly generated keys in the response as they will not be returned again.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • channel_id (String) —

    Unique Channel identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

  • :if_match (String) —

    For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the if-match query parameter to the value of the ETAG header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

Returns:



3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
 
# File 'lib/oci/oda/management_client.rb', line 3532

def rotate_channel_keys(oda_instance_id, channel_id, opts = {})
  logger.debug 'Calling operation ManagementClient#rotate_channel_keys.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling rotate_channel_keys." if oda_instance_id.nil?
  raise "Missing the required parameter 'channel_id' when calling rotate_channel_keys." if channel_id.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'channel_id' must not be blank" if OCI::Internal::Util.blank_string?(channel_id)

  path = '/odaInstances/{odaInstanceId}/channels/{channelId}/actions/rotateKeys'.sub('{odaInstanceId}', oda_instance_id.to_s).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-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#rotate_channel_keys') 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::CreateChannelResult'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#start_channel(oda_instance_id, channel_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use start_channel API.

Starts a Channel so that it will begin accepting messages.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • channel_id (String) —

    Unique Channel identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

  • :if_match (String) —

    For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the if-match query parameter to the value of the ETAG header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

Returns:



3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
 
# File 'lib/oci/oda/management_client.rb', line 3598

def start_channel(oda_instance_id, channel_id, opts = {})
  logger.debug 'Calling operation ManagementClient#start_channel.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling start_channel." if oda_instance_id.nil?
  raise "Missing the required parameter 'channel_id' when calling start_channel." if channel_id.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'channel_id' must not be blank" if OCI::Internal::Util.blank_string?(channel_id)

  path = '/odaInstances/{odaInstanceId}/channels/{channelId}/actions/start'.sub('{odaInstanceId}', oda_instance_id.to_s).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-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#start_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::Oda::Models::Channel'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#stop_channel(oda_instance_id, channel_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use stop_channel API.

Stops a Channel so that it will no longer accept messages.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • channel_id (String) —

    Unique Channel identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

  • :if_match (String) —

    For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the if-match query parameter to the value of the ETAG header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

Returns:



3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
 
# File 'lib/oci/oda/management_client.rb', line 3664

def stop_channel(oda_instance_id, channel_id, opts = {})
  logger.debug 'Calling operation ManagementClient#stop_channel.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling stop_channel." if oda_instance_id.nil?
  raise "Missing the required parameter 'channel_id' when calling stop_channel." if channel_id.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'channel_id' must not be blank" if OCI::Internal::Util.blank_string?(channel_id)

  path = '/odaInstances/{odaInstanceId}/channels/{channelId}/actions/stop'.sub('{odaInstanceId}', oda_instance_id.to_s).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-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#stop_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::Oda::Models::Channel'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#train_skill(oda_instance_id, skill_id, train_skill_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use train_skill API.

Train a skill.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • skill_id (String) —

    Unique Skill identifier.

  • train_skill_details (OCI::Oda::Models::TrainSkillDetails) —

    Metadata for training a skill.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :if_match (String) —

    For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the if-match query parameter to the value of the ETAG header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

  • :opc_retry_token (String) —

    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.

Returns:

  • (Response) —

    A Response object with data of type nil



3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
 
# File 'lib/oci/oda/management_client.rb', line 3737

def train_skill(oda_instance_id, skill_id, train_skill_details, opts = {})
  logger.debug 'Calling operation ManagementClient#train_skill.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling train_skill." if oda_instance_id.nil?
  raise "Missing the required parameter 'skill_id' when calling train_skill." if skill_id.nil?
  raise "Missing the required parameter 'train_skill_details' when calling train_skill." if train_skill_details.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'skill_id' must not be blank" if OCI::Internal::Util.blank_string?(skill_id)

  path = '/odaInstances/{odaInstanceId}/skills/{skillId}/actions/train'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{skillId}', skill_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(train_skill_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#train_skill') 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_authentication_provider(oda_instance_id, authentication_provider_id, update_authentication_provider_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_authentication_provider API.

Updates the specified Authentication Provider with the information in the request body.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • authentication_provider_id (String) —

    Unique Authentication Provider identifier.

  • update_authentication_provider_details (OCI::Oda::Models::UpdateAuthenticationProviderDetails) —

    Property values to update the Authentication Provider.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :if_match (String) —

    For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the if-match query parameter to the value of the ETAG header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:



3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
 
# File 'lib/oci/oda/management_client.rb', line 3805

def update_authentication_provider(oda_instance_id, authentication_provider_id, update_authentication_provider_details, opts = {})
  logger.debug 'Calling operation ManagementClient#update_authentication_provider.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling update_authentication_provider." if oda_instance_id.nil?
  raise "Missing the required parameter 'authentication_provider_id' when calling update_authentication_provider." if authentication_provider_id.nil?
  raise "Missing the required parameter 'update_authentication_provider_details' when calling update_authentication_provider." if update_authentication_provider_details.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'authentication_provider_id' must not be blank" if OCI::Internal::Util.blank_string?(authentication_provider_id)

  path = '/odaInstances/{odaInstanceId}/authenticationProviders/{authenticationProviderId}'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{authenticationProviderId}', authentication_provider_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 = @api_client.object_to_http_body(update_authentication_provider_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#update_authentication_provider') 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,
      return_type: 'OCI::Oda::Models::AuthenticationProvider'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_channel(oda_instance_id, channel_id, update_channel_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_channel API.

Updates the specified Channel with the information in the request body.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • channel_id (String) —

    Unique Channel identifier.

  • update_channel_details (OCI::Oda::Models::UpdateChannelDetails) —

    Property values to update the Channel.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :if_match (String) —

    For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the if-match query parameter to the value of the ETAG header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:



3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
 
# File 'lib/oci/oda/management_client.rb', line 3872

def update_channel(oda_instance_id, channel_id, update_channel_details, opts = {})
  logger.debug 'Calling operation ManagementClient#update_channel.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling update_channel." if oda_instance_id.nil?
  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 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'channel_id' must not be blank" if OCI::Internal::Util.blank_string?(channel_id)

  path = '/odaInstances/{odaInstanceId}/channels/{channelId}'.sub('{odaInstanceId}', oda_instance_id.to_s).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 = @api_client.object_to_http_body(update_channel_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#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,
      return_type: 'OCI::Oda::Models::Channel'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_digital_assistant(oda_instance_id, digital_assistant_id, update_digital_assistant_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_digital_assistant API.

Updates the specified Digital Assistant with the information in the request body.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • digital_assistant_id (String) —

    Unique Digital Assistant identifier.

  • update_digital_assistant_details (OCI::Oda::Models::UpdateDigitalAssistantDetails) —

    Property values to update the Digital Assistant.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :if_match (String) —

    For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the if-match query parameter to the value of the ETAG header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:



3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
 
# File 'lib/oci/oda/management_client.rb', line 3939

def update_digital_assistant(oda_instance_id, digital_assistant_id, update_digital_assistant_details, opts = {})
  logger.debug 'Calling operation ManagementClient#update_digital_assistant.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling update_digital_assistant." if oda_instance_id.nil?
  raise "Missing the required parameter 'digital_assistant_id' when calling update_digital_assistant." if digital_assistant_id.nil?
  raise "Missing the required parameter 'update_digital_assistant_details' when calling update_digital_assistant." if update_digital_assistant_details.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'digital_assistant_id' must not be blank" if OCI::Internal::Util.blank_string?(digital_assistant_id)

  path = '/odaInstances/{odaInstanceId}/digitalAssistants/{digitalAssistantId}'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{digitalAssistantId}', digital_assistant_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 = @api_client.object_to_http_body(update_digital_assistant_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#update_digital_assistant') 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,
      return_type: 'OCI::Oda::Models::DigitalAssistant'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_digital_assistant_parameter(oda_instance_id, digital_assistant_id, parameter_name, update_digital_assistant_parameter_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_digital_assistant_parameter API.

Updates the specified Digital Assistant Parameter with the information in the request body.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • digital_assistant_id (String) —

    Unique Digital Assistant identifier.

  • parameter_name (String) —

    The name of a Digital Assistant Parameter. This is unique with the Digital Assistant.

  • update_digital_assistant_parameter_details (OCI::Oda::Models::UpdateDigitalAssistantParameterDetails) —

    Property values to update the Digital Assistant Parameter.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :if_match (String) —

    For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the if-match query parameter to the value of the ETAG header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:



4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
 
# File 'lib/oci/oda/management_client.rb', line 4007

def update_digital_assistant_parameter(oda_instance_id, digital_assistant_id, parameter_name, update_digital_assistant_parameter_details, opts = {})
  logger.debug 'Calling operation ManagementClient#update_digital_assistant_parameter.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling update_digital_assistant_parameter." if oda_instance_id.nil?
  raise "Missing the required parameter 'digital_assistant_id' when calling update_digital_assistant_parameter." if digital_assistant_id.nil?
  raise "Missing the required parameter 'parameter_name' when calling update_digital_assistant_parameter." if parameter_name.nil?
  raise "Missing the required parameter 'update_digital_assistant_parameter_details' when calling update_digital_assistant_parameter." if update_digital_assistant_parameter_details.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'digital_assistant_id' must not be blank" if OCI::Internal::Util.blank_string?(digital_assistant_id)
  raise "Parameter value for 'parameter_name' must not be blank" if OCI::Internal::Util.blank_string?(parameter_name)

  path = '/odaInstances/{odaInstanceId}/digitalAssistants/{digitalAssistantId}/parameters/{parameterName}'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{digitalAssistantId}', digital_assistant_id.to_s).sub('{parameterName}', parameter_name.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 = @api_client.object_to_http_body(update_digital_assistant_parameter_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#update_digital_assistant_parameter') 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,
      return_type: 'OCI::Oda::Models::DigitalAssistantParameter'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_oda_private_endpoint(oda_private_endpoint_id, update_oda_private_endpoint_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_oda_private_endpoint API.

Starts an asynchronous job to update the specified ODA Private Endpoint with the information in the request body.

Parameters:

  • oda_private_endpoint_id (String) —

    Unique ODA Private Endpoint identifier which is the OCID.

  • update_oda_private_endpoint_details (OCI::Oda::Models::UpdateOdaPrivateEndpointDetails) —

    The information to update.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :if_match (String) —

    For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the if-match query parameter to the value of the ETAG header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:

  • (Response) —

    A Response object with data of type nil



4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
 
# File 'lib/oci/oda/management_client.rb', line 4075

def update_oda_private_endpoint(oda_private_endpoint_id, update_oda_private_endpoint_details, opts = {})
  logger.debug 'Calling operation ManagementClient#update_oda_private_endpoint.' if logger

  raise "Missing the required parameter 'oda_private_endpoint_id' when calling update_oda_private_endpoint." if oda_private_endpoint_id.nil?
  raise "Missing the required parameter 'update_oda_private_endpoint_details' when calling update_oda_private_endpoint." if update_oda_private_endpoint_details.nil?
  raise "Parameter value for 'oda_private_endpoint_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_private_endpoint_id)

  path = '/odaPrivateEndpoints/{odaPrivateEndpointId}'.sub('{odaPrivateEndpointId}', oda_private_endpoint_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 = @api_client.object_to_http_body(update_oda_private_endpoint_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#update_oda_private_endpoint') 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

#update_skill(oda_instance_id, skill_id, update_skill_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_skill API.

Updates the specified Skill with the information in the request body.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • skill_id (String) —

    Unique Skill identifier.

  • update_skill_details (OCI::Oda::Models::UpdateSkillDetails) —

    Property values to update the Skill.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :if_match (String) —

    For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the if-match query parameter to the value of the ETAG header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:



4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
 
# File 'lib/oci/oda/management_client.rb', line 4139

def update_skill(oda_instance_id, skill_id, update_skill_details, opts = {})
  logger.debug 'Calling operation ManagementClient#update_skill.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling update_skill." if oda_instance_id.nil?
  raise "Missing the required parameter 'skill_id' when calling update_skill." if skill_id.nil?
  raise "Missing the required parameter 'update_skill_details' when calling update_skill." if update_skill_details.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'skill_id' must not be blank" if OCI::Internal::Util.blank_string?(skill_id)

  path = '/odaInstances/{odaInstanceId}/skills/{skillId}'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{skillId}', skill_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 = @api_client.object_to_http_body(update_skill_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#update_skill') 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,
      return_type: 'OCI::Oda::Models::Skill'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_skill_parameter(oda_instance_id, skill_id, parameter_name, update_skill_parameter_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_skill_parameter API.

Updates the specified Skill Parameter with the information in the request body.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • skill_id (String) —

    Unique Skill identifier.

  • parameter_name (String) —

    The name of a Skill Parameter.

  • update_skill_parameter_details (OCI::Oda::Models::UpdateSkillParameterDetails) —

    Property values to update the Skill Parameter.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :if_match (String) —

    For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the if-match query parameter to the value of the ETAG header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:



4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
 
# File 'lib/oci/oda/management_client.rb', line 4207

def update_skill_parameter(oda_instance_id, skill_id, parameter_name, update_skill_parameter_details, opts = {})
  logger.debug 'Calling operation ManagementClient#update_skill_parameter.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling update_skill_parameter." if oda_instance_id.nil?
  raise "Missing the required parameter 'skill_id' when calling update_skill_parameter." if skill_id.nil?
  raise "Missing the required parameter 'parameter_name' when calling update_skill_parameter." if parameter_name.nil?
  raise "Missing the required parameter 'update_skill_parameter_details' when calling update_skill_parameter." if update_skill_parameter_details.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'skill_id' must not be blank" if OCI::Internal::Util.blank_string?(skill_id)
  raise "Parameter value for 'parameter_name' must not be blank" if OCI::Internal::Util.blank_string?(parameter_name)

  path = '/odaInstances/{odaInstanceId}/skills/{skillId}/parameters/{parameterName}'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{skillId}', skill_id.to_s).sub('{parameterName}', parameter_name.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 = @api_client.object_to_http_body(update_skill_parameter_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#update_skill_parameter') 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,
      return_type: 'OCI::Oda::Models::SkillParameter'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_translator(oda_instance_id, translator_id, update_translator_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_translator API.

Updates the specified Translator with the information in the request body.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • translator_id (String) —

    Unique Translator identifier.

  • update_translator_details (OCI::Oda::Models::UpdateTranslatorDetails) —

    Property values to update the Translator.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :if_match (String) —

    For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the if-match query parameter to the value of the ETAG header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:



4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
 
# File 'lib/oci/oda/management_client.rb', line 4276

def update_translator(oda_instance_id, translator_id, update_translator_details, opts = {})
  logger.debug 'Calling operation ManagementClient#update_translator.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling update_translator." if oda_instance_id.nil?
  raise "Missing the required parameter 'translator_id' when calling update_translator." if translator_id.nil?
  raise "Missing the required parameter 'update_translator_details' when calling update_translator." if update_translator_details.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'translator_id' must not be blank" if OCI::Internal::Util.blank_string?(translator_id)

  path = '/odaInstances/{odaInstanceId}/translators/{translatorId}'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{translatorId}', translator_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 = @api_client.object_to_http_body(update_translator_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#update_translator') 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,
      return_type: 'OCI::Oda::Models::Translator'
    )
  end
  # rubocop:enable Metrics/BlockLength
end