ExportRequestSummary¶
- class oci.data_integration.models.ExportRequestSummary(**kwargs)¶
Bases:
objectExport metadata object response summary.
Attributes:
A constant which can be used with the status property of a ExportRequestSummary.
A constant which can be used with the status property of a ExportRequestSummary.
A constant which can be used with the status property of a ExportRequestSummary.
A constant which can be used with the status property of a ExportRequestSummary.
A constant which can be used with the status property of a ExportRequestSummary.
A constant which can be used with the status property of a ExportRequestSummary.
Gets the are_references_included of this ExportRequestSummary.
Gets the bucket_name of this ExportRequestSummary.
Gets the created_by of this ExportRequestSummary.
Gets the error_messages of this ExportRequestSummary.
Gets the exported_items of this ExportRequestSummary.
Gets the file_name of this ExportRequestSummary.
Gets the filters of this ExportRequestSummary.
Gets the is_object_overwrite_enabled of this ExportRequestSummary.
Gets the key of this ExportRequestSummary.
Gets the name of this ExportRequestSummary.
Gets the object_keys of this ExportRequestSummary.
Gets the object_storage_region of this ExportRequestSummary.
Gets the object_storage_tenancy_id of this ExportRequestSummary.
Gets the referenced_items of this ExportRequestSummary.
Gets the status of this ExportRequestSummary.
Gets the time_ended_in_millis of this ExportRequestSummary.
Gets the time_started_in_millis of this ExportRequestSummary.
Gets the total_exported_object_count of this ExportRequestSummary.
Methods:
__init__(**kwargs)Initializes a new ExportRequestSummary object with values from keyword arguments.
- STATUS_FAILED = 'FAILED'¶
A constant which can be used with the status property of a ExportRequestSummary. This constant has a value of “FAILED”
- STATUS_IN_PROGRESS = 'IN_PROGRESS'¶
A constant which can be used with the status property of a ExportRequestSummary. This constant has a value of “IN_PROGRESS”
- STATUS_QUEUED = 'QUEUED'¶
A constant which can be used with the status property of a ExportRequestSummary. This constant has a value of “QUEUED”
- STATUS_SUCCESSFUL = 'SUCCESSFUL'¶
A constant which can be used with the status property of a ExportRequestSummary. This constant has a value of “SUCCESSFUL”
- STATUS_TERMINATED = 'TERMINATED'¶
A constant which can be used with the status property of a ExportRequestSummary. This constant has a value of “TERMINATED”
- STATUS_TERMINATING = 'TERMINATING'¶
A constant which can be used with the status property of a ExportRequestSummary. This constant has a value of “TERMINATING”
- __init__(**kwargs)¶
Initializes a new ExportRequestSummary 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 ExportRequestSummary.
object_keys (list[str]) – The value to assign to the object_keys property of this ExportRequestSummary.
bucket_name (str) – The value to assign to the bucket_name property of this ExportRequestSummary.
file_name (str) – The value to assign to the file_name property of this ExportRequestSummary.
object_storage_tenancy_id (str) – The value to assign to the object_storage_tenancy_id property of this ExportRequestSummary.
object_storage_region (str) – The value to assign to the object_storage_region property of this ExportRequestSummary.
are_references_included (bool) – The value to assign to the are_references_included property of this ExportRequestSummary.
is_object_overwrite_enabled (bool) – The value to assign to the is_object_overwrite_enabled property of this ExportRequestSummary.
filters (list[str]) – The value to assign to the filters property of this ExportRequestSummary.
status (str) – The value to assign to the status property of this ExportRequestSummary. 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 ExportRequestSummary.
total_exported_object_count (int) – The value to assign to the total_exported_object_count property of this ExportRequestSummary.
time_started_in_millis (int) – The value to assign to the time_started_in_millis property of this ExportRequestSummary.
time_ended_in_millis (int) – The value to assign to the time_ended_in_millis property of this ExportRequestSummary.
error_messages (dict(str, str)) – The value to assign to the error_messages property of this ExportRequestSummary.
exported_items (list[oci.data_integration.models.ExportObjectMetadataSummary]) – The value to assign to the exported_items property of this ExportRequestSummary.
referenced_items (str) – The value to assign to the referenced_items property of this ExportRequestSummary.
name (str) – The value to assign to the name property of this ExportRequestSummary.
- property are_references_included¶
Gets the are_references_included of this ExportRequestSummary. Controls if the references will be exported along with the objects
- Returns
The are_references_included of this ExportRequestSummary.
- Return type
bool
- property bucket_name¶
Gets the bucket_name of this ExportRequestSummary. The name of the Object Storage Bucket where the objects will be exported to
- Returns
The bucket_name of this ExportRequestSummary.
- Return type
str
- property created_by¶
Gets the created_by of this ExportRequestSummary. Name of the user who initiated export request.
- Returns
The created_by of this ExportRequestSummary.
- Return type
str
- property error_messages¶
Gets the error_messages of this ExportRequestSummary. Contains key of the error
- Returns
The error_messages of this ExportRequestSummary.
- Return type
dict(str, str)
- property exported_items¶
Gets the exported_items of this ExportRequestSummary. The array of exported object details.
- Returns
The exported_items of this ExportRequestSummary.
- Return type
list[oci.data_integration.models.ExportObjectMetadataSummary]
- property file_name¶
Gets the file_name of this ExportRequestSummary. Name of the exported zip file.
- Returns
The file_name of this ExportRequestSummary.
- Return type
str
- property filters¶
Gets the filters of this ExportRequestSummary. Export multiple objects based on filters.
- Returns
The filters of this ExportRequestSummary.
- Return type
list[str]
- property is_object_overwrite_enabled¶
Gets the is_object_overwrite_enabled of this ExportRequestSummary. 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 ExportRequestSummary.
- Return type
bool
- property key¶
Gets the key of this ExportRequestSummary. Export object request key
- Returns
The key of this ExportRequestSummary.
- Return type
str
- property name¶
Gets the name of this ExportRequestSummary. Name of the export request.
- Returns
The name of this ExportRequestSummary.
- Return type
str
- property object_keys¶
Gets the object_keys of this ExportRequestSummary. The list of the objects to be exported
- Returns
The object_keys of this ExportRequestSummary.
- Return type
list[str]
- property object_storage_region¶
Gets the object_storage_region of this ExportRequestSummary. Region of the object storage (if using object storage of different region)
- Returns
The object_storage_region of this ExportRequestSummary.
- Return type
str
- property object_storage_tenancy_id¶
Gets the object_storage_tenancy_id of this ExportRequestSummary. Optional parameter to point to object storage tenancy (if using Object Storage of different tenancy)
- Returns
The object_storage_tenancy_id of this ExportRequestSummary.
- Return type
str
- property referenced_items¶
Gets the referenced_items of this ExportRequestSummary. The array of exported referenced objects.
- Returns
The referenced_items of this ExportRequestSummary.
- Return type
str
- property status¶
Gets the status of this ExportRequestSummary. 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 ExportRequestSummary.
- Return type
str
- property time_ended_in_millis¶
Gets the time_ended_in_millis of this ExportRequestSummary. Time at which the request was completely processed.
- Returns
The time_ended_in_millis of this ExportRequestSummary.
- Return type
int
- property time_started_in_millis¶
Gets the time_started_in_millis of this ExportRequestSummary. Time at which the request started getting processed.
- Returns
The time_started_in_millis of this ExportRequestSummary.
- Return type
int
- property total_exported_object_count¶
Gets the total_exported_object_count of this ExportRequestSummary. Number of objects that are exported.
- Returns
The total_exported_object_count of this ExportRequestSummary.
- Return type
int