Class: OCI::Rover::RoverBundleClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/rover/rover_bundle_client.rb

Overview

A description of the RoverCloudService API.

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

Creates a new RoverBundleClient. 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 OCI::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/rover/rover_bundle_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 + '/20201210'
  else
    region ||= config.region
    region ||= signer.region if signer.respond_to?(:region)
    self.region = region
  end
  logger.info "RoverBundleClient 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/rover/rover_bundle_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/rover/rover_bundle_client.rb', line 19

def endpoint
  @endpoint
end

#region ⇒ String

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

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/rover/rover_bundle_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/rover/rover_bundle_client.rb', line 25

def retry_config
  @retry_config
end

Instance Method Details

#list_rover_cluster_rover_bundle_requests(rover_cluster_id, opts = {}) ⇒ Response

Note:

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

List all the roverBundleRequests for a given roverClusterId. Allowed values are: timeTaskCreated

Parameters:

  • rover_cluster_id (String) —

    Unique RoverCluster identifier

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

    the optional parameters

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :limit (Integer) —

    The maximum number of items to return. (default to 10)

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. (default to ASC)

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for timeTaskCreated is descending. If no value is specified timeTaskCreated is default. (default to timeTaskCreated)

Returns:



117
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
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/oci/rover/rover_bundle_client.rb', line 117

def list_rover_cluster_rover_bundle_requests(rover_cluster_id, opts = {})
  logger.debug 'Calling operation RoverBundleClient#list_rover_cluster_rover_bundle_requests.' if logger

  raise "Missing the required parameter 'rover_cluster_id' when calling list_rover_cluster_rover_bundle_requests." if rover_cluster_id.nil?

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

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

  path = '/roverClusters/{roverClusterId}/roverBundleRequests'.sub('{roverClusterId}', rover_cluster_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]
  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: 'RoverBundleClient#list_rover_cluster_rover_bundle_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: 'OCI::Rover::Models::RoverBundleRequestCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_rover_node_rover_bundle_requests(rover_node_id, opts = {}) ⇒ Response

Note:

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

List all the roverBundleRequests for a given roverNodeId. Allowed values are: timeTaskCreated

Parameters:

  • rover_node_id (String) —

    Unique RoverNode identifier

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

    the optional parameters

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :limit (Integer) —

    The maximum number of items to return. (default to 10)

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. (default to ASC)

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for timeTaskCreated is descending. If no value is specified timeTaskCreated is default. (default to timeTaskCreated)

Returns:



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
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/oci/rover/rover_bundle_client.rb', line 189

def list_rover_node_rover_bundle_requests(rover_node_id, opts = {})
  logger.debug 'Calling operation RoverBundleClient#list_rover_node_rover_bundle_requests.' if logger

  raise "Missing the required parameter 'rover_node_id' when calling list_rover_node_rover_bundle_requests." if rover_node_id.nil?

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

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

  path = '/roverNodes/{roverNodeId}/roverBundleRequests'.sub('{roverNodeId}', rover_node_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]
  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: 'RoverBundleClient#list_rover_node_rover_bundle_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: 'OCI::Rover::Models::RoverBundleRequestCollection'
    )
  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/rover/rover_bundle_client.rb', line 94

def logger
  @api_client.config.logger
end

#request_bundle_rover_cluster(request_rover_bundle_details, rover_cluster_id, opts = {}) ⇒ Response

Note:

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

Request to get rover bundle to the bucket in customer's tenancy.

Parameters:

  • request_rover_bundle_details (OCI::Rover::Models::RequestRoverBundleDetails) —

    Request the rover bundle details.

  • rover_cluster_id (String) —

    Unique RoverCluster identifier

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

    the optional parameters

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



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

def request_bundle_rover_cluster(request_rover_bundle_details, rover_cluster_id, opts = {})
  logger.debug 'Calling operation RoverBundleClient#request_bundle_rover_cluster.' if logger

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

  path = '/roverClusters/{roverClusterId}/actions/requestRoverBundle'.sub('{roverClusterId}', rover_cluster_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(request_rover_bundle_details)

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

#request_bundle_rover_node(request_rover_bundle_details, rover_node_id, opts = {}) ⇒ Response

Note:

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

Request to get rover bundle to the bucket in customer's tenancy.

Parameters:

  • request_rover_bundle_details (OCI::Rover::Models::RequestRoverBundleDetails) —

    Request the rover bundle details.

  • rover_node_id (String) —

    Unique RoverNode identifier

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

    the optional parameters

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/oci/rover/rover_bundle_client.rb', line 313

def request_bundle_rover_node(request_rover_bundle_details, rover_node_id, opts = {})
  logger.debug 'Calling operation RoverBundleClient#request_bundle_rover_node.' if logger

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

  path = '/roverNodes/{roverNodeId}/actions/requestRoverBundle'.sub('{roverNodeId}', rover_node_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(request_rover_bundle_details)

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

#retrieve_available_bundle_versions_rover_cluster(current_rover_bundle_details, rover_cluster_id, opts = {}) ⇒ Response

Note:

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

Retrieve the latest available rover bundle version that can be upgraded to based on current bundle version.

Parameters:

  • current_rover_bundle_details (OCI::Rover::Models::CurrentRoverBundleDetails) —

    Provide the current rover bundle details.

  • rover_cluster_id (String) —

    Unique RoverCluster identifier

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

    the optional parameters

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



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
405
 
# File 'lib/oci/rover/rover_bundle_client.rb', line 368

def retrieve_available_bundle_versions_rover_cluster(current_rover_bundle_details, rover_cluster_id, opts = {})
  logger.debug 'Calling operation RoverBundleClient#retrieve_available_bundle_versions_rover_cluster.' if logger

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

  path = '/roverClusters/{roverClusterId}/actions/retrieveAvailableRoverBundleVersion'.sub('{roverClusterId}', rover_cluster_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(current_rover_bundle_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'RoverBundleClient#retrieve_available_bundle_versions_rover_cluster') 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::Rover::Models::RoverBundleVersion'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#retrieve_available_bundle_versions_rover_node(current_rover_bundle_details, rover_node_id, opts = {}) ⇒ Response

Note:

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

Retrieve the latest available rover bundle version that can be upgraded to based on current bundle version.

Parameters:

  • current_rover_bundle_details (OCI::Rover::Models::CurrentRoverBundleDetails) —

    Provide the current rover bundle details.

  • rover_node_id (String) —

    Unique RoverNode identifier

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

    the optional parameters

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



424
425
426
427
428
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
 
# File 'lib/oci/rover/rover_bundle_client.rb', line 424

def retrieve_available_bundle_versions_rover_node(current_rover_bundle_details, rover_node_id, opts = {})
  logger.debug 'Calling operation RoverBundleClient#retrieve_available_bundle_versions_rover_node.' if logger

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

  path = '/roverNodes/{roverNodeId}/actions/retrieveAvailableRoverBundleVersion'.sub('{roverNodeId}', rover_node_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(current_rover_bundle_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'RoverBundleClient#retrieve_available_bundle_versions_rover_node') 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::Rover::Models::RoverBundleVersion'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#retrieve_bundle_status_rover_cluster(rover_bundle_status_details, rover_cluster_id, opts = {}) ⇒ Response

Note:

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

Retrieve the status and progress of a rover bundle copy request.

Parameters:

  • rover_bundle_status_details (OCI::Rover::Models::RoverBundleStatusDetails) —

    Provide the rover bundle details that requires to retrieve its status.

  • rover_cluster_id (String) —

    Unique RoverCluster identifier

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

    the optional parameters

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



480
481
482
483
484
485
486
487
488
489
490
491
492
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
 
# File 'lib/oci/rover/rover_bundle_client.rb', line 480

def retrieve_bundle_status_rover_cluster(rover_bundle_status_details, rover_cluster_id, opts = {})
  logger.debug 'Calling operation RoverBundleClient#retrieve_bundle_status_rover_cluster.' if logger

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

  path = '/roverClusters/{roverClusterId}/actions/retrieveRoverBundleStatus'.sub('{roverClusterId}', rover_cluster_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(rover_bundle_status_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'RoverBundleClient#retrieve_bundle_status_rover_cluster') 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::Rover::Models::RoverBundleStatus'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#retrieve_bundle_status_rover_node(rover_bundle_status_details, rover_node_id, opts = {}) ⇒ Response

Note:

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

Retrieve the status and progress of a rover bundle copy request.

Parameters:

  • rover_bundle_status_details (OCI::Rover::Models::RoverBundleStatusDetails) —

    Provide the rover bundle details that requires to retrieve its status.

  • rover_node_id (String) —

    Unique RoverNode identifier

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

    the optional parameters

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
 
# File 'lib/oci/rover/rover_bundle_client.rb', line 536

def retrieve_bundle_status_rover_node(rover_bundle_status_details, rover_node_id, opts = {})
  logger.debug 'Calling operation RoverBundleClient#retrieve_bundle_status_rover_node.' if logger

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

  path = '/roverNodes/{roverNodeId}/actions/retrieveRoverBundleStatus'.sub('{roverNodeId}', rover_node_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(rover_bundle_status_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'RoverBundleClient#retrieve_bundle_status_rover_node') 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::Rover::Models::RoverBundleStatus'
    )
  end
  # rubocop:enable Metrics/BlockLength
end