ExportRequest¶

class oci.data_integration.models.ExportRequest(**kwargs)¶

Bases: object

Export metadata object response.

Attributes

`STATUS_FAILED`	A constant which can be used with the status property of a ExportRequest.
`STATUS_IN_PROGRESS`	A constant which can be used with the status property of a ExportRequest.
`STATUS_QUEUED`	A constant which can be used with the status property of a ExportRequest.
`STATUS_SUCCESSFUL`	A constant which can be used with the status property of a ExportRequest.
`STATUS_TERMINATED`	A constant which can be used with the status property of a ExportRequest.
`STATUS_TERMINATING`	A constant which can be used with the status property of a ExportRequest.
`are_references_included`	Gets the are_references_included of this ExportRequest.
`bucket_name`	Gets the bucket_name of this ExportRequest.
`created_by`	Gets the created_by of this ExportRequest.
`error_messages`	Gets the error_messages of this ExportRequest.
`exported_items`	Gets the exported_items of this ExportRequest.
`file_name`	Gets the file_name of this ExportRequest.
`filters`	Gets the filters of this ExportRequest.
`is_object_overwrite_enabled`	Gets the is_object_overwrite_enabled of this ExportRequest.
`key`	Gets the key of this ExportRequest.
`name`	Gets the name of this ExportRequest.
`object_keys`	Gets the object_keys of this ExportRequest.
`object_storage_region`	Gets the object_storage_region of this ExportRequest.
`object_storage_tenancy_id`	Gets the object_storage_tenancy_id of this ExportRequest.
`referenced_items`	Gets the referenced_items of this ExportRequest.
`status`	Gets the status of this ExportRequest.
`time_ended_in_millis`	Gets the time_ended_in_millis of this ExportRequest.
`time_started_in_millis`	Gets the time_started_in_millis of this ExportRequest.
`total_exported_object_count`	Gets the total_exported_object_count of this ExportRequest.

Methods

__init__(**kwargs) Initializes a new ExportRequest object with values from keyword arguments.

STATUS_FAILED = 'FAILED'¶: A constant which can be used with the status property of a ExportRequest. This constant has a value of “FAILED”

STATUS_IN_PROGRESS = 'IN_PROGRESS'¶: A constant which can be used with the status property of a ExportRequest. This constant has a value of “IN_PROGRESS”

STATUS_QUEUED = 'QUEUED'¶: A constant which can be used with the status property of a ExportRequest. This constant has a value of “QUEUED”

STATUS_SUCCESSFUL = 'SUCCESSFUL'¶: A constant which can be used with the status property of a ExportRequest. This constant has a value of “SUCCESSFUL”

STATUS_TERMINATED = 'TERMINATED'¶: A constant which can be used with the status property of a ExportRequest. This constant has a value of “TERMINATED”

STATUS_TERMINATING = 'TERMINATING'¶: A constant which can be used with the status property of a ExportRequest. This constant has a value of “TERMINATING”

__init__(**kwargs)¶

Initializes a new ExportRequest object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

key (str) – The value to assign to the key property of this ExportRequest.
object_keys (list[str]) – The value to assign to the object_keys property of this ExportRequest.
bucket_name (str) – The value to assign to the bucket_name property of this ExportRequest.
file_name (str) – The value to assign to the file_name property of this ExportRequest.
object_storage_tenancy_id (str) – The value to assign to the object_storage_tenancy_id property of this ExportRequest.
object_storage_region (str) – The value to assign to the object_storage_region property of this ExportRequest.
are_references_included (bool) – The value to assign to the are_references_included property of this ExportRequest.
is_object_overwrite_enabled (bool) – The value to assign to the is_object_overwrite_enabled property of this ExportRequest.
filters (list[str]) – The value to assign to the filters property of this ExportRequest.
status (str) – The value to assign to the status property of this ExportRequest. Allowed values for this property are: “SUCCESSFUL”, “FAILED”, “IN_PROGRESS”, “TERMINATING”, “TERMINATED”, “QUEUED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
created_by (str) – The value to assign to the created_by property of this ExportRequest.
total_exported_object_count (int) – The value to assign to the total_exported_object_count property of this ExportRequest.
time_started_in_millis (int) – The value to assign to the time_started_in_millis property of this ExportRequest.
time_ended_in_millis (int) – The value to assign to the time_ended_in_millis property of this ExportRequest.
error_messages (dict(str, str)) – The value to assign to the error_messages property of this ExportRequest.
exported_items (list[oci.data_integration.models.ExportObjectMetadataSummary]) – The value to assign to the exported_items property of this ExportRequest.
referenced_items (str) – The value to assign to the referenced_items property of this ExportRequest.
name (str) – The value to assign to the name property of this ExportRequest.

are_references_included¶

Gets the are_references_included of this ExportRequest. Controls if the references will be exported along with the objects

Returns:	The are_references_included of this ExportRequest.
Return type:	bool

bucket_name¶

Gets the bucket_name of this ExportRequest. The name of the Object Storage Bucket where the objects will be exported to

Returns:	The bucket_name of this ExportRequest.
Return type:	str

created_by¶

Gets the created_by of this ExportRequest. Name of the user who initiated export request.

Returns:	The created_by of this ExportRequest.
Return type:	str

error_messages¶

Gets the error_messages of this ExportRequest. Contains key of the error

Returns:	The error_messages of this ExportRequest.
Return type:	dict(str, str)

exported_items¶

Gets the exported_items of this ExportRequest. The array of exported object details.

Returns:	The exported_items of this ExportRequest.
Return type:	list[oci.data_integration.models.ExportObjectMetadataSummary]

file_name¶

Gets the file_name of this ExportRequest. Name of the exported zip file.

Returns:	The file_name of this ExportRequest.
Return type:	str

filters¶

Gets the filters of this ExportRequest. Export multiple objects based on filters.

Returns:	The filters of this ExportRequest.
Return type:	list[str]

is_object_overwrite_enabled¶

Gets the is_object_overwrite_enabled of this ExportRequest. Flag to control whether to overwrite the object if it is already present at the provided object storage location.

Returns:	The is_object_overwrite_enabled of this ExportRequest.
Return type:	bool

key¶

Gets the key of this ExportRequest. Export object request key

Returns:	The key of this ExportRequest.
Return type:	str

name¶

Gets the name of this ExportRequest. Name of the export request.

Returns:	The name of this ExportRequest.
Return type:	str

object_keys¶

Gets the object_keys of this ExportRequest. The list of the objects to be exported

Returns:	The object_keys of this ExportRequest.
Return type:	list[str]

object_storage_region¶

Gets the object_storage_region of this ExportRequest. Region of the object storage (if using object storage of different region)

Returns:	The object_storage_region of this ExportRequest.
Return type:	str

object_storage_tenancy_id¶

Gets the object_storage_tenancy_id of this ExportRequest. Optional parameter to point to object storage tenancy (if using Object Storage of different tenancy)

Returns:	The object_storage_tenancy_id of this ExportRequest.
Return type:	str

referenced_items¶

Gets the referenced_items of this ExportRequest. The array of exported referenced objects.

Returns:	The referenced_items of this ExportRequest.
Return type:	str

status¶

Gets the status of this ExportRequest. Export Objects request status.

Allowed values for this property are: “SUCCESSFUL”, “FAILED”, “IN_PROGRESS”, “TERMINATING”, “TERMINATED”, “QUEUED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The status of this ExportRequest.
Return type:	str

time_ended_in_millis¶

Gets the time_ended_in_millis of this ExportRequest. Time at which the request was completely processed.

Returns:	The time_ended_in_millis of this ExportRequest.
Return type:	int

time_started_in_millis¶

Gets the time_started_in_millis of this ExportRequest. Time at which the request started getting processed.

Returns:	The time_started_in_millis of this ExportRequest.
Return type:	int

total_exported_object_count¶

Gets the total_exported_object_count of this ExportRequest. Number of objects that are exported.

Returns:	The total_exported_object_count of this ExportRequest.
Return type:	int