CopyObjectDetails¶

class oci.object_storage.models.CopyObjectDetails(**kwargs)¶

Bases: object

The parameters required by Object Storage to process a request to copy an object to another bucket.

To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies.

Attributes

`DESTINATION_OBJECT_STORAGE_TIER_ARCHIVE`	A constant which can be used with the destination_object_storage_tier property of a CopyObjectDetails.
`DESTINATION_OBJECT_STORAGE_TIER_INFREQUENT_ACCESS`	A constant which can be used with the destination_object_storage_tier property of a CopyObjectDetails.
`DESTINATION_OBJECT_STORAGE_TIER_STANDARD`	A constant which can be used with the destination_object_storage_tier property of a CopyObjectDetails.
`destination_bucket`	[Required] Gets the destination_bucket of this CopyObjectDetails.
`destination_namespace`	[Required] Gets the destination_namespace of this CopyObjectDetails.
`destination_object_if_match_e_tag`	Gets the destination_object_if_match_e_tag of this CopyObjectDetails.
`destination_object_if_none_match_e_tag`	Gets the destination_object_if_none_match_e_tag of this CopyObjectDetails.
`destination_object_metadata`	Gets the destination_object_metadata of this CopyObjectDetails.
`destination_object_name`	[Required] Gets the destination_object_name of this CopyObjectDetails.
`destination_object_storage_tier`	Gets the destination_object_storage_tier of this CopyObjectDetails.
`destination_region`	[Required] Gets the destination_region of this CopyObjectDetails.
`source_object_if_match_e_tag`	Gets the source_object_if_match_e_tag of this CopyObjectDetails.
`source_object_name`	[Required] Gets the source_object_name of this CopyObjectDetails.
`source_version_id`	Gets the source_version_id of this CopyObjectDetails.

Methods

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

DESTINATION_OBJECT_STORAGE_TIER_ARCHIVE = 'Archive'¶: A constant which can be used with the destination_object_storage_tier property of a CopyObjectDetails. This constant has a value of “Archive”

DESTINATION_OBJECT_STORAGE_TIER_INFREQUENT_ACCESS = 'InfrequentAccess'¶: A constant which can be used with the destination_object_storage_tier property of a CopyObjectDetails. This constant has a value of “InfrequentAccess”

DESTINATION_OBJECT_STORAGE_TIER_STANDARD = 'Standard'¶: A constant which can be used with the destination_object_storage_tier property of a CopyObjectDetails. This constant has a value of “Standard”

__init__(**kwargs)¶

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

Parameters:

source_object_name (str) – The value to assign to the source_object_name property of this CopyObjectDetails.
source_object_if_match_e_tag (str) – The value to assign to the source_object_if_match_e_tag property of this CopyObjectDetails.
source_version_id (str) – The value to assign to the source_version_id property of this CopyObjectDetails.
destination_region (str) – The value to assign to the destination_region property of this CopyObjectDetails.
destination_namespace (str) – The value to assign to the destination_namespace property of this CopyObjectDetails.
destination_bucket (str) – The value to assign to the destination_bucket property of this CopyObjectDetails.
destination_object_name (str) – The value to assign to the destination_object_name property of this CopyObjectDetails.
destination_object_if_match_e_tag (str) – The value to assign to the destination_object_if_match_e_tag property of this CopyObjectDetails.
destination_object_if_none_match_e_tag (str) – The value to assign to the destination_object_if_none_match_e_tag property of this CopyObjectDetails.
destination_object_metadata (dict(str, str)) – The value to assign to the destination_object_metadata property of this CopyObjectDetails.
destination_object_storage_tier (str) – The value to assign to the destination_object_storage_tier property of this CopyObjectDetails. Allowed values for this property are: “Standard”, “InfrequentAccess”, “Archive”

destination_bucket¶

[Required] Gets the destination_bucket of this CopyObjectDetails. The destination bucket the object will be copied to.

Returns:	The destination_bucket of this CopyObjectDetails.
Return type:	str

destination_namespace¶

[Required] Gets the destination_namespace of this CopyObjectDetails. The destination Object Storage namespace the object will be copied to.

Returns:	The destination_namespace of this CopyObjectDetails.
Return type:	str

destination_object_if_match_e_tag¶

Gets the destination_object_if_match_e_tag of this CopyObjectDetails. The entity tag (ETag) to match against that of the destination object (an object intended to be overwritten). Used to confirm that the destination object stored under a given name is the version of that object storing a specified entity tag.

Returns:	The destination_object_if_match_e_tag of this CopyObjectDetails.
Return type:	str

destination_object_if_none_match_e_tag¶

Gets the destination_object_if_none_match_e_tag of this CopyObjectDetails. The entity tag (ETag) to avoid matching. The only valid value is ‘*’, which indicates that the request should fail if the object already exists in the destination bucket.

Returns:	The destination_object_if_none_match_e_tag of this CopyObjectDetails.
Return type:	str

destination_object_metadata¶

Gets the destination_object_metadata of this CopyObjectDetails. Arbitrary string keys and values for the user-defined metadata for the object. Keys must be in “opc-meta-*” format. Avoid entering confidential information. Metadata key-value pairs entered in this field are assigned to the destination object. If you enter no metadata values, the destination object will inherit any existing metadata values associated with the source object.

Returns:	The destination_object_metadata of this CopyObjectDetails.
Return type:	dict(str, str)

destination_object_name¶

[Required] Gets the destination_object_name of this CopyObjectDetails. The name of the destination object resulting from the copy operation. Avoid entering confidential information.

Returns:	The destination_object_name of this CopyObjectDetails.
Return type:	str

destination_object_storage_tier¶

Gets the destination_object_storage_tier of this CopyObjectDetails. The storage tier that the object should be stored in. If not specified, the object will be stored in the same storage tier as the bucket.

Allowed values for this property are: “Standard”, “InfrequentAccess”, “Archive”

Returns:	The destination_object_storage_tier of this CopyObjectDetails.
Return type:	str

destination_region¶

[Required] Gets the destination_region of this CopyObjectDetails. The destination region the object will be copied to, for example “us-ashburn-1”.

Returns:	The destination_region of this CopyObjectDetails.
Return type:	str

source_object_if_match_e_tag¶

Gets the source_object_if_match_e_tag of this CopyObjectDetails. The entity tag (ETag) to match against that of the source object. Used to confirm that the source object with a given name is the version of that object storing a specified ETag.

Returns:	The source_object_if_match_e_tag of this CopyObjectDetails.
Return type:	str

source_object_name¶

[Required] Gets the source_object_name of this CopyObjectDetails. The name of the object to be copied.

Returns:	The source_object_name of this CopyObjectDetails.
Return type:	str

source_version_id¶

Gets the source_version_id of this CopyObjectDetails. VersionId of the object to copy. If not provided then current version is copied by default.

Returns:	The source_version_id of this CopyObjectDetails.
Return type:	str