TransferApplianceClient¶

class oci.dts.TransferApplianceClient(config, **kwargs)¶

Data Transfer Service API Specification

Methods

`__init__`(config, **kwargs)	Creates a new service client
`create_transfer_appliance`(id, **kwargs)	Create a new Transfer Appliance
`create_transfer_appliance_admin_credentials`(id, …)	Creates an X.509 certificate from a public key
`delete_transfer_appliance`(id, …)	deletes a transfer Appliance
`get_transfer_appliance`(id, …)	Describes a transfer appliance in detail
`get_transfer_appliance_certificate_authority_certificate`(id, …)	Gets the x.509 certificate for the Transfer Appliance’s dedicated Certificate Authority (CA)
`get_transfer_appliance_encryption_passphrase`(id, …)	Describes a transfer appliance encryptionPassphrase in detail
`list_transfer_appliances`(id, **kwargs)	Lists Transfer Appliances associated with a transferJob
`update_transfer_appliance`(id, …)	Updates a Transfer Appliance

__init__(config, **kwargs)¶

Creates a new service client

Parameters:

config (dict) – Configuration keys and values as per SDK and Tool Configuration. The from_file() method can be used to load configuration from a file. Alternatively, a dict can be passed. You can validate_config the dict using validate_config()
service_endpoint (str) – (optional) The endpoint of the service to call using this client. For example https://iaas.us-ashburn-1.oraclecloud.com. If this keyword argument is not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit need to specify a service endpoint.
timeout (float or tuple(float, float)) – (optional) The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout.
signer (AbstractBaseSigner) –
(optional) The signer to use when signing requests made by the service client. The default is to use a Signer based on the values provided in the config parameter.

One use case for this parameter is for Instance Principals authentication by passing an instance of InstancePrincipalsSecurityTokenSigner as the value for this keyword argument
retry_strategy (obj) –
(optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a retry_strategy keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level.

This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.
circuit_breaker_strategy (obj) – (optional) A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). This client uses DEFAULT_CIRCUIT_BREAKER_STRATEGY as default if no circuit breaker strategy is provided. The specifics of circuit breaker strategy are described here.
circuit_breaker_callback (function) – (optional) Callback function to receive any exceptions triggerred by the circuit breaker.
client_level_realm_specific_endpoint_template_enabled (bool) – (optional) A boolean flag to indicate whether or not this client should be created with realm specific endpoint template enabled or disable. By default, this will be set as None.
allow_control_chars – (optional) allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object.

create_transfer_appliance(id, **kwargs)¶

Create a new Transfer Appliance

Parameters:	id (str) – (required) ID of the Transfer Job opc_retry_token (str) – (optional) 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) – (optional) Creates a New Transfer Appliance retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `TransferAppliance`
Return type:	`Response`
Example:

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

create_transfer_appliance_admin_credentials(id, transfer_appliance_label, admin_public_key, **kwargs)¶

Creates an X.509 certificate from a public key

Parameters:	id (str) – (required) ID of the Transfer Job transfer_appliance_label (str) – (required) Label of the Transfer Appliance admin_public_key (oci.dts.models.TransferAppliancePublicKey) – (required) opc_retry_token (str) – (optional) 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). retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `TransferApplianceCertificate`
Return type:	`Response`
Example:

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

delete_transfer_appliance(id, transfer_appliance_label, **kwargs)¶

deletes a transfer Appliance

Parameters:	id (str) – (required) ID of the Transfer Job transfer_appliance_label (str) – (required) Label of the Transfer Appliance opc_retry_token (str) – (optional) 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). retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

get_transfer_appliance(id, transfer_appliance_label, **kwargs)¶

Describes a transfer appliance in detail

Parameters:	id (str) – (required) ID of the Transfer Job transfer_appliance_label (str) – (required) Label of the Transfer Appliance retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `TransferAppliance`
Return type:	`Response`
Example:

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

get_transfer_appliance_certificate_authority_certificate(id, transfer_appliance_label, **kwargs)¶

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

Parameters:	id (str) – (required) ID of the Transfer Job transfer_appliance_label (str) – (required) Label of the Transfer Appliance retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `TransferApplianceCertificate`
Return type:	`Response`
Example:

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

get_transfer_appliance_encryption_passphrase(id, transfer_appliance_label, **kwargs)¶

Describes a transfer appliance encryptionPassphrase in detail

Parameters:	id (str) – (required) ID of the Transfer Job transfer_appliance_label (str) – (required) Label of the Transfer Appliance retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `TransferApplianceEncryptionPassphrase`
Return type:	`Response`
Example:

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

list_transfer_appliances(id, **kwargs)¶

Lists Transfer Appliances associated with a transferJob

Parameters:	id (str) – (required) ID of the Transfer Job lifecycle_state (str) – (optional) 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” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `MultipleTransferAppliances`
Return type:	`Response`
Example:

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

update_transfer_appliance(id, transfer_appliance_label, update_transfer_appliance_details, **kwargs)¶

Updates a Transfer Appliance

Parameters:	id (str) – (required) ID of the Transfer Job transfer_appliance_label (str) – (required) Label of the Transfer Appliance update_transfer_appliance_details (oci.dts.models.UpdateTransferApplianceDetails) – (required) fields to update if_match (str) – (optional) 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. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `TransferAppliance`
Return type:	`Response`
Example:

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