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_model_group(model_group_id, opts = {}) ⇒ Response

Note:

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

Activates the model group.

Parameters:

  • model_group_id (String) —

    The OCID of the modelGroup.

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



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

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

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

  path = '/modelGroups/{modelGroupId}/actions/activate'.sub('{modelGroupId}', model_group_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_group') 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::ModelGroup'
    )
  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



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

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



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

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



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

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



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

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



557
558
559
560
561
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
 
# File 'lib/oci/data_science/data_science_client.rb', line 557

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_compute_target_compartment(compute_target_id, change_compute_target_compartment_details, opts = {}) ⇒ Response

Note:

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

Moves a compute target 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



621
622
623
624
625
626
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
 
# File 'lib/oci/data_science/data_science_client.rb', line 621

def change_compute_target_compartment(compute_target_id, change_compute_target_compartment_details, opts = {})
  logger.debug 'Calling operation DataScienceClient#change_compute_target_compartment.' if logger

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

  path = '/computeTargets/{computeTargetId}/actions/changeCompartment'.sub('{computeTargetId}', compute_target_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_compute_target_compartment_details)

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



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

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



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

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



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

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



884
885
886
887
888
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
 
# File 'lib/oci/data_science/data_science_client.rb', line 884

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



951
952
953
954
955
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
 
# File 'lib/oci/data_science/data_science_client.rb', line 951

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



1018
1019
1020
1021
1022
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
 
# File 'lib/oci/data_science/data_science_client.rb', line 1018

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



1085
1086
1087
1088
1089
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
 
# File 'lib/oci/data_science/data_science_client.rb', line 1085

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



1152
1153
1154
1155
1156
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
 
# File 'lib/oci/data_science/data_science_client.rb', line 1152

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



1219
1220
1221
1222
1223
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
 
# File 'lib/oci/data_science/data_science_client.rb', line 1219

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_group_compartment(model_group_id, change_model_group_compartment_details, opts = {}) ⇒ Response

Note:

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

Moves a model group 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



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

def change_model_group_compartment(model_group_id, change_model_group_compartment_details, opts = {})
  logger.debug 'Calling operation DataScienceClient#change_model_group_compartment.' if logger

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

  path = '/modelGroups/{modelGroupId}/actions/changeCompartment'.sub('{modelGroupId}', model_group_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_group_compartment_details)

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

Note:

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

Moves a model Group Version History 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



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

def change_model_group_version_history_compartment(model_group_version_history_id, change_model_group_version_history_compartment_details, opts = {})
  logger.debug 'Calling operation DataScienceClient#change_model_group_version_history_compartment.' if logger

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

  path = '/modelGroupVersionHistory/{modelGroupVersionHistoryId}/actions/changeCompartment'.sub('{modelGroupVersionHistoryId}', model_group_version_history_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_group_version_history_compartment_details)

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



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

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



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

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



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
1584
1585
1586
1587
1588
1589
 
# File 'lib/oci/data_science/data_science_client.rb', line 1552

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



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
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
 
# File 'lib/oci/data_science/data_science_client.rb', line 1615

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



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
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
 
# File 'lib/oci/data_science/data_science_client.rb', line 1680

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



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

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_compute_target(create_compute_target_details, opts = {}) ⇒ Response

Note:

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

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

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



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

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

  raise "Missing the required parameter 'create_compute_target_details' when calling create_compute_target." if create_compute_target_details.nil?

  path = '/computeTargets'
  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_compute_target_details)

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



1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
 
# File 'lib/oci/data_science/data_science_client.rb', line 1867

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



1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
 
# File 'lib/oci/data_science/data_science_client.rb', line 1925

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



1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
 
# File 'lib/oci/data_science/data_science_client.rb', line 1988

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:



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
2082
2083
2084
2085
2086
2087
2088
2089
 
# File 'lib/oci/data_science/data_science_client.rb', line 2051

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:



2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
 
# File 'lib/oci/data_science/data_science_client.rb', line 2111

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:



2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
 
# File 'lib/oci/data_science/data_science_client.rb', line 2170

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:



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

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:



2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
 
# File 'lib/oci/data_science/data_science_client.rb', line 2287

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



2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
 
# File 'lib/oci/data_science/data_science_client.rb', line 2361

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



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
2474
2475
2476
2477
2478
2479
 
# File 'lib/oci/data_science/data_science_client.rb', line 2438

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



2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
 
# File 'lib/oci/data_science/data_science_client.rb', line 2515

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:



2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
 
# File 'lib/oci/data_science/data_science_client.rb', line 2579

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_group(create_base_model_group_details, opts = {}) ⇒ Response

Note:

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

Create a new Model Group 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.

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



2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
 
# File 'lib/oci/data_science/data_science_client.rb', line 2638

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

  raise "Missing the required parameter 'create_base_model_group_details' when calling create_model_group." if create_base_model_group_details.nil?

  path = '/modelGroups'
  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_base_model_group_details)

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

#create_model_group_artifact(model_group_id, model_group_artifact, opts = {}) ⇒ Response

Note:

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

Creates artifact for the Model Group.

Parameters:

  • model_group_id (String) —

    The OCID of the modelGroup.

  • model_group_artifact (String, IO) —

    The model group 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



2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
 
# File 'lib/oci/data_science/data_science_client.rb', line 2712

def create_model_group_artifact(model_group_id, model_group_artifact, opts = {})
  logger.debug 'Calling operation DataScienceClient#create_model_group_artifact.' if logger

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

  path = '/modelGroups/{modelGroupId}/artifact'.sub('{modelGroupId}', model_group_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_group_artifact)

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

Note:

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

Creates a new modelGroupVersionHistory.

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:



2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
 
# File 'lib/oci/data_science/data_science_client.rb', line 2774

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

  raise "Missing the required parameter 'create_model_group_version_history_details' when calling create_model_group_version_history." if create_model_group_version_history_details.nil?

  path = '/modelGroupVersionHistory'
  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_group_version_history_details)

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



2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
 
# File 'lib/oci/data_science/data_science_client.rb', line 2833

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:



2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
 
# File 'lib/oci/data_science/data_science_client.rb', line 2893

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:



2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
 
# File 'lib/oci/data_science/data_science_client.rb', line 2951

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:



3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
 
# File 'lib/oci/data_science/data_science_client.rb', line 3010

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:



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
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
 
# File 'lib/oci/data_science/data_science_client.rb', line 3071

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:



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
3161
3162
3163
3164
3165
3166
3167
 
# File 'lib/oci/data_science/data_science_client.rb', line 3130

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:



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
3222
3223
3224
3225
3226
 
# File 'lib/oci/data_science/data_science_client.rb', line 3189

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



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
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
 
# File 'lib/oci/data_science/data_science_client.rb', line 3258

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:



3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
 
# File 'lib/oci/data_science/data_science_client.rb', line 3325

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



3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
 
# File 'lib/oci/data_science/data_science_client.rb', line 3387

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_model_group(model_group_id, opts = {}) ⇒ Response

Note:

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

Deactivates the model group.

Parameters:

  • model_group_id (String) —

    The OCID of the modelGroup.

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



3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
 
# File 'lib/oci/data_science/data_science_client.rb', line 3448

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

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

  path = '/modelGroups/{modelGroupId}/actions/deactivate'.sub('{modelGroupId}', model_group_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_group') 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::ModelGroup'
    )
  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



3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
 
# File 'lib/oci/data_science/data_science_client.rb', line 3510

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



3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
 
# File 'lib/oci/data_science/data_science_client.rb', line 3573

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_compute_target(compute_target_id, opts = {}) ⇒ Response

Note:

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

Deletes the specified compute target.

Parameters:

  • compute_target_id (String) —

    The OCID of the compute target.

  • 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



3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
 
# File 'lib/oci/data_science/data_science_client.rb', line 3636

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

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

  path = '/computeTargets/{computeTargetId}'.sub('{computeTargetId}', compute_target_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_compute_target') 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_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



3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
 
# File 'lib/oci/data_science/data_science_client.rb', line 3699

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



3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
 
# File 'lib/oci/data_science/data_science_client.rb', line 3761

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



3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
 
# File 'lib/oci/data_science/data_science_client.rb', line 3823

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



3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
 
# File 'lib/oci/data_science/data_science_client.rb', line 3884

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



3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
 
# File 'lib/oci/data_science/data_science_client.rb', line 3945

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



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
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
 
# File 'lib/oci/data_science/data_science_client.rb', line 4006

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



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
4099
4100
4101
4102
4103
 
# File 'lib/oci/data_science/data_science_client.rb', line 4067

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



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

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



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

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



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

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_group(model_group_id, opts = {}) ⇒ Response

Note:

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

Deletes the specified Model Group.

Parameters:

  • model_group_id (String) —

    The OCID of the modelGroup.

  • 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



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
4346
4347
4348
4349
4350
4351
4352
4353
 
# File 'lib/oci/data_science/data_science_client.rb', line 4317

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

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

  path = '/modelGroups/{modelGroupId}'.sub('{modelGroupId}', model_group_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_model_group') 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_group_version_history(model_group_version_history_id, opts = {}) ⇒ Response

Note:

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

Deletes the specified modelGroupVersionHistory.

Parameters:

  • model_group_version_history_id (String) —

    The OCID of the modelGroupVersionHistory.

  • 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



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

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

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

  path = '/modelGroupVersionHistory/{modelGroupVersionHistoryId}'.sub('{modelGroupVersionHistoryId}', model_group_version_history_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_model_group_version_history') 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



4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
 
# File 'lib/oci/data_science/data_science_client.rb', line 4442

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



4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
 
# File 'lib/oci/data_science/data_science_client.rb', line 4504

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



4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
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
 
# File 'lib/oci/data_science/data_science_client.rb', line 4567

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



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
4662
4663
4664
4665
4666
4667
4668
 
# File 'lib/oci/data_science/data_science_client.rb', line 4631

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



4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
 
# File 'lib/oci/data_science/data_science_client.rb', line 4693

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



4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
 
# File 'lib/oci/data_science/data_science_client.rb', line 4754

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:



4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
 
# File 'lib/oci/data_science/data_science_client.rb', line 4818

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:



4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
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
 
# File 'lib/oci/data_science/data_science_client.rb', line 4886

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



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
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
 
# File 'lib/oci/data_science/data_science_client.rb', line 4954

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_compute_target(compute_target_id, opts = {}) ⇒ Response

Note:

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

Retrieves the compute target for the specified computeTargetId.

Parameters:

  • compute_target_id (String) —

    The OCID of the compute target.

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



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
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
 
# File 'lib/oci/data_science/data_science_client.rb', line 5012

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

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

  path = '/computeTargets/{computeTargetId}'.sub('{computeTargetId}', compute_target_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_compute_target') 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::ComputeTarget'
    )
  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:



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

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



5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
 
# File 'lib/oci/data_science/data_science_client.rb', line 5124

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



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
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
 
# File 'lib/oci/data_science/data_science_client.rb', line 5184

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:



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

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:



5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
 
# File 'lib/oci/data_science/data_science_client.rb', line 5339

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



5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
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
5469
5470
5471
5472
5473
5474
5475
5476
 
# File 'lib/oci/data_science/data_science_client.rb', line 5396

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:



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
5524
5525
5526
5527
5528
5529
5530
5531
 
# File 'lib/oci/data_science/data_science_client.rb', line 5495

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:



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
5579
5580
5581
5582
5583
5584
5585
5586
 
# File 'lib/oci/data_science/data_science_client.rb', line 5550

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:



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
5634
5635
5636
5637
5638
5639
5640
5641
 
# File 'lib/oci/data_science/data_science_client.rb', line 5605

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:



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
5689
5690
5691
5692
5693
5694
5695
5696
 
# File 'lib/oci/data_science/data_science_client.rb', line 5660

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



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
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
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
 
# File 'lib/oci/data_science/data_science_client.rb', line 5717

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:



5816
5817
5818
5819
5820
5821
5822
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
 
# File 'lib/oci/data_science/data_science_client.rb', line 5816

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



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
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
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
 
# File 'lib/oci/data_science/data_science_client.rb', line 5876

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



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
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
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
 
# File 'lib/oci/data_science/data_science_client.rb', line 5982

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



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
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
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
 
# File 'lib/oci/data_science/data_science_client.rb', line 6090

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:



6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
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
 
# File 'lib/oci/data_science/data_science_client.rb', line 6192

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_group(model_group_id, opts = {}) ⇒ Response

Note:

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

Retrieves the Model Group resource based on the specified modelGroup id.

Parameters:

  • model_group_id (String) —

    The OCID of the modelGroup.

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



6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
 
# File 'lib/oci/data_science/data_science_client.rb', line 6247

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

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

  path = '/modelGroups/{modelGroupId}'.sub('{modelGroupId}', model_group_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_group') 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::ModelGroup'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_model_group_artifact_content(model_group_id, opts = {}, &block) ⇒ Response

Note:

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

Downloads the model artifact for the specified model group.

Parameters:

  • model_group_id (String) —

    The OCID of the modelGroup.

  • 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



6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
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
 
# File 'lib/oci/data_science/data_science_client.rb', line 6307

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

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

  path = '/modelGroups/{modelGroupId}/artifact/content'.sub('{modelGroupId}', model_group_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_group_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_group_version_history(model_group_version_history_id, opts = {}) ⇒ Response

Note:

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

Gets the specified modelGroupVersionHistory's information.

Parameters:

  • model_group_version_history_id (String) —

    The OCID of the modelGroupVersionHistory.

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



6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
 
# File 'lib/oci/data_science/data_science_client.rb', line 6407

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

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

  path = '/modelGroupVersionHistory/{modelGroupVersionHistoryId}'.sub('{modelGroupVersionHistoryId}', model_group_version_history_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_group_version_history') 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::ModelGroupVersionHistory'
    )
  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:



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

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:



6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
 
# File 'lib/oci/data_science/data_science_client.rb', line 6517

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:



6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
 
# File 'lib/oci/data_science/data_science_client.rb', line 6572

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:



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

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:



6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
 
# File 'lib/oci/data_science/data_science_client.rb', line 6682

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:



6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
 
# File 'lib/oci/data_science/data_science_client.rb', line 6737

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:



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

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



6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
6885
6886
6887
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
 
# File 'lib/oci/data_science/data_science_client.rb', line 6853

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:



6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
 
# File 'lib/oci/data_science/data_science_client.rb', line 6955

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



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
7042
7043
7044
7045
 
# File 'lib/oci/data_science/data_science_client.rb', line 7010

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



7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
 
# File 'lib/oci/data_science/data_science_client.rb', line 7064

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



7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
 
# File 'lib/oci/data_science/data_science_client.rb', line 7119

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



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

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_model_group_artifact(model_group_id, opts = {}) ⇒ Response

Note:

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

Gets model group artifact metadata for a specified model group.

Parameters:

  • model_group_id (String) —

    The OCID of the modelGroup.

  • 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



7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
 
# File 'lib/oci/data_science/data_science_client.rb', line 7232

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

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

  path = '/modelGroups/{modelGroupId}/artifact/content'.sub('{modelGroupId}', model_group_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_group_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



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

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



7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
 
# File 'lib/oci/data_science/data_science_client.rb', line 7350

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_compute_target_shapes(compartment_id, opts = {}) ⇒ Response

Note:

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

Lists the valid compute target 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:



7418
7419
7420
7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
 
# File 'lib/oci/data_science/data_science_client.rb', line 7418

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

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

  path = '/computeTargetShapes'
  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_compute_target_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::ComputeTargetShapeSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

List all compute targets in the specified compartment. Supports queries on various other parameters in the query alongside compartmentId (must be included).

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.

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



7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
7542
7543
7544
7545
7546
7547
7548
7549
7550
7551
7552
7553
7554
7555
7556
7557
7558
 
# File 'lib/oci/data_science/data_science_client.rb', line 7503

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

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

  if opts[:lifecycle_state] && !OCI::DataScience::Models::COMPUTE_TARGET_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataScience::Models::COMPUTE_TARGET_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 = '/computeTargets'
  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[: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_compute_targets') 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::ComputeTargetSummary>'
    )
  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:



7597
7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
 
# File 'lib/oci/data_science/data_science_client.rb', line 7597

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:



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
7736
7737
7738
7739
7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
7750
7751
7752
7753
7754
7755
7756
 
# File 'lib/oci/data_science/data_science_client.rb', line 7696

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:



7787
7788
7789
7790
7791
7792
7793
7794
7795
7796
7797
7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
 
# File 'lib/oci/data_science/data_science_client.rb', line 7787

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:



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
7910
7911
7912
7913
7914
7915
7916
7917
7918
7919
7920
7921
7922
7923
7924
7925
7926
7927
7928
7929
7930
 
# File 'lib/oci/data_science/data_science_client.rb', line 7873

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:



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

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:



8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
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
 
# File 'lib/oci/data_science/data_science_client.rb', line 8047

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:



8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
8161
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
 
# File 'lib/oci/data_science/data_science_client.rb', line 8143

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:



8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
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
 
# File 'lib/oci/data_science/data_science_client.rb', line 8239

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

  • :ml_application_instance_id (String) —

    unique MlApplicationInstance 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:



8339
8340
8341
8342
8343
8344
8345
8346
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
8386
8387
8388
8389
8390
8391
8392
8393
8394
8395
8396
 
# File 'lib/oci/data_science/data_science_client.rb', line 8339

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[:mlApplicationInstanceId] = opts[:ml_application_instance_id] if opts[:ml_application_instance_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:



8437
8438
8439
8440
8441
8442
8443
8444
8445
8446
8447
8448
8449
8450
8451
8452
8453
8454
8455
8456
8457
8458
8459
8460
8461
8462
8463
8464
8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
8484
8485
8486
8487
8488
8489
8490
8491
8492
 
# File 'lib/oci/data_science/data_science_client.rb', line 8437

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:



8534
8535
8536
8537
8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
8548
8549
8550
8551
8552
8553
8554
8555
8556
8557
8558
8559
8560
8561
8562
8563
8564
8565
8566
8567
8568
8569
8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
 
# File 'lib/oci/data_science/data_science_client.rb', line 8534

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_model_states(model_deployment_id, compartment_id, opts = {}) ⇒ Response

Note:

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

Lists the status of models in a model group deployment.

Parameters:

  • model_deployment_id (String) —

    The OCID of the model deployment.

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

  • :display_name (String) —

    Filter results by its user-friendly name.

  • :inference_key (String) —

    Filter results by the inference key.

  • :model_id (String) —

    Filter results by the model ocid.

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



8637
8638
8639
8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
8651
8652
8653
8654
8655
8656
8657
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
 
# File 'lib/oci/data_science/data_science_client.rb', line 8637

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

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

  path = '/modelDeployments/{modelDeploymentId}/models/modelState'.sub('{modelDeploymentId}', model_deployment_id.to_s)
  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[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:inferenceKey] = opts[:inference_key] if opts[:inference_key]
  query_params[:modelId] = opts[:model_id] if opts[:model_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]
  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#list_model_deployment_model_states') 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::ModelDeploymentModelStateSummary>'
    )
  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:



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

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:



8811
8812
8813
8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
8827
8828
8829
8830
8831
8832
8833
8834
8835
8836
8837
8838
8839
8840
8841
8842
8843
8844
8845
8846
8847
8848
8849
8850
8851
8852
8853
8854
8855
8856
8857
8858
8859
8860
8861
8862
8863
8864
8865
8866
8867
8868
 
# File 'lib/oci/data_science/data_science_client.rb', line 8811

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_group_models(model_group_id, compartment_id, opts = {}) ⇒ Response

Note:

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

Lists all models associated with the modelGroup in the specified compartment.

Parameters:

  • model_group_id (String) —

    The OCID of the modelGroup.

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



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
8951
8952
8953
8954
8955
8956
8957
8958
8959
8960
8961
8962
8963
8964
8965
8966
8967
8968
8969
8970
8971
8972
8973
 
# File 'lib/oci/data_science/data_science_client.rb', line 8915

def list_model_group_models(model_group_id, compartment_id, opts = {})
  logger.debug 'Calling operation DataScienceClient#list_model_group_models.' if logger

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

  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
  raise "Parameter value for 'model_group_id' must not be blank" if OCI::Internal::Util.blank_string?(model_group_id)

  path = '/modelGroups/{modelGroupId}/models'.sub('{modelGroupId}', model_group_id.to_s)
  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_model_group_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::ModelGroupModelSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

List all modelGroupVersionHistories in the specified compartment. The query must include compartmentId.

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

    A filter to return resources matching the given lifecycleState.

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



9018
9019
9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
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
 
# File 'lib/oci/data_science/data_science_client.rb', line 9018

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

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

  if opts[:lifecycle_state] && !OCI::DataScience::Models::MODEL_GROUP_VERSION_HISTORY_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataScience::Models::MODEL_GROUP_VERSION_HISTORY_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 = '/modelGroupVersionHistory'
  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_model_group_version_histories') 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::ModelGroupVersionHistorySummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Lists all the modelGroups in the specified compartment. The query must include compartmentId.

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

    A filter to return resources matching the given lifecycleState.

  • :created_by (String) —

    Filter results by the OCID of the user who created the resource.

  • :model_group_version_history_id (String) —

    The OCID of the modelGroupVersionHistory.

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



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
9148
9149
9150
9151
9152
9153
9154
9155
9156
9157
9158
9159
9160
9161
9162
9163
9164
9165
9166
9167
9168
9169
9170
9171
9172
9173
9174
9175
9176
9177
9178
9179
 
# File 'lib/oci/data_science/data_science_client.rb', line 9121

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

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

  if opts[:lifecycle_state] && !OCI::DataScience::Models::MODEL_GROUP_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataScience::Models::MODEL_GROUP_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 = '/modelGroups'
  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[:modelGroupVersionHistoryId] = opts[:model_group_version_history_id] if opts[:model_group_version_history_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_model_groups') 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::ModelGroupSummary>'
    )
  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:



9228
9229
9230
9231
9232
9233
9234
9235
9236
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
9275
9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
9287
9288
9289
9290
 
# File 'lib/oci/data_science/data_science_client.rb', line 9228

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:



9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
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
9402
9403
9404
9405
9406
 
# File 'lib/oci/data_science/data_science_client.rb', line 9342

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:



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
9466
9467
9468
9469
9470
9471
9472
9473
9474
9475
 
# File 'lib/oci/data_science/data_science_client.rb', line 9437

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:



9523
9524
9525
9526
9527
9528
9529
9530
9531
9532
9533
9534
9535
9536
9537
9538
9539
9540
9541
9542
9543
9544
9545
9546
9547
9548
9549
9550
9551
9552
9553
9554
9555
9556
9557
9558
9559
9560
9561
9562
9563
9564
9565
9566
9567
9568
9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
9580
 
# File 'lib/oci/data_science/data_science_client.rb', line 9523

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:



9626
9627
9628
9629
9630
9631
9632
9633
9634
9635
9636
9637
9638
9639
9640
9641
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 9626

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:



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
9755
9756
9757
9758
9759
9760
9761
9762
9763
9764
9765
9766
9767
9768
9769
9770
9771
9772
9773
9774
9775
9776
9777
9778
9779
9780
9781
9782
9783
9784
9785
9786
 
# File 'lib/oci/data_science/data_science_client.rb', line 9729

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:



9833
9834
9835
9836
9837
9838
9839
9840
9841
9842
9843
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
9883
9884
9885
9886
9887
9888
9889
 
# File 'lib/oci/data_science/data_science_client.rb', line 9833

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:



9931
9932
9933
9934
9935
9936
9937
9938
9939
9940
9941
9942
9943
9944
9945
9946
9947
9948
9949
9950
9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
9974
9975
9976
9977
9978
9979
9980
9981
9982
9983
9984
9985
9986
9987
 
# File 'lib/oci/data_science/data_science_client.rb', line 9931

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:



10018
10019
10020
10021
10022
10023
10024
10025
10026
10027
10028
10029
10030
10031
10032
10033
10034
10035
10036
10037
10038
10039
10040
10041
10042
10043
10044
10045
10046
10047
10048
10049
10050
10051
10052
10053
10054
10055
10056
 
# File 'lib/oci/data_science/data_science_client.rb', line 10018

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:



10087
10088
10089
10090
10091
10092
10093
10094
10095
10096
10097
10098
10099
10100
10101
10102
10103
10104
10105
10106
10107
10108
10109
10110
10111
10112
10113
10114
10115
10116
10117
10118
10119
10120
10121
10122
10123
10124
10125
 
# File 'lib/oci/data_science/data_science_client.rb', line 10087

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.

  • :resource_id (String) —

    Filter results by the OCID of the resource associated with the work request.

  • :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, COMPUTE_TARGET_CREATE, COMPUTE_TARGET_UPDATE, COMPUTE_TARGET_DELETE, MODEL_GROUP_CREATE, MODEL_GROUP_UPDATE, MODEL_GROUP_DELETE, MODEL_GROUP_VERSION_HISTORY_DELETE

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



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
10207
10208
10209
10210
10211
10212
10213
10214
10215
10216
10217
10218
10219
10220
10221
10222
10223
10224
10225
10226
10227
10228
10229
 
# File 'lib/oci/data_science/data_science_client.rb', line 10169

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 COMPUTE_TARGET_CREATE COMPUTE_TARGET_UPDATE COMPUTE_TARGET_DELETE MODEL_GROUP_CREATE MODEL_GROUP_UPDATE MODEL_GROUP_DELETE MODEL_GROUP_VERSION_HISTORY_DELETE].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, COMPUTE_TARGET_CREATE, COMPUTE_TARGET_UPDATE, COMPUTE_TARGET_DELETE, MODEL_GROUP_CREATE, MODEL_GROUP_UPDATE, MODEL_GROUP_DELETE, MODEL_GROUP_VERSION_HISTORY_DELETE.'
  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[:resourceId] = opts[:resource_id] if opts[:resource_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



10261
10262
10263
10264
10265
10266
10267
10268
10269
10270
10271
10272
10273
10274
10275
10276
10277
10278
10279
10280
10281
10282
10283
10284
10285
10286
10287
10288
10289
10290
10291
10292
10293
10294
10295
10296
10297
10298
10299
10300
10301
10302
 
# File 'lib/oci/data_science/data_science_client.rb', line 10261

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



10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
10367
10368
10369
 
# File 'lib/oci/data_science/data_science_client.rb', line 10331

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



10397
10398
10399
10400
10401
10402
10403
10404
10405
10406
10407
10408
10409
10410
10411
10412
10413
10414
10415
10416
10417
10418
10419
10420
10421
10422
10423
10424
10425
10426
10427
10428
10429
10430
10431
10432
10433
10434
10435
10436
 
# File 'lib/oci/data_science/data_science_client.rb', line 10397

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



10464
10465
10466
10467
10468
10469
10470
10471
10472
10473
10474
10475
10476
10477
10478
10479
10480
10481
10482
10483
10484
10485
10486
10487
10488
10489
10490
10491
10492
10493
10494
10495
10496
10497
10498
10499
10500
10501
10502
10503
 
# File 'lib/oci/data_science/data_science_client.rb', line 10464

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



10525
10526
10527
10528
10529
10530
10531
10532
10533
10534
10535
10536
10537
10538
10539
10540
10541
10542
10543
10544
10545
10546
10547
10548
10549
10550
10551
10552
10553
10554
10555
10556
10557
10558
10559
10560
10561
10562
10563
 
# File 'lib/oci/data_science/data_science_client.rb', line 10525

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



10585
10586
10587
10588
10589
10590
10591
10592
10593
10594
10595
10596
10597
10598
10599
10600
10601
10602
10603
10604
10605
10606
10607
10608
10609
10610
10611
10612
10613
10614
10615
10616
10617
10618
10619
10620
10621
10622
10623
 
# File 'lib/oci/data_science/data_science_client.rb', line 10585

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_compute_target(compute_target_id, update_compute_target_details, opts = {}) ⇒ Response

Note:

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

Updates the compute target.

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



10649
10650
10651
10652
10653
10654
10655
10656
10657
10658
10659
10660
10661
10662
10663
10664
10665
10666
10667
10668
10669
10670
10671
10672
10673
10674
10675
10676
10677
10678
10679
10680
10681
10682
10683
10684
10685
10686
 
# File 'lib/oci/data_science/data_science_client.rb', line 10649

def update_compute_target(compute_target_id, update_compute_target_details, opts = {})
  logger.debug 'Calling operation DataScienceClient#update_compute_target.' if logger

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

  path = '/computeTargets/{computeTargetId}'.sub('{computeTargetId}', compute_target_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_compute_target_details)

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



10717
10718
10719
10720
10721
10722
10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
10736
10737
10738
10739
10740
10741
10742
10743
10744
10745
10746
10747
10748
10749
10750
10751
10752
10753
10754
10755
 
# File 'lib/oci/data_science/data_science_client.rb', line 10717

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



10781
10782
10783
10784
10785
10786
10787
10788
10789
10790
10791
10792
10793
10794
10795
10796
10797
10798
10799
10800
10801
10802
10803
10804
10805
10806
10807
10808
10809
10810
10811
10812
10813
10814
10815
10816
10817
10818
10819
 
# File 'lib/oci/data_science/data_science_client.rb', line 10781

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:



10845
10846
10847
10848
10849
10850
10851
10852
10853
10854
10855
10856
10857
10858
10859
10860
10861
10862
10863
10864
10865
10866
10867
10868
10869
10870
10871
10872
10873
10874
10875
10876
10877
10878
10879
10880
10881
10882
10883
 
# File 'lib/oci/data_science/data_science_client.rb', line 10845

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:



10909
10910
10911
10912
10913
10914
10915
10916
10917
10918
10919
10920
10921
10922
10923
10924
10925
10926
10927
10928
10929
10930
10931
10932
10933
10934
10935
10936
10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
 
# File 'lib/oci/data_science/data_science_client.rb', line 10909

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



10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
10988
10989
10990
10991
10992
10993
10994
10995
10996
10997
10998
10999
11000
11001
11002
11003
11004
11005
11006
11007
11008
11009
11010
 
# File 'lib/oci/data_science/data_science_client.rb', line 10973

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:



11036
11037
11038
11039
11040
11041
11042
11043
11044
11045
11046
11047
11048
11049
11050
11051
11052
11053
11054
11055
11056
11057
11058
11059
11060
11061
11062
11063
11064
11065
11066
11067
11068
11069
11070
11071
11072
11073
11074
 
# File 'lib/oci/data_science/data_science_client.rb', line 11036

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



11100
11101
11102
11103
11104
11105
11106
11107
11108
11109
11110
11111
11112
11113
11114
11115
11116
11117
11118
11119
11120
11121
11122
11123
11124
11125
11126
11127
11128
11129
11130
11131
11132
11133
11134
11135
11136
11137
 
# File 'lib/oci/data_science/data_science_client.rb', line 11100

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:



11163
11164
11165
11166
11167
11168
11169
11170
11171
11172
11173
11174
11175
11176
11177
11178
11179
11180
11181
11182
11183
11184
11185
11186
11187
11188
11189
11190
11191
11192
11193
11194
11195
11196
11197
11198
11199
11200
11201
 
# File 'lib/oci/data_science/data_science_client.rb', line 11163

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:



11227
11228
11229
11230
11231
11232
11233
11234
11235
11236
11237
11238
11239
11240
11241
11242
11243
11244
11245
11246
11247
11248
11249
11250
11251
11252
11253
11254
11255
11256
11257
11258
11259
11260
11261
11262
11263
11264
11265
 
# File 'lib/oci/data_science/data_science_client.rb', line 11227

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



11301
11302
11303
11304
11305
11306
11307
11308
11309
11310
11311
11312
11313
11314
11315
11316
11317
11318
11319
11320
11321
11322
11323
11324
11325
11326
11327
11328
11329
11330
11331
11332
11333
11334
11335
11336
11337
11338
11339
11340
11341
11342
 
# File 'lib/oci/data_science/data_science_client.rb', line 11301

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



11378
11379
11380
11381
11382
11383
11384
11385
11386
11387
11388
11389
11390
11391
11392
11393
11394
11395
11396
11397
11398
11399
11400
11401
11402
11403
11404
11405
11406
11407
11408
11409
11410
11411
11412
11413
11414
11415
11416
11417
11418
11419
 
# File 'lib/oci/data_science/data_science_client.rb', line 11378

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



11453
11454
11455
11456
11457
11458
11459
11460
11461
11462
11463
11464
11465
11466
11467
11468
11469
11470
11471
11472
11473
11474
11475
11476
11477
11478
11479
11480
11481
11482
11483
11484
11485
11486
11487
11488
11489
11490
 
# File 'lib/oci/data_science/data_science_client.rb', line 11453

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_group(model_group_id, update_model_group_details, opts = {}) ⇒ Response

Note:

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

Updates the properties of the Model Group.

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:



11516
11517
11518
11519
11520
11521
11522
11523
11524
11525
11526
11527
11528
11529
11530
11531
11532
11533
11534
11535
11536
11537
11538
11539
11540
11541
11542
11543
11544
11545
11546
11547
11548
11549
11550
11551
11552
11553
11554
 
# File 'lib/oci/data_science/data_science_client.rb', line 11516

def update_model_group(model_group_id, update_model_group_details, opts = {})
  logger.debug 'Calling operation DataScienceClient#update_model_group.' if logger

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

  path = '/modelGroups/{modelGroupId}'.sub('{modelGroupId}', model_group_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_group_details)

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

#update_model_group_version_history(model_group_version_history_id, update_model_group_version_history_details, opts = {}) ⇒ Response

Note:

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

Updates the properties of a modelGroupVersionHistory.

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:



11580
11581
11582
11583
11584
11585
11586
11587
11588
11589
11590
11591
11592
11593
11594
11595
11596
11597
11598
11599
11600
11601
11602
11603
11604
11605
11606
11607
11608
11609
11610
11611
11612
11613
11614
11615
11616
11617
11618
 
# File 'lib/oci/data_science/data_science_client.rb', line 11580

def update_model_group_version_history(model_group_version_history_id, update_model_group_version_history_details, opts = {})
  logger.debug 'Calling operation DataScienceClient#update_model_group_version_history.' if logger

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

  path = '/modelGroupVersionHistory/{modelGroupVersionHistoryId}'.sub('{modelGroupVersionHistoryId}', model_group_version_history_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_group_version_history_details)

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



11644
11645
11646
11647
11648
11649
11650
11651
11652
11653
11654
11655
11656
11657
11658
11659
11660
11661
11662
11663
11664
11665
11666
11667
11668
11669
11670
11671
11672
11673
11674
11675
11676
11677
11678
11679
11680
11681
11682
 
# File 'lib/oci/data_science/data_science_client.rb', line 11644

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:



11708
11709
11710
11711
11712
11713
11714
11715
11716
11717
11718
11719
11720
11721
11722
11723
11724
11725
11726
11727
11728
11729
11730
11731
11732
11733
11734
11735
11736
11737
11738
11739
11740
11741
11742
11743
11744
11745
11746
 
# File 'lib/oci/data_science/data_science_client.rb', line 11708

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:



11777
11778
11779
11780
11781
11782
11783
11784
11785
11786
11787
11788
11789
11790
11791
11792
11793
11794
11795
11796
11797
11798
11799
11800
11801
11802
11803
11804
11805
11806
11807
11808
11809
11810
11811
11812
11813
11814
11815
 
# File 'lib/oci/data_science/data_science_client.rb', line 11777

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:



11841
11842
11843
11844
11845
11846
11847
11848
11849
11850
11851
11852
11853
11854
11855
11856
11857
11858
11859
11860
11861
11862
11863
11864
11865
11866
11867
11868
11869
11870
11871
11872
11873
11874
11875
11876
11877
11878
11879
 
# File 'lib/oci/data_science/data_science_client.rb', line 11841

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:



11905
11906
11907
11908
11909
11910
11911
11912
11913
11914
11915
11916
11917
11918
11919
11920
11921
11922
11923
11924
11925
11926
11927
11928
11929
11930
11931
11932
11933
11934
11935
11936
11937
11938
11939
11940
11941
11942
11943
 
# File 'lib/oci/data_science/data_science_client.rb', line 11905

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:



11969
11970
11971
11972
11973
11974
11975
11976
11977
11978
11979
11980
11981
11982
11983
11984
11985
11986
11987
11988
11989
11990
11991
11992
11993
11994
11995
11996
11997
11998
11999
12000
12001
12002
12003
12004
12005
12006
12007
 
# File 'lib/oci/data_science/data_science_client.rb', line 11969

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



12033
12034
12035
12036
12037
12038
12039
12040
12041
12042
12043
12044
12045
12046
12047
12048
12049
12050
12051
12052
12053
12054
12055
12056
12057
12058
12059
12060
12061
12062
12063
12064
12065
12066
12067
12068
12069
12070
 
# File 'lib/oci/data_science/data_science_client.rb', line 12033

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