ApplianceExportJobClient

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

Data Transfer Service API Specification

Methods

__init__(config, **kwargs) Creates a new service client
change_appliance_export_job_compartment(…) Moves a ApplianceExportJob into a different compartment.
create_appliance_export_job(…) Creates a new Appliance Export Job that corresponds with customer’s logical dataset
delete_appliance_export_job(…) deletes a Appliance Export Job
get_appliance_export_job(…) Describes a Appliance Export Job in detail
list_appliance_export_jobs(compartment_id, …) Lists Appliance Export Jobs in a given compartment
update_appliance_export_job(…) Updates a Appliance Export Job that corresponds with customer’s logical dataset.
__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.

change_appliance_export_job_compartment(appliance_export_job_id, change_appliance_export_job_compartment_details, **kwargs)

Moves a ApplianceExportJob into a different compartment.

Parameters:
  • appliance_export_job_id (str) – (required) ID of the Appliance Export Job
  • change_appliance_export_job_compartment_details (ChangeApplianceExportJobCompartmentDetails) – (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_appliance_export_job(create_appliance_export_job_details, **kwargs)

Creates a new Appliance Export Job that corresponds with customer’s logical dataset

Parameters:
  • create_appliance_export_job_details (CreateApplianceExportJobDetails) – (required) Creates a new Appliance Export 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).
  • 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.
  • 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 ApplianceExportJob

Return type:

Response

delete_appliance_export_job(appliance_export_job_id, **kwargs)

deletes a Appliance Export Job

Parameters:
  • appliance_export_job_id (str) – (required) ID of the Appliance Export Job
  • 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.
  • 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_appliance_export_job(appliance_export_job_id, **kwargs)

Describes a Appliance Export Job in detail

Parameters:
  • appliance_export_job_id (str) – (required) OCID of the Appliance Export Job
  • 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.
  • 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 ApplianceExportJob

Return type:

Response

list_appliance_export_jobs(compartment_id, **kwargs)

Lists Appliance Export Jobs in a given compartment

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

    (optional) filtering by lifecycleState

    Allowed values are: “CREATING”, “ACTIVE”, “INPROGRESS”, “SUCCEEDED”, “FAILED”, “CANCELLED”, “DELETED”

  • display_name (str) – (optional) filtering by displayName
  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

  • 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.
  • 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 ApplianceExportJobSummary

Return type:

Response

update_appliance_export_job(appliance_export_job_id, update_appliance_export_job_details, **kwargs)

Updates a Appliance Export Job that corresponds with customer’s logical dataset.

Parameters:
  • appliance_export_job_id (str) – (required) ID of the Appliance Export Job
  • update_appliance_export_job_details (UpdateApplianceExportJobDetails) – (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.
  • 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.
  • 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 ApplianceExportJob

Return type:

Response