TransferJobClient

class oci.dts.TransferJobClient(config, **kwargs)

Data Transfer Service API Specification

__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 is that the client never times out. 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.

change_transfer_job_compartment(transfer_job_id, change_transfer_job_compartment_details, **kwargs)

Move a job into a different compartment. When provided, if-Match is matched against ETag values of the resource. Moves a TransferJob into a different compartment.

Parameters:
  • transfer_job_id (str) -- (required) ID of the Transfer Job
  • change_transfer_job_compartment_details (ChangeTransferJobCompartmentDetails) -- (required) CompartmentId of the destination compartment
  • 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.
  • opc_request_id (str) -- (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

create_transfer_job(create_transfer_job_details, **kwargs)

Create a new Transfer Job Create a new Transfer Job that corresponds with customer's logical dataset e.g. a DB or a filesystem.

Parameters:
  • create_transfer_job_details (CreateTransferJobDetails) -- (required) Creates a New Transfer Job
  • opc_retry_token (str) -- (optional)
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type TransferJob

Return type:

Response

delete_transfer_job(id, **kwargs)

deletes a transfer job deletes a transfer job

Parameters:
  • id (str) -- (required) ID of the Transfer Job
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

get_transfer_job(id, **kwargs)

Describes a transfer job in detail Describes a transfer job in detail

Parameters:
  • id (str) -- (required) OCID of the Transfer Job
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type TransferJob

Return type:

Response

list_transfer_jobs(compartment_id, **kwargs)

Lists Transfer Jobs in a given compartment Lists Transfer Jobs in a given compartment

Parameters:
  • compartment_id (str) -- (required) compartment id
  • lifecycle_state (str) --

    (optional) filtering by lifecycleState

    Allowed values are: "INITIATED", "PREPARING", "ACTIVE", "DELETED", "CLOSED"

  • display_name (str) -- (optional) filtering by displayName
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of TransferJobSummary

Return type:

Response

update_transfer_job(id, update_transfer_job_details, **kwargs)

Updates a Transfer Job Updates a Transfer Job that corresponds with customer's logical dataset e.g. a DB or a filesystem.

Parameters:
  • id (str) -- (required) ID of the Transfer Job
  • update_transfer_job_details (UpdateTransferJobDetails) -- (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type TransferJob

Return type:

Response