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

#include <GetObjectAclRequest.h>

+ Inheritance diagram for Aws::S3::Model::GetObjectAclRequest:

Public Member Functions

 GetObjectAclRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
void AddQueryStringParameters (Aws::Http::URI &uri) const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetBucket () const
 
bool BucketHasBeenSet () const
 
void SetBucket (const Aws::String &value)
 
void SetBucket (Aws::String &&value)
 
void SetBucket (const char *value)
 
GetObjectAclRequestWithBucket (const Aws::String &value)
 
GetObjectAclRequestWithBucket (Aws::String &&value)
 
GetObjectAclRequestWithBucket (const char *value)
 
const Aws::StringGetKey () const
 
bool KeyHasBeenSet () const
 
void SetKey (const Aws::String &value)
 
void SetKey (Aws::String &&value)
 
void SetKey (const char *value)
 
GetObjectAclRequestWithKey (const Aws::String &value)
 
GetObjectAclRequestWithKey (Aws::String &&value)
 
GetObjectAclRequestWithKey (const char *value)
 
const Aws::StringGetVersionId () const
 
bool VersionIdHasBeenSet () const
 
void SetVersionId (const Aws::String &value)
 
void SetVersionId (Aws::String &&value)
 
void SetVersionId (const char *value)
 
GetObjectAclRequestWithVersionId (const Aws::String &value)
 
GetObjectAclRequestWithVersionId (Aws::String &&value)
 
GetObjectAclRequestWithVersionId (const char *value)
 
const RequestPayerGetRequestPayer () const
 
bool RequestPayerHasBeenSet () const
 
void SetRequestPayer (const RequestPayer &value)
 
void SetRequestPayer (RequestPayer &&value)
 
GetObjectAclRequestWithRequestPayer (const RequestPayer &value)
 
GetObjectAclRequestWithRequestPayer (RequestPayer &&value)
 
const Aws::StringGetExpectedBucketOwner () const
 
bool ExpectedBucketOwnerHasBeenSet () const
 
void SetExpectedBucketOwner (const Aws::String &value)
 
void SetExpectedBucketOwner (Aws::String &&value)
 
void SetExpectedBucketOwner (const char *value)
 
GetObjectAclRequestWithExpectedBucketOwner (const Aws::String &value)
 
GetObjectAclRequestWithExpectedBucketOwner (Aws::String &&value)
 
GetObjectAclRequestWithExpectedBucketOwner (const char *value)
 
const Aws::Map< Aws::String, Aws::String > & GetCustomizedAccessLogTag () const
 
bool CustomizedAccessLogTagHasBeenSet () const
 
void SetCustomizedAccessLogTag (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetCustomizedAccessLogTag (Aws::Map< Aws::String, Aws::String > &&value)
 
GetObjectAclRequestWithCustomizedAccessLogTag (const Aws::Map< Aws::String, Aws::String > &value)
 
GetObjectAclRequestWithCustomizedAccessLogTag (Aws::Map< Aws::String, Aws::String > &&value)
 
GetObjectAclRequestAddCustomizedAccessLogTag (const Aws::String &key, const Aws::String &value)
 
GetObjectAclRequestAddCustomizedAccessLogTag (Aws::String &&key, const Aws::String &value)
 
GetObjectAclRequestAddCustomizedAccessLogTag (const Aws::String &key, Aws::String &&value)
 
GetObjectAclRequestAddCustomizedAccessLogTag (Aws::String &&key, Aws::String &&value)
 
GetObjectAclRequestAddCustomizedAccessLogTag (const char *key, Aws::String &&value)
 
GetObjectAclRequestAddCustomizedAccessLogTag (Aws::String &&key, const char *value)
 
GetObjectAclRequestAddCustomizedAccessLogTag (const char *key, const char *value)
 
- Public Member Functions inherited from Aws::S3::S3Request
virtual ~S3Request ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 27 of file GetObjectAclRequest.h.

Constructor & Destructor Documentation

◆ GetObjectAclRequest()

Aws::S3::Model::GetObjectAclRequest::GetObjectAclRequest ( )

Member Function Documentation

◆ AddCustomizedAccessLogTag() [1/7]

GetObjectAclRequest& Aws::S3::Model::GetObjectAclRequest::AddCustomizedAccessLogTag ( const Aws::String key,
const Aws::String value 
)
inline

Definition at line 335 of file GetObjectAclRequest.h.

◆ AddCustomizedAccessLogTag() [2/7]

GetObjectAclRequest& Aws::S3::Model::GetObjectAclRequest::AddCustomizedAccessLogTag ( Aws::String &&  key,
const Aws::String value 
)
inline

Definition at line 338 of file GetObjectAclRequest.h.

◆ AddCustomizedAccessLogTag() [3/7]

GetObjectAclRequest& Aws::S3::Model::GetObjectAclRequest::AddCustomizedAccessLogTag ( const Aws::String key,
Aws::String &&  value 
)
inline

Definition at line 341 of file GetObjectAclRequest.h.

◆ AddCustomizedAccessLogTag() [4/7]

GetObjectAclRequest& Aws::S3::Model::GetObjectAclRequest::AddCustomizedAccessLogTag ( Aws::String &&  key,
Aws::String &&  value 
)
inline

Definition at line 344 of file GetObjectAclRequest.h.

◆ AddCustomizedAccessLogTag() [5/7]

GetObjectAclRequest& Aws::S3::Model::GetObjectAclRequest::AddCustomizedAccessLogTag ( const char *  key,
Aws::String &&  value 
)
inline

Definition at line 347 of file GetObjectAclRequest.h.

◆ AddCustomizedAccessLogTag() [6/7]

GetObjectAclRequest& Aws::S3::Model::GetObjectAclRequest::AddCustomizedAccessLogTag ( Aws::String &&  key,
const char *  value 
)
inline

Definition at line 350 of file GetObjectAclRequest.h.

◆ AddCustomizedAccessLogTag() [7/7]

GetObjectAclRequest& Aws::S3::Model::GetObjectAclRequest::AddCustomizedAccessLogTag ( const char *  key,
const char *  value 
)
inline

Definition at line 353 of file GetObjectAclRequest.h.

◆ AddQueryStringParameters()

void Aws::S3::Model::GetObjectAclRequest::AddQueryStringParameters ( Aws::Http::URI uri) const
overridevirtual

Do nothing virtual, override this to add query strings to the request

Reimplemented from Aws::AmazonWebServiceRequest.

◆ BucketHasBeenSet()

bool Aws::S3::Model::GetObjectAclRequest::BucketHasBeenSet ( ) const
inline

The bucket name that contains the object for which to get the ACL information.

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

Definition at line 71 of file GetObjectAclRequest.h.

◆ CustomizedAccessLogTagHasBeenSet()

bool Aws::S3::Model::GetObjectAclRequest::CustomizedAccessLogTagHasBeenSet ( ) const
inline

Definition at line 320 of file GetObjectAclRequest.h.

◆ ExpectedBucketOwnerHasBeenSet()

bool Aws::S3::Model::GetObjectAclRequest::ExpectedBucketOwnerHasBeenSet ( ) const
inline

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Definition at line 271 of file GetObjectAclRequest.h.

◆ GetBucket()

const Aws::String& Aws::S3::Model::GetObjectAclRequest::GetBucket ( ) const
inline

The bucket name that contains the object for which to get the ACL information.

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

Definition at line 57 of file GetObjectAclRequest.h.

◆ GetCustomizedAccessLogTag()

const Aws::Map<Aws::String, Aws::String>& Aws::S3::Model::GetObjectAclRequest::GetCustomizedAccessLogTag ( ) const
inline

Definition at line 317 of file GetObjectAclRequest.h.

◆ GetExpectedBucketOwner()

const Aws::String& Aws::S3::Model::GetObjectAclRequest::GetExpectedBucketOwner ( ) const
inline

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Definition at line 264 of file GetObjectAclRequest.h.

◆ GetKey()

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

The key of the object for which to get the ACL information.

Definition at line 161 of file GetObjectAclRequest.h.

◆ GetRequestPayer()

const RequestPayer& Aws::S3::Model::GetObjectAclRequest::GetRequestPayer ( ) const
inline

Definition at line 241 of file GetObjectAclRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::S3::Model::GetObjectAclRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::S3::S3Request.

◆ GetServiceRequestName()

virtual const char* Aws::S3::Model::GetObjectAclRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 36 of file GetObjectAclRequest.h.

◆ GetVersionId()

const Aws::String& Aws::S3::Model::GetObjectAclRequest::GetVersionId ( ) const
inline

VersionId used to reference a specific version of the object.

Definition at line 202 of file GetObjectAclRequest.h.

◆ KeyHasBeenSet()

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

The key of the object for which to get the ACL information.

Definition at line 166 of file GetObjectAclRequest.h.

◆ RequestPayerHasBeenSet()

bool Aws::S3::Model::GetObjectAclRequest::RequestPayerHasBeenSet ( ) const
inline

Definition at line 244 of file GetObjectAclRequest.h.

◆ SerializePayload()

Aws::String Aws::S3::Model::GetObjectAclRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetBucket() [1/3]

void Aws::S3::Model::GetObjectAclRequest::SetBucket ( const Aws::String value)
inline

The bucket name that contains the object for which to get the ACL information.

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

Definition at line 85 of file GetObjectAclRequest.h.

◆ SetBucket() [2/3]

void Aws::S3::Model::GetObjectAclRequest::SetBucket ( Aws::String &&  value)
inline

The bucket name that contains the object for which to get the ACL information.

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

Definition at line 99 of file GetObjectAclRequest.h.

◆ SetBucket() [3/3]

void Aws::S3::Model::GetObjectAclRequest::SetBucket ( const char *  value)
inline

The bucket name that contains the object for which to get the ACL information.

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

Definition at line 113 of file GetObjectAclRequest.h.

◆ SetCustomizedAccessLogTag() [1/2]

void Aws::S3::Model::GetObjectAclRequest::SetCustomizedAccessLogTag ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

Definition at line 323 of file GetObjectAclRequest.h.

◆ SetCustomizedAccessLogTag() [2/2]

void Aws::S3::Model::GetObjectAclRequest::SetCustomizedAccessLogTag ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

Definition at line 326 of file GetObjectAclRequest.h.

◆ SetExpectedBucketOwner() [1/3]

void Aws::S3::Model::GetObjectAclRequest::SetExpectedBucketOwner ( const Aws::String value)
inline

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Definition at line 278 of file GetObjectAclRequest.h.

◆ SetExpectedBucketOwner() [2/3]

void Aws::S3::Model::GetObjectAclRequest::SetExpectedBucketOwner ( Aws::String &&  value)
inline

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Definition at line 285 of file GetObjectAclRequest.h.

◆ SetExpectedBucketOwner() [3/3]

void Aws::S3::Model::GetObjectAclRequest::SetExpectedBucketOwner ( const char *  value)
inline

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Definition at line 292 of file GetObjectAclRequest.h.

◆ SetKey() [1/3]

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

The key of the object for which to get the ACL information.

Definition at line 171 of file GetObjectAclRequest.h.

◆ SetKey() [2/3]

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

The key of the object for which to get the ACL information.

Definition at line 176 of file GetObjectAclRequest.h.

◆ SetKey() [3/3]

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

The key of the object for which to get the ACL information.

Definition at line 181 of file GetObjectAclRequest.h.

◆ SetRequestPayer() [1/2]

void Aws::S3::Model::GetObjectAclRequest::SetRequestPayer ( const RequestPayer value)
inline

Definition at line 247 of file GetObjectAclRequest.h.

◆ SetRequestPayer() [2/2]

void Aws::S3::Model::GetObjectAclRequest::SetRequestPayer ( RequestPayer &&  value)
inline

Definition at line 250 of file GetObjectAclRequest.h.

◆ SetVersionId() [1/3]

void Aws::S3::Model::GetObjectAclRequest::SetVersionId ( const Aws::String value)
inline

VersionId used to reference a specific version of the object.

Definition at line 212 of file GetObjectAclRequest.h.

◆ SetVersionId() [2/3]

void Aws::S3::Model::GetObjectAclRequest::SetVersionId ( Aws::String &&  value)
inline

VersionId used to reference a specific version of the object.

Definition at line 217 of file GetObjectAclRequest.h.

◆ SetVersionId() [3/3]

void Aws::S3::Model::GetObjectAclRequest::SetVersionId ( const char *  value)
inline

VersionId used to reference a specific version of the object.

Definition at line 222 of file GetObjectAclRequest.h.

◆ VersionIdHasBeenSet()

bool Aws::S3::Model::GetObjectAclRequest::VersionIdHasBeenSet ( ) const
inline

VersionId used to reference a specific version of the object.

Definition at line 207 of file GetObjectAclRequest.h.

◆ WithBucket() [1/3]

GetObjectAclRequest& Aws::S3::Model::GetObjectAclRequest::WithBucket ( const Aws::String value)
inline

The bucket name that contains the object for which to get the ACL information.

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

Definition at line 127 of file GetObjectAclRequest.h.

◆ WithBucket() [2/3]

GetObjectAclRequest& Aws::S3::Model::GetObjectAclRequest::WithBucket ( Aws::String &&  value)
inline

The bucket name that contains the object for which to get the ACL information.

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

Definition at line 141 of file GetObjectAclRequest.h.

◆ WithBucket() [3/3]

GetObjectAclRequest& Aws::S3::Model::GetObjectAclRequest::WithBucket ( const char *  value)
inline

The bucket name that contains the object for which to get the ACL information.

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

Definition at line 155 of file GetObjectAclRequest.h.

◆ WithCustomizedAccessLogTag() [1/2]

GetObjectAclRequest& Aws::S3::Model::GetObjectAclRequest::WithCustomizedAccessLogTag ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

Definition at line 329 of file GetObjectAclRequest.h.

◆ WithCustomizedAccessLogTag() [2/2]

GetObjectAclRequest& Aws::S3::Model::GetObjectAclRequest::WithCustomizedAccessLogTag ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

Definition at line 332 of file GetObjectAclRequest.h.

◆ WithExpectedBucketOwner() [1/3]

GetObjectAclRequest& Aws::S3::Model::GetObjectAclRequest::WithExpectedBucketOwner ( const Aws::String value)
inline

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Definition at line 299 of file GetObjectAclRequest.h.

◆ WithExpectedBucketOwner() [2/3]

GetObjectAclRequest& Aws::S3::Model::GetObjectAclRequest::WithExpectedBucketOwner ( Aws::String &&  value)
inline

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Definition at line 306 of file GetObjectAclRequest.h.

◆ WithExpectedBucketOwner() [3/3]

GetObjectAclRequest& Aws::S3::Model::GetObjectAclRequest::WithExpectedBucketOwner ( const char *  value)
inline

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Definition at line 313 of file GetObjectAclRequest.h.

◆ WithKey() [1/3]

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

The key of the object for which to get the ACL information.

Definition at line 186 of file GetObjectAclRequest.h.

◆ WithKey() [2/3]

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

The key of the object for which to get the ACL information.

Definition at line 191 of file GetObjectAclRequest.h.

◆ WithKey() [3/3]

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

The key of the object for which to get the ACL information.

Definition at line 196 of file GetObjectAclRequest.h.

◆ WithRequestPayer() [1/2]

GetObjectAclRequest& Aws::S3::Model::GetObjectAclRequest::WithRequestPayer ( const RequestPayer value)
inline

Definition at line 253 of file GetObjectAclRequest.h.

◆ WithRequestPayer() [2/2]

GetObjectAclRequest& Aws::S3::Model::GetObjectAclRequest::WithRequestPayer ( RequestPayer &&  value)
inline

Definition at line 256 of file GetObjectAclRequest.h.

◆ WithVersionId() [1/3]

GetObjectAclRequest& Aws::S3::Model::GetObjectAclRequest::WithVersionId ( const Aws::String value)
inline

VersionId used to reference a specific version of the object.

Definition at line 227 of file GetObjectAclRequest.h.

◆ WithVersionId() [2/3]

GetObjectAclRequest& Aws::S3::Model::GetObjectAclRequest::WithVersionId ( Aws::String &&  value)
inline

VersionId used to reference a specific version of the object.

Definition at line 232 of file GetObjectAclRequest.h.

◆ WithVersionId() [3/3]

GetObjectAclRequest& Aws::S3::Model::GetObjectAclRequest::WithVersionId ( const char *  value)
inline

VersionId used to reference a specific version of the object.

Definition at line 237 of file GetObjectAclRequest.h.


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