Class: OCI::Oda::OdapackageClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/oda/odapackage_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) ⇒ OdapackageClient

Creates a new OdapackageClient. 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/odapackage_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 "OdapackageClient 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/odapackage_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/odapackage_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/odapackage_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/odapackage_client.rb', line 25

def retry_config
  @retry_config
end

Instance Method Details

#create_imported_package(create_imported_package_details, oda_instance_id, opts = {}) ⇒ Response

Note:

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

Starts an asynchronous job to import a package into a Digital Assistant instance.

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

Parameters:

  • create_imported_package_details (OCI::Oda::Models::CreateImportedPackageDetails) —

    Parameter values required to import the package.

  • 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

  • :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.

  • :opc_request_id (String) —

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

Returns:



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
162
 
# File 'lib/oci/oda/odapackage_client.rb', line 123

def create_imported_package(create_imported_package_details, oda_instance_id, opts = {})
  logger.debug 'Calling operation OdapackageClient#create_imported_package.' if logger

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

  path = '/odaInstances/{odaInstanceId}/importedPackages'.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-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_imported_package_details)

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

#delete_imported_package(oda_instance_id, package_id, opts = {}) ⇒ Response

Note:

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

Starts an asynchronous job to delete a package from a Digital Assistant instance.

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

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • package_id (String) —

    Unique Digital Assistant package 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_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.

  • :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



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
236
237
238
239
 
# File 'lib/oci/oda/odapackage_client.rb', line 199

def delete_imported_package(oda_instance_id, package_id, opts = {})
  logger.debug 'Calling operation OdapackageClient#delete_imported_package.' if logger

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

  path = '/odaInstances/{odaInstanceId}/importedPackages/{packageId}'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{packageId}', package_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-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  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
  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: 'OdapackageClient#delete_imported_package') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_imported_package(oda_instance_id, package_id, opts = {}) ⇒ Response

Note:

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

Returns a list of summaries for imported packages in the instance.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • package_id (String) —

    Unique Digital Assistant package 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.

Returns:



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/oci/oda/odapackage_client.rb', line 259

def get_imported_package(oda_instance_id, package_id, opts = {})
  logger.debug 'Calling operation OdapackageClient#get_imported_package.' if logger

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

  path = '/odaInstances/{odaInstanceId}/importedPackages/{packageId}'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{packageId}', package_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: 'OdapackageClient#get_imported_package') 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::ImportedPackage'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_package(oda_instance_id, package_id, opts = {}) ⇒ Response

Note:

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

Returns details about a package, and how to import it.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • package_id (String) —

    Unique Digital Assistant package 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.

Returns:



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/oci/oda/odapackage_client.rb', line 317

def get_package(oda_instance_id, package_id, opts = {})
  logger.debug 'Calling operation OdapackageClient#get_package.' if logger

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

  path = '/odaInstances/{odaInstanceId}/packages/{packageId}'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{packageId}', package_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: 'OdapackageClient#get_package') 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::Package'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Returns a list of summaries for imported packages in the instance.

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

  • :name (String) —

    List only the information for the package with this name. Package names are unique to a publisher and may not change.

    Example: My Package

  • :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:



393
394
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
435
436
437
438
439
440
441
442
 
# File 'lib/oci/oda/odapackage_client.rb', line 393

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

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

  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_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)

  path = '/odaInstances/{odaInstanceId}/importedPackages'.sub('{odaInstanceId}', oda_instance_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[: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: 'OdapackageClient#list_imported_packages') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Oda::Models::ImportedPackageSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_packages(opts = {}) ⇒ Response

Note:

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

Returns a page of summaries for packages that are available for import. The optional odaInstanceId query parameter can be used to filter packages that are available for import by a specific instance. If odaInstanceId query parameter is not provided, the returned list will include packages available within the region indicated by the request URL. The optional resourceType query param may be specified to filter packages that contain the indicated resource type. If no resourceType query param is given, packages containing all resource types will be returned. The optional name query parameter can be used to limit the list to packages whose name matches the given name. The optional displayName query parameter can be used to limit the list to packages whose displayName matches the given name. The optional isLatestVersionOnly query parameter can be used to limit the returned list to include only the latest version of any given package. If not specified, all versions of any otherwise matching package will be returned.

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:

  • 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

  • :oda_instance_id (String) —

    List only the information for this Digital Assistant instance.

  • :resource_type (String) —

    Resource type identifier. Used to limit query results to the items which are applicable to the given type. (default to oracle_da_skills)

  • :compartment_id (String) —

    List the packages that belong to this compartment.

  • :name (String) —

    List only the information for the package with this name. Package names are unique to a publisher and may not change.

    Example: My Package

  • :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

  • :is_latest_version_only (BOOLEAN) —

    Should we return only the latest version of a package (instead of all versions)? (default to false)

  • :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:



500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
 
# File 'lib/oci/oda/odapackage_client.rb', line 500

def list_packages(opts = {})
  logger.debug 'Calling operation OdapackageClient#list_packages.' if logger


  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 = '/packages'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:odaInstanceId] = opts[:oda_instance_id] if opts[:oda_instance_id]
  query_params[:resourceType] = opts[:resource_type] if opts[:resource_type]
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:name] = opts[:name] if opts[:name]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:isLatestVersionOnly] = opts[:is_latest_version_only] if !opts[:is_latest_version_only].nil?
  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: 'OdapackageClient#list_packages') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Oda::Models::PackageSummary>'
    )
  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/odapackage_client.rb', line 94

def logger
  @api_client.config.logger
end

#update_imported_package(update_imported_package_details, oda_instance_id, package_id, opts = {}) ⇒ Response

Note:

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

Starts an asynchronous job to update a package within a Digital Assistant instance.

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

Parameters:

  • update_imported_package_details (OCI::Oda::Models::UpdateImportedPackageDetails) —

    Parameter values required to import the package, with updated values.

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • package_id (String) —

    Unique Digital Assistant package 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

  • :is_replace_skills (BOOLEAN) —

    Should old skills be replaced by new skills if packageId differs from already imported package? (default to false)

  • :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.

  • :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:



591
592
593
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
632
633
634
 
# File 'lib/oci/oda/odapackage_client.rb', line 591

def update_imported_package(update_imported_package_details, oda_instance_id, package_id, opts = {})
  logger.debug 'Calling operation OdapackageClient#update_imported_package.' if logger

  raise "Missing the required parameter 'update_imported_package_details' when calling update_imported_package." if update_imported_package_details.nil?
  raise "Missing the required parameter 'oda_instance_id' when calling update_imported_package." if oda_instance_id.nil?
  raise "Missing the required parameter 'package_id' when calling update_imported_package." if package_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 'package_id' must not be blank" if OCI::Internal::Util.blank_string?(package_id)

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

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:isReplaceSkills] = opts[:is_replace_skills] if !opts[:is_replace_skills].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  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
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(update_imported_package_details)

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