AWS SDK for C++  1.8.73
AWS SDK for C++
Public Member Functions | List of all members
Aws::S3::Model::Object Class Reference

#include <Object.h>

Public Member Functions

 Object ()
 
 Object (const Aws::Utils::Xml::XmlNode &xmlNode)
 
Objectoperator= (const Aws::Utils::Xml::XmlNode &xmlNode)
 
void AddToNode (Aws::Utils::Xml::XmlNode &parentNode) const
 
const Aws::StringGetKey () const
 
bool KeyHasBeenSet () const
 
void SetKey (const Aws::String &value)
 
void SetKey (Aws::String &&value)
 
void SetKey (const char *value)
 
ObjectWithKey (const Aws::String &value)
 
ObjectWithKey (Aws::String &&value)
 
ObjectWithKey (const char *value)
 
const Aws::Utils::DateTimeGetLastModified () const
 
bool LastModifiedHasBeenSet () const
 
void SetLastModified (const Aws::Utils::DateTime &value)
 
void SetLastModified (Aws::Utils::DateTime &&value)
 
ObjectWithLastModified (const Aws::Utils::DateTime &value)
 
ObjectWithLastModified (Aws::Utils::DateTime &&value)
 
const Aws::StringGetETag () const
 
bool ETagHasBeenSet () const
 
void SetETag (const Aws::String &value)
 
void SetETag (Aws::String &&value)
 
void SetETag (const char *value)
 
ObjectWithETag (const Aws::String &value)
 
ObjectWithETag (Aws::String &&value)
 
ObjectWithETag (const char *value)
 
long long GetSize () const
 
bool SizeHasBeenSet () const
 
void SetSize (long long value)
 
ObjectWithSize (long long value)
 
const ObjectStorageClassGetStorageClass () const
 
bool StorageClassHasBeenSet () const
 
void SetStorageClass (const ObjectStorageClass &value)
 
void SetStorageClass (ObjectStorageClass &&value)
 
ObjectWithStorageClass (const ObjectStorageClass &value)
 
ObjectWithStorageClass (ObjectStorageClass &&value)
 
const OwnerGetOwner () const
 
bool OwnerHasBeenSet () const
 
void SetOwner (const Owner &value)
 
void SetOwner (Owner &&value)
 
ObjectWithOwner (const Owner &value)
 
ObjectWithOwner (Owner &&value)
 

Detailed Description

An object consists of data and its descriptive metadata.

See Also:

AWS API Reference

Definition at line 34 of file Object.h.

Constructor & Destructor Documentation

◆ Object() [1/2]

Aws::S3::Model::Object::Object ( )

◆ Object() [2/2]

Aws::S3::Model::Object::Object ( const Aws::Utils::Xml::XmlNode xmlNode)

Member Function Documentation

◆ AddToNode()

void Aws::S3::Model::Object::AddToNode ( Aws::Utils::Xml::XmlNode parentNode) const

◆ ETagHasBeenSet()

bool Aws::S3::Model::Object::ETagHasBeenSet ( ) const
inline

The entity tag is a hash of the object. The ETag reflects changes only to the contents of an object, not its metadata. The ETag may or may not be an MD5 digest of the object data. Whether or not it is depends on how the object was created and how it is encrypted as described below:

  • Objects created by the PUT Object, POST Object, or Copy operation, or through the AWS Management Console, and are encrypted by SSE-S3 or plaintext, have ETags that are an MD5 digest of their object data.

  • Objects created by the PUT Object, POST Object, or Copy operation, or through the AWS Management Console, and are encrypted by SSE-C or SSE-KMS, have ETags that are not an MD5 digest of their object data.

  • If an object is created by either the Multipart Upload or Part Copy operation, the ETag is not an MD5 digest, regardless of the method of encryption.

Definition at line 154 of file Object.h.

◆ GetETag()

const Aws::String& Aws::S3::Model::Object::GetETag ( ) const
inline

The entity tag is a hash of the object. The ETag reflects changes only to the contents of an object, not its metadata. The ETag may or may not be an MD5 digest of the object data. Whether or not it is depends on how the object was created and how it is encrypted as described below:

  • Objects created by the PUT Object, POST Object, or Copy operation, or through the AWS Management Console, and are encrypted by SSE-S3 or plaintext, have ETags that are an MD5 digest of their object data.

  • Objects created by the PUT Object, POST Object, or Copy operation, or through the AWS Management Console, and are encrypted by SSE-C or SSE-KMS, have ETags that are not an MD5 digest of their object data.

  • If an object is created by either the Multipart Upload or Part Copy operation, the ETag is not an MD5 digest, regardless of the method of encryption.

Definition at line 138 of file Object.h.

◆ GetKey()

const Aws::String& Aws::S3::Model::Object::GetKey ( ) const
inline

The name that you assign to an object. You use the object key to retrieve the object.

Definition at line 48 of file Object.h.

◆ GetLastModified()

const Aws::Utils::DateTime& Aws::S3::Model::Object::GetLastModified ( ) const
inline

The date the Object was Last Modified

Definition at line 96 of file Object.h.

◆ GetOwner()

const Owner& Aws::S3::Model::Object::GetOwner ( ) const
inline

The owner of the object

Definition at line 308 of file Object.h.

◆ GetSize()

long long Aws::S3::Model::Object::GetSize ( ) const
inline

Size in bytes of the object

Definition at line 256 of file Object.h.

◆ GetStorageClass()

const ObjectStorageClass& Aws::S3::Model::Object::GetStorageClass ( ) const
inline

The class of storage used to store the object.

Definition at line 277 of file Object.h.

◆ KeyHasBeenSet()

bool Aws::S3::Model::Object::KeyHasBeenSet ( ) const
inline

The name that you assign to an object. You use the object key to retrieve the object.

Definition at line 54 of file Object.h.

◆ LastModifiedHasBeenSet()

bool Aws::S3::Model::Object::LastModifiedHasBeenSet ( ) const
inline

The date the Object was Last Modified

Definition at line 101 of file Object.h.

◆ operator=()

Object& Aws::S3::Model::Object::operator= ( const Aws::Utils::Xml::XmlNode xmlNode)

◆ OwnerHasBeenSet()

bool Aws::S3::Model::Object::OwnerHasBeenSet ( ) const
inline

The owner of the object

Definition at line 313 of file Object.h.

◆ SetETag() [1/3]

void Aws::S3::Model::Object::SetETag ( const Aws::String value)
inline

The entity tag is a hash of the object. The ETag reflects changes only to the contents of an object, not its metadata. The ETag may or may not be an MD5 digest of the object data. Whether or not it is depends on how the object was created and how it is encrypted as described below:

  • Objects created by the PUT Object, POST Object, or Copy operation, or through the AWS Management Console, and are encrypted by SSE-S3 or plaintext, have ETags that are an MD5 digest of their object data.

  • Objects created by the PUT Object, POST Object, or Copy operation, or through the AWS Management Console, and are encrypted by SSE-C or SSE-KMS, have ETags that are not an MD5 digest of their object data.

  • If an object is created by either the Multipart Upload or Part Copy operation, the ETag is not an MD5 digest, regardless of the method of encryption.

Definition at line 170 of file Object.h.

◆ SetETag() [2/3]

void Aws::S3::Model::Object::SetETag ( Aws::String &&  value)
inline

The entity tag is a hash of the object. The ETag reflects changes only to the contents of an object, not its metadata. The ETag may or may not be an MD5 digest of the object data. Whether or not it is depends on how the object was created and how it is encrypted as described below:

  • Objects created by the PUT Object, POST Object, or Copy operation, or through the AWS Management Console, and are encrypted by SSE-S3 or plaintext, have ETags that are an MD5 digest of their object data.

  • Objects created by the PUT Object, POST Object, or Copy operation, or through the AWS Management Console, and are encrypted by SSE-C or SSE-KMS, have ETags that are not an MD5 digest of their object data.

  • If an object is created by either the Multipart Upload or Part Copy operation, the ETag is not an MD5 digest, regardless of the method of encryption.

Definition at line 186 of file Object.h.

◆ SetETag() [3/3]

void Aws::S3::Model::Object::SetETag ( const char *  value)
inline

The entity tag is a hash of the object. The ETag reflects changes only to the contents of an object, not its metadata. The ETag may or may not be an MD5 digest of the object data. Whether or not it is depends on how the object was created and how it is encrypted as described below:

  • Objects created by the PUT Object, POST Object, or Copy operation, or through the AWS Management Console, and are encrypted by SSE-S3 or plaintext, have ETags that are an MD5 digest of their object data.

  • Objects created by the PUT Object, POST Object, or Copy operation, or through the AWS Management Console, and are encrypted by SSE-C or SSE-KMS, have ETags that are not an MD5 digest of their object data.

  • If an object is created by either the Multipart Upload or Part Copy operation, the ETag is not an MD5 digest, regardless of the method of encryption.

Definition at line 202 of file Object.h.

◆ SetKey() [1/3]

void Aws::S3::Model::Object::SetKey ( const Aws::String value)
inline

The name that you assign to an object. You use the object key to retrieve the object.

Definition at line 60 of file Object.h.

◆ SetKey() [2/3]

void Aws::S3::Model::Object::SetKey ( Aws::String &&  value)
inline

The name that you assign to an object. You use the object key to retrieve the object.

Definition at line 66 of file Object.h.

◆ SetKey() [3/3]

void Aws::S3::Model::Object::SetKey ( const char *  value)
inline

The name that you assign to an object. You use the object key to retrieve the object.

Definition at line 72 of file Object.h.

◆ SetLastModified() [1/2]

void Aws::S3::Model::Object::SetLastModified ( const Aws::Utils::DateTime value)
inline

The date the Object was Last Modified

Definition at line 106 of file Object.h.

◆ SetLastModified() [2/2]

void Aws::S3::Model::Object::SetLastModified ( Aws::Utils::DateTime &&  value)
inline

The date the Object was Last Modified

Definition at line 111 of file Object.h.

◆ SetOwner() [1/2]

void Aws::S3::Model::Object::SetOwner ( const Owner value)
inline

The owner of the object

Definition at line 318 of file Object.h.

◆ SetOwner() [2/2]

void Aws::S3::Model::Object::SetOwner ( Owner &&  value)
inline

The owner of the object

Definition at line 323 of file Object.h.

◆ SetSize()

void Aws::S3::Model::Object::SetSize ( long long  value)
inline

Size in bytes of the object

Definition at line 266 of file Object.h.

◆ SetStorageClass() [1/2]

void Aws::S3::Model::Object::SetStorageClass ( const ObjectStorageClass value)
inline

The class of storage used to store the object.

Definition at line 287 of file Object.h.

◆ SetStorageClass() [2/2]

void Aws::S3::Model::Object::SetStorageClass ( ObjectStorageClass &&  value)
inline

The class of storage used to store the object.

Definition at line 292 of file Object.h.

◆ SizeHasBeenSet()

bool Aws::S3::Model::Object::SizeHasBeenSet ( ) const
inline

Size in bytes of the object

Definition at line 261 of file Object.h.

◆ StorageClassHasBeenSet()

bool Aws::S3::Model::Object::StorageClassHasBeenSet ( ) const
inline

The class of storage used to store the object.

Definition at line 282 of file Object.h.

◆ WithETag() [1/3]

Object& Aws::S3::Model::Object::WithETag ( const Aws::String value)
inline

The entity tag is a hash of the object. The ETag reflects changes only to the contents of an object, not its metadata. The ETag may or may not be an MD5 digest of the object data. Whether or not it is depends on how the object was created and how it is encrypted as described below:

  • Objects created by the PUT Object, POST Object, or Copy operation, or through the AWS Management Console, and are encrypted by SSE-S3 or plaintext, have ETags that are an MD5 digest of their object data.

  • Objects created by the PUT Object, POST Object, or Copy operation, or through the AWS Management Console, and are encrypted by SSE-C or SSE-KMS, have ETags that are not an MD5 digest of their object data.

  • If an object is created by either the Multipart Upload or Part Copy operation, the ETag is not an MD5 digest, regardless of the method of encryption.

Definition at line 218 of file Object.h.

◆ WithETag() [2/3]

Object& Aws::S3::Model::Object::WithETag ( Aws::String &&  value)
inline

The entity tag is a hash of the object. The ETag reflects changes only to the contents of an object, not its metadata. The ETag may or may not be an MD5 digest of the object data. Whether or not it is depends on how the object was created and how it is encrypted as described below:

  • Objects created by the PUT Object, POST Object, or Copy operation, or through the AWS Management Console, and are encrypted by SSE-S3 or plaintext, have ETags that are an MD5 digest of their object data.

  • Objects created by the PUT Object, POST Object, or Copy operation, or through the AWS Management Console, and are encrypted by SSE-C or SSE-KMS, have ETags that are not an MD5 digest of their object data.

  • If an object is created by either the Multipart Upload or Part Copy operation, the ETag is not an MD5 digest, regardless of the method of encryption.

Definition at line 234 of file Object.h.

◆ WithETag() [3/3]

Object& Aws::S3::Model::Object::WithETag ( const char *  value)
inline

The entity tag is a hash of the object. The ETag reflects changes only to the contents of an object, not its metadata. The ETag may or may not be an MD5 digest of the object data. Whether or not it is depends on how the object was created and how it is encrypted as described below:

  • Objects created by the PUT Object, POST Object, or Copy operation, or through the AWS Management Console, and are encrypted by SSE-S3 or plaintext, have ETags that are an MD5 digest of their object data.

  • Objects created by the PUT Object, POST Object, or Copy operation, or through the AWS Management Console, and are encrypted by SSE-C or SSE-KMS, have ETags that are not an MD5 digest of their object data.

  • If an object is created by either the Multipart Upload or Part Copy operation, the ETag is not an MD5 digest, regardless of the method of encryption.

Definition at line 250 of file Object.h.

◆ WithKey() [1/3]

Object& Aws::S3::Model::Object::WithKey ( const Aws::String value)
inline

The name that you assign to an object. You use the object key to retrieve the object.

Definition at line 78 of file Object.h.

◆ WithKey() [2/3]

Object& Aws::S3::Model::Object::WithKey ( Aws::String &&  value)
inline

The name that you assign to an object. You use the object key to retrieve the object.

Definition at line 84 of file Object.h.

◆ WithKey() [3/3]

Object& Aws::S3::Model::Object::WithKey ( const char *  value)
inline

The name that you assign to an object. You use the object key to retrieve the object.

Definition at line 90 of file Object.h.

◆ WithLastModified() [1/2]

Object& Aws::S3::Model::Object::WithLastModified ( const Aws::Utils::DateTime value)
inline

The date the Object was Last Modified

Definition at line 116 of file Object.h.

◆ WithLastModified() [2/2]

Object& Aws::S3::Model::Object::WithLastModified ( Aws::Utils::DateTime &&  value)
inline

The date the Object was Last Modified

Definition at line 121 of file Object.h.

◆ WithOwner() [1/2]

Object& Aws::S3::Model::Object::WithOwner ( const Owner value)
inline

The owner of the object

Definition at line 328 of file Object.h.

◆ WithOwner() [2/2]

Object& Aws::S3::Model::Object::WithOwner ( Owner &&  value)
inline

The owner of the object

Definition at line 333 of file Object.h.

◆ WithSize()

Object& Aws::S3::Model::Object::WithSize ( long long  value)
inline

Size in bytes of the object

Definition at line 271 of file Object.h.

◆ WithStorageClass() [1/2]

Object& Aws::S3::Model::Object::WithStorageClass ( const ObjectStorageClass value)
inline

The class of storage used to store the object.

Definition at line 297 of file Object.h.

◆ WithStorageClass() [2/2]

Object& Aws::S3::Model::Object::WithStorageClass ( ObjectStorageClass &&  value)
inline

The class of storage used to store the object.

Definition at line 302 of file Object.h.


The documentation for this class was generated from the following file: