AWS SDK for C++  1.9.102
AWS SDK for C++
Public Member Functions | List of all members
Aws::Lightsail::Model::GetBucketsRequest Class Reference

#include <GetBucketsRequest.h>

+ Inheritance diagram for Aws::Lightsail::Model::GetBucketsRequest:

Public Member Functions

 GetBucketsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetBucketName () const
 
bool BucketNameHasBeenSet () const
 
void SetBucketName (const Aws::String &value)
 
void SetBucketName (Aws::String &&value)
 
void SetBucketName (const char *value)
 
GetBucketsRequestWithBucketName (const Aws::String &value)
 
GetBucketsRequestWithBucketName (Aws::String &&value)
 
GetBucketsRequestWithBucketName (const char *value)
 
const Aws::StringGetPageToken () const
 
bool PageTokenHasBeenSet () const
 
void SetPageToken (const Aws::String &value)
 
void SetPageToken (Aws::String &&value)
 
void SetPageToken (const char *value)
 
GetBucketsRequestWithPageToken (const Aws::String &value)
 
GetBucketsRequestWithPageToken (Aws::String &&value)
 
GetBucketsRequestWithPageToken (const char *value)
 
bool GetIncludeConnectedResources () const
 
bool IncludeConnectedResourcesHasBeenSet () const
 
void SetIncludeConnectedResources (bool value)
 
GetBucketsRequestWithIncludeConnectedResources (bool value)
 
- Public Member Functions inherited from Aws::Lightsail::LightsailRequest
virtual ~LightsailRequest ()
 
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 AddQueryStringParameters (Aws::Http::URI &uri) const
 
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 21 of file GetBucketsRequest.h.

Constructor & Destructor Documentation

◆ GetBucketsRequest()

Aws::Lightsail::Model::GetBucketsRequest::GetBucketsRequest ( )

Member Function Documentation

◆ BucketNameHasBeenSet()

bool Aws::Lightsail::Model::GetBucketsRequest::BucketNameHasBeenSet ( ) const
inline

The name of the bucket for which to return information.

When omitted, the response includes all of your buckets in the AWS Region where the request is made.

Definition at line 49 of file GetBucketsRequest.h.

◆ GetBucketName()

const Aws::String& Aws::Lightsail::Model::GetBucketsRequest::GetBucketName ( ) const
inline

The name of the bucket for which to return information.

When omitted, the response includes all of your buckets in the AWS Region where the request is made.

Definition at line 42 of file GetBucketsRequest.h.

◆ GetIncludeConnectedResources()

bool Aws::Lightsail::Model::GetBucketsRequest::GetIncludeConnectedResources ( ) const
inline

A Boolean value that indicates whether to include Lightsail instances that were given access to the bucket using the SetResourceAccessForBucket action.

Definition at line 164 of file GetBucketsRequest.h.

◆ GetPageToken()

const Aws::String& Aws::Lightsail::Model::GetBucketsRequest::GetPageToken ( ) const
inline

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetBuckets request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

Definition at line 100 of file GetBucketsRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::Lightsail::Model::GetBucketsRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::Lightsail::LightsailRequest.

◆ GetServiceRequestName()

virtual const char* Aws::Lightsail::Model::GetBucketsRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 30 of file GetBucketsRequest.h.

◆ IncludeConnectedResourcesHasBeenSet()

bool Aws::Lightsail::Model::GetBucketsRequest::IncludeConnectedResourcesHasBeenSet ( ) const
inline

A Boolean value that indicates whether to include Lightsail instances that were given access to the bucket using the SetResourceAccessForBucket action.

Definition at line 171 of file GetBucketsRequest.h.

◆ PageTokenHasBeenSet()

bool Aws::Lightsail::Model::GetBucketsRequest::PageTokenHasBeenSet ( ) const
inline

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetBuckets request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

Definition at line 108 of file GetBucketsRequest.h.

◆ SerializePayload()

Aws::String Aws::Lightsail::Model::GetBucketsRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetBucketName() [1/3]

void Aws::Lightsail::Model::GetBucketsRequest::SetBucketName ( Aws::String &&  value)
inline

The name of the bucket for which to return information.

When omitted, the response includes all of your buckets in the AWS Region where the request is made.

Definition at line 63 of file GetBucketsRequest.h.

◆ SetBucketName() [2/3]

void Aws::Lightsail::Model::GetBucketsRequest::SetBucketName ( const Aws::String value)
inline

The name of the bucket for which to return information.

When omitted, the response includes all of your buckets in the AWS Region where the request is made.

Definition at line 56 of file GetBucketsRequest.h.

◆ SetBucketName() [3/3]

void Aws::Lightsail::Model::GetBucketsRequest::SetBucketName ( const char *  value)
inline

The name of the bucket for which to return information.

When omitted, the response includes all of your buckets in the AWS Region where the request is made.

Definition at line 70 of file GetBucketsRequest.h.

◆ SetIncludeConnectedResources()

void Aws::Lightsail::Model::GetBucketsRequest::SetIncludeConnectedResources ( bool  value)
inline

A Boolean value that indicates whether to include Lightsail instances that were given access to the bucket using the SetResourceAccessForBucket action.

Definition at line 178 of file GetBucketsRequest.h.

◆ SetPageToken() [1/3]

void Aws::Lightsail::Model::GetBucketsRequest::SetPageToken ( Aws::String &&  value)
inline

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetBuckets request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

Definition at line 124 of file GetBucketsRequest.h.

◆ SetPageToken() [2/3]

void Aws::Lightsail::Model::GetBucketsRequest::SetPageToken ( const Aws::String value)
inline

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetBuckets request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

Definition at line 116 of file GetBucketsRequest.h.

◆ SetPageToken() [3/3]

void Aws::Lightsail::Model::GetBucketsRequest::SetPageToken ( const char *  value)
inline

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetBuckets request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

Definition at line 132 of file GetBucketsRequest.h.

◆ WithBucketName() [1/3]

GetBucketsRequest& Aws::Lightsail::Model::GetBucketsRequest::WithBucketName ( Aws::String &&  value)
inline

The name of the bucket for which to return information.

When omitted, the response includes all of your buckets in the AWS Region where the request is made.

Definition at line 84 of file GetBucketsRequest.h.

◆ WithBucketName() [2/3]

GetBucketsRequest& Aws::Lightsail::Model::GetBucketsRequest::WithBucketName ( const Aws::String value)
inline

The name of the bucket for which to return information.

When omitted, the response includes all of your buckets in the AWS Region where the request is made.

Definition at line 77 of file GetBucketsRequest.h.

◆ WithBucketName() [3/3]

GetBucketsRequest& Aws::Lightsail::Model::GetBucketsRequest::WithBucketName ( const char *  value)
inline

The name of the bucket for which to return information.

When omitted, the response includes all of your buckets in the AWS Region where the request is made.

Definition at line 91 of file GetBucketsRequest.h.

◆ WithIncludeConnectedResources()

GetBucketsRequest& Aws::Lightsail::Model::GetBucketsRequest::WithIncludeConnectedResources ( bool  value)
inline

A Boolean value that indicates whether to include Lightsail instances that were given access to the bucket using the SetResourceAccessForBucket action.

Definition at line 185 of file GetBucketsRequest.h.

◆ WithPageToken() [1/3]

GetBucketsRequest& Aws::Lightsail::Model::GetBucketsRequest::WithPageToken ( Aws::String &&  value)
inline

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetBuckets request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

Definition at line 148 of file GetBucketsRequest.h.

◆ WithPageToken() [2/3]

GetBucketsRequest& Aws::Lightsail::Model::GetBucketsRequest::WithPageToken ( const Aws::String value)
inline

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetBuckets request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

Definition at line 140 of file GetBucketsRequest.h.

◆ WithPageToken() [3/3]

GetBucketsRequest& Aws::Lightsail::Model::GetBucketsRequest::WithPageToken ( const char *  value)
inline

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetBuckets request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

Definition at line 156 of file GetBucketsRequest.h.


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