Class: OCI::Dts::TransferApplianceClient
- Inherits:
-
Object
- Object
- OCI::Dts::TransferApplianceClient
- Defined in:
- lib/oci/dts/transfer_appliance_client.rb
Overview
Data Transfer Service API Specification
Instance Attribute Summary collapse
-
#api_client ⇒ OCI::ApiClient
readonly
Client used to make HTTP requests.
-
#endpoint ⇒ String
readonly
Fully qualified endpoint URL.
-
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
-
#retry_config ⇒ OCI::Retry::RetryConfig
readonly
The default retry configuration to apply to all operations in this service client.
Instance Method Summary collapse
-
#create_transfer_appliance(id, opts = {}) ⇒ Response
Create a new Transfer Appliance.
-
#create_transfer_appliance_admin_credentials(id, transfer_appliance_label, admin_public_key, opts = {}) ⇒ Response
Creates an X.509 certificate from a public key.
-
#delete_transfer_appliance(id, transfer_appliance_label, opts = {}) ⇒ Response
deletes a transfer Appliance.
-
#get_transfer_appliance(id, transfer_appliance_label, opts = {}) ⇒ Response
Describes a transfer appliance in detail.
-
#get_transfer_appliance_certificate_authority_certificate(id, transfer_appliance_label, opts = {}) ⇒ Response
Gets the x.509 certificate for the Transfer Appliance's dedicated Certificate Authority (CA).
-
#get_transfer_appliance_encryption_passphrase(id, transfer_appliance_label, opts = {}) ⇒ Response
Describes a transfer appliance encryptionPassphrase in detail.
-
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ TransferApplianceClient
constructor
Creates a new TransferApplianceClient.
-
#list_transfer_appliances(id, opts = {}) ⇒ Response
Lists Transfer Appliances associated with a transferJob.
-
#logger ⇒ Logger
The logger for this client.
-
#update_transfer_appliance(id, transfer_appliance_label, update_transfer_appliance_details, opts = {}) ⇒ Response
Updates a Transfer Appliance.
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.
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 |
# File 'lib/oci/dts/transfer_appliance_client.rb', line 53 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) if signer.nil? signer = OCI::Signer.new( config.user, config.fingerprint, config.tenancy, config.key_file, pass_phrase: config.pass_phrase, private_key_content: config.key_content ) end @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.
13 14 15 |
# File 'lib/oci/dts/transfer_appliance_client.rb', line 13 def api_client @api_client end |
#endpoint ⇒ String (readonly)
Fully qualified endpoint URL
17 18 19 |
# File 'lib/oci/dts/transfer_appliance_client.rb', line 17 def endpoint @endpoint end |
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
27 28 29 |
# File 'lib/oci/dts/transfer_appliance_client.rb', line 27 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
23 24 25 |
# File 'lib/oci/dts/transfer_appliance_client.rb', line 23 def retry_config @retry_config end |
Instance Method Details
#create_transfer_appliance(id, opts = {}) ⇒ Response
Create a new Transfer Appliance
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/dts/transfer_appliance_client.rb', line 118 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.(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
Creates an X.509 certificate from a public key
174 175 176 177 178 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 |
# File 'lib/oci/dts/transfer_appliance_client.rb', line 174 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' # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(admin_public_key) # rubocop:disable Metrics/BlockLength OCI::Retry.(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
deletes a transfer Appliance
231 232 233 234 235 236 237 238 239 240 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 |
# File 'lib/oci/dts/transfer_appliance_client.rb', line 231 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' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(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
Describes a transfer appliance in detail
286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 |
# File 'lib/oci/dts/transfer_appliance_client.rb', line 286 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.(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
Gets the x.509 certificate for the Transfer Appliance's dedicated Certificate Authority (CA)
342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 |
# File 'lib/oci/dts/transfer_appliance_client.rb', line 342 def (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.(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
Describes a transfer appliance encryptionPassphrase in detail
398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 |
# File 'lib/oci/dts/transfer_appliance_client.rb', line 398 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.(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
Lists Transfer Appliances associated with a transferJob
454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 |
# File 'lib/oci/dts/transfer_appliance_client.rb', line 454 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_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_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.(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.
101 102 103 |
# File 'lib/oci/dts/transfer_appliance_client.rb', line 101 def logger @api_client.config.logger end |
#update_transfer_appliance(id, transfer_appliance_label, update_transfer_appliance_details, opts = {}) ⇒ Response
Updates a Transfer Appliance
515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 |
# File 'lib/oci/dts/transfer_appliance_client.rb', line 515 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.(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 |