Class: OCI::DataScience::DataScienceClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/data_science/data_science_client.rb

Overview

Use the Data Science API to organize your data science work, access data and computing resources, and build, train, deploy and manage models and model deployments. For more information, see Data Science.

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) ⇒ DataScienceClient

Creates a new DataScienceClient. 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/data_science/data_science_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 + '/20190101'
  else
    region ||= config.region
    region ||= signer.region if signer.respond_to?(:region)
    self.region = region
  end
  logger.info "DataScienceClient 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/data_science/data_science_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/data_science/data_science_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/data_science/data_science_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/data_science/data_science_client.rb', line 25

def retry_config
  @retry_config
end

Instance Method Details

#activate_model(model_id, opts = {}) ⇒ Response

Note:

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

Activates the model.

Parameters:

  • model_id (String) —

    The OCID of the model.

  • 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 the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:



118
119
120
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
 
# File 'lib/oci/data_science/data_science_client.rb', line 118

def activate_model(model_id, opts = {})
  logger.debug 'Calling operation DataScienceClient#activate_model.' if logger

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

  path = '/models/{modelId}/actions/activate'.sub('{modelId}', model_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: 'DataScienceClient#activate_model') 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::DataScience::Models::Model'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#activate_model_deployment(model_deployment_id, opts = {}) ⇒ Response

Note:

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

Activates the model deployment.

Parameters:

  • model_deployment_id (String) —

    The OCID of the model deployment.

  • 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 the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/oci/data_science/data_science_client.rb', line 180

def activate_model_deployment(model_deployment_id, opts = {})
  logger.debug 'Calling operation DataScienceClient#activate_model_deployment.' if logger

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

  path = '/modelDeployments/{modelDeploymentId}/actions/activate'.sub('{modelDeploymentId}', model_deployment_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: 'DataScienceClient#activate_model_deployment') 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

#activate_notebook_session(notebook_session_id, opts = {}) ⇒ Response

Note:

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

Activates the notebook session.

Parameters:

  • notebook_session_id (String) —

    The OCID of the notebook session.

  • 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 the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/oci/data_science/data_science_client.rb', line 241

def activate_notebook_session(notebook_session_id, opts = {})
  logger.debug 'Calling operation DataScienceClient#activate_notebook_session.' if logger

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

  path = '/notebookSessions/{notebookSessionId}/actions/activate'.sub('{notebookSessionId}', notebook_session_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: 'DataScienceClient#activate_notebook_session') 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

#activate_schedule(schedule_id, opts = {}) ⇒ Response

Note:

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

Activate schedule.

Parameters:

  • schedule_id (String) —

    unique Schedule 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) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



304
305
306
307
308
309
310
311
312
313
314
315
316
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
 
# File 'lib/oci/data_science/data_science_client.rb', line 304

def activate_schedule(schedule_id, opts = {})
  logger.debug 'Calling operation DataScienceClient#activate_schedule.' if logger

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

  path = '/schedules/{scheduleId}/actions/activate'.sub('{scheduleId}', schedule_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]
  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: 'DataScienceClient#activate_schedule') 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

#cancel_job_run(job_run_id, opts = {}) ⇒ Response

Note:

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

Cancels an IN_PROGRESS job run.

Parameters:

  • job_run_id (String) —

    The OCID of the job run.

  • 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) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/oci/data_science/data_science_client.rb', line 367

def cancel_job_run(job_run_id, opts = {})
  logger.debug 'Calling operation DataScienceClient#cancel_job_run.' if logger

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

  path = '/jobRuns/{jobRunId}/actions/cancelJobRun'.sub('{jobRunId}', job_run_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: 'DataScienceClient#cancel_job_run') 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

#cancel_pipeline_run(pipeline_run_id, opts = {}) ⇒ Response

Note:

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

Cancel a PipelineRun.

Parameters:

  • pipeline_run_id (String) —

    The OCID of the pipeline run.

  • 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) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :terminate_gracefully (BOOLEAN) —

    A boolean value to specify whether to terminate pipeline run gracefully.

Returns:

  • (Response) —

    A Response object with data of type nil



431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
 
# File 'lib/oci/data_science/data_science_client.rb', line 431

def cancel_pipeline_run(pipeline_run_id, opts = {})
  logger.debug 'Calling operation DataScienceClient#cancel_pipeline_run.' if logger

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

  path = '/pipelineRuns/{pipelineRunId}/actions/cancelPipelineRun'.sub('{pipelineRunId}', pipeline_run_id.to_s)
  operation_signing_strategy = :standard

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

  # 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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # 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: 'DataScienceClient#cancel_pipeline_run') 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

#cancel_work_request(work_request_id, opts = {}) ⇒ Response

Note:

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

Cancels a work request that has not started.

Parameters:

  • work_request_id (String) —

    The OCID of the work request.

  • 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 the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



495
496
497
498
499
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
 
# File 'lib/oci/data_science/data_science_client.rb', line 495

def cancel_work_request(work_request_id, opts = {})
  logger.debug 'Calling operation DataScienceClient#cancel_work_request.' if logger

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

  path = '/workRequests/{workRequestId}'.sub('{workRequestId}', work_request_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: 'DataScienceClient#cancel_work_request') 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

#change_data_science_private_endpoint_compartment(data_science_private_endpoint_id, change_data_science_private_endpoint_compartment_details, opts = {}) ⇒ Response

Note:

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

Moves a private endpoint into a different compartment. When provided, If-Match is checked against ETag values of the resource.

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) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
 
# File 'lib/oci/data_science/data_science_client.rb', line 562

def change_data_science_private_endpoint_compartment(data_science_private_endpoint_id, change_data_science_private_endpoint_compartment_details, opts = {})
  logger.debug 'Calling operation DataScienceClient#change_data_science_private_endpoint_compartment.' if logger

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

  path = '/dataSciencePrivateEndpoints/{dataSciencePrivateEndpointId}/actions/changeCompartment'.sub('{dataSciencePrivateEndpointId}', data_science_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[:'if-match'] = opts[:if_match] if opts[:if_match]
  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_data_science_private_endpoint_compartment_details)

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

#change_job_compartment(job_id, change_job_compartment_details, opts = {}) ⇒ Response

Note:

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

Changes a job's compartment

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 the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
 
# File 'lib/oci/data_science/data_science_client.rb', line 627

def change_job_compartment(job_id, change_job_compartment_details, opts = {})
  logger.debug 'Calling operation DataScienceClient#change_job_compartment.' if logger

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

  path = '/jobs/{jobId}/actions/changeCompartment'.sub('{jobId}', job_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(change_job_compartment_details)

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

#change_job_run_compartment(job_run_id, change_job_run_compartment_details, opts = {}) ⇒ Response

Note:

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

Changes a job run's compartment

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 the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
 
# File 'lib/oci/data_science/data_science_client.rb', line 690

def change_job_run_compartment(job_run_id, change_job_run_compartment_details, opts = {})
  logger.debug 'Calling operation DataScienceClient#change_job_run_compartment.' if logger

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

  path = '/jobRuns/{jobRunId}/actions/changeCompartment'.sub('{jobRunId}', job_run_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(change_job_run_compartment_details)

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

#change_ml_application_compartment(ml_application_id, change_ml_application_compartment_details, opts = {}) ⇒ Response

Note:

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

Moves a MlApplication resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.

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 the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
 
# File 'lib/oci/data_science/data_science_client.rb', line 755

def change_ml_application_compartment(ml_application_id, change_ml_application_compartment_details, opts = {})
  logger.debug 'Calling operation DataScienceClient#change_ml_application_compartment.' if logger

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

  path = '/mlApplications/{mlApplicationId}/actions/changeCompartment'.sub('{mlApplicationId}', ml_application_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_ml_application_compartment_details)

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

#change_ml_application_implementation_compartment(ml_application_implementation_id, change_ml_application_implementation_compartment_details, opts = {}) ⇒ Response

Note:

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

Moves a MlApplicationImplementation resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.

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 the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
 
# File 'lib/oci/data_science/data_science_client.rb', line 822

def change_ml_application_implementation_compartment(ml_application_implementation_id, change_ml_application_implementation_compartment_details, opts = {})
  logger.debug 'Calling operation DataScienceClient#change_ml_application_implementation_compartment.' if logger

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

  path = '/mlApplicationImplementations/{mlApplicationImplementationId}/actions/changeCompartment'.sub('{mlApplicationImplementationId}', ml_application_implementation_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_ml_application_implementation_compartment_details)

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

#change_ml_application_instance_compartment(ml_application_instance_id, change_ml_application_instance_compartment_details, opts = {}) ⇒ Response

Note:

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

Moves a MlApplicationInstance resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.

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 the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
 
# File 'lib/oci/data_science/data_science_client.rb', line 889

def change_ml_application_instance_compartment(ml_application_instance_id, change_ml_application_instance_compartment_details, opts = {})
  logger.debug 'Calling operation DataScienceClient#change_ml_application_instance_compartment.' if logger

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

  path = '/mlApplicationInstances/{mlApplicationInstanceId}/actions/changeCompartment'.sub('{mlApplicationInstanceId}', ml_application_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[:'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_ml_application_instance_compartment_details)

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

#change_ml_application_instance_view_compartment(ml_application_instance_view_id, change_ml_application_instance_view_compartment_details, opts = {}) ⇒ Response

Note:

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

Moves a MlApplicationInstanceView resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.

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 the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
 
# File 'lib/oci/data_science/data_science_client.rb', line 956

def change_ml_application_instance_view_compartment(ml_application_instance_view_id, change_ml_application_instance_view_compartment_details, opts = {})
  logger.debug 'Calling operation DataScienceClient#change_ml_application_instance_view_compartment.' if logger

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

  path = '/mlApplicationInstanceViews/{mlApplicationInstanceViewId}/actions/changeCompartment'.sub('{mlApplicationInstanceViewId}', ml_application_instance_view_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_ml_application_instance_view_compartment_details)

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

#change_model_compartment(model_id, change_model_compartment_details, opts = {}) ⇒ Response

Note:

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

Moves a model resource into a different compartment.

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 the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
 
# File 'lib/oci/data_science/data_science_client.rb', line 1023

def change_model_compartment(model_id, change_model_compartment_details, opts = {})
  logger.debug 'Calling operation DataScienceClient#change_model_compartment.' if logger

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

  path = '/models/{modelId}/actions/changeCompartment'.sub('{modelId}', model_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_model_compartment_details)

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

#change_model_deployment_compartment(model_deployment_id, change_model_deployment_compartment_details, opts = {}) ⇒ Response

Note:

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

Moves a model deployment into a different compartment. When provided, If-Match is checked against ETag values of the resource.

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 the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
 
# File 'lib/oci/data_science/data_science_client.rb', line 1090

def change_model_deployment_compartment(model_deployment_id, change_model_deployment_compartment_details, opts = {})
  logger.debug 'Calling operation DataScienceClient#change_model_deployment_compartment.' if logger

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

  path = '/modelDeployments/{modelDeploymentId}/actions/changeCompartment'.sub('{modelDeploymentId}', model_deployment_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_model_deployment_compartment_details)

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

#change_model_version_set_compartment(model_version_set_id, change_model_version_set_compartment_details, opts = {}) ⇒ Response

Note:

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

Moves a modelVersionSet resource into a different compartment.

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 the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
 
# File 'lib/oci/data_science/data_science_client.rb', line 1157

def change_model_version_set_compartment(model_version_set_id, change_model_version_set_compartment_details, opts = {})
  logger.debug 'Calling operation DataScienceClient#change_model_version_set_compartment.' if logger

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

  path = '/modelVersionSets/{modelVersionSetId}/actions/changeCompartment'.sub('{modelVersionSetId}', model_version_set_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_model_version_set_compartment_details)

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

#change_notebook_session_compartment(notebook_session_id, change_notebook_session_compartment_details, opts = {}) ⇒ Response

Note:

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

Moves a notebook session resource into a different compartment.

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 the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
 
# File 'lib/oci/data_science/data_science_client.rb', line 1224

def change_notebook_session_compartment(notebook_session_id, change_notebook_session_compartment_details, opts = {})
  logger.debug 'Calling operation DataScienceClient#change_notebook_session_compartment.' if logger

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

  path = '/notebookSessions/{notebookSessionId}/actions/changeCompartment'.sub('{notebookSessionId}', notebook_session_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_notebook_session_compartment_details)

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

#change_pipeline_compartment(pipeline_id, change_pipeline_compartment_details, opts = {}) ⇒ Response

Note:

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

Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.

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) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
 
# File 'lib/oci/data_science/data_science_client.rb', line 1289

def change_pipeline_compartment(pipeline_id, change_pipeline_compartment_details, opts = {})
  logger.debug 'Calling operation DataScienceClient#change_pipeline_compartment.' if logger

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

  path = '/pipelines/{pipelineId}/actions/changeCompartment'.sub('{pipelineId}', pipeline_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 = @api_client.object_to_http_body(change_pipeline_compartment_details)

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

#change_pipeline_run_compartment(pipeline_run_id, change_pipeline_run_compartment_details, opts = {}) ⇒ Response

Note:

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

Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.

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) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
 
# File 'lib/oci/data_science/data_science_client.rb', line 1352

def change_pipeline_run_compartment(pipeline_run_id, change_pipeline_run_compartment_details, opts = {})
  logger.debug 'Calling operation DataScienceClient#change_pipeline_run_compartment.' if logger

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

  path = '/pipelineRuns/{pipelineRunId}/actions/changeCompartment'.sub('{pipelineRunId}', pipeline_run_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 = @api_client.object_to_http_body(change_pipeline_run_compartment_details)

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

#change_project_compartment(project_id, change_project_compartment_details, opts = {}) ⇒ Response

Note:

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

Moves a project resource into a different compartment.

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 the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
 
# File 'lib/oci/data_science/data_science_client.rb', line 1417

def change_project_compartment(project_id, change_project_compartment_details, opts = {})
  logger.debug 'Calling operation DataScienceClient#change_project_compartment.' if logger

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

  path = '/projects/{projectId}/actions/changeCompartment'.sub('{projectId}', project_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_project_compartment_details)

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

#change_schedule_compartment(schedule_id, change_schedule_compartment_details, opts = {}) ⇒ Response

Note:

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

Moves a Schedule resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.

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 it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
 
# File 'lib/oci/data_science/data_science_client.rb', line 1484

def change_schedule_compartment(schedule_id, change_schedule_compartment_details, opts = {})
  logger.debug 'Calling operation DataScienceClient#change_schedule_compartment.' if logger

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

  path = '/schedules/{scheduleId}/actions/changeCompartment'.sub('{scheduleId}', schedule_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 = @api_client.object_to_http_body(change_schedule_compartment_details)

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

#create_data_science_private_endpoint(create_data_science_private_endpoint_details, opts = {}) ⇒ Response

Note:

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

Creates a Data Science private endpoint to be used by a Data Science resource.

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 it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:



1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
 
# File 'lib/oci/data_science/data_science_client.rb', line 1546

def create_data_science_private_endpoint(create_data_science_private_endpoint_details, opts = {})
  logger.debug 'Calling operation DataScienceClient#create_data_science_private_endpoint.' if logger

  raise "Missing the required parameter 'create_data_science_private_endpoint_details' when calling create_data_science_private_endpoint." if create_data_science_private_endpoint_details.nil?

  path = '/dataSciencePrivateEndpoints'
  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_data_science_private_endpoint_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataScienceClient#create_data_science_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::DataScience::Models::DataSciencePrivateEndpoint'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_job(create_job_details, opts = {}) ⇒ Response

Note:

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

Creates a job.

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) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

  • (Response) —

    A Response object with data of type Job



1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
 
# File 'lib/oci/data_science/data_science_client.rb', line 1604

def create_job(create_job_details, opts = {})
  logger.debug 'Calling operation DataScienceClient#create_job.' if logger

  raise "Missing the required parameter 'create_job_details' when calling create_job." if create_job_details.nil?

  path = '/jobs'
  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_job_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataScienceClient#create_job') 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::DataScience::Models::Job'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_job_artifact(job_id, job_artifact, opts = {}) ⇒ Response

Note:

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

Uploads a job artifact.

Parameters:

  • job_id (String) —

    The OCID of the job.

  • job_artifact (String, IO) —

    The job artifact to upload.

  • 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

  • :content_length (Integer) —

    The content length of the body.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :content_disposition (String) —

    This header is for specifying a filename during upload. It is used to identify the file type and validate if the file type is supported. Example: --content-disposition \"attachment; filename=hello-world.py\"

Returns:

  • (Response) —

    A Response object with data of type nil



1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
 
# File 'lib/oci/data_science/data_science_client.rb', line 1667

def create_job_artifact(job_id, job_artifact, opts = {})
  logger.debug 'Calling operation DataScienceClient#create_job_artifact.' if logger

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

  path = '/jobs/{jobId}/artifact'.sub('{jobId}', job_id.to_s)
  operation_signing_strategy = :exclude_body

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'content-length'] = opts[:content_length] if opts[:content_length]
  header_params[:'content-disposition'] = opts[:content_disposition] if opts[:content_disposition]
  # rubocop:enable Style/NegatedIf
  header_params[:'content-type'] ||= 'application/octet-stream'
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(job_artifact)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataScienceClient#create_job_artifact') 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_job_run(create_job_run_details, opts = {}) ⇒ Response

Note:

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

Creates a job run.

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) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_parent_rpt_url (String) —

    URL to fetch the Resource Principal Token from the parent resource.

Returns:



1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
 
# File 'lib/oci/data_science/data_science_client.rb', line 1730

def create_job_run(create_job_run_details, opts = {})
  logger.debug 'Calling operation DataScienceClient#create_job_run.' if logger

  raise "Missing the required parameter 'create_job_run_details' when calling create_job_run." if create_job_run_details.nil?

  path = '/jobRuns'
  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]
  header_params[:'opc-parent-rpt-url'] = opts[:opc_parent_rpt_url] if opts[:opc_parent_rpt_url]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_job_run_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataScienceClient#create_job_run') 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::DataScience::Models::JobRun'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_ml_application(create_ml_application_details, opts = {}) ⇒ Response

Note:

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

Creates a new MlApplication.

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 it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:



1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
 
# File 'lib/oci/data_science/data_science_client.rb', line 1790

def create_ml_application(create_ml_application_details, opts = {})
  logger.debug 'Calling operation DataScienceClient#create_ml_application.' if logger

  raise "Missing the required parameter 'create_ml_application_details' when calling create_ml_application." if create_ml_application_details.nil?

  path = '/mlApplications'
  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_ml_application_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataScienceClient#create_ml_application') 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::DataScience::Models::MlApplication'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_ml_application_implementation(create_ml_application_implementation_details, opts = {}) ⇒ Response

Note:

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

Creates a new MlApplicationImplementation.

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 it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:



1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
 
# File 'lib/oci/data_science/data_science_client.rb', line 1849

def create_ml_application_implementation(create_ml_application_implementation_details, opts = {})
  logger.debug 'Calling operation DataScienceClient#create_ml_application_implementation.' if logger

  raise "Missing the required parameter 'create_ml_application_implementation_details' when calling create_ml_application_implementation." if create_ml_application_implementation_details.nil?

  path = '/mlApplicationImplementations'
  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_ml_application_implementation_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataScienceClient#create_ml_application_implementation') 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::DataScience::Models::MlApplicationImplementation'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_ml_application_instance(create_ml_application_instance_details, opts = {}) ⇒ Response

Note:

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

Creates a new MlApplicationInstance.

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 it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:



1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
 
# File 'lib/oci/data_science/data_science_client.rb', line 1908

def create_ml_application_instance(create_ml_application_instance_details, opts = {})
  logger.debug 'Calling operation DataScienceClient#create_ml_application_instance.' if logger

  raise "Missing the required parameter 'create_ml_application_instance_details' when calling create_ml_application_instance." if create_ml_application_instance_details.nil?

  path = '/mlApplicationInstances'
  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_ml_application_instance_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataScienceClient#create_ml_application_instance') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::DataScience::Models::MlApplicationInstance'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_model(create_model_details, opts = {}) ⇒ Response

Note:

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

Creates a new model.

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) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
 
# File 'lib/oci/data_science/data_science_client.rb', line 1966

def create_model(create_model_details, opts = {})
  logger.debug 'Calling operation DataScienceClient#create_model.' if logger

  raise "Missing the required parameter 'create_model_details' when calling create_model." if create_model_details.nil?

  path = '/models'
  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_model_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataScienceClient#create_model') 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::DataScience::Models::Model'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_model_artifact(model_id, model_artifact, opts = {}) ⇒ Response

Note:

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

Creates model artifact for specified model.

Parameters:

  • model_id (String) —

    The OCID of the model.

  • model_artifact (String, IO) —

    The model artifact to upload.

  • 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

  • :content_length (Integer) —

    The content length of the body.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :content_disposition (String) —

    This header allows you to specify a filename during upload. This file name is used to dispose of the file contents while downloading the file. If this optional field is not populated in the request, then the OCID of the model is used for the file name when downloading. Example: {\"Content-Disposition\": \"attachment\" \"filename\"=\"model.tar.gz\" \"Content-Length\": \"2347\" \"Content-Type\": \"application/gzip\"}

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



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
2078
2079
2080
2081
 
# File 'lib/oci/data_science/data_science_client.rb', line 2040

def create_model_artifact(model_id, model_artifact, opts = {})
  logger.debug 'Calling operation DataScienceClient#create_model_artifact.' if logger

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

  path = '/models/{modelId}/artifact'.sub('{modelId}', model_id.to_s)
  operation_signing_strategy = :exclude_body

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'content-length'] = opts[:content_length] if opts[:content_length]
  header_params[:'content-disposition'] = opts[:content_disposition] if opts[:content_disposition]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'content-type'] ||= 'application/octet-stream'
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(model_artifact)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataScienceClient#create_model_artifact') 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_model_custom_metadatum_artifact(model_id, metadatum_key_name, model_custom_metadatum_artifact, opts = {}) ⇒ Response

Note:

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

Creates model custom metadata artifact for specified model.

Parameters:

  • model_id (String) —

    The OCID of the model.

  • metadatum_key_name (String) —

    The name of the model metadatum in the metadata.

  • model_custom_metadatum_artifact (String, IO) —

    The model custom metadata artifact to upload.

  • 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

  • :content_length (Integer) —

    The content length of the body.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :content_disposition (String) —

    This header allows you to specify a filename during upload. This file name is used to dispose of the file contents while downloading the file. If this optional field is not populated in the request, then the OCID of the model is used for the file name when downloading. Example: {\"Content-Disposition\": \"attachment\" \"filename\"=\"model.tar.gz\" \"Content-Length\": \"2347\" \"Content-Type\": \"application/gzip\"}

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
 
# File 'lib/oci/data_science/data_science_client.rb', line 2117

def create_model_custom_metadatum_artifact(model_id, metadatum_key_name, model_custom_metadatum_artifact, opts = {})
  logger.debug 'Calling operation DataScienceClient#create_model_custom_metadatum_artifact.' if logger

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

  path = '/models/{modelId}/customMetadata/{metadatumKeyName}/artifact'.sub('{modelId}', model_id.to_s).sub('{metadatumKeyName}', metadatum_key_name.to_s)
  operation_signing_strategy = :exclude_body

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'content-length'] = opts[:content_length] if opts[:content_length]
  header_params[:'content-disposition'] = opts[:content_disposition] if opts[:content_disposition]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'content-type'] ||= 'application/octet-stream'

  post_body = @api_client.object_to_http_body(model_custom_metadatum_artifact)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataScienceClient#create_model_custom_metadatum_artifact') 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_model_defined_metadatum_artifact(model_id, metadatum_key_name, model_defined_metadatum_artifact, opts = {}) ⇒ Response

Note:

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

Creates model defined metadata artifact for specified model.

Parameters:

  • model_id (String) —

    The OCID of the model.

  • metadatum_key_name (String) —

    The name of the model metadatum in the metadata.

  • model_defined_metadatum_artifact (String, IO) —

    The model defined metadata artifact to upload.

  • 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

  • :content_length (Integer) —

    The content length of the body.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :content_disposition (String) —

    This header allows you to specify a filename during upload. This file name is used to dispose of the file contents while downloading the file. If this optional field is not populated in the request, then the OCID of the model is used for the file name when downloading. Example: {\"Content-Disposition\": \"attachment\" \"filename\"=\"model.tar.gz\" \"Content-Length\": \"2347\" \"Content-Type\": \"application/gzip\"}

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
 
# File 'lib/oci/data_science/data_science_client.rb', line 2194

def create_model_defined_metadatum_artifact(model_id, metadatum_key_name, model_defined_metadatum_artifact, opts = {})
  logger.debug 'Calling operation DataScienceClient#create_model_defined_metadatum_artifact.' if logger

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

  path = '/models/{modelId}/definedMetadata/{metadatumKeyName}/artifact'.sub('{modelId}', model_id.to_s).sub('{metadatumKeyName}', metadatum_key_name.to_s)
  operation_signing_strategy = :exclude_body

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'content-length'] = opts[:content_length] if opts[:content_length]
  header_params[:'content-disposition'] = opts[:content_disposition] if opts[:content_disposition]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'content-type'] ||= 'application/octet-stream'

  post_body = @api_client.object_to_http_body(model_defined_metadatum_artifact)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataScienceClient#create_model_defined_metadatum_artifact') 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_model_deployment(create_model_deployment_details, opts = {}) ⇒ Response

Note:

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

Creates a new model deployment.

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) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_parent_rpt_url (String) —

    URL to fetch the Resource Principal Token from the parent resource.

Returns:



2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
 
# File 'lib/oci/data_science/data_science_client.rb', line 2258

def create_model_deployment(create_model_deployment_details, opts = {})
  logger.debug 'Calling operation DataScienceClient#create_model_deployment.' if logger

  raise "Missing the required parameter 'create_model_deployment_details' when calling create_model_deployment." if create_model_deployment_details.nil?

  path = '/modelDeployments'
  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]
  header_params[:'opc-parent-rpt-url'] = opts[:opc_parent_rpt_url] if opts[:opc_parent_rpt_url]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_model_deployment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataScienceClient#create_model_deployment') 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::DataScience::Models::ModelDeployment'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_model_provenance(model_id, create_model_provenance_details, opts = {}) ⇒ Response

Note:

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

Creates provenance information for the specified model.

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) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
 
# File 'lib/oci/data_science/data_science_client.rb', line 2318

def create_model_provenance(model_id, create_model_provenance_details, opts = {})
  logger.debug 'Calling operation DataScienceClient#create_model_provenance.' if logger

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

  path = '/models/{modelId}/provenance'.sub('{modelId}', model_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_model_provenance_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataScienceClient#create_model_provenance') 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::DataScience::Models::ModelProvenance'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_model_version_set(create_model_version_set_details, opts = {}) ⇒ Response

Note:

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

Creates a new modelVersionSet.

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) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



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
 
# File 'lib/oci/data_science/data_science_client.rb', line 2378

def create_model_version_set(create_model_version_set_details, opts = {})
  logger.debug 'Calling operation DataScienceClient#create_model_version_set.' if logger

  raise "Missing the required parameter 'create_model_version_set_details' when calling create_model_version_set." if create_model_version_set_details.nil?

  path = '/modelVersionSets'
  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_model_version_set_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataScienceClient#create_model_version_set') 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::DataScience::Models::ModelVersionSet'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_notebook_session(create_notebook_session_details, opts = {}) ⇒ Response

Note:

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

Creates a new notebook session.

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) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
 
# File 'lib/oci/data_science/data_science_client.rb', line 2436

def create_notebook_session(create_notebook_session_details, opts = {})
  logger.debug 'Calling operation DataScienceClient#create_notebook_session.' if logger

  raise "Missing the required parameter 'create_notebook_session_details' when calling create_notebook_session." if create_notebook_session_details.nil?

  path = '/notebookSessions'
  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_notebook_session_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataScienceClient#create_notebook_session') 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::DataScience::Models::NotebookSession'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_pipeline(create_pipeline_details, opts = {}) ⇒ Response

Note:

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

Creates a new Pipeline.

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 it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:



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
 
# File 'lib/oci/data_science/data_science_client.rb', line 2495

def create_pipeline(create_pipeline_details, opts = {})
  logger.debug 'Calling operation DataScienceClient#create_pipeline.' if logger

  raise "Missing the required parameter 'create_pipeline_details' when calling create_pipeline." if create_pipeline_details.nil?

  path = '/pipelines'
  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_pipeline_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataScienceClient#create_pipeline') 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::DataScience::Models::Pipeline'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_pipeline_run(create_pipeline_run_details, opts = {}) ⇒ Response

Note:

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

Creates a new PipelineRun.

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 it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :opc_parent_rpt_url (String) —

    URL to fetch the Resource Principal Token from the parent resource.

Returns:



2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
 
# File 'lib/oci/data_science/data_science_client.rb', line 2556

def create_pipeline_run(create_pipeline_run_details, opts = {})
  logger.debug 'Calling operation DataScienceClient#create_pipeline_run.' if logger

  raise "Missing the required parameter 'create_pipeline_run_details' when calling create_pipeline_run." if create_pipeline_run_details.nil?

  path = '/pipelineRuns'
  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]
  header_params[:'opc-parent-rpt-url'] = opts[:opc_parent_rpt_url] if opts[:opc_parent_rpt_url]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_pipeline_run_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataScienceClient#create_pipeline_run') 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::DataScience::Models::PipelineRun'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_project(create_project_details, opts = {}) ⇒ Response

Note:

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

Creates a new project.

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) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



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
2645
2646
2647
2648
2649
2650
2651
2652
 
# File 'lib/oci/data_science/data_science_client.rb', line 2615

def create_project(create_project_details, opts = {})
  logger.debug 'Calling operation DataScienceClient#create_project.' if logger

  raise "Missing the required parameter 'create_project_details' when calling create_project." if create_project_details.nil?

  path = '/projects'
  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_project_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataScienceClient#create_project') 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::DataScience::Models::Project'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_schedule(create_schedule_details, opts = {}) ⇒ Response

Note:

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

Creates a new Schedule.

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 it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:



2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
 
# File 'lib/oci/data_science/data_science_client.rb', line 2674

def create_schedule(create_schedule_details, opts = {})
  logger.debug 'Calling operation DataScienceClient#create_schedule.' if logger

  raise "Missing the required parameter 'create_schedule_details' when calling create_schedule." if create_schedule_details.nil?

  path = '/schedules'
  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_schedule_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataScienceClient#create_schedule') 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::DataScience::Models::Schedule'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_step_artifact(pipeline_id, step_name, step_artifact, opts = {}) ⇒ Response

Note:

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

Upload the artifact for a step in the pipeline.

Parameters:

  • pipeline_id (String) —

    The OCID of the pipeline.

  • step_name (String) —

    Unique Step identifier in a pipeline.

  • step_artifact (String, IO) —

    The step artifact to upload.

  • 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

  • :content_length (Integer) —

    The content length of the body.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :content_disposition (String) —

    This header allows you to specify a filename during upload. This file name is used to dispose of the file contents while downloading the file. If this optional field is not populated in the request, then the OCID of the model is used for the file name when downloading. Example: {\"Content-Disposition\": \"attachment\" \"filename\"=\"model.tar.gz\" \"Content-Length\": \"2347\" \"Content-Type\": \"application/gzip\"}

Returns:

  • (Response) —

    A Response object with data of type nil



2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
 
# File 'lib/oci/data_science/data_science_client.rb', line 2743

def create_step_artifact(pipeline_id, step_name, step_artifact, opts = {})
  logger.debug 'Calling operation DataScienceClient#create_step_artifact.' if logger

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

  path = '/pipelines/{pipelineId}/steps/{stepName}/artifact'.sub('{pipelineId}', pipeline_id.to_s).sub('{stepName}', step_name.to_s)
  operation_signing_strategy = :exclude_body

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'content-length'] = opts[:content_length] if opts[:content_length]
  header_params[:'content-disposition'] = opts[:content_disposition] if opts[:content_disposition]
  # rubocop:enable Style/NegatedIf
  header_params[:'content-type'] ||= 'application/octet-stream'
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(step_artifact)

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

#deactivate_model(model_id, opts = {}) ⇒ Response

Note:

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

Deactivates the model.

Parameters:

  • model_id (String) —

    The OCID of the model.

  • 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 the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:



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
 
# File 'lib/oci/data_science/data_science_client.rb', line 2810

def deactivate_model(model_id, opts = {})
  logger.debug 'Calling operation DataScienceClient#deactivate_model.' if logger

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

  path = '/models/{modelId}/actions/deactivate'.sub('{modelId}', model_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: 'DataScienceClient#deactivate_model') 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::DataScience::Models::Model'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#deactivate_model_deployment(model_deployment_id, opts = {}) ⇒ Response

Note:

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

Deactivates the model deployment.

Parameters:

  • model_deployment_id (String) —

    The OCID of the model deployment.

  • 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 the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
 
# File 'lib/oci/data_science/data_science_client.rb', line 2872

def deactivate_model_deployment(model_deployment_id, opts = {})
  logger.debug 'Calling operation DataScienceClient#deactivate_model_deployment.' if logger

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

  path = '/modelDeployments/{modelDeploymentId}/actions/deactivate'.sub('{modelDeploymentId}', model_deployment_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: 'DataScienceClient#deactivate_model_deployment') 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

#deactivate_notebook_session(notebook_session_id, opts = {}) ⇒ Response

Note:

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

Deactivates the notebook session.

Parameters:

  • notebook_session_id (String) —

    The OCID of the notebook session.

  • 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 the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
 
# File 'lib/oci/data_science/data_science_client.rb', line 2933

def deactivate_notebook_session(notebook_session_id, opts = {})
  logger.debug 'Calling operation DataScienceClient#deactivate_notebook_session.' if logger

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

  path = '/notebookSessions/{notebookSessionId}/actions/deactivate'.sub('{notebookSessionId}', notebook_session_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: 'DataScienceClient#deactivate_notebook_session') 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

#deactivate_schedule(schedule_id, opts = {}) ⇒ Response

Note:

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

Deactivate schedule.

Parameters:

  • schedule_id (String) —

    unique Schedule 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) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



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
 
# File 'lib/oci/data_science/data_science_client.rb', line 2996

def deactivate_schedule(schedule_id, opts = {})
  logger.debug 'Calling operation DataScienceClient#deactivate_schedule.' if logger

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

  path = '/schedules/{scheduleId}/actions/deactivate'.sub('{scheduleId}', schedule_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]
  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: 'DataScienceClient#deactivate_schedule') 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

#delete_data_science_private_endpoint(data_science_private_endpoint_id, opts = {}) ⇒ Response

Note:

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

Deletes a private endpoint using privateEndpointId.

Parameters:

  • data_science_private_endpoint_id (String) —

    The unique ID for a Data Science private endpoint.

  • 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) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
 
# File 'lib/oci/data_science/data_science_client.rb', line 3061

def delete_data_science_private_endpoint(data_science_private_endpoint_id, opts = {})
  logger.debug 'Calling operation DataScienceClient#delete_data_science_private_endpoint.' if logger

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

  path = '/dataSciencePrivateEndpoints/{dataSciencePrivateEndpointId}'.sub('{dataSciencePrivateEndpointId}', data_science_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[:'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: 'DataScienceClient#delete_data_science_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_job(job_id, opts = {}) ⇒ Response

Note:

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

Deletes a job.

Parameters:

  • job_id (String) —

    The OCID of the job.

  • 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 the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :delete_related_job_runs (BOOLEAN) —

    Delete all JobRuns associated with this job. (default to false)

Returns:

  • (Response) —

    A Response object with data of type nil



3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
 
# File 'lib/oci/data_science/data_science_client.rb', line 3123

def delete_job(job_id, opts = {})
  logger.debug 'Calling operation DataScienceClient#delete_job.' if logger

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

  path = '/jobs/{jobId}'.sub('{jobId}', job_id.to_s)
  operation_signing_strategy = :standard

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

  # 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: 'DataScienceClient#delete_job') 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_job_run(job_run_id, opts = {}) ⇒ Response

Note:

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

Deletes a job run.

Parameters:

  • job_run_id (String) —

    The OCID of the job run.

  • 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 the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
 
# File 'lib/oci/data_science/data_science_client.rb', line 3185

def delete_job_run(job_run_id, opts = {})
  logger.debug 'Calling operation DataScienceClient#delete_job_run.' if logger

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

  path = '/jobRuns/{jobRunId}'.sub('{jobRunId}', job_run_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: 'DataScienceClient#delete_job_run') 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_ml_application(ml_application_id, opts = {}) ⇒ Response

Note:

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

Deletes a MlApplication resource by identifier

Parameters:

  • ml_application_id (String) —

    unique MlApplication 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 the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
 
# File 'lib/oci/data_science/data_science_client.rb', line 3246

def delete_ml_application(ml_application_id, opts = {})
  logger.debug 'Calling operation DataScienceClient#delete_ml_application.' if logger

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

  path = '/mlApplications/{mlApplicationId}'.sub('{mlApplicationId}', ml_application_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: 'DataScienceClient#delete_ml_application') 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_ml_application_implementation(ml_application_implementation_id, opts = {}) ⇒ Response

Note:

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

Deletes a MlApplicationImplementation resource by identifier

Parameters:

  • ml_application_implementation_id (String) —

    unique MlApplicationImplementation 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 the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



3307
3308
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
 
# File 'lib/oci/data_science/data_science_client.rb', line 3307

def delete_ml_application_implementation(ml_application_implementation_id, opts = {})
  logger.debug 'Calling operation DataScienceClient#delete_ml_application_implementation.' if logger

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

  path = '/mlApplicationImplementations/{mlApplicationImplementationId}'.sub('{mlApplicationImplementationId}', ml_application_implementation_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: 'DataScienceClient#delete_ml_application_implementation') 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_ml_application_instance(ml_application_instance_id, opts = {}) ⇒ Response

Note:

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

Deletes a MlApplicationInstance resource by identifier

Parameters:

  • ml_application_instance_id (String) —

    unique MlApplicationInstance 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 the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
 
# File 'lib/oci/data_science/data_science_client.rb', line 3368

def delete_ml_application_instance(ml_application_instance_id, opts = {})
  logger.debug 'Calling operation DataScienceClient#delete_ml_application_instance.' if logger

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

  path = '/mlApplicationInstances/{mlApplicationInstanceId}'.sub('{mlApplicationInstanceId}', ml_application_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[:'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: 'DataScienceClient#delete_ml_application_instance') 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_model(model_id, opts = {}) ⇒ Response

Note:

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

Deletes the specified model.

Parameters:

  • model_id (String) —

    The OCID of the model.

  • 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 the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
 
# File 'lib/oci/data_science/data_science_client.rb', line 3429

def delete_model(model_id, opts = {})
  logger.debug 'Calling operation DataScienceClient#delete_model.' if logger

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

  path = '/models/{modelId}'.sub('{modelId}', model_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: 'DataScienceClient#delete_model') 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_model_custom_metadatum_artifact(model_id, metadatum_key_name, opts = {}) ⇒ Response

Note:

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

Deletes model custom metadata artifact for specified model metadata key.

Parameters:

  • model_id (String) —

    The OCID of the model.

  • metadatum_key_name (String) —

    The name of the model metadatum in the metadata.

  • 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) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
 
# File 'lib/oci/data_science/data_science_client.rb', line 3491

def delete_model_custom_metadatum_artifact(model_id, metadatum_key_name, opts = {})
  logger.debug 'Calling operation DataScienceClient#delete_model_custom_metadatum_artifact.' if logger

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

  path = '/models/{modelId}/customMetadata/{metadatumKeyName}/artifact'.sub('{modelId}', model_id.to_s).sub('{metadatumKeyName}', metadatum_key_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[:'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: 'DataScienceClient#delete_model_custom_metadatum_artifact') 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_model_defined_metadatum_artifact(model_id, metadatum_key_name, opts = {}) ⇒ Response

Note:

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

Deletes model defined metadata artifact for specified model metadata key.

Parameters:

  • model_id (String) —

    The OCID of the model.

  • metadatum_key_name (String) —

    The name of the model metadatum in the metadata.

  • 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) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
 
# File 'lib/oci/data_science/data_science_client.rb', line 3555

def delete_model_defined_metadatum_artifact(model_id, metadatum_key_name, opts = {})
  logger.debug 'Calling operation DataScienceClient#delete_model_defined_metadatum_artifact.' if logger

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

  path = '/models/{modelId}/definedMetadata/{metadatumKeyName}/artifact'.sub('{modelId}', model_id.to_s).sub('{metadatumKeyName}', metadatum_key_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[:'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: 'DataScienceClient#delete_model_defined_metadatum_artifact') 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_model_deployment(model_deployment_id, opts = {}) ⇒ Response

Note:

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

Deletes the specified model deployment. Any unsaved work in this model deployment is lost.

Parameters:

  • model_deployment_id (String) —

    The OCID of the model deployment.

  • 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 the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
 
# File 'lib/oci/data_science/data_science_client.rb', line 3618

def delete_model_deployment(model_deployment_id, opts = {})
  logger.debug 'Calling operation DataScienceClient#delete_model_deployment.' if logger

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

  path = '/modelDeployments/{modelDeploymentId}'.sub('{modelDeploymentId}', model_deployment_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: 'DataScienceClient#delete_model_deployment') 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_model_version_set(model_version_set_id, opts = {}) ⇒ Response

Note:

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

Deletes the specified modelVersionSet.

Parameters:

  • model_version_set_id (String) —

    The OCID of the model version set.

  • 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_delete_related_models (BOOLEAN) —

    By default, this parameter is false. A model version set can only be deleted if all the models associate with it are already in the DELETED state. You can optionally specify the deleteRelatedModels boolean query parameters to true, which deletes all associated models for you. (default to false)

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
 
# File 'lib/oci/data_science/data_science_client.rb', line 3682

def delete_model_version_set(model_version_set_id, opts = {})
  logger.debug 'Calling operation DataScienceClient#delete_model_version_set.' if logger

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

  path = '/modelVersionSets/{modelVersionSetId}'.sub('{modelVersionSetId}', model_version_set_id.to_s)
  operation_signing_strategy = :standard

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

  # 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: 'DataScienceClient#delete_model_version_set') 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_notebook_session(notebook_session_id, opts = {}) ⇒ Response

Note:

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

Deletes the specified notebook session. Any unsaved work in this notebook session are lost.

Parameters:

  • notebook_session_id (String) —

    The OCID of the notebook session.

  • 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 the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



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
3779
3780
 
# File 'lib/oci/data_science/data_science_client.rb', line 3744

def delete_notebook_session(notebook_session_id, opts = {})
  logger.debug 'Calling operation DataScienceClient#delete_notebook_session.' if logger

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

  path = '/notebookSessions/{notebookSessionId}'.sub('{notebookSessionId}', notebook_session_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: 'DataScienceClient#delete_notebook_session') 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_pipeline(pipeline_id, opts = {}) ⇒ Response

Note:

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

Deletes a Pipeline resource by identifier.

Parameters:

  • pipeline_id (String) —

    The OCID of the pipeline.

  • 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

  • :delete_related_pipeline_runs (BOOLEAN) —

    A boolean value to specify whether to delete related PipelineRuns or not.

  • :delete_related_job_runs (BOOLEAN) —

    A boolean value to specify whether to delete related jobRuns or not.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



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/data_science/data_science_client.rb', line 3807

def delete_pipeline(pipeline_id, opts = {})
  logger.debug 'Calling operation DataScienceClient#delete_pipeline.' if logger

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

  path = '/pipelines/{pipelineId}'.sub('{pipelineId}', pipeline_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:deleteRelatedPipelineRuns] = opts[:delete_related_pipeline_runs] if !opts[:delete_related_pipeline_runs].nil?
  query_params[:deleteRelatedJobRuns] = opts[:delete_related_job_runs] if !opts[:delete_related_job_runs].nil?

  # 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: 'DataScienceClient#delete_pipeline') 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_pipeline_run(pipeline_run_id, opts = {}) ⇒ Response

Note:

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

Deletes a PipelineRun resource by identifier.

Parameters:

  • pipeline_run_id (String) —

    The OCID of the pipeline run.

  • 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

  • :delete_related_job_runs (BOOLEAN) —

    A boolean value to specify whether to delete related jobRuns or not.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



3871
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
 
# File 'lib/oci/data_science/data_science_client.rb', line 3871

def delete_pipeline_run(pipeline_run_id, opts = {})
  logger.debug 'Calling operation DataScienceClient#delete_pipeline_run.' if logger

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

  path = '/pipelineRuns/{pipelineRunId}'.sub('{pipelineRunId}', pipeline_run_id.to_s)
  operation_signing_strategy = :standard

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

  # 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: 'DataScienceClient#delete_pipeline_run') 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_project(project_id, opts = {}) ⇒ Response

Note:

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

Deletes the specified project. This operation fails unless all associated resources (notebook sessions or models) are in a DELETED state. You must delete all associated resources before deleting a project.

Parameters:

  • project_id (String) —

    The OCID of the project.

  • 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 the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



3933
3934
3935
3936
3937
3938
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
 
# File 'lib/oci/data_science/data_science_client.rb', line 3933

def delete_project(project_id, opts = {})
  logger.debug 'Calling operation DataScienceClient#delete_project.' if logger

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

  path = '/projects/{projectId}'.sub('{projectId}', project_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: 'DataScienceClient#delete_project') 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_schedule(schedule_id, opts = {}) ⇒ Response

Note:

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

Deletes a Schedule resource by identifier

Parameters:

  • schedule_id (String) —

    unique Schedule 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 the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
 
# File 'lib/oci/data_science/data_science_client.rb', line 3994

def delete_schedule(schedule_id, opts = {})
  logger.debug 'Calling operation DataScienceClient#delete_schedule.' if logger

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

  path = '/schedules/{scheduleId}'.sub('{scheduleId}', schedule_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: 'DataScienceClient#delete_schedule') 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

#disable_ml_application_instance_view_trigger(disable_ml_application_instance_view_trigger_details, ml_application_instance_view_id, opts = {}) ⇒ Response

Note:

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

Disable trigger of given name for given ML Application Instance View flow

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 the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
 
# File 'lib/oci/data_science/data_science_client.rb', line 4058

def disable_ml_application_instance_view_trigger(disable_ml_application_instance_view_trigger_details, ml_application_instance_view_id, opts = {})
  logger.debug 'Calling operation DataScienceClient#disable_ml_application_instance_view_trigger.' if logger

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

  path = '/mlApplicationInstanceViews/{mlApplicationInstanceViewId}/actions/disableTrigger'.sub('{mlApplicationInstanceViewId}', ml_application_instance_view_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(disable_ml_application_instance_view_trigger_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataScienceClient#disable_ml_application_instance_view_trigger') 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::DataScience::Models::MlApplicationInstanceView'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#enable_ml_application_instance_view_trigger(enable_ml_application_instance_view_trigger_details, ml_application_instance_view_id, opts = {}) ⇒ Response

Note:

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

Enable trigger of given name for given ML Application Instance View flow

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 the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
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
 
# File 'lib/oci/data_science/data_science_client.rb', line 4126

def enable_ml_application_instance_view_trigger(enable_ml_application_instance_view_trigger_details, ml_application_instance_view_id, opts = {})
  logger.debug 'Calling operation DataScienceClient#enable_ml_application_instance_view_trigger.' if logger

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

  path = '/mlApplicationInstanceViews/{mlApplicationInstanceViewId}/actions/enableTrigger'.sub('{mlApplicationInstanceViewId}', ml_application_instance_view_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(enable_ml_application_instance_view_trigger_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataScienceClient#enable_ml_application_instance_view_trigger') 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::DataScience::Models::MlApplicationInstanceView'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#export_model_artifact(model_id, export_model_artifact_details, opts = {}) ⇒ Response

Note:

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

Export model artifact from source to the service bucket

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) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
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
 
# File 'lib/oci/data_science/data_science_client.rb', line 4194

def export_model_artifact(model_id, export_model_artifact_details, opts = {})
  logger.debug 'Calling operation DataScienceClient#export_model_artifact.' if logger

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

  path = '/models/{modelId}/actions/exportArtifact'.sub('{modelId}', model_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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(export_model_artifact_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataScienceClient#export_model_artifact') 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_data_science_private_endpoint(data_science_private_endpoint_id, opts = {}) ⇒ Response

Note:

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

Retrieves an private endpoint using a privateEndpointId.

Parameters:

  • data_science_private_endpoint_id (String) —

    The unique ID for a Data Science private endpoint.

  • 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) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:



4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
 
# File 'lib/oci/data_science/data_science_client.rb', line 4254

def get_data_science_private_endpoint(data_science_private_endpoint_id, opts = {})
  logger.debug 'Calling operation DataScienceClient#get_data_science_private_endpoint.' if logger

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

  path = '/dataSciencePrivateEndpoints/{dataSciencePrivateEndpointId}'.sub('{dataSciencePrivateEndpointId}', data_science_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: 'DataScienceClient#get_data_science_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::DataScience::Models::DataSciencePrivateEndpoint'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_job(job_id, opts = {}) ⇒ Response

Note:

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

Gets a job.

Parameters:

  • job_id (String) —

    The OCID of the job.

  • 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) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type Job



4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
 
# File 'lib/oci/data_science/data_science_client.rb', line 4309

def get_job(job_id, opts = {})
  logger.debug 'Calling operation DataScienceClient#get_job.' if logger

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

  path = '/jobs/{jobId}'.sub('{jobId}', job_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: 'DataScienceClient#get_job') 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::DataScience::Models::Job'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_job_artifact_content(job_id, opts = {}, &block) ⇒ Response

Note:

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

Downloads job artifact content for specified job.

Parameters:

  • job_id (String) —

    The OCID of the job.

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

    the optional parameters

  • [Block] (Hash) —

    a customizable set of options

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) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :range (String) —

    Optional byte range to fetch, as described in RFC 7233, section 2.1. Note that only a single range of bytes is supported.

  • :response_target (String, IO) —

    Streaming http body into a file (specified by file name or File object) or IO object if the block is not given

Returns:

  • (Response) —

    A Response object with data of type String if response_target and block are not given, otherwise with nil data



4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
 
# File 'lib/oci/data_science/data_science_client.rb', line 4369

def get_job_artifact_content(job_id, opts = {}, &block)
  logger.debug 'Calling operation DataScienceClient#get_job_artifact_content.' if logger

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

  path = '/jobs/{jobId}/artifact/content'.sub('{jobId}', job_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = opts[:accept] if opts[:accept]
  header_params[:accept] ||= 'application/octet-stream'
  header_params[:'accept-encoding'] = opts[:accept_encoding] if opts[:accept_encoding]
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:range] = opts[:range] if opts[:range]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataScienceClient#get_job_artifact_content') do
    if !block.nil?
      @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: 'Stream',
        &block
      )
    elsif opts[:response_target]
      if opts[:response_target].respond_to? :write
        @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: 'Stream',
          &proc { |chunk, _response| opts[:response_target].write(chunk) }
        )
      elsif opts[:response_target].is_a?(String)
        File.open(opts[:response_target], 'wb') do |output|
          return @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: 'Stream',
            &proc { |chunk, _response| output.write(chunk) }
          )
        end
      end
    else
      @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: 'String'
      )
    end
  end
  # rubocop:enable Metrics/BlockLength
end

#get_job_run(job_run_id, opts = {}) ⇒ Response

Note:

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

Gets a job run.

Parameters:

  • job_run_id (String) —

    The OCID of the job run.

  • 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) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:



4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
 
# File 'lib/oci/data_science/data_science_client.rb', line 4469

def get_job_run(job_run_id, opts = {})
  logger.debug 'Calling operation DataScienceClient#get_job_run.' if logger

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

  path = '/jobRuns/{jobRunId}'.sub('{jobRunId}', job_run_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: 'DataScienceClient#get_job_run') 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::DataScience::Models::JobRun'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_ml_application(ml_application_id, opts = {}) ⇒ Response

Note:

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

Gets a MlApplication by identifier

Parameters:

  • ml_application_id (String) —

    unique MlApplication 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) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:



4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
 
# File 'lib/oci/data_science/data_science_client.rb', line 4524

def get_ml_application(ml_application_id, opts = {})
  logger.debug 'Calling operation DataScienceClient#get_ml_application.' if logger

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

  path = '/mlApplications/{mlApplicationId}'.sub('{mlApplicationId}', ml_application_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: 'DataScienceClient#get_ml_application') 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::DataScience::Models::MlApplication'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_ml_application_historical_package_content(ml_application_implementation_version_id, opts = {}, &block) ⇒ Response

Note:

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

Retrieves ML Application package for MlApplicationImplementationVersion with given id.

Parameters:

  • ml_application_implementation_version_id (String) —

    unique MlApplicationImplementationVersion identifier

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

    the optional parameters

  • [Block] (Hash) —

    a customizable set of options

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) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :response_target (String, IO) —

    Streaming http body into a file (specified by file name or File object) or IO object if the block is not given

Returns:

  • (Response) —

    A Response object with data of type String if response_target and block are not given, otherwise with nil data



4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
 
# File 'lib/oci/data_science/data_science_client.rb', line 4581

def get_ml_application_historical_package_content(ml_application_implementation_version_id, opts = {}, &block)
  logger.debug 'Calling operation DataScienceClient#get_ml_application_historical_package_content.' if logger

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

  path = '/mlApplicationImplementationVersions/{mlApplicationImplementationVersionId}/mlApplicationHistoricalPackage/content'.sub('{mlApplicationImplementationVersionId}', ml_application_implementation_version_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = opts[:accept] if opts[:accept]
  header_params[:accept] ||= 'application/octet-stream'
  header_params[:'accept-encoding'] = opts[:accept_encoding] if opts[:accept_encoding]
  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: 'DataScienceClient#get_ml_application_historical_package_content') do
    if !block.nil?
      @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: 'Stream',
        &block
      )
    elsif opts[:response_target]
      if opts[:response_target].respond_to? :write
        @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: 'Stream',
          &proc { |chunk, _response| opts[:response_target].write(chunk) }
        )
      elsif opts[:response_target].is_a?(String)
        File.open(opts[:response_target], 'wb') do |output|
          return @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: 'Stream',
            &proc { |chunk, _response| output.write(chunk) }
          )
        end
      end
    else
      @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: 'String'
      )
    end
  end
  # rubocop:enable Metrics/BlockLength
end

#get_ml_application_implementation(ml_application_implementation_id, opts = {}) ⇒ Response

Note:

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

Gets a MlApplicationImplementation by identifier

Parameters:

  • ml_application_implementation_id (String) —

    unique MlApplicationImplementation 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) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:



4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
 
# File 'lib/oci/data_science/data_science_client.rb', line 4680

def get_ml_application_implementation(ml_application_implementation_id, opts = {})
  logger.debug 'Calling operation DataScienceClient#get_ml_application_implementation.' if logger

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

  path = '/mlApplicationImplementations/{mlApplicationImplementationId}'.sub('{mlApplicationImplementationId}', ml_application_implementation_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: 'DataScienceClient#get_ml_application_implementation') 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::DataScience::Models::MlApplicationImplementation'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_ml_application_implementation_version(ml_application_implementation_version_id, opts = {}) ⇒ Response

Note:

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

Gets a MlApplicationImplementationVersion by identifier

Parameters:

  • ml_application_implementation_version_id (String) —

    unique MlApplicationImplementationVersion 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) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:



4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
 
# File 'lib/oci/data_science/data_science_client.rb', line 4735

def get_ml_application_implementation_version(ml_application_implementation_version_id, opts = {})
  logger.debug 'Calling operation DataScienceClient#get_ml_application_implementation_version.' if logger

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

  path = '/mlApplicationImplementationVersions/{mlApplicationImplementationVersionId}'.sub('{mlApplicationImplementationVersionId}', ml_application_implementation_version_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: 'DataScienceClient#get_ml_application_implementation_version') 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::DataScience::Models::MlApplicationImplementationVersion'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_ml_application_instance(ml_application_instance_id, opts = {}) ⇒ Response

Note:

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

Gets a MlApplicationInstance by identifier

Parameters:

  • ml_application_instance_id (String) —

    unique MlApplicationInstance 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) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:



4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
 
# File 'lib/oci/data_science/data_science_client.rb', line 4790

def get_ml_application_instance(ml_application_instance_id, opts = {})
  logger.debug 'Calling operation DataScienceClient#get_ml_application_instance.' if logger

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

  path = '/mlApplicationInstances/{mlApplicationInstanceId}'.sub('{mlApplicationInstanceId}', ml_application_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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataScienceClient#get_ml_application_instance') 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::DataScience::Models::MlApplicationInstance'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_ml_application_instance_view(ml_application_instance_view_id, opts = {}) ⇒ Response

Note:

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

Gets a MlApplicationInstanceView by identifier

Parameters:

  • ml_application_instance_view_id (String) —

    unique MlApplicationInstanceView 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) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:



4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
 
# File 'lib/oci/data_science/data_science_client.rb', line 4845

def get_ml_application_instance_view(ml_application_instance_view_id, opts = {})
  logger.debug 'Calling operation DataScienceClient#get_ml_application_instance_view.' if logger

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

  path = '/mlApplicationInstanceViews/{mlApplicationInstanceViewId}'.sub('{mlApplicationInstanceViewId}', ml_application_instance_view_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: 'DataScienceClient#get_ml_application_instance_view') 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::DataScience::Models::MlApplicationInstanceView'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_ml_application_package_content(ml_application_implementation_id, opts = {}, &block) ⇒ Response

Note:

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

Retrieves last ML Application package uploaded for given ML Application Implementation

Parameters:

  • ml_application_implementation_id (String) —

    unique MlApplicationImplementation identifier

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

    the optional parameters

  • [Block] (Hash) —

    a customizable set of options

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) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :response_target (String, IO) —

    Streaming http body into a file (specified by file name or File object) or IO object if the block is not given

Returns:

  • (Response) —

    A Response object with data of type String if response_target and block are not given, otherwise with nil data



4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
 
# File 'lib/oci/data_science/data_science_client.rb', line 4902

def get_ml_application_package_content(ml_application_implementation_id, opts = {}, &block)
  logger.debug 'Calling operation DataScienceClient#get_ml_application_package_content.' if logger

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

  path = '/mlApplicationImplementations/{mlApplicationImplementationId}/mlApplicationPackage/content'.sub('{mlApplicationImplementationId}', ml_application_implementation_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = opts[:accept] if opts[:accept]
  header_params[:accept] ||= 'application/octet-stream'
  header_params[:'accept-encoding'] = opts[:accept_encoding] if opts[:accept_encoding]
  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: 'DataScienceClient#get_ml_application_package_content') do
    if !block.nil?
      @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: 'Stream',
        &block
      )
    elsif opts[:response_target]
      if opts[:response_target].respond_to? :write
        @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: 'Stream',
          &proc { |chunk, _response| opts[:response_target].write(chunk) }
        )
      elsif opts[:response_target].is_a?(String)
        File.open(opts[:response_target], 'wb') do |output|
          return @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: 'Stream',
            &proc { |chunk, _response| output.write(chunk) }
          )
        end
      end
    else
      @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: 'String'
      )
    end
  end
  # rubocop:enable Metrics/BlockLength
end

#get_model(model_id, opts = {}) ⇒ Response

Note:

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

Gets the specified model's information.

Parameters:

  • model_id (String) —

    The OCID of the model.

  • 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) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:



5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
 
# File 'lib/oci/data_science/data_science_client.rb', line 5001

def get_model(model_id, opts = {})
  logger.debug 'Calling operation DataScienceClient#get_model.' if logger

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

  path = '/models/{modelId}'.sub('{modelId}', model_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: 'DataScienceClient#get_model') 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::DataScience::Models::Model'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_model_artifact_content(model_id, opts = {}, &block) ⇒ Response

Note:

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

Downloads model artifact content for specified model.

Parameters:

  • model_id (String) —

    The OCID of the model.

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

    the optional parameters

  • [Block] (Hash) —

    a customizable set of options

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) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :range (String) —

    Optional byte range to fetch, as described in RFC 7233, section 2.1. Note that only a single range of bytes is supported.

  • :response_target (String, IO) —

    Streaming http body into a file (specified by file name or File object) or IO object if the block is not given

Returns:

  • (Response) —

    A Response object with data of type String if response_target and block are not given, otherwise with nil data



5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
 
# File 'lib/oci/data_science/data_science_client.rb', line 5061

def get_model_artifact_content(model_id, opts = {}, &block)
  logger.debug 'Calling operation DataScienceClient#get_model_artifact_content.' if logger

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

  path = '/models/{modelId}/artifact/content'.sub('{modelId}', model_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = opts[:accept] if opts[:accept]
  header_params[:accept] ||= 'application/octet-stream'
  header_params[:'accept-encoding'] = opts[:accept_encoding] if opts[:accept_encoding]
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:range] = opts[:range] if opts[:range]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataScienceClient#get_model_artifact_content') do
    if !block.nil?
      @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: 'Stream',
        &block
      )
    elsif opts[:response_target]
      if opts[:response_target].respond_to? :write
        @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: 'Stream',
          &proc { |chunk, _response| opts[:response_target].write(chunk) }
        )
      elsif opts[:response_target].is_a?(String)
        File.open(opts[:response_target], 'wb') do |output|
          return @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: 'Stream',
            &proc { |chunk, _response| output.write(chunk) }
          )
        end
      end
    else
      @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: 'String'
      )
    end
  end
  # rubocop:enable Metrics/BlockLength
end

#get_model_custom_metadatum_artifact_content(model_id, metadatum_key_name, opts = {}, &block) ⇒ Response

Note:

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

Downloads model custom metadata artifact content for specified model metadata key.

Parameters:

  • model_id (String) —

    The OCID of the model.

  • metadatum_key_name (String) —

    The name of the model metadatum in the metadata.

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

    the optional parameters

  • [Block] (Hash) —

    a customizable set of options

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) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :range (String) —

    Optional byte range to fetch, as described in RFC 7233, section 2.1. Note that only a single range of bytes is supported.

  • :response_target (String, IO) —

    Streaming http body into a file (specified by file name or File object) or IO object if the block is not given

Returns:

  • (Response) —

    A Response object with data of type String if response_target and block are not given, otherwise with nil data



5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
 
# File 'lib/oci/data_science/data_science_client.rb', line 5167

def get_model_custom_metadatum_artifact_content(model_id, metadatum_key_name, opts = {}, &block)
  logger.debug 'Calling operation DataScienceClient#get_model_custom_metadatum_artifact_content.' if logger

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

  path = '/models/{modelId}/customMetadata/{metadatumKeyName}/artifact/content'.sub('{modelId}', model_id.to_s).sub('{metadatumKeyName}', metadatum_key_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = opts[:accept] if opts[:accept]
  header_params[:accept] ||= 'application/octet-stream'
  header_params[:'accept-encoding'] = opts[:accept_encoding] if opts[:accept_encoding]
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:range] = opts[:range] if opts[:range]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataScienceClient#get_model_custom_metadatum_artifact_content') do
    if !block.nil?
      @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: 'Stream',
        &block
      )
    elsif opts[:response_target]
      if opts[:response_target].respond_to? :write
        @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: 'Stream',
          &proc { |chunk, _response| opts[:response_target].write(chunk) }
        )
      elsif opts[:response_target].is_a?(String)
        File.open(opts[:response_target], 'wb') do |output|
          return @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: 'Stream',
            &proc { |chunk, _response| output.write(chunk) }
          )
        end
      end
    else
      @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: 'String'
      )
    end
  end
  # rubocop:enable Metrics/BlockLength
end

#get_model_defined_metadatum_artifact_content(model_id, metadatum_key_name, opts = {}, &block) ⇒ Response

Note:

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

Downloads model defined metadata artifact content for specified model metadata key.

Parameters:

  • model_id (String) —

    The OCID of the model.

  • metadatum_key_name (String) —

    The name of the model metadatum in the metadata.

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

    the optional parameters

  • [Block] (Hash) —

    a customizable set of options

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) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :range (String) —

    Optional byte range to fetch, as described in RFC 7233, section 2.1. Note that only a single range of bytes is supported.

  • :response_target (String, IO) —

    Streaming http body into a file (specified by file name or File object) or IO object if the block is not given

Returns:

  • (Response) —

    A Response object with data of type String if response_target and block are not given, otherwise with nil data



5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
 
# File 'lib/oci/data_science/data_science_client.rb', line 5275

def get_model_defined_metadatum_artifact_content(model_id, metadatum_key_name, opts = {}, &block)
  logger.debug 'Calling operation DataScienceClient#get_model_defined_metadatum_artifact_content.' if logger

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

  path = '/models/{modelId}/definedMetadata/{metadatumKeyName}/artifact/content'.sub('{modelId}', model_id.to_s).sub('{metadatumKeyName}', metadatum_key_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = opts[:accept] if opts[:accept]
  header_params[:accept] ||= 'application/octet-stream'
  header_params[:'accept-encoding'] = opts[:accept_encoding] if opts[:accept_encoding]
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:range] = opts[:range] if opts[:range]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataScienceClient#get_model_defined_metadatum_artifact_content') do
    if !block.nil?
      @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: 'Stream',
        &block
      )
    elsif opts[:response_target]
      if opts[:response_target].respond_to? :write
        @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: 'Stream',
          &proc { |chunk, _response| opts[:response_target].write(chunk) }
        )
      elsif opts[:response_target].is_a?(String)
        File.open(opts[:response_target], 'wb') do |output|
          return @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: 'Stream',
            &proc { |chunk, _response| output.write(chunk) }
          )
        end
      end
    else
      @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: 'String'
      )
    end
  end
  # rubocop:enable Metrics/BlockLength
end

#get_model_deployment(model_deployment_id, opts = {}) ⇒ Response

Note:

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

Retrieves the model deployment for the specified modelDeploymentId.

Parameters:

  • model_deployment_id (String) —

    The OCID of the model deployment.

  • 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) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:



5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
 
# File 'lib/oci/data_science/data_science_client.rb', line 5377

def get_model_deployment(model_deployment_id, opts = {})
  logger.debug 'Calling operation DataScienceClient#get_model_deployment.' if logger

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

  path = '/modelDeployments/{modelDeploymentId}'.sub('{modelDeploymentId}', model_deployment_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: 'DataScienceClient#get_model_deployment') 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::DataScience::Models::ModelDeployment'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_model_provenance(model_id, opts = {}) ⇒ Response

Note:

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

Gets provenance information for specified model.

Parameters:

  • model_id (String) —

    The OCID of the model.

  • 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) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:



5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
 
# File 'lib/oci/data_science/data_science_client.rb', line 5432

def get_model_provenance(model_id, opts = {})
  logger.debug 'Calling operation DataScienceClient#get_model_provenance.' if logger

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

  path = '/models/{modelId}/provenance'.sub('{modelId}', model_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: 'DataScienceClient#get_model_provenance') 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::DataScience::Models::ModelProvenance'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_model_version_set(model_version_set_id, opts = {}) ⇒ Response

Note:

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

Gets the specified model version set information.

Parameters:

  • model_version_set_id (String) —

    The OCID of the model version set.

  • 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) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:



5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
 
# File 'lib/oci/data_science/data_science_client.rb', line 5487

def get_model_version_set(model_version_set_id, opts = {})
  logger.debug 'Calling operation DataScienceClient#get_model_version_set.' if logger

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

  path = '/modelVersionSets/{modelVersionSetId}'.sub('{modelVersionSetId}', model_version_set_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: 'DataScienceClient#get_model_version_set') 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::DataScience::Models::ModelVersionSet'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_notebook_session(notebook_session_id, opts = {}) ⇒ Response

Note:

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

Gets the specified notebook session's information.

Parameters:

  • notebook_session_id (String) —

    The OCID of the notebook session.

  • 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) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:



5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
 
# File 'lib/oci/data_science/data_science_client.rb', line 5542

def get_notebook_session(notebook_session_id, opts = {})
  logger.debug 'Calling operation DataScienceClient#get_notebook_session.' if logger

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

  path = '/notebookSessions/{notebookSessionId}'.sub('{notebookSessionId}', notebook_session_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: 'DataScienceClient#get_notebook_session') 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::DataScience::Models::NotebookSession'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_pipeline(pipeline_id, opts = {}) ⇒ Response

Note:

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

Gets a Pipeline by identifier.

Parameters:

  • pipeline_id (String) —

    The OCID of the pipeline.

  • 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) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:



5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
 
# File 'lib/oci/data_science/data_science_client.rb', line 5597

def get_pipeline(pipeline_id, opts = {})
  logger.debug 'Calling operation DataScienceClient#get_pipeline.' if logger

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

  path = '/pipelines/{pipelineId}'.sub('{pipelineId}', pipeline_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: 'DataScienceClient#get_pipeline') 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::DataScience::Models::Pipeline'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_pipeline_run(pipeline_run_id, opts = {}) ⇒ Response

Note:

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

Gets a PipelineRun by identifier.

Parameters:

  • pipeline_run_id (String) —

    The OCID of the pipeline run.

  • 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) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:



5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
 
# File 'lib/oci/data_science/data_science_client.rb', line 5652

def get_pipeline_run(pipeline_run_id, opts = {})
  logger.debug 'Calling operation DataScienceClient#get_pipeline_run.' if logger

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

  path = '/pipelineRuns/{pipelineRunId}'.sub('{pipelineRunId}', pipeline_run_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: 'DataScienceClient#get_pipeline_run') 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::DataScience::Models::PipelineRun'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_project(project_id, opts = {}) ⇒ Response

Note:

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

Gets the specified project's information.

Parameters:

  • project_id (String) —

    The OCID of the project.

  • 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) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:



5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
 
# File 'lib/oci/data_science/data_science_client.rb', line 5707

def get_project(project_id, opts = {})
  logger.debug 'Calling operation DataScienceClient#get_project.' if logger

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

  path = '/projects/{projectId}'.sub('{projectId}', project_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: 'DataScienceClient#get_project') 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::DataScience::Models::Project'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_schedule(schedule_id, opts = {}) ⇒ Response

Note:

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

Gets a Schedule by identifier

Parameters:

  • schedule_id (String) —

    unique Schedule 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) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:



5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
 
# File 'lib/oci/data_science/data_science_client.rb', line 5762

def get_schedule(schedule_id, opts = {})
  logger.debug 'Calling operation DataScienceClient#get_schedule.' if logger

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

  path = '/schedules/{scheduleId}'.sub('{scheduleId}', schedule_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: 'DataScienceClient#get_schedule') 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::DataScience::Models::Schedule'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_step_artifact_content(pipeline_id, step_name, opts = {}, &block) ⇒ Response

Note:

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

Download the artifact for a step in the pipeline.

Parameters:

  • pipeline_id (String) —

    The OCID of the pipeline.

  • step_name (String) —

    Unique Step identifier in a pipeline.

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

    the optional parameters

  • [Block] (Hash) —

    a customizable set of options

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) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :range (String) —

    Optional byte range to fetch, as described in RFC 7233, section 2.1. Note that only a single range of bytes is supported.

  • :response_target (String, IO) —

    Streaming http body into a file (specified by file name or File object) or IO object if the block is not given

Returns:

  • (Response) —

    A Response object with data of type String if response_target and block are not given, otherwise with nil data



5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
 
# File 'lib/oci/data_science/data_science_client.rb', line 5823

def get_step_artifact_content(pipeline_id, step_name, opts = {}, &block)
  logger.debug 'Calling operation DataScienceClient#get_step_artifact_content.' if logger

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

  path = '/pipelines/{pipelineId}/steps/{stepName}/artifact/content'.sub('{pipelineId}', pipeline_id.to_s).sub('{stepName}', step_name.to_s)
  operation_signing_strategy = :exclude_body

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = opts[:accept] if opts[:accept]
  header_params[:accept] ||= 'application/octet-stream'
  header_params[:'accept-encoding'] = opts[:accept_encoding] if opts[:accept_encoding]
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:range] = opts[:range] if opts[:range]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataScienceClient#get_step_artifact_content') do
    if !block.nil?
      @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: 'Stream',
        &block
      )
    elsif opts[:response_target]
      if opts[:response_target].respond_to? :write
        @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: 'Stream',
          &proc { |chunk, _response| opts[:response_target].write(chunk) }
        )
      elsif opts[:response_target].is_a?(String)
        File.open(opts[:response_target], 'wb') do |output|
          return @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: 'Stream',
            &proc { |chunk, _response| output.write(chunk) }
          )
        end
      end
    else
      @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: 'String'
      )
    end
  end
  # rubocop:enable Metrics/BlockLength
end

#get_work_request(work_request_id, opts = {}) ⇒ Response

Note:

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

Gets the specified work request's information.

Parameters:

  • work_request_id (String) —

    The OCID of the work request.

  • 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) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:



5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
 
# File 'lib/oci/data_science/data_science_client.rb', line 5925

def get_work_request(work_request_id, opts = {})
  logger.debug 'Calling operation DataScienceClient#get_work_request.' if logger

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

  path = '/workRequests/{workRequestId}'.sub('{workRequestId}', work_request_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: 'DataScienceClient#get_work_request') 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::DataScience::Models::WorkRequest'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#head_job_artifact(job_id, opts = {}) ⇒ Response

Note:

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

Gets job artifact metadata.

Parameters:

  • job_id (String) —

    The OCID of the job.

  • 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) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
 
# File 'lib/oci/data_science/data_science_client.rb', line 5980

def head_job_artifact(job_id, opts = {})
  logger.debug 'Calling operation DataScienceClient#head_job_artifact.' if logger

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

  path = '/jobs/{jobId}/artifact/content'.sub('{jobId}', job_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: 'DataScienceClient#head_job_artifact') do
    @api_client.call_api(
      :HEAD,
      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

#head_model_artifact(model_id, opts = {}) ⇒ Response

Note:

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

Gets model artifact metadata for specified model.

Parameters:

  • model_id (String) —

    The OCID of the model.

  • 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) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
 
# File 'lib/oci/data_science/data_science_client.rb', line 6034

def head_model_artifact(model_id, opts = {})
  logger.debug 'Calling operation DataScienceClient#head_model_artifact.' if logger

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

  path = '/models/{modelId}/artifact/content'.sub('{modelId}', model_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: 'DataScienceClient#head_model_artifact') do
    @api_client.call_api(
      :HEAD,
      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

#head_model_custom_metadatum_artifact(model_id, metadatum_key_name, opts = {}) ⇒ Response

Note:

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

Gets custom metadata artifact metadata for specified model metadata key.

Parameters:

  • model_id (String) —

    The OCID of the model.

  • metadatum_key_name (String) —

    The name of the model metadatum in the metadata.

  • 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) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
 
# File 'lib/oci/data_science/data_science_client.rb', line 6089

def head_model_custom_metadatum_artifact(model_id, metadatum_key_name, opts = {})
  logger.debug 'Calling operation DataScienceClient#head_model_custom_metadatum_artifact.' if logger

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

  path = '/models/{modelId}/customMetadata/{metadatumKeyName}/artifact/content'.sub('{modelId}', model_id.to_s).sub('{metadatumKeyName}', metadatum_key_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[:'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: 'DataScienceClient#head_model_custom_metadatum_artifact') do
    @api_client.call_api(
      :HEAD,
      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

#head_model_defined_metadatum_artifact(model_id, metadatum_key_name, opts = {}) ⇒ Response

Note:

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

Gets defined metadata artifact metadata for specified model metadata key.

Parameters:

  • model_id (String) —

    The OCID of the model.

  • metadatum_key_name (String) —

    The name of the model metadatum in the metadata.

  • 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) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
 
# File 'lib/oci/data_science/data_science_client.rb', line 6146

def head_model_defined_metadatum_artifact(model_id, metadatum_key_name, opts = {})
  logger.debug 'Calling operation DataScienceClient#head_model_defined_metadatum_artifact.' if logger

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

  path = '/models/{modelId}/definedMetadata/{metadatumKeyName}/artifact/content'.sub('{modelId}', model_id.to_s).sub('{metadatumKeyName}', metadatum_key_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[:'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: 'DataScienceClient#head_model_defined_metadatum_artifact') do
    @api_client.call_api(
      :HEAD,
      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

#head_step_artifact(pipeline_id, step_name, opts = {}) ⇒ Response

Note:

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

Get the artifact metadata for a step in the pipeline.

Parameters:

  • pipeline_id (String) —

    The OCID of the pipeline.

  • step_name (String) —

    Unique Step identifier in a pipeline.

  • 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) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
 
# File 'lib/oci/data_science/data_science_client.rb', line 6203

def head_step_artifact(pipeline_id, step_name, opts = {})
  logger.debug 'Calling operation DataScienceClient#head_step_artifact.' if logger

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

  path = '/pipelines/{pipelineId}/steps/{stepName}/artifact/content'.sub('{pipelineId}', pipeline_id.to_s).sub('{stepName}', step_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[:'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: 'DataScienceClient#head_step_artifact') do
    @api_client.call_api(
      :HEAD,
      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

#import_model_artifact(model_id, import_model_artifact_details, opts = {}) ⇒ Response

Note:

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

Import model artifact from service bucket

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) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
 
# File 'lib/oci/data_science/data_science_client.rb', line 6266

def import_model_artifact(model_id, import_model_artifact_details, opts = {})
  logger.debug 'Calling operation DataScienceClient#import_model_artifact.' if logger

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

  path = '/models/{modelId}/actions/importArtifact'.sub('{modelId}', model_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 = @api_client.object_to_http_body(import_model_artifact_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataScienceClient#import_model_artifact') 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_containers(opts = {}) ⇒ Response

Note:

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

List containers.

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

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :is_latest (BOOLEAN) —

    if true, this returns latest version of container. (default to false)

  • :display_name (String) —

    Filter results by its user-friendly name.

  • :container_name (String) —

    Filter results by the container name.

  • :lifecycle_state (String) —

    Filter results by the specified lifecycle state. Must be a valid state for the resource type.

  • :target_workload (String) —

    Filter results by the target workload.

  • :usage_query_param (String) —

    Filter results by the usage.

  • :tag_query_param (String) —

    Filter results by the container version tag.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. 1 is the minimum, 100 is the maximum. See List Pagination.

    Example: 50 (default to 50)

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call.

    See List Pagination.

Returns:



6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
 
# File 'lib/oci/data_science/data_science_client.rb', line 6342

def list_containers(opts = {})
  logger.debug 'Calling operation DataScienceClient#list_containers.' if logger


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

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

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

  path = '/containers'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:isLatest] = opts[:is_latest] if !opts[:is_latest].nil?
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:containerName] = opts[:container_name] if opts[:container_name]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:targetWorkload] = opts[:target_workload] if opts[:target_workload]
  query_params[:usageQueryParam] = opts[:usage_query_param] if opts[:usage_query_param]
  query_params[:tagQueryParam] = opts[:tag_query_param] if opts[:tag_query_param]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # 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: 'DataScienceClient#list_containers') 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::DataScience::Models::ContainerSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Lists all Data Science private endpoints in the specified compartment. The query must include compartmentId. The query can also include one other parameter. If the query doesn't include compartmentId, or includes compartmentId with two or more other parameters, then an error is returned.

Allowed values are: timeCreated

Parameters:

  • compartment_id (String) —

    Filter results by the OCID of the 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

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. 1 is the minimum, 100 is the maximum. See List Pagination.

    Example: 50 (default to 50)

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call.

    See List Pagination.

  • :lifecycle_state (String) —

    The lifecycle state of the private endpoint.

  • :sort_by (String) —

    The field used to sort the results. Multiple fields aren't supported. (default to timeCreated)

  • :sort_order (String) —

    Specifies sort order to use, either ASC (ascending) or DESC (descending).

    Allowed values are: ASC, DESC

  • :display_name (String) —

    Filter results by its user-friendly name.

  • :created_by (String) —

    Filter results by the OCID of the user who created the resource.

  • :data_science_resource_type (String) —

    Resource types in the Data Science service such as notebooks.

Returns:



6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
 
# File 'lib/oci/data_science/data_science_client.rb', line 6441

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

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

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

  if opts[:sort_by] && !%w[timeCreated].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated.'
  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[:data_science_resource_type] && !OCI::DataScience::Models::DATA_SCIENCE_RESOURCE_TYPE_ENUM.include?(opts[:data_science_resource_type])
    raise 'Invalid value for "data_science_resource_type", must be one of the values in OCI::DataScience::Models::DATA_SCIENCE_RESOURCE_TYPE_ENUM.'
  end

  path = '/dataSciencePrivateEndpoints'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  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[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:createdBy] = opts[:created_by] if opts[:created_by]
  query_params[:dataScienceResourceType] = opts[:data_science_resource_type] if opts[:data_science_resource_type]

  # 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: 'DataScienceClient#list_data_science_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: 'Array<OCI::DataScience::Models::DataSciencePrivateEndpointSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

List fast launch capable job configs in the specified compartment.

Parameters:

  • compartment_id (String) —

    Filter results by the OCID of the 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

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. 1 is the minimum, 100 is the maximum. See List Pagination.

    Example: 50 (default to 50)

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call.

    See List Pagination.

Returns:



6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
 
# File 'lib/oci/data_science/data_science_client.rb', line 6532

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

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

  path = '/fastLaunchJobConfigs'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # 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: 'DataScienceClient#list_fast_launch_job_configs') 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::DataScience::Models::FastLaunchJobConfigSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

List out job runs.

Parameters:

  • compartment_id (String) —

    Filter results by the OCID of the 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

  • :id (String) —

    Filter results by OCID. Must be an OCID of the correct type for the resource type.

  • :job_id (String) —

    The OCID of the job.

  • :created_by (String) —

    Filter results by the OCID of the user who created the resource.

  • :display_name (String) —

    Filter results by its user-friendly name.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. 1 is the minimum, 100 is the maximum. See List Pagination.

    Example: 50 (default to 50)

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call.

    See List Pagination.

  • :sort_order (String) —

    Specifies sort order to use, either ASC (ascending) or DESC (descending).

    Allowed values are: ASC, DESC

  • :sort_by (String) —

    Specifies the field to sort by. Accepts only one field. By default, when you sort by timeCreated, the results are shown in descending order. When you sort by displayName, the results are shown in ascending order. Sort order for the displayName field is case sensitive.

    Allowed values are: timeCreated, displayName

  • :lifecycle_state (String) —

    Filter results by the specified lifecycle state. Must be a valid state for the resource type.

Returns:



6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
 
# File 'lib/oci/data_science/data_science_client.rb', line 6618

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

  raise "Missing the required parameter 'compartment_id' when calling list_job_runs." if compartment_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

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

  path = '/jobRuns'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:jobId] = opts[:job_id] if opts[:job_id]
  query_params[:createdBy] = opts[:created_by] if opts[:created_by]
  query_params[:displayName] = opts[:display_name] if opts[:display_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]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]

  # 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: 'DataScienceClient#list_job_runs') 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::DataScience::Models::JobRunSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

List job shapes available in the specified compartment.

Parameters:

  • compartment_id (String) —

    Filter results by the OCID of the 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

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. 1 is the minimum, 100 is the maximum. See List Pagination.

    Example: 50 (default to 50)

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call.

    See List Pagination.

Returns:



6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
 
# File 'lib/oci/data_science/data_science_client.rb', line 6706

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

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

  path = '/jobShapes'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # 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: 'DataScienceClient#list_job_shapes') 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::DataScience::Models::JobShapeSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

List jobs in the specified compartment.

Parameters:

  • compartment_id (String) —

    Filter results by the OCID of the 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

  • :project_id (String) —

    Filter results by the OCID of the project.

  • :id (String) —

    Filter results by OCID. Must be an OCID of the correct type for the resource type.

  • :display_name (String) —

    Filter results by its user-friendly name.

  • :lifecycle_state (String) —

    Filter results by the specified lifecycle state. Must be a valid state for the resource type.

  • :created_by (String) —

    Filter results by the OCID of the user who created the resource.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. 1 is the minimum, 100 is the maximum. See List Pagination.

    Example: 50 (default to 50)

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call.

    See List Pagination.

  • :sort_order (String) —

    Specifies sort order to use, either ASC (ascending) or DESC (descending).

    Allowed values are: ASC, DESC

  • :sort_by (String) —

    Specifies the field to sort by. Accepts only one field. By default, when you sort by timeCreated, the results are shown in descending order. When you sort by displayName, the results are shown in ascending order. Sort order for the displayName field is case sensitive.

    Allowed values are: timeCreated, displayName

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:



6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
 
# File 'lib/oci/data_science/data_science_client.rb', line 6792

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

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

  if opts[:lifecycle_state] && !OCI::DataScience::Models::JOB_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataScience::Models::JOB_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 = '/jobs'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:projectId] = opts[:project_id] if opts[:project_id]
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:createdBy] = opts[:created_by] if opts[:created_by]
  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: 'DataScienceClient#list_jobs') 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::DataScience::Models::JobSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_ml_application_implementation_versions(ml_application_implementation_id, opts = {}) ⇒ Response

Note:

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

Returns a list of MlApplicationImplementationVersions.

Allowed values are: timeCreated, name

Parameters:

  • ml_application_implementation_id (String) —

    unique MlApplicationImplementation 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

  • :lifecycle_state (String) —

    A filter to return only resources matching the given lifecycleState.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. 1 is the minimum, 100 is the maximum. See List Pagination.

    Example: 50 (default to 50)

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call.

    See List Pagination.

  • :sort_order (String) —

    Specifies sort order to use, either ASC (ascending) or DESC (descending).

    Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for name is ascending. (default to timeCreated)

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:



6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
 
# File 'lib/oci/data_science/data_science_client.rb', line 6888

def list_ml_application_implementation_versions(ml_application_implementation_id, opts = {})
  logger.debug 'Calling operation DataScienceClient#list_ml_application_implementation_versions.' if logger

  raise "Missing the required parameter 'ml_application_implementation_id' when calling list_ml_application_implementation_versions." if ml_application_implementation_id.nil?

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

  path = '/mlApplicationImplementationVersions'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:mlApplicationImplementationId] = ml_application_implementation_id
  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: 'DataScienceClient#list_ml_application_implementation_versions') 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::DataScience::Models::MlApplicationImplementationVersionCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Returns a list of MlApplicationImplementations.

Allowed values are: timeCreated, name

Parameters:

  • compartment_id (String) —

    Filter results by the OCID of the 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

  • :ml_application_implementation_id (String) —

    unique MlApplicationImplementation identifier

  • :name (String) —

    A filter to return only resources that match the entire name given.

  • :ml_application_id (String) —

    unique MlApplication identifier

  • :compartment_id_in_subtree (BOOLEAN) —

    If it is true search must include all results from descendant compartments. Value true is allowed only if compartmentId refers to root compartment. (default to false)

  • :lifecycle_state (String) —

    A filter to return only resources with lifecycleState matching the given lifecycleState.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. 1 is the minimum, 100 is the maximum. See List Pagination.

    Example: 50 (default to 50)

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call.

    See List Pagination.

  • :sort_order (String) —

    Specifies sort order to use, either ASC (ascending) or DESC (descending).

    Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for name is ascending. (default to timeCreated)

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:



6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
 
# File 'lib/oci/data_science/data_science_client.rb', line 6984

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

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

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

  path = '/mlApplicationImplementations'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:mlApplicationImplementationId] = opts[:ml_application_implementation_id] if opts[:ml_application_implementation_id]
  query_params[:name] = opts[:name] if opts[:name]
  query_params[:mlApplicationId] = opts[:ml_application_id] if opts[:ml_application_id]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  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: 'DataScienceClient#list_ml_application_implementations') 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::DataScience::Models::MlApplicationImplementationCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Returns a list of MlApplicationInstanceViews.

Allowed values are: timeCreated, name

Parameters:

  • compartment_id (String) —

    Filter results by the OCID of the 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) —

    Filter results by its user-friendly name.

  • :ml_application_id (String) —

    unique MlApplication identifier

  • :ml_application_implementation_id (String) —

    unique MlApplicationImplementation identifier

  • :lifecycle_state (String) —

    A filter to return only resources matching the given lifecycleState.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. 1 is the minimum, 100 is the maximum. See List Pagination.

    Example: 50 (default to 50)

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call.

    See List Pagination.

  • :sort_order (String) —

    Specifies sort order to use, either ASC (ascending) or DESC (descending).

    Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for name is ascending. (default to timeCreated)

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:



7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
 
# File 'lib/oci/data_science/data_science_client.rb', line 7083

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

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

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

  path = '/mlApplicationInstanceViews'
  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[:mlApplicationId] = opts[:ml_application_id] if opts[:ml_application_id]
  query_params[:mlApplicationImplementationId] = opts[:ml_application_implementation_id] if opts[:ml_application_implementation_id]
  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: 'DataScienceClient#list_ml_application_instance_views') 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::DataScience::Models::MlApplicationInstanceViewCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Returns a list of MlApplicationsInstances.

Allowed values are: timeCreated, name

Parameters:

  • compartment_id (String) —

    Filter results by the OCID of the 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) —

    Filter results by its user-friendly name.

  • :ml_application_id (String) —

    unique MlApplication identifier

  • :lifecycle_state (String) —

    A filter to return only resources matching the given lifecycleState.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. 1 is the minimum, 100 is the maximum. See List Pagination.

    Example: 50 (default to 50)

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call.

    See List Pagination.

  • :sort_order (String) —

    Specifies sort order to use, either ASC (ascending) or DESC (descending).

    Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for name is ascending. (default to timeCreated)

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:



7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
 
# File 'lib/oci/data_science/data_science_client.rb', line 7180

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

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

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

  path = '/mlApplicationInstances'
  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[:mlApplicationId] = opts[:ml_application_id] if opts[:ml_application_id]
  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: 'DataScienceClient#list_ml_application_instances') 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::DataScience::Models::MlApplicationInstanceCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Returns a list of MlApplications.

Allowed values are: timeCreated, name

Parameters:

  • compartment_id (String) —

    Filter results by the OCID of the 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

  • :ml_application_id (String) —

    unique MlApplication identifier

  • :compartment_id_in_subtree (BOOLEAN) —

    If it is true search must include all results from descendant compartments. Value true is allowed only if compartmentId refers to root compartment. (default to false)

  • :name (String) —

    A filter to return only resources that match the entire name given.

  • :lifecycle_state (String) —

    A filter to return only resources with lifecycleState matching the given lifecycleState.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. 1 is the minimum, 100 is the maximum. See List Pagination.

    Example: 50 (default to 50)

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call.

    See List Pagination.

  • :sort_order (String) —

    Specifies sort order to use, either ASC (ascending) or DESC (descending).

    Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for name is ascending. (default to timeCreated)

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:



7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
 
# File 'lib/oci/data_science/data_science_client.rb', line 7277

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

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

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

  path = '/mlApplications'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:mlApplicationId] = opts[:ml_application_id] if opts[:ml_application_id]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  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: 'DataScienceClient#list_ml_applications') 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::DataScience::Models::MlApplicationCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Lists the valid model deployment shapes.

Parameters:

  • compartment_id (String) —

    Filter results by the OCID of the 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

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. 1 is the minimum, 100 is the maximum. See List Pagination.

    Example: 50 (default to 50)

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call.

    See List Pagination.

Returns:



7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
 
# File 'lib/oci/data_science/data_science_client.rb', line 7364

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

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

  path = '/modelDeploymentShapes'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # 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: 'DataScienceClient#list_model_deployment_shapes') 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::DataScience::Models::ModelDeploymentShapeSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Lists all model deployments in the specified compartment. Only one parameter other than compartmentId may also be included in a query. The query must include compartmentId. If the query does not include compartmentId, or includes compartmentId but two or more other parameters an error is returned.

Parameters:

  • compartment_id (String) —

    Filter results by the OCID of the 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

  • :id (String) —

    Filter results by OCID. Must be an OCID of the correct type for the resource type.

  • :project_id (String) —

    Filter results by the OCID of the project.

  • :display_name (String) —

    Filter results by its user-friendly name.

  • :lifecycle_state (String) —

    Filter results by the specified lifecycle state. Must be a valid state for the resource type.

  • :created_by (String) —

    Filter results by the OCID of the user who created the resource.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. 1 is the minimum, 100 is the maximum. See List Pagination.

    Example: 50 (default to 50)

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call.

    See List Pagination.

  • :sort_order (String) —

    Specifies sort order to use, either ASC (ascending) or DESC (descending).

    Allowed values are: ASC, DESC

  • :sort_by (String) —

    Specifies the field to sort by. Accepts only one field. By default, when you sort by timeCreated, results are shown in descending order. When you sort by displayName, results are shown in ascending order. Sort order for the displayName field is case sensitive.

    Allowed values are: timeCreated, displayName

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:



7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
 
# File 'lib/oci/data_science/data_science_client.rb', line 7451

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

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

  if opts[:lifecycle_state] && !OCI::DataScience::Models::MODEL_DEPLOYMENT_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataScience::Models::MODEL_DEPLOYMENT_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 = '/modelDeployments'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:projectId] = opts[:project_id] if opts[:project_id]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:createdBy] = opts[:created_by] if opts[:created_by]
  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: 'DataScienceClient#list_model_deployments') 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::DataScience::Models::ModelDeploymentSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Lists model version sets in the specified compartment.

Parameters:

  • compartment_id (String) —

    Filter results by the OCID of the 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

  • :category (String) —

    Specifies the type of model version sets to list. By default, user model version sets are listed.

    Allowed values are: USER, SERVICE

  • :id (String) —

    Filter results by OCID. Must be an OCID of the correct type for the resource type.

  • :project_id (String) —

    Filter results by the OCID of the project.

  • :name (String) —

    A filter to return only resources that match the entire name given.

  • :lifecycle_state (String) —

    Filter results by the specified lifecycle state. Must be a valid state for the resource type.

  • :created_by (String) —

    Filter results by the OCID of the user who created the resource.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. 1 is the minimum, 100 is the maximum. See List Pagination.

    Example: 50 (default to 50)

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call.

    See List Pagination.

  • :sort_order (String) —

    Specifies sort order to use, either ASC (ascending) or DESC (descending).

    Allowed values are: ASC, DESC

  • :sort_by (String) —

    Specifies the field to sort by. Accepts only one field. By default, when you sort by timeCreated, the results are shown in descending order.

    Allowed values are: timeCreated, name, lifecycleState

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:



7557
7558
7559
7560
7561
7562
7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619
 
# File 'lib/oci/data_science/data_science_client.rb', line 7557

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

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

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

  if opts[:lifecycle_state] && !OCI::DataScience::Models::MODEL_VERSION_SET_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataScience::Models::MODEL_VERSION_SET_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 name lifecycleState].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, name, lifecycleState.'
  end

  path = '/modelVersionSets'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:category] = opts[:category] if opts[:category]
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:projectId] = opts[:project_id] if opts[:project_id]
  query_params[:name] = opts[:name] if opts[:name]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:createdBy] = opts[:created_by] if opts[:created_by]
  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: 'DataScienceClient#list_model_version_sets') 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::DataScience::Models::ModelVersionSetSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Lists models in the specified compartment.

Parameters:

  • compartment_id (String) —

    Filter results by the OCID of the 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

  • :model_version_set_name (String) —

    Filter results by the name of the model version set.

  • :version_label (String) —

    Filter results by version label.

  • :category (String) —

    Specifies the type of models to list. By default, user models are listed.

    Allowed values are: USER, SERVICE

  • :id (String) —

    Filter results by OCID. Must be an OCID of the correct type for the resource type.

  • :project_id (String) —

    Filter results by the OCID of the project.

  • :display_name (String) —

    Filter results by its user-friendly name.

  • :lifecycle_state (String) —

    Filter results by the specified lifecycle state. Must be a valid state for the resource type.

  • :created_by (String) —

    Filter results by the OCID of the user who created the resource.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. 1 is the minimum, 100 is the maximum. See List Pagination.

    Example: 50 (default to 50)

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call.

    See List Pagination.

  • :sort_order (String) —

    Specifies sort order to use, either ASC (ascending) or DESC (descending).

    Allowed values are: ASC, DESC

  • :sort_by (String) —

    Specifies the field to sort by. Accepts only one field. By default, when you sort by timeCreated, the results are shown in descending order. All other fields default to ascending order. Sort order for the displayName field is case sensitive.

    Allowed values are: timeCreated, displayName, lifecycleState

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:



7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
7694
7695
7696
7697
7698
7699
7700
7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
7725
7726
7727
7728
7729
7730
7731
7732
7733
7734
7735
 
# File 'lib/oci/data_science/data_science_client.rb', line 7671

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

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

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

  if opts[:lifecycle_state] && !OCI::DataScience::Models::MODEL_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataScience::Models::MODEL_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 lifecycleState].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, displayName, lifecycleState.'
  end

  path = '/models'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:modelVersionSetName] = opts[:model_version_set_name] if opts[:model_version_set_name]
  query_params[:versionLabel] = opts[:version_label] if opts[:version_label]
  query_params[:category] = opts[:category] if opts[:category]
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:projectId] = opts[:project_id] if opts[:project_id]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:createdBy] = opts[:created_by] if opts[:created_by]
  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: 'DataScienceClient#list_models') 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::DataScience::Models::ModelSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Lists the valid notebook session shapes.

Parameters:

  • compartment_id (String) —

    Filter results by the OCID of the 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

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. 1 is the minimum, 100 is the maximum. See List Pagination.

    Example: 50 (default to 50)

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call.

    See List Pagination.

Returns:



7766
7767
7768
7769
7770
7771
7772
7773
7774
7775
7776
7777
7778
7779
7780
7781
7782
7783
7784
7785
7786
7787
7788
7789
7790
7791
7792
7793
7794
7795
7796
7797
7798
7799
7800
7801
7802
7803
7804
 
# File 'lib/oci/data_science/data_science_client.rb', line 7766

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

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

  path = '/notebookSessionShapes'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # 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: 'DataScienceClient#list_notebook_session_shapes') 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::DataScience::Models::NotebookSessionShapeSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Lists the notebook sessions in the specified compartment.

Parameters:

  • compartment_id (String) —

    Filter results by the OCID of the 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

  • :id (String) —

    Filter results by OCID. Must be an OCID of the correct type for the resource type.

  • :project_id (String) —

    Filter results by the OCID of the project.

  • :display_name (String) —

    Filter results by its user-friendly name.

  • :lifecycle_state (String) —

    Filter results by the specified lifecycle state. Must be a valid state for the resource type.

  • :created_by (String) —

    Filter results by the OCID of the user who created the resource.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. 1 is the minimum, 100 is the maximum. See List Pagination.

    Example: 50 (default to 50)

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call.

    See List Pagination.

  • :sort_order (String) —

    Specifies sort order to use, either ASC (ascending) or DESC (descending).

    Allowed values are: ASC, DESC

  • :sort_by (String) —

    Specifies the field to sort by. Accepts only one field. By default, when you sort by timeCreated, the results are shown in descending order. When you sort by displayName, results are shown in ascending order. Sort order for the displayName field is case sensitive.

    Allowed values are: timeCreated, displayName

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:



7852
7853
7854
7855
7856
7857
7858
7859
7860
7861
7862
7863
7864
7865
7866
7867
7868
7869
7870
7871
7872
7873
7874
7875
7876
7877
7878
7879
7880
7881
7882
7883
7884
7885
7886
7887
7888
7889
7890
7891
7892
7893
7894
7895
7896
7897
7898
7899
7900
7901
7902
7903
7904
7905
7906
7907
7908
7909
 
# File 'lib/oci/data_science/data_science_client.rb', line 7852

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

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

  if opts[:lifecycle_state] && !OCI::DataScience::Models::NOTEBOOK_SESSION_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataScience::Models::NOTEBOOK_SESSION_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 = '/notebookSessions'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:projectId] = opts[:project_id] if opts[:project_id]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:createdBy] = opts[:created_by] if opts[:created_by]
  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: 'DataScienceClient#list_notebook_sessions') 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::DataScience::Models::NotebookSessionSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Returns a list of PipelineRuns.

Parameters:

  • compartment_id (String) —

    Filter results by the OCID of the 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

  • :id (String) —

    Filter results by OCID. Must be an OCID of the correct type for the resource type.

  • :pipeline_id (String) —

    The OCID of the pipeline.

  • :display_name (String) —

    Filter results by its user-friendly name.

  • :lifecycle_state (String) —

    The current state of the PipelineRun.

  • :created_by (String) —

    Filter results by the OCID of the user who created the resource.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. 1 is the minimum, 100 is the maximum. See List Pagination.

    Example: 50 (default to 50)

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call.

    See List Pagination.

  • :sort_order (String) —

    Specifies sort order to use, either ASC (ascending) or DESC (descending).

    Allowed values are: ASC, DESC

  • :sort_by (String) —

    Specifies the field to sort by. Accepts only one field. By default, when you sort by timeAccepted, the results are shown in descending order. When you sort by displayName, the results are shown in ascending order. Sort order for the displayName field is case sensitive.

    Allowed values are: timeAccepted, displayName

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:



7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
7966
7967
7968
7969
7970
7971
7972
7973
7974
7975
7976
7977
7978
7979
7980
7981
7982
7983
7984
7985
7986
7987
7988
7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
7999
8000
8001
8002
8003
8004
8005
8006
8007
8008
8009
8010
8011
8012
 
# File 'lib/oci/data_science/data_science_client.rb', line 7955

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

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

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

  path = '/pipelineRuns'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:pipelineId] = opts[:pipeline_id] if opts[:pipeline_id]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:createdBy] = opts[:created_by] if opts[:created_by]
  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: 'DataScienceClient#list_pipeline_runs') 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::DataScience::Models::PipelineRunSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Returns a list of Pipelines.

Parameters:

  • compartment_id (String) —

    Filter results by the OCID of the 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

  • :project_id (String) —

    Filter results by the OCID of the project.

  • :id (String) —

    Filter results by OCID. Must be an OCID of the correct type for the resource type.

  • :display_name (String) —

    Filter results by its user-friendly name.

  • :lifecycle_state (String) —

    The current state of the Pipeline.

  • :created_by (String) —

    Filter results by the OCID of the user who created the resource.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. 1 is the minimum, 100 is the maximum. See List Pagination.

    Example: 50 (default to 50)

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call.

    See List Pagination.

  • :sort_order (String) —

    Specifies sort order to use, either ASC (ascending) or DESC (descending).

    Allowed values are: ASC, DESC

  • :sort_by (String) —

    Specifies the field to sort by. Accepts only one field. By default, when you sort by timeCreated, the results are shown in descending order. When you sort by displayName, the results are shown in ascending order. Sort order for the displayName field is case sensitive.

    Allowed values are: timeCreated, displayName

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:



8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
8100
8101
8102
8103
8104
8105
8106
8107
8108
8109
8110
8111
8112
8113
8114
8115
 
# File 'lib/oci/data_science/data_science_client.rb', line 8058

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

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

  if opts[:lifecycle_state] && !OCI::DataScience::Models::PIPELINE_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataScience::Models::PIPELINE_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 = '/pipelines'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:projectId] = opts[:project_id] if opts[:project_id]
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:createdBy] = opts[:created_by] if opts[:created_by]
  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: 'DataScienceClient#list_pipelines') 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::DataScience::Models::PipelineSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Lists projects in the specified compartment.

Parameters:

  • compartment_id (String) —

    Filter results by the OCID of the 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

  • :id (String) —

    Filter results by OCID. Must be an OCID of the correct type for the resource type.

  • :display_name (String) —

    Filter results by its user-friendly name.

  • :lifecycle_state (String) —

    Filter results by the specified lifecycle state. Must be a valid state for the resource type.

  • :created_by (String) —

    Filter results by the OCID of the user who created the resource.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. 1 is the minimum, 100 is the maximum. See List Pagination.

    Example: 50 (default to 50)

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call.

    See List Pagination.

  • :sort_order (String) —

    Specifies sort order to use, either ASC (ascending) or DESC (descending).

    Allowed values are: ASC, DESC

  • :sort_by (String) —

    Specifies the field to sort by. Accepts only one field. By default, when you sort by timeCreated, the results are shown in descending order. When you sort by displayName, the results are shown in ascending order. Sort order for the displayName field is case sensitive.

    Allowed values are: timeCreated, displayName

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:



8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
8176
8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
8195
8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
8213
8214
8215
8216
8217
8218
 
# File 'lib/oci/data_science/data_science_client.rb', line 8162

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

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

  if opts[:lifecycle_state] && !OCI::DataScience::Models::PROJECT_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataScience::Models::PROJECT_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 = '/projects'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:createdBy] = opts[:created_by] if opts[:created_by]
  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: 'DataScienceClient#list_projects') 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::DataScience::Models::ProjectSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Returns a list of Schedules.

Allowed values are: timeCreated, displayName

Parameters:

  • compartment_id (String) —

    Filter results by the OCID of the 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

  • :project_id (String) —

    Filter results by the OCID of the project.

  • :lifecycle_state (String) —

    A filter to return only resources their lifecycleState matches the given lifecycleState.

  • :display_name (String) —

    Filter results by its user-friendly name.

  • :id (String) —

    unique Schedule identifier

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. 1 is the minimum, 100 is the maximum. See List Pagination.

    Example: 50 (default to 50)

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call.

    See List Pagination.

  • :sort_order (String) —

    Specifies sort order to use, either ASC (ascending) or DESC (descending).

    Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. (default to timeCreated)

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:



8260
8261
8262
8263
8264
8265
8266
8267
8268
8269
8270
8271
8272
8273
8274
8275
8276
8277
8278
8279
8280
8281
8282
8283
8284
8285
8286
8287
8288
8289
8290
8291
8292
8293
8294
8295
8296
8297
8298
8299
8300
8301
8302
8303
8304
8305
8306
8307
8308
8309
8310
8311
8312
8313
8314
8315
8316
 
# File 'lib/oci/data_science/data_science_client.rb', line 8260

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

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

  if opts[:lifecycle_state] && !OCI::DataScience::Models::SCHEDULE_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataScience::Models::SCHEDULE_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 = '/schedules'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:projectId] = opts[:project_id] if opts[:project_id]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:id] = opts[:id] if opts[:id]
  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: 'DataScienceClient#list_schedules') 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::DataScience::Models::ScheduleSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_work_request_errors(work_request_id, opts = {}) ⇒ Response

Note:

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

Lists work request errors for the specified work request.

Parameters:

  • work_request_id (String) —

    The OCID of the work request.

  • 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) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. 1 is the minimum, 100 is the maximum. See List Pagination.

    Example: 50 (default to 50)

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call.

    See List Pagination.

Returns:



8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
8377
8378
8379
8380
8381
8382
8383
8384
8385
 
# File 'lib/oci/data_science/data_science_client.rb', line 8347

def list_work_request_errors(work_request_id, opts = {})
  logger.debug 'Calling operation DataScienceClient#list_work_request_errors.' if logger

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

  path = '/workRequests/{workRequestId}/errors'.sub('{workRequestId}', work_request_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # 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: 'DataScienceClient#list_work_request_errors') 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::DataScience::Models::WorkRequestError>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_work_request_logs(work_request_id, opts = {}) ⇒ Response

Note:

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

Lists work request logs for the specified work request.

Parameters:

  • work_request_id (String) —

    The OCID of the work request.

  • 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) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. 1 is the minimum, 100 is the maximum. See List Pagination.

    Example: 50 (default to 50)

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call.

    See List Pagination.

Returns:



8416
8417
8418
8419
8420
8421
8422
8423
8424
8425
8426
8427
8428
8429
8430
8431
8432
8433
8434
8435
8436
8437
8438
8439
8440
8441
8442
8443
8444
8445
8446
8447
8448
8449
8450
8451
8452
8453
8454
 
# File 'lib/oci/data_science/data_science_client.rb', line 8416

def list_work_request_logs(work_request_id, opts = {})
  logger.debug 'Calling operation DataScienceClient#list_work_request_logs.' if logger

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

  path = '/workRequests/{workRequestId}/logs'.sub('{workRequestId}', work_request_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # 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: 'DataScienceClient#list_work_request_logs') 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::DataScience::Models::WorkRequestLogEntry>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Lists work requests in the specified compartment.

Parameters:

  • compartment_id (String) —

    Filter results by the OCID of the 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

  • :id (String) —

    Filter results by OCID. Must be an OCID of the correct type for the resource type.

  • :operation_type (String) —

    Filter results by the type of the operation associated with the work request. Allowed values are: NOTEBOOK_SESSION_CREATE, NOTEBOOK_SESSION_DELETE, NOTEBOOK_SESSION_ACTIVATE, NOTEBOOK_SESSION_DEACTIVATE, MODELVERSIONSET_DELETE, EXPORT_MODEL_ARTIFACT, IMPORT_MODEL_ARTIFACT, MODEL_DEPLOYMENT_CREATE, MODEL_DEPLOYMENT_DELETE, MODEL_DEPLOYMENT_ACTIVATE, MODEL_DEPLOYMENT_DEACTIVATE, MODEL_DEPLOYMENT_UPDATE, PROJECT_DELETE, WORKREQUEST_CANCEL, JOB_DELETE, PIPELINE_CREATE, PIPELINE_DELETE, PIPELINE_RUN_CREATE, PIPELINE_RUN_CANCEL, PIPELINE_RUN_DELETE, ML_APPLICATION_PACKAGE_UPLOAD, ML_APPLICATION_TRIGGER_START, ML_APPLICATION_IMPLEMENTATION_DELETE, ML_APPLICATION_IMPLEMENTATION_UPDATE, ML_APPLICATION_IMPLEMENTATION_MOVE, ML_APPLICATION_INSTANCE_CREATE, ML_APPLICATION_INSTANCE_UPDATE, ML_APPLICATION_INSTANCE_DELETE, ML_APPLICATION_INSTANCE_MOVE, ML_APPLICATION_INSTANCE_VIEW_CREATE, ML_APPLICATION_INSTANCE_VIEW_UPDATE, ML_APPLICATION_INSTANCE_VIEW_DELETE, ML_APPLICATION_INSTANCE_VIEW_UPGRADE, ML_APPLICATION_INSTANCE_VIEW_MOVE, PRIVATE_ENDPOINT_CREATE, PRIVATE_ENDPOINT_DELETE, PRIVATE_ENDPOINT_MOVE, PRIVATE_ENDPOINT_UPDATE, SCHEDULE_CREATE, SCHEDULE_UPDATE, SCHEDULE_DELETE, SCHEDULE_MOVE, SCHEDULE_ACTIVATE, SCHEDULE_DEACTIVATE, REGISTER_MODEL_ARTIFACT, RESTORE_ARCHIVED_MODEL

  • :status (String) —

    Filter results by work request status. Allowed values are: ACCEPTED, IN_PROGRESS, FAILED, SUCCEEDED, CANCELING, CANCELED

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. 1 is the minimum, 100 is the maximum. See List Pagination.

    Example: 50 (default to 50)

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call.

    See List Pagination.

  • :sort_order (String) —

    Specifies sort order to use, either ASC (ascending) or DESC (descending).

    Allowed values are: ASC, DESC

  • :sort_by (String) —

    Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, the results are shown in descending order. All other fields default to ascending order.

    Allowed values are: operationType, status, timeAccepted

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:



8497
8498
8499
8500
8501
8502
8503
8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
8519
8520
8521
8522
8523
8524
8525
8526
8527
8528
8529
8530
8531
8532
8533
8534
8535
8536
8537
8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
8548
8549
8550
8551
8552
8553
8554
8555
8556
 
# File 'lib/oci/data_science/data_science_client.rb', line 8497

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

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

  if opts[:operation_type] && !%w[NOTEBOOK_SESSION_CREATE NOTEBOOK_SESSION_DELETE NOTEBOOK_SESSION_ACTIVATE NOTEBOOK_SESSION_DEACTIVATE MODELVERSIONSET_DELETE EXPORT_MODEL_ARTIFACT IMPORT_MODEL_ARTIFACT MODEL_DEPLOYMENT_CREATE MODEL_DEPLOYMENT_DELETE MODEL_DEPLOYMENT_ACTIVATE MODEL_DEPLOYMENT_DEACTIVATE MODEL_DEPLOYMENT_UPDATE PROJECT_DELETE WORKREQUEST_CANCEL JOB_DELETE PIPELINE_CREATE PIPELINE_DELETE PIPELINE_RUN_CREATE PIPELINE_RUN_CANCEL PIPELINE_RUN_DELETE ML_APPLICATION_PACKAGE_UPLOAD ML_APPLICATION_TRIGGER_START ML_APPLICATION_IMPLEMENTATION_DELETE ML_APPLICATION_IMPLEMENTATION_UPDATE ML_APPLICATION_IMPLEMENTATION_MOVE ML_APPLICATION_INSTANCE_CREATE ML_APPLICATION_INSTANCE_UPDATE ML_APPLICATION_INSTANCE_DELETE ML_APPLICATION_INSTANCE_MOVE ML_APPLICATION_INSTANCE_VIEW_CREATE ML_APPLICATION_INSTANCE_VIEW_UPDATE ML_APPLICATION_INSTANCE_VIEW_DELETE ML_APPLICATION_INSTANCE_VIEW_UPGRADE ML_APPLICATION_INSTANCE_VIEW_MOVE PRIVATE_ENDPOINT_CREATE PRIVATE_ENDPOINT_DELETE PRIVATE_ENDPOINT_MOVE PRIVATE_ENDPOINT_UPDATE SCHEDULE_CREATE SCHEDULE_UPDATE SCHEDULE_DELETE SCHEDULE_MOVE SCHEDULE_ACTIVATE SCHEDULE_DEACTIVATE REGISTER_MODEL_ARTIFACT RESTORE_ARCHIVED_MODEL].include?(opts[:operation_type])
    raise 'Invalid value for "operation_type", must be one of NOTEBOOK_SESSION_CREATE, NOTEBOOK_SESSION_DELETE, NOTEBOOK_SESSION_ACTIVATE, NOTEBOOK_SESSION_DEACTIVATE, MODELVERSIONSET_DELETE, EXPORT_MODEL_ARTIFACT, IMPORT_MODEL_ARTIFACT, MODEL_DEPLOYMENT_CREATE, MODEL_DEPLOYMENT_DELETE, MODEL_DEPLOYMENT_ACTIVATE, MODEL_DEPLOYMENT_DEACTIVATE, MODEL_DEPLOYMENT_UPDATE, PROJECT_DELETE, WORKREQUEST_CANCEL, JOB_DELETE, PIPELINE_CREATE, PIPELINE_DELETE, PIPELINE_RUN_CREATE, PIPELINE_RUN_CANCEL, PIPELINE_RUN_DELETE, ML_APPLICATION_PACKAGE_UPLOAD, ML_APPLICATION_TRIGGER_START, ML_APPLICATION_IMPLEMENTATION_DELETE, ML_APPLICATION_IMPLEMENTATION_UPDATE, ML_APPLICATION_IMPLEMENTATION_MOVE, ML_APPLICATION_INSTANCE_CREATE, ML_APPLICATION_INSTANCE_UPDATE, ML_APPLICATION_INSTANCE_DELETE, ML_APPLICATION_INSTANCE_MOVE, ML_APPLICATION_INSTANCE_VIEW_CREATE, ML_APPLICATION_INSTANCE_VIEW_UPDATE, ML_APPLICATION_INSTANCE_VIEW_DELETE, ML_APPLICATION_INSTANCE_VIEW_UPGRADE, ML_APPLICATION_INSTANCE_VIEW_MOVE, PRIVATE_ENDPOINT_CREATE, PRIVATE_ENDPOINT_DELETE, PRIVATE_ENDPOINT_MOVE, PRIVATE_ENDPOINT_UPDATE, SCHEDULE_CREATE, SCHEDULE_UPDATE, SCHEDULE_DELETE, SCHEDULE_MOVE, SCHEDULE_ACTIVATE, SCHEDULE_DEACTIVATE, REGISTER_MODEL_ARTIFACT, RESTORE_ARCHIVED_MODEL.'
  end

  if opts[:status] && !%w[ACCEPTED IN_PROGRESS FAILED SUCCEEDED CANCELING CANCELED].include?(opts[:status])
    raise 'Invalid value for "status", must be one of ACCEPTED, IN_PROGRESS, FAILED, SUCCEEDED, CANCELING, CANCELED.'
  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[operationType status timeAccepted].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of operationType, status, timeAccepted.'
  end

  path = '/workRequests'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:operationType] = opts[:operation_type] if opts[:operation_type]
  query_params[:status] = opts[:status] if opts[:status]
  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: 'DataScienceClient#list_work_requests') 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::DataScience::Models::WorkRequestSummary>'
    )
  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/data_science/data_science_client.rb', line 94

def logger
  @api_client.config.logger
end

#put_ml_application_package(ml_application_implementation_id, put_ml_application_package, opts = {}) ⇒ Response

Note:

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

Upload ML Application Package

Parameters:

  • ml_application_implementation_id (String) —

    unique MlApplicationImplementation identifier

  • put_ml_application_package (String, IO) —

    ML Application Package to upload

  • 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

  • :content_length (Integer) —

    The content length of the body.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :content_disposition (String) —

    This header allows you to specify a filename during upload. This file name is used to dispose of the file contents while downloading the file. If this optional field is not populated in the request, then the OCID of the model is used for the file name when downloading. Example: {\"Content-Disposition\": \"attachment\" \"filename\"=\"model.tar.gz\" \"Content-Length\": \"2347\" \"Content-Type\": \"application/gzip\"}

  • :opc_ml_app_package_args (String) —

    List of arguments (Json map - argument name to argument value) for ML Application package (available arguments are in ML Application package descriptor). E.g. "ocid1.vcn.oc1.iad.abcd…", "logId":"ocid1.log.oc1.iad.abcd…" (default to {})

Returns:

  • (Response) —

    A Response object with data of type nil



8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
8605
8606
8607
8608
8609
8610
8611
8612
8613
8614
8615
8616
8617
8618
8619
8620
8621
8622
8623
8624
8625
8626
8627
8628
8629
 
# File 'lib/oci/data_science/data_science_client.rb', line 8588

def put_ml_application_package(ml_application_implementation_id, put_ml_application_package, opts = {})
  logger.debug 'Calling operation DataScienceClient#put_ml_application_package.' if logger

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

  path = '/mlApplicationImplementations/{mlApplicationImplementationId}/mlApplicationPackage'.sub('{mlApplicationImplementationId}', ml_application_implementation_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[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'content-length'] = opts[:content_length] if opts[:content_length]
  header_params[:'content-disposition'] = opts[:content_disposition] if opts[:content_disposition]
  header_params[:'opc-ml-app-package-args'] = opts[:opc_ml_app_package_args] if opts[:opc_ml_app_package_args]
  # rubocop:enable Style/NegatedIf
  header_params[:'content-type'] ||= 'application/octet-stream'
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(put_ml_application_package)

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

#recover_ml_application_instance_view(ml_application_instance_view_id, opts = {}) ⇒ Response

Note:

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

Provider can initiate recovery of the resource only if MlApplicationInstanceView is in one of the recoverable sub-states (RECOVERABLE_PROVIDER_ISSUE, RECOVERABLE_SERVICE_ISSUE). Provider should investigate (using MlApplicationInstanceView lifecycleDetails, relevant logs and metrics) and fix the issue before the recovery is initiated.

Parameters:

  • ml_application_instance_view_id (String) —

    unique MlApplicationInstanceView 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 the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



8658
8659
8660
8661
8662
8663
8664
8665
8666
8667
8668
8669
8670
8671
8672
8673
8674
8675
8676
8677
8678
8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
8693
8694
8695
8696
 
# File 'lib/oci/data_science/data_science_client.rb', line 8658

def recover_ml_application_instance_view(ml_application_instance_view_id, opts = {})
  logger.debug 'Calling operation DataScienceClient#recover_ml_application_instance_view.' if logger

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

  path = '/mlApplicationInstanceViews/{mlApplicationInstanceViewId}/actions/recover'.sub('{mlApplicationInstanceViewId}', ml_application_instance_view_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: 'DataScienceClient#recover_ml_application_instance_view') 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

#register_model_artifact_reference(register_model_artifact_reference_details, model_id, opts = {}) ⇒ Response

Note:

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

Registers model artifact reference metadata

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) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



8724
8725
8726
8727
8728
8729
8730
8731
8732
8733
8734
8735
8736
8737
8738
8739
8740
8741
8742
8743
8744
8745
8746
8747
8748
8749
8750
8751
8752
8753
8754
8755
8756
8757
8758
8759
8760
8761
8762
8763
 
# File 'lib/oci/data_science/data_science_client.rb', line 8724

def register_model_artifact_reference(register_model_artifact_reference_details, model_id, opts = {})
  logger.debug 'Calling operation DataScienceClient#register_model_artifact_reference.' if logger

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

  path = '/models/{modelId}/actions/registerArtifactReference'.sub('{modelId}', model_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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(register_model_artifact_reference_details)

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

#restore_archived_model_artifact(model_id, opts = {}) ⇒ Response

Note:

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

Restore archived model artifact

Parameters:

  • model_id (String) —

    The OCID of the model.

  • 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

  • :restore_model_for_hours_specified (Integer) —

    Duration in hours for which the archived model is available for access. (default to 24)

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



8791
8792
8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
8804
8805
8806
8807
8808
8809
8810
8811
8812
8813
8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
8827
8828
8829
8830
 
# File 'lib/oci/data_science/data_science_client.rb', line 8791

def restore_archived_model_artifact(model_id, opts = {})
  logger.debug 'Calling operation DataScienceClient#restore_archived_model_artifact.' if logger

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

  path = '/models/{modelId}/actions/restore'.sub('{modelId}', model_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:restoreModelForHoursSpecified] = opts[:restore_model_for_hours_specified] if opts[:restore_model_for_hours_specified]

  # 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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # 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: 'DataScienceClient#restore_archived_model_artifact') 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

#trigger_ml_application_instance_flow(trigger_ml_application_instance_flow_details, ml_application_instance_id, opts = {}) ⇒ Response

Note:

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

Trigger ML Application Instance flow if possible

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) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



8852
8853
8854
8855
8856
8857
8858
8859
8860
8861
8862
8863
8864
8865
8866
8867
8868
8869
8870
8871
8872
8873
8874
8875
8876
8877
8878
8879
8880
8881
8882
8883
8884
8885
8886
8887
8888
8889
8890
 
# File 'lib/oci/data_science/data_science_client.rb', line 8852

def trigger_ml_application_instance_flow(trigger_ml_application_instance_flow_details, ml_application_instance_id, opts = {})
  logger.debug 'Calling operation DataScienceClient#trigger_ml_application_instance_flow.' if logger

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

  path = '/mlApplicationInstances/{mlApplicationInstanceId}/actions/trigger'.sub('{mlApplicationInstanceId}', ml_application_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(trigger_ml_application_instance_flow_details)

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

#trigger_ml_application_instance_view_flow(trigger_ml_application_instance_view_flow_details, ml_application_instance_view_id, opts = {}) ⇒ Response

Note:

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

Trigger ML Application Instance View flow if possible

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) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



8912
8913
8914
8915
8916
8917
8918
8919
8920
8921
8922
8923
8924
8925
8926
8927
8928
8929
8930
8931
8932
8933
8934
8935
8936
8937
8938
8939
8940
8941
8942
8943
8944
8945
8946
8947
8948
8949
8950
 
# File 'lib/oci/data_science/data_science_client.rb', line 8912

def trigger_ml_application_instance_view_flow(trigger_ml_application_instance_view_flow_details, ml_application_instance_view_id, opts = {})
  logger.debug 'Calling operation DataScienceClient#trigger_ml_application_instance_view_flow.' if logger

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

  path = '/mlApplicationInstanceViews/{mlApplicationInstanceViewId}/actions/trigger'.sub('{mlApplicationInstanceViewId}', ml_application_instance_view_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(trigger_ml_application_instance_view_flow_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataScienceClient#trigger_ml_application_instance_view_flow') 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_data_science_private_endpoint(data_science_private_endpoint_id, update_data_science_private_endpoint_details, opts = {}) ⇒ Response

Note:

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

Updates a private endpoint using a privateEndpointId. If changes to a private endpoint match a previously defined private endpoint, then a 409 status code is returned. This indicates that a conflict has been detected.

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) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:



8981
8982
8983
8984
8985
8986
8987
8988
8989
8990
8991
8992
8993
8994
8995
8996
8997
8998
8999
9000
9001
9002
9003
9004
9005
9006
9007
9008
9009
9010
9011
9012
9013
9014
9015
9016
9017
9018
9019
 
# File 'lib/oci/data_science/data_science_client.rb', line 8981

def update_data_science_private_endpoint(data_science_private_endpoint_id, update_data_science_private_endpoint_details, opts = {})
  logger.debug 'Calling operation DataScienceClient#update_data_science_private_endpoint.' if logger

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

  path = '/dataSciencePrivateEndpoints/{dataSciencePrivateEndpointId}'.sub('{dataSciencePrivateEndpointId}', data_science_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[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_data_science_private_endpoint_details)

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

#update_job(job_id, update_job_details, opts = {}) ⇒ Response

Note:

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

Updates a job.

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) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type Job



9045
9046
9047
9048
9049
9050
9051
9052
9053
9054
9055
9056
9057
9058
9059
9060
9061
9062
9063
9064
9065
9066
9067
9068
9069
9070
9071
9072
9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
9083
 
# File 'lib/oci/data_science/data_science_client.rb', line 9045

def update_job(job_id, update_job_details, opts = {})
  logger.debug 'Calling operation DataScienceClient#update_job.' if logger

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

  path = '/jobs/{jobId}'.sub('{jobId}', job_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 = @api_client.object_to_http_body(update_job_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataScienceClient#update_job') 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::DataScience::Models::Job'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_job_run(job_run_id, update_job_run_details, opts = {}) ⇒ Response

Note:

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

Updates a job run.

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) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:



9109
9110
9111
9112
9113
9114
9115
9116
9117
9118
9119
9120
9121
9122
9123
9124
9125
9126
9127
9128
9129
9130
9131
9132
9133
9134
9135
9136
9137
9138
9139
9140
9141
9142
9143
9144
9145
9146
9147
 
# File 'lib/oci/data_science/data_science_client.rb', line 9109

def update_job_run(job_run_id, update_job_run_details, opts = {})
  logger.debug 'Calling operation DataScienceClient#update_job_run.' if logger

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

  path = '/jobRuns/{jobRunId}'.sub('{jobRunId}', job_run_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 = @api_client.object_to_http_body(update_job_run_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataScienceClient#update_job_run') 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::DataScience::Models::JobRun'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_ml_application(ml_application_id, update_ml_application_details, opts = {}) ⇒ Response

Note:

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

Updates the MlApplication

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 the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:



9173
9174
9175
9176
9177
9178
9179
9180
9181
9182
9183
9184
9185
9186
9187
9188
9189
9190
9191
9192
9193
9194
9195
9196
9197
9198
9199
9200
9201
9202
9203
9204
9205
9206
9207
9208
9209
9210
9211
 
# File 'lib/oci/data_science/data_science_client.rb', line 9173

def update_ml_application(ml_application_id, update_ml_application_details, opts = {})
  logger.debug 'Calling operation DataScienceClient#update_ml_application.' if logger

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

  path = '/mlApplications/{mlApplicationId}'.sub('{mlApplicationId}', ml_application_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_ml_application_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataScienceClient#update_ml_application') 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::DataScience::Models::MlApplication'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_ml_application_implementation(ml_application_implementation_id, update_ml_application_implementation_details, opts = {}) ⇒ Response

Note:

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

Updates the MlApplicationImplementation

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 the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



9237
9238
9239
9240
9241
9242
9243
9244
9245
9246
9247
9248
9249
9250
9251
9252
9253
9254
9255
9256
9257
9258
9259
9260
9261
9262
9263
9264
9265
9266
9267
9268
9269
9270
9271
9272
9273
9274
 
# File 'lib/oci/data_science/data_science_client.rb', line 9237

def update_ml_application_implementation(ml_application_implementation_id, update_ml_application_implementation_details, opts = {})
  logger.debug 'Calling operation DataScienceClient#update_ml_application_implementation.' if logger

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

  path = '/mlApplicationImplementations/{mlApplicationImplementationId}'.sub('{mlApplicationImplementationId}', ml_application_implementation_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_ml_application_implementation_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataScienceClient#update_ml_application_implementation') 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_ml_application_implementation_version(ml_application_implementation_version_id, update_ml_application_implementation_version_details, opts = {}) ⇒ Response

Note:

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

Updates the MlApplicationImplementationVersion

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 the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:



9300
9301
9302
9303
9304
9305
9306
9307
9308
9309
9310
9311
9312
9313
9314
9315
9316
9317
9318
9319
9320
9321
9322
9323
9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
 
# File 'lib/oci/data_science/data_science_client.rb', line 9300

def update_ml_application_implementation_version(ml_application_implementation_version_id, update_ml_application_implementation_version_details, opts = {})
  logger.debug 'Calling operation DataScienceClient#update_ml_application_implementation_version.' if logger

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

  path = '/mlApplicationImplementationVersions/{mlApplicationImplementationVersionId}'.sub('{mlApplicationImplementationVersionId}', ml_application_implementation_version_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_ml_application_implementation_version_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataScienceClient#update_ml_application_implementation_version') 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::DataScience::Models::MlApplicationImplementationVersion'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_ml_application_instance(ml_application_instance_id, update_ml_application_instance_details, opts = {}) ⇒ Response

Note:

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

Updates the MlApplicationInstance

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 the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



9364
9365
9366
9367
9368
9369
9370
9371
9372
9373
9374
9375
9376
9377
9378
9379
9380
9381
9382
9383
9384
9385
9386
9387
9388
9389
9390
9391
9392
9393
9394
9395
9396
9397
9398
9399
9400
9401
 
# File 'lib/oci/data_science/data_science_client.rb', line 9364

def update_ml_application_instance(ml_application_instance_id, update_ml_application_instance_details, opts = {})
  logger.debug 'Calling operation DataScienceClient#update_ml_application_instance.' if logger

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

  path = '/mlApplicationInstances/{mlApplicationInstanceId}'.sub('{mlApplicationInstanceId}', ml_application_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[:'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_ml_application_instance_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataScienceClient#update_ml_application_instance') 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_ml_application_instance_view(ml_application_instance_view_id, update_ml_application_instance_view_details, opts = {}) ⇒ Response

Note:

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

Updates the MlApplicationInstanceView

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 the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:



9427
9428
9429
9430
9431
9432
9433
9434
9435
9436
9437
9438
9439
9440
9441
9442
9443
9444
9445
9446
9447
9448
9449
9450
9451
9452
9453
9454
9455
9456
9457
9458
9459
9460
9461
9462
9463
9464
9465
 
# File 'lib/oci/data_science/data_science_client.rb', line 9427

def update_ml_application_instance_view(ml_application_instance_view_id, update_ml_application_instance_view_details, opts = {})
  logger.debug 'Calling operation DataScienceClient#update_ml_application_instance_view.' if logger

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

  path = '/mlApplicationInstanceViews/{mlApplicationInstanceViewId}'.sub('{mlApplicationInstanceViewId}', ml_application_instance_view_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_ml_application_instance_view_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataScienceClient#update_ml_application_instance_view') 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::DataScience::Models::MlApplicationInstanceView'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_model(model_id, update_model_details, opts = {}) ⇒ Response

Note:

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

Updates the properties of a model. You can update the displayName, description, freeformTags, and definedTags properties.

Parameters:

  • model_id (String) —

    The OCID of the model.

  • update_model_details (OCI::DataScience::Models::UpdateModelDetails) —

    Details for updating a model. You can update the displayName, description, freeformTags, and definedTags properties.

  • 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 the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:



9491
9492
9493
9494
9495
9496
9497
9498
9499
9500
9501
9502
9503
9504
9505
9506
9507
9508
9509
9510
9511
9512
9513
9514
9515
9516
9517
9518
9519
9520
9521
9522
9523
9524
9525
9526
9527
9528
9529
 
# File 'lib/oci/data_science/data_science_client.rb', line 9491

def update_model(model_id, update_model_details, opts = {})
  logger.debug 'Calling operation DataScienceClient#update_model.' if logger

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

  path = '/models/{modelId}'.sub('{modelId}', model_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_model_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataScienceClient#update_model') 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::DataScience::Models::Model'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_model_custom_metadatum_artifact(model_id, metadatum_key_name, model_custom_metadatum_artifact, opts = {}) ⇒ Response

Note:

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

Updates model custom metadata artifact for specified model metadata key.

Parameters:

  • model_id (String) —

    The OCID of the model.

  • metadatum_key_name (String) —

    The name of the model metadatum in the metadata.

  • model_custom_metadatum_artifact (String, IO) —

    The model custom metadata artifact to upload.

  • 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

  • :content_length (Integer) —

    The content length of the body.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :content_disposition (String) —

    This header allows you to specify a filename during upload. This file name is used to dispose of the file contents while downloading the file. If this optional field is not populated in the request, then the OCID of the model is used for the file name when downloading. Example: {\"Content-Disposition\": \"attachment\" \"filename\"=\"model.tar.gz\" \"Content-Length\": \"2347\" \"Content-Type\": \"application/gzip\"}

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



9565
9566
9567
9568
9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
9580
9581
9582
9583
9584
9585
9586
9587
9588
9589
9590
9591
9592
9593
9594
9595
9596
9597
9598
9599
9600
9601
9602
9603
9604
9605
9606
 
# File 'lib/oci/data_science/data_science_client.rb', line 9565

def update_model_custom_metadatum_artifact(model_id, metadatum_key_name, model_custom_metadatum_artifact, opts = {})
  logger.debug 'Calling operation DataScienceClient#update_model_custom_metadatum_artifact.' if logger

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

  path = '/models/{modelId}/customMetadata/{metadatumKeyName}/artifact'.sub('{modelId}', model_id.to_s).sub('{metadatumKeyName}', metadatum_key_name.to_s)
  operation_signing_strategy = :exclude_body

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'content-length'] = opts[:content_length] if opts[:content_length]
  header_params[:'content-disposition'] = opts[:content_disposition] if opts[:content_disposition]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'content-type'] ||= 'application/octet-stream'

  post_body = @api_client.object_to_http_body(model_custom_metadatum_artifact)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataScienceClient#update_model_custom_metadatum_artifact') 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_model_defined_metadatum_artifact(model_id, metadatum_key_name, model_defined_metadatum_artifact, opts = {}) ⇒ Response

Note:

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

Updates model defined metadata artifact for specified model metadata key.

Parameters:

  • model_id (String) —

    The OCID of the model.

  • metadatum_key_name (String) —

    The name of the model metadatum in the metadata.

  • model_defined_metadatum_artifact (String, IO) —

    The model defined metadata artifact to upload.

  • 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

  • :content_length (Integer) —

    The content length of the body.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :content_disposition (String) —

    This header allows you to specify a filename during upload. This file name is used to dispose of the file contents while downloading the file. If this optional field is not populated in the request, then the OCID of the model is used for the file name when downloading. Example: {\"Content-Disposition\": \"attachment\" \"filename\"=\"model.tar.gz\" \"Content-Length\": \"2347\" \"Content-Type\": \"application/gzip\"}

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



9642
9643
9644
9645
9646
9647
9648
9649
9650
9651
9652
9653
9654
9655
9656
9657
9658
9659
9660
9661
9662
9663
9664
9665
9666
9667
9668
9669
9670
9671
9672
9673
9674
9675
9676
9677
9678
9679
9680
9681
9682
9683
 
# File 'lib/oci/data_science/data_science_client.rb', line 9642

def update_model_defined_metadatum_artifact(model_id, metadatum_key_name, model_defined_metadatum_artifact, opts = {})
  logger.debug 'Calling operation DataScienceClient#update_model_defined_metadatum_artifact.' if logger

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

  path = '/models/{modelId}/definedMetadata/{metadatumKeyName}/artifact'.sub('{modelId}', model_id.to_s).sub('{metadatumKeyName}', metadatum_key_name.to_s)
  operation_signing_strategy = :exclude_body

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'content-length'] = opts[:content_length] if opts[:content_length]
  header_params[:'content-disposition'] = opts[:content_disposition] if opts[:content_disposition]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'content-type'] ||= 'application/octet-stream'

  post_body = @api_client.object_to_http_body(model_defined_metadatum_artifact)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataScienceClient#update_model_defined_metadatum_artifact') 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_model_deployment(model_deployment_id, update_model_deployment_details, opts = {}) ⇒ Response

Note:

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

Updates the properties of a model deployment. Some of the properties of modelDeploymentConfigurationDetails or CategoryLogDetails can also be updated with zero down time when the model deployment's lifecycle state is ACTIVE or NEEDS_ATTENTION i.e instanceShapeName, instanceCount and modelId, separately loadBalancerShape or CategoryLogDetails can also be updated independently. All of the fields can be updated when the deployment is in the INACTIVE lifecycle state. Changes will take effect the next time the model deployment is activated.

Parameters:

  • model_deployment_id (String) —

    The OCID of the model deployment.

  • update_model_deployment_details (OCI::DataScience::Models::UpdateModelDeploymentDetails) —

    Details for updating a model deployment. Some of the properties of modelDeploymentConfigurationDetails or CategoryLogDetails can also be updated with zero down time when the model deployment's lifecycle state is ACTIVE or NEEDS_ATTENTION i.e instanceShapeName, instanceCount and modelId, separately loadBalancerShape or CategoryLogDetails can also be updated independently. All of the fields can be updated when the deployment is in the INACTIVE lifecycle state. Changes will take effect the next time the model deployment is activated.

  • 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 the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



9717
9718
9719
9720
9721
9722
9723
9724
9725
9726
9727
9728
9729
9730
9731
9732
9733
9734
9735
9736
9737
9738
9739
9740
9741
9742
9743
9744
9745
9746
9747
9748
9749
9750
9751
9752
9753
9754
 
# File 'lib/oci/data_science/data_science_client.rb', line 9717

def update_model_deployment(model_deployment_id, update_model_deployment_details, opts = {})
  logger.debug 'Calling operation DataScienceClient#update_model_deployment.' if logger

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

  path = '/modelDeployments/{modelDeploymentId}'.sub('{modelDeploymentId}', model_deployment_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_model_deployment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataScienceClient#update_model_deployment') 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_model_provenance(model_id, update_model_provenance_details, opts = {}) ⇒ Response

Note:

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

Updates the provenance information for the specified model.

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) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:



9780
9781
9782
9783
9784
9785
9786
9787
9788
9789
9790
9791
9792
9793
9794
9795
9796
9797
9798
9799
9800
9801
9802
9803
9804
9805
9806
9807
9808
9809
9810
9811
9812
9813
9814
9815
9816
9817
9818
 
# File 'lib/oci/data_science/data_science_client.rb', line 9780

def update_model_provenance(model_id, update_model_provenance_details, opts = {})
  logger.debug 'Calling operation DataScienceClient#update_model_provenance.' if logger

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

  path = '/models/{modelId}/provenance'.sub('{modelId}', model_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 = @api_client.object_to_http_body(update_model_provenance_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataScienceClient#update_model_provenance') 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::DataScience::Models::ModelProvenance'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_model_version_set(model_version_set_id, update_model_version_set_details, opts = {}) ⇒ Response

Note:

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

Updates the properties of a model version set. User can update the description property.

Parameters:

  • model_version_set_id (String) —

    The OCID of the model version set.

  • update_model_version_set_details (OCI::DataScience::Models::UpdateModelVersionSetDetails) —

    Details for updating a model version set. You can update description property only.

  • 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 the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:



9844
9845
9846
9847
9848
9849
9850
9851
9852
9853
9854
9855
9856
9857
9858
9859
9860
9861
9862
9863
9864
9865
9866
9867
9868
9869
9870
9871
9872
9873
9874
9875
9876
9877
9878
9879
9880
9881
9882
 
# File 'lib/oci/data_science/data_science_client.rb', line 9844

def update_model_version_set(model_version_set_id, update_model_version_set_details, opts = {})
  logger.debug 'Calling operation DataScienceClient#update_model_version_set.' if logger

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

  path = '/modelVersionSets/{modelVersionSetId}'.sub('{modelVersionSetId}', model_version_set_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_model_version_set_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataScienceClient#update_model_version_set') 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::DataScience::Models::ModelVersionSet'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_notebook_session(notebook_session_id, update_notebook_session_details, opts = {}) ⇒ Response

Note:

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

Updates the properties of a notebook session. You can update the displayName, freeformTags, and definedTags properties. When the notebook session is in the INACTIVE lifecycle state, you can update notebookSessionConfigurationDetails and change shape, subnetId, and blockStorageSizeInGBs. Changes to the notebookSessionConfigurationDetails take effect the next time the ActivateNotebookSession action is invoked on the notebook session resource.

Parameters:

  • notebook_session_id (String) —

    The OCID of the notebook session.

  • update_notebook_session_details (OCI::DataScience::Models::UpdateNotebookSessionDetails) —

    Details for updating a notebook session. notebookSessionConfigurationDetails can only be updated while the notebook session is in the INACTIVE state. Changes to the notebookSessionConfigurationDetails take effect the next time the ActivateNotebookSession action is invoked on the notebook session resource.

  • 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 the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:



9913
9914
9915
9916
9917
9918
9919
9920
9921
9922
9923
9924
9925
9926
9927
9928
9929
9930
9931
9932
9933
9934
9935
9936
9937
9938
9939
9940
9941
9942
9943
9944
9945
9946
9947
9948
9949
9950
9951
 
# File 'lib/oci/data_science/data_science_client.rb', line 9913

def update_notebook_session(notebook_session_id, update_notebook_session_details, opts = {})
  logger.debug 'Calling operation DataScienceClient#update_notebook_session.' if logger

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

  path = '/notebookSessions/{notebookSessionId}'.sub('{notebookSessionId}', notebook_session_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_notebook_session_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataScienceClient#update_notebook_session') 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::DataScience::Models::NotebookSession'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_pipeline(pipeline_id, update_pipeline_details, opts = {}) ⇒ Response

Note:

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

Updates the Pipeline.

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 the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:



9977
9978
9979
9980
9981
9982
9983
9984
9985
9986
9987
9988
9989
9990
9991
9992
9993
9994
9995
9996
9997
9998
9999
10000
10001
10002
10003
10004
10005
10006
10007
10008
10009
10010
10011
10012
10013
10014
10015
 
# File 'lib/oci/data_science/data_science_client.rb', line 9977

def update_pipeline(pipeline_id, update_pipeline_details, opts = {})
  logger.debug 'Calling operation DataScienceClient#update_pipeline.' if logger

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

  path = '/pipelines/{pipelineId}'.sub('{pipelineId}', pipeline_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_pipeline_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataScienceClient#update_pipeline') 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::DataScience::Models::Pipeline'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_pipeline_run(pipeline_run_id, update_pipeline_run_details, opts = {}) ⇒ Response

Note:

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

Updates the PipelineRun.

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 the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:



10041
10042
10043
10044
10045
10046
10047
10048
10049
10050
10051
10052
10053
10054
10055
10056
10057
10058
10059
10060
10061
10062
10063
10064
10065
10066
10067
10068
10069
10070
10071
10072
10073
10074
10075
10076
10077
10078
10079
 
# File 'lib/oci/data_science/data_science_client.rb', line 10041

def update_pipeline_run(pipeline_run_id, update_pipeline_run_details, opts = {})
  logger.debug 'Calling operation DataScienceClient#update_pipeline_run.' if logger

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

  path = '/pipelineRuns/{pipelineRunId}'.sub('{pipelineRunId}', pipeline_run_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_pipeline_run_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataScienceClient#update_pipeline_run') 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::DataScience::Models::PipelineRun'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_project(project_id, update_project_details, opts = {}) ⇒ Response

Note:

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

Updates the properties of a project. You can update the displayName, description, freeformTags, and definedTags properties.

Parameters:

  • project_id (String) —

    The OCID of the project.

  • update_project_details (OCI::DataScience::Models::UpdateProjectDetails) —

    Details for updating a project. You can update the displayName, description, freeformTags, and definedTags properties.

  • 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 the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:



10105
10106
10107
10108
10109
10110
10111
10112
10113
10114
10115
10116
10117
10118
10119
10120
10121
10122
10123
10124
10125
10126
10127
10128
10129
10130
10131
10132
10133
10134
10135
10136
10137
10138
10139
10140
10141
10142
10143
 
# File 'lib/oci/data_science/data_science_client.rb', line 10105

def update_project(project_id, update_project_details, opts = {})
  logger.debug 'Calling operation DataScienceClient#update_project.' if logger

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

  path = '/projects/{projectId}'.sub('{projectId}', project_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_project_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DataScienceClient#update_project') 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::DataScience::Models::Project'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_schedule(schedule_id, update_schedule_details, opts = {}) ⇒ Response

Note:

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

Updates the Schedule

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 the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



10169
10170
10171
10172
10173
10174
10175
10176
10177
10178
10179
10180
10181
10182
10183
10184
10185
10186
10187
10188
10189
10190
10191
10192
10193
10194
10195
10196
10197
10198
10199
10200
10201
10202
10203
10204
10205
10206
 
# File 'lib/oci/data_science/data_science_client.rb', line 10169

def update_schedule(schedule_id, update_schedule_details, opts = {})
  logger.debug 'Calling operation DataScienceClient#update_schedule.' if logger

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

  path = '/schedules/{scheduleId}'.sub('{scheduleId}', schedule_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_schedule_details)

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