ObjectSummary¶

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

Bases: object

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:

`ARCHIVAL_STATE_ARCHIVED`	A constant which can be used with the archival_state property of a ObjectSummary.
`ARCHIVAL_STATE_RESTORED`	A constant which can be used with the archival_state property of a ObjectSummary.
`ARCHIVAL_STATE_RESTORING`	A constant which can be used with the archival_state property of a ObjectSummary.
`STORAGE_TIER_ARCHIVE`	A constant which can be used with the storage_tier property of a ObjectSummary.
`STORAGE_TIER_INFREQUENT_ACCESS`	A constant which can be used with the storage_tier property of a ObjectSummary.
`STORAGE_TIER_STANDARD`	A constant which can be used with the storage_tier property of a ObjectSummary.
`archival_state`	Gets the archival_state of this ObjectSummary.
`etag`	Gets the etag of this ObjectSummary.
`md5`	Gets the md5 of this ObjectSummary.
`name`	[Required] Gets the name of this ObjectSummary.
`size`	Gets the size of this ObjectSummary.
`storage_tier`	Gets the storage_tier of this ObjectSummary.
`time_created`	Gets the time_created of this ObjectSummary.
`time_modified`	Gets the time_modified of this ObjectSummary.

Methods:

__init__(**kwargs)

Initializes a new ObjectSummary object with values from keyword arguments.

ARCHIVAL_STATE_ARCHIVED = 'Archived'¶: A constant which can be used with the archival_state property of a ObjectSummary. This constant has a value of “Archived”

ARCHIVAL_STATE_RESTORED = 'Restored'¶: A constant which can be used with the archival_state property of a ObjectSummary. This constant has a value of “Restored”

ARCHIVAL_STATE_RESTORING = 'Restoring'¶: A constant which can be used with the archival_state property of a ObjectSummary. This constant has a value of “Restoring”

STORAGE_TIER_ARCHIVE = 'Archive'¶: A constant which can be used with the storage_tier property of a ObjectSummary. This constant has a value of “Archive”

STORAGE_TIER_INFREQUENT_ACCESS = 'InfrequentAccess'¶: A constant which can be used with the storage_tier property of a ObjectSummary. This constant has a value of “InfrequentAccess”

STORAGE_TIER_STANDARD = 'Standard'¶: A constant which can be used with the storage_tier property of a ObjectSummary. This constant has a value of “Standard”

__init__(**kwargs)¶

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

Parameters

name (str) – The value to assign to the name property of this ObjectSummary.
size (int) – The value to assign to the size property of this ObjectSummary.
md5 (str) – The value to assign to the md5 property of this ObjectSummary.
time_created (datetime) – The value to assign to the time_created property of this ObjectSummary.
etag (str) – The value to assign to the etag property of this ObjectSummary.
storage_tier (str) – The value to assign to the storage_tier property of this ObjectSummary. Allowed values for this property are: “Standard”, “InfrequentAccess”, “Archive”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
archival_state (str) – The value to assign to the archival_state property of this ObjectSummary. Allowed values for this property are: “Archived”, “Restoring”, “Restored”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_modified (datetime) – The value to assign to the time_modified property of this ObjectSummary.

property archival_state¶

Gets the archival_state of this ObjectSummary. Archival state of an object. This field is set only for objects in Archive tier.

Allowed values for this property are: “Archived”, “Restoring”, “Restored”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns: The archival_state of this ObjectSummary.
Return type: str

property etag¶

Gets the etag of this ObjectSummary. The current entity tag (ETag) for the object.

Returns: The etag of this ObjectSummary.
Return type: str

property md5¶

Gets the md5 of this ObjectSummary. Base64-encoded MD5 hash of the object data.

Returns: The md5 of this ObjectSummary.
Return type: str

property name¶

[Required] Gets the name of this ObjectSummary. The name of the object. Avoid entering confidential information. Example: test/object1.log

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

property size¶

Gets the size of this ObjectSummary. Size of the object in bytes.

Returns: The size of this ObjectSummary.
Return type: int

property storage_tier¶

Gets the storage_tier of this ObjectSummary. The storage tier that the object is stored in.

Allowed values for this property are: “Standard”, “InfrequentAccess”, “Archive”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns: The storage_tier of this ObjectSummary.
Return type: str

property time_created¶

Gets the time_created of this ObjectSummary. The date and time the object was created, as described in RFC 2616.

Returns: The time_created of this ObjectSummary.
Return type: datetime

property time_modified¶

Gets the time_modified of this ObjectSummary. The date and time the object was modified, as described in RFC 2616, section 14.29.

Returns: The time_modified of this ObjectSummary.
Return type: datetime