ImportRequest

class oci.data_integration.models.ImportRequest(**kwargs)

Bases: object

Import metadata object response.

Attributes:

STATUS_FAILED

A constant which can be used with the status property of a ImportRequest.

STATUS_IN_PROGRESS

A constant which can be used with the status property of a ImportRequest.

STATUS_QUEUED

A constant which can be used with the status property of a ImportRequest.

STATUS_SUCCESSFUL

A constant which can be used with the status property of a ImportRequest.

STATUS_TERMINATED

A constant which can be used with the status property of a ImportRequest.

STATUS_TERMINATING

A constant which can be used with the status property of a ImportRequest.

are_data_asset_references_included

Gets the are_data_asset_references_included of this ImportRequest.

bucket_name

Gets the bucket_name of this ImportRequest.

created_by

Gets the created_by of this ImportRequest.

error_messages

Gets the error_messages of this ImportRequest.

file_name

Gets the file_name of this ImportRequest.

import_conflict_resolution

Gets the import_conflict_resolution of this ImportRequest.

imported_objects

Gets the imported_objects of this ImportRequest.

key

Gets the key of this ImportRequest.

name

Gets the name of this ImportRequest.

object_key_for_import

Gets the object_key_for_import of this ImportRequest.

object_storage_region

Gets the object_storage_region of this ImportRequest.

object_storage_tenancy_id

Gets the object_storage_tenancy_id of this ImportRequest.

status

Gets the status of this ImportRequest.

time_ended_in_millis

Gets the time_ended_in_millis of this ImportRequest.

time_started_in_millis

Gets the time_started_in_millis of this ImportRequest.

total_imported_object_count

Gets the total_imported_object_count of this ImportRequest.

Methods:

__init__(**kwargs)

Initializes a new ImportRequest object with values from keyword arguments.

STATUS_FAILED = 'FAILED'

A constant which can be used with the status property of a ImportRequest. This constant has a value of “FAILED”

STATUS_IN_PROGRESS = 'IN_PROGRESS'

A constant which can be used with the status property of a ImportRequest. This constant has a value of “IN_PROGRESS”

STATUS_QUEUED = 'QUEUED'

A constant which can be used with the status property of a ImportRequest. This constant has a value of “QUEUED”

STATUS_SUCCESSFUL = 'SUCCESSFUL'

A constant which can be used with the status property of a ImportRequest. This constant has a value of “SUCCESSFUL”

STATUS_TERMINATED = 'TERMINATED'

A constant which can be used with the status property of a ImportRequest. This constant has a value of “TERMINATED”

STATUS_TERMINATING = 'TERMINATING'

A constant which can be used with the status property of a ImportRequest. This constant has a value of “TERMINATING”

__init__(**kwargs)

Initializes a new ImportRequest 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 ImportRequest.

  • bucket_name (str) – The value to assign to the bucket_name property of this ImportRequest.

  • file_name (str) – The value to assign to the file_name property of this ImportRequest.

  • object_storage_tenancy_id (str) – The value to assign to the object_storage_tenancy_id property of this ImportRequest.

  • object_storage_region (str) – The value to assign to the object_storage_region property of this ImportRequest.

  • object_key_for_import (str) – The value to assign to the object_key_for_import property of this ImportRequest.

  • are_data_asset_references_included (bool) – The value to assign to the are_data_asset_references_included property of this ImportRequest.

  • import_conflict_resolution (oci.data_integration.models.ImportConflictResolution) – The value to assign to the import_conflict_resolution property of this ImportRequest.

  • status (str) – The value to assign to the status property of this ImportRequest. 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 ImportRequest.

  • total_imported_object_count (int) – The value to assign to the total_imported_object_count property of this ImportRequest.

  • time_started_in_millis (int) – The value to assign to the time_started_in_millis property of this ImportRequest.

  • time_ended_in_millis (int) – The value to assign to the time_ended_in_millis property of this ImportRequest.

  • error_messages (dict(str, str)) – The value to assign to the error_messages property of this ImportRequest.

  • imported_objects (list[oci.data_integration.models.ImportObjectMetadataSummary]) – The value to assign to the imported_objects property of this ImportRequest.

  • name (str) – The value to assign to the name property of this ImportRequest.

property are_data_asset_references_included

Gets the are_data_asset_references_included of this ImportRequest. This field controls if the data asset references will be included during import.

Returns

The are_data_asset_references_included of this ImportRequest.

Return type

bool

property bucket_name

Gets the bucket_name of this ImportRequest. The name of the Object Storage Bucket where the objects will be imported from

Returns

The bucket_name of this ImportRequest.

Return type

str

property created_by

Gets the created_by of this ImportRequest. Name of the user who initiated import request.

Returns

The created_by of this ImportRequest.

Return type

str

property error_messages

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

Returns

The error_messages of this ImportRequest.

Return type

dict(str, str)

property file_name

Gets the file_name of this ImportRequest. Name of the zip file from which objects will be imported.

Returns

The file_name of this ImportRequest.

Return type

str

property import_conflict_resolution

Gets the import_conflict_resolution of this ImportRequest.

Returns

The import_conflict_resolution of this ImportRequest.

Return type

oci.data_integration.models.ImportConflictResolution

property imported_objects

Gets the imported_objects of this ImportRequest. The array of imported object details.

Returns

The imported_objects of this ImportRequest.

Return type

list[oci.data_integration.models.ImportObjectMetadataSummary]

property key

Gets the key of this ImportRequest. Import object request key

Returns

The key of this ImportRequest.

Return type

str

property name

Gets the name of this ImportRequest. Name of the import request.

Returns

The name of this ImportRequest.

Return type

str

property object_key_for_import

Gets the object_key_for_import of this ImportRequest. Key of the object inside which all the objects will be imported

Returns

The object_key_for_import of this ImportRequest.

Return type

str

property object_storage_region

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

Returns

The object_storage_region of this ImportRequest.

Return type

str

property object_storage_tenancy_id

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

Returns

The object_storage_tenancy_id of this ImportRequest.

Return type

str

property status

Gets the status of this ImportRequest. Import 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 ImportRequest.

Return type

str

property time_ended_in_millis

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

Returns

The time_ended_in_millis of this ImportRequest.

Return type

int

property time_started_in_millis

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

Returns

The time_started_in_millis of this ImportRequest.

Return type

int

property total_imported_object_count

Gets the total_imported_object_count of this ImportRequest. Number of objects that are imported.

Returns

The total_imported_object_count of this ImportRequest.

Return type

int