Class: OCI::Dts::TransferApplianceClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/dts/transfer_appliance_client.rb

Overview

Data Transfer Service API Specification

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

Creates a new TransferApplianceClient. 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/dts/transfer_appliance_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 + '/20171001'
  else
    region ||= config.region
    region ||= signer.region if signer.respond_to?(:region)
    self.region = region
  end
  logger.info "TransferApplianceClient 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/dts/transfer_appliance_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/dts/transfer_appliance_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/dts/transfer_appliance_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/dts/transfer_appliance_client.rb', line 25

def retry_config
  @retry_config
end

Instance Method Details

#create_transfer_appliance(id, opts = {}) ⇒ Response

Note:

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

Create a new Transfer Appliance

Parameters:

  • id (String) —

    ID of the Transfer 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_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 (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

  • :create_transfer_appliance_details (OCI::Dts::Models::CreateTransferApplianceDetails) —

    Creates a New Transfer Appliance

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
 
# File 'lib/oci/dts/transfer_appliance_client.rb', line 117

def create_transfer_appliance(id, opts = {})
  logger.debug 'Calling operation TransferApplianceClient#create_transfer_appliance.' if logger

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

  path = '/transferJobs/{id}/transferAppliances'.sub('{id}', 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]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(opts[:create_transfer_appliance_details])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'TransferApplianceClient#create_transfer_appliance') 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::Dts::Models::TransferAppliance'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_transfer_appliance_admin_credentials(id, transfer_appliance_label, admin_public_key, opts = {}) ⇒ Response

Note:

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

Creates an X.509 certificate from a public key

Parameters:

  • id (String) —

    ID of the Transfer Job

  • transfer_appliance_label (String) —

    Label of the Transfer Appliance

  • admin_public_key (OCI::Dts::Models::TransferAppliancePublicKey)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the 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 (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:



179
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
217
218
219
 
# File 'lib/oci/dts/transfer_appliance_client.rb', line 179

def create_transfer_appliance_admin_credentials(id, transfer_appliance_label, admin_public_key, opts = {})
  logger.debug 'Calling operation TransferApplianceClient#create_transfer_appliance_admin_credentials.' if logger

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

  path = '/transferJobs/{id}/transferAppliances/{transferApplianceLabel}/admin_credentials'.sub('{id}', id.to_s).sub('{transferApplianceLabel}', transfer_appliance_label.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]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(admin_public_key)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'TransferApplianceClient#create_transfer_appliance_admin_credentials') 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::Dts::Models::TransferApplianceCertificate'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_transfer_appliance(id, transfer_appliance_label, opts = {}) ⇒ Response

Note:

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

deletes a transfer Appliance

Parameters:

  • id (String) —

    ID of the Transfer Job

  • transfer_appliance_label (String) —

    Label of the Transfer Appliance

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

    the optional parameters

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the 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 (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:

  • (Response) —

    A Response object with data of type nil



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
279
280
281
 
# File 'lib/oci/dts/transfer_appliance_client.rb', line 243

def delete_transfer_appliance(id, transfer_appliance_label, opts = {})
  logger.debug 'Calling operation TransferApplianceClient#delete_transfer_appliance.' if logger

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

  path = '/transferJobs/{id}/transferAppliances/{transferApplianceLabel}'.sub('{id}', id.to_s).sub('{transferApplianceLabel}', transfer_appliance_label.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]
  # 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: 'TransferApplianceClient#delete_transfer_appliance') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_transfer_appliance(id, transfer_appliance_label, opts = {}) ⇒ Response

Note:

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

Describes a transfer appliance in detail

Parameters:

  • id (String) —

    ID of the Transfer Job

  • transfer_appliance_label (String) —

    Label of the Transfer Appliance

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

    the optional parameters

Options Hash (opts):

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

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

Returns:



300
301
302
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
 
# File 'lib/oci/dts/transfer_appliance_client.rb', line 300

def get_transfer_appliance(id, transfer_appliance_label, opts = {})
  logger.debug 'Calling operation TransferApplianceClient#get_transfer_appliance.' if logger

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

  path = '/transferJobs/{id}/transferAppliances/{transferApplianceLabel}'.sub('{id}', id.to_s).sub('{transferApplianceLabel}', transfer_appliance_label.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'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'TransferApplianceClient#get_transfer_appliance') 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::Dts::Models::TransferAppliance'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_transfer_appliance_certificate_authority_certificate(id, transfer_appliance_label, opts = {}) ⇒ Response

Note:

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

Gets the x.509 certificate for the Transfer Appliance's dedicated Certificate Authority (CA)

Parameters:

  • id (String) —

    ID of the Transfer Job

  • transfer_appliance_label (String) —

    Label of the Transfer Appliance

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

    the optional parameters

Options Hash (opts):

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

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

Returns:



357
358
359
360
361
362
363
364
365
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
 
# File 'lib/oci/dts/transfer_appliance_client.rb', line 357

def get_transfer_appliance_certificate_authority_certificate(id, transfer_appliance_label, opts = {})
  logger.debug 'Calling operation TransferApplianceClient#get_transfer_appliance_certificate_authority_certificate.' if logger

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

  path = '/transferJobs/{id}/transferAppliances/{transferApplianceLabel}/certificate_authority_certificate'.sub('{id}', id.to_s).sub('{transferApplianceLabel}', transfer_appliance_label.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'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'TransferApplianceClient#get_transfer_appliance_certificate_authority_certificate') 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::Dts::Models::TransferApplianceCertificate'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_transfer_appliance_encryption_passphrase(id, transfer_appliance_label, opts = {}) ⇒ Response

Note:

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

Describes a transfer appliance encryptionPassphrase in detail

Parameters:

  • id (String) —

    ID of the Transfer Job

  • transfer_appliance_label (String) —

    Label of the Transfer Appliance

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

    the optional parameters

Options Hash (opts):

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

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

Returns:



414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
 
# File 'lib/oci/dts/transfer_appliance_client.rb', line 414

def get_transfer_appliance_encryption_passphrase(id, transfer_appliance_label, opts = {})
  logger.debug 'Calling operation TransferApplianceClient#get_transfer_appliance_encryption_passphrase.' if logger

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

  path = '/transferJobs/{id}/transferAppliances/{transferApplianceLabel}/encryptionPassphrase'.sub('{id}', id.to_s).sub('{transferApplianceLabel}', transfer_appliance_label.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'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'TransferApplianceClient#get_transfer_appliance_encryption_passphrase') 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::Dts::Models::TransferApplianceEncryptionPassphrase'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_transfer_appliances(id, opts = {}) ⇒ Response

Note:

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

Lists Transfer Appliances associated with a transferJob

Parameters:

  • id (String) —

    ID of the Transfer 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

  • :lifecycle_state (String) —

    filtering by lifecycleState Allowed values are: REQUESTED, ORACLE_PREPARING, SHIPPING, DELIVERED, PREPARING, FINALIZED, RETURN_LABEL_REQUESTED, RETURN_LABEL_GENERATING, RETURN_LABEL_AVAILABLE, RETURN_DELAYED, RETURN_SHIPPED, RETURN_SHIPPED_CANCELLED, ORACLE_RECEIVED, ORACLE_RECEIVED_CANCELLED, PROCESSING, COMPLETE, CUSTOMER_NEVER_RECEIVED, ORACLE_NEVER_RECEIVED, CUSTOMER_LOST, CANCELLED, DELETED, REJECTED, ERROR

Returns:



471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
 
# File 'lib/oci/dts/transfer_appliance_client.rb', line 471

def list_transfer_appliances(id, opts = {})
  logger.debug 'Calling operation TransferApplianceClient#list_transfer_appliances.' if logger

  raise "Missing the required parameter 'id' when calling list_transfer_appliances." if id.nil?

  if opts[:lifecycle_state] && !%w[REQUESTED ORACLE_PREPARING SHIPPING DELIVERED PREPARING FINALIZED RETURN_LABEL_REQUESTED RETURN_LABEL_GENERATING RETURN_LABEL_AVAILABLE RETURN_DELAYED RETURN_SHIPPED RETURN_SHIPPED_CANCELLED ORACLE_RECEIVED ORACLE_RECEIVED_CANCELLED PROCESSING COMPLETE CUSTOMER_NEVER_RECEIVED ORACLE_NEVER_RECEIVED CUSTOMER_LOST CANCELLED DELETED REJECTED ERROR].include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of REQUESTED, ORACLE_PREPARING, SHIPPING, DELIVERED, PREPARING, FINALIZED, RETURN_LABEL_REQUESTED, RETURN_LABEL_GENERATING, RETURN_LABEL_AVAILABLE, RETURN_DELAYED, RETURN_SHIPPED, RETURN_SHIPPED_CANCELLED, ORACLE_RECEIVED, ORACLE_RECEIVED_CANCELLED, PROCESSING, COMPLETE, CUSTOMER_NEVER_RECEIVED, ORACLE_NEVER_RECEIVED, CUSTOMER_LOST, CANCELLED, DELETED, REJECTED, ERROR.'
  end
  raise "Parameter value for 'id' must not be blank" if OCI::Internal::Util.blank_string?(id)

  path = '/transferJobs/{id}/transferAppliances'.sub('{id}', id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'TransferApplianceClient#list_transfer_appliances') 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::Dts::Models::MultipleTransferAppliances'
    )
  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/dts/transfer_appliance_client.rb', line 94

def logger
  @api_client.config.logger
end

#update_transfer_appliance(id, transfer_appliance_label, update_transfer_appliance_details, opts = {}) ⇒ Response

Note:

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

Updates a Transfer Appliance

Parameters:

  • id (String) —

    ID of the Transfer Job

  • transfer_appliance_label (String) —

    Label of the Transfer Appliance

  • update_transfer_appliance_details (OCI::Dts::Models::UpdateTransferApplianceDetails) —

    fields to update

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

    the optional parameters

Options Hash (opts):

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

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

  • :if_match (String) —

    The entity tag to match. Optional, if set, the update will be successful only if the object's tag matches the tag specified in the request.

Returns:



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

def update_transfer_appliance(id, transfer_appliance_label, update_transfer_appliance_details, opts = {})
  logger.debug 'Calling operation TransferApplianceClient#update_transfer_appliance.' if logger

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

  path = '/transferJobs/{id}/transferAppliances/{transferApplianceLabel}'.sub('{id}', id.to_s).sub('{transferApplianceLabel}', transfer_appliance_label.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]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_transfer_appliance_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'TransferApplianceClient#update_transfer_appliance') 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::Dts::Models::TransferAppliance'
    )
  end
  # rubocop:enable Metrics/BlockLength
end