AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::SQS::Model::ChangeMessageVisibilityBatchRequestEntry Class Reference

#include <ChangeMessageVisibilityBatchRequestEntry.h>

Public Member Functions

 ChangeMessageVisibilityBatchRequestEntry ()
 
 ChangeMessageVisibilityBatchRequestEntry (const Aws::Utils::Xml::XmlNode &xmlNode)
 
ChangeMessageVisibilityBatchRequestEntryoperator= (const Aws::Utils::Xml::XmlNode &xmlNode)
 
void OutputToStream (Aws::OStream &ostream, const char *location, unsigned index, const char *locationValue) const
 
void OutputToStream (Aws::OStream &oStream, const char *location) const
 
const Aws::StringGetId () const
 
bool IdHasBeenSet () const
 
void SetId (const Aws::String &value)
 
void SetId (Aws::String &&value)
 
void SetId (const char *value)
 
ChangeMessageVisibilityBatchRequestEntryWithId (const Aws::String &value)
 
ChangeMessageVisibilityBatchRequestEntryWithId (Aws::String &&value)
 
ChangeMessageVisibilityBatchRequestEntryWithId (const char *value)
 
const Aws::StringGetReceiptHandle () const
 
bool ReceiptHandleHasBeenSet () const
 
void SetReceiptHandle (const Aws::String &value)
 
void SetReceiptHandle (Aws::String &&value)
 
void SetReceiptHandle (const char *value)
 
ChangeMessageVisibilityBatchRequestEntryWithReceiptHandle (const Aws::String &value)
 
ChangeMessageVisibilityBatchRequestEntryWithReceiptHandle (Aws::String &&value)
 
ChangeMessageVisibilityBatchRequestEntryWithReceiptHandle (const char *value)
 
int GetVisibilityTimeout () const
 
bool VisibilityTimeoutHasBeenSet () const
 
void SetVisibilityTimeout (int value)
 
ChangeMessageVisibilityBatchRequestEntryWithVisibilityTimeout (int value)
 

Detailed Description

Encloses a receipt handle and an entry id for each message in ChangeMessageVisibilityBatch.

All of the following list parameters must be prefixed with ChangeMessageVisibilityBatchRequestEntry.n, where n is an integer value starting with 1. For example, a parameter list for this action might look like this:

&ChangeMessageVisibilityBatchRequestEntry.1.Id=change_visibility_msg_2

&ChangeMessageVisibilityBatchRequestEntry.1.ReceiptHandle=your_receipt_handle

&ChangeMessageVisibilityBatchRequestEntry.1.VisibilityTimeout=45

See Also:

AWS API Reference

Definition at line 42 of file ChangeMessageVisibilityBatchRequestEntry.h.

Constructor & Destructor Documentation

◆ ChangeMessageVisibilityBatchRequestEntry() [1/2]

Aws::SQS::Model::ChangeMessageVisibilityBatchRequestEntry::ChangeMessageVisibilityBatchRequestEntry ( )

◆ ChangeMessageVisibilityBatchRequestEntry() [2/2]

Aws::SQS::Model::ChangeMessageVisibilityBatchRequestEntry::ChangeMessageVisibilityBatchRequestEntry ( const Aws::Utils::Xml::XmlNode xmlNode)

Member Function Documentation

◆ GetId()

const Aws::String& Aws::SQS::Model::ChangeMessageVisibilityBatchRequestEntry::GetId ( ) const
inline

An identifier for this particular receipt handle used to communicate the result.

The Ids of a batch request need to be unique within a request.

This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).

Definition at line 60 of file ChangeMessageVisibilityBatchRequestEntry.h.

◆ GetReceiptHandle()

const Aws::String& Aws::SQS::Model::ChangeMessageVisibilityBatchRequestEntry::GetReceiptHandle ( ) const
inline

A receipt handle.

Definition at line 129 of file ChangeMessageVisibilityBatchRequestEntry.h.

◆ GetVisibilityTimeout()

int Aws::SQS::Model::ChangeMessageVisibilityBatchRequestEntry::GetVisibilityTimeout ( ) const
inline

The new value (in seconds) for the message's visibility timeout.

Definition at line 170 of file ChangeMessageVisibilityBatchRequestEntry.h.

◆ IdHasBeenSet()

bool Aws::SQS::Model::ChangeMessageVisibilityBatchRequestEntry::IdHasBeenSet ( ) const
inline

An identifier for this particular receipt handle used to communicate the result.

The Ids of a batch request need to be unique within a request.

This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).

Definition at line 69 of file ChangeMessageVisibilityBatchRequestEntry.h.

◆ operator=()

ChangeMessageVisibilityBatchRequestEntry& Aws::SQS::Model::ChangeMessageVisibilityBatchRequestEntry::operator= ( const Aws::Utils::Xml::XmlNode xmlNode)

◆ OutputToStream() [1/2]

void Aws::SQS::Model::ChangeMessageVisibilityBatchRequestEntry::OutputToStream ( Aws::OStream ostream,
const char *  location,
unsigned  index,
const char *  locationValue 
) const

◆ OutputToStream() [2/2]

void Aws::SQS::Model::ChangeMessageVisibilityBatchRequestEntry::OutputToStream ( Aws::OStream oStream,
const char *  location 
) const

◆ ReceiptHandleHasBeenSet()

bool Aws::SQS::Model::ChangeMessageVisibilityBatchRequestEntry::ReceiptHandleHasBeenSet ( ) const
inline

A receipt handle.

Definition at line 134 of file ChangeMessageVisibilityBatchRequestEntry.h.

◆ SetId() [1/3]

void Aws::SQS::Model::ChangeMessageVisibilityBatchRequestEntry::SetId ( const Aws::String value)
inline

An identifier for this particular receipt handle used to communicate the result.

The Ids of a batch request need to be unique within a request.

This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).

Definition at line 78 of file ChangeMessageVisibilityBatchRequestEntry.h.

◆ SetId() [2/3]

void Aws::SQS::Model::ChangeMessageVisibilityBatchRequestEntry::SetId ( Aws::String &&  value)
inline

An identifier for this particular receipt handle used to communicate the result.

The Ids of a batch request need to be unique within a request.

This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).

Definition at line 87 of file ChangeMessageVisibilityBatchRequestEntry.h.

◆ SetId() [3/3]

void Aws::SQS::Model::ChangeMessageVisibilityBatchRequestEntry::SetId ( const char *  value)
inline

An identifier for this particular receipt handle used to communicate the result.

The Ids of a batch request need to be unique within a request.

This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).

Definition at line 96 of file ChangeMessageVisibilityBatchRequestEntry.h.

◆ SetReceiptHandle() [1/3]

void Aws::SQS::Model::ChangeMessageVisibilityBatchRequestEntry::SetReceiptHandle ( const Aws::String value)
inline

A receipt handle.

Definition at line 139 of file ChangeMessageVisibilityBatchRequestEntry.h.

◆ SetReceiptHandle() [2/3]

void Aws::SQS::Model::ChangeMessageVisibilityBatchRequestEntry::SetReceiptHandle ( Aws::String &&  value)
inline

A receipt handle.

Definition at line 144 of file ChangeMessageVisibilityBatchRequestEntry.h.

◆ SetReceiptHandle() [3/3]

void Aws::SQS::Model::ChangeMessageVisibilityBatchRequestEntry::SetReceiptHandle ( const char *  value)
inline

A receipt handle.

Definition at line 149 of file ChangeMessageVisibilityBatchRequestEntry.h.

◆ SetVisibilityTimeout()

void Aws::SQS::Model::ChangeMessageVisibilityBatchRequestEntry::SetVisibilityTimeout ( int  value)
inline

The new value (in seconds) for the message's visibility timeout.

Definition at line 180 of file ChangeMessageVisibilityBatchRequestEntry.h.

◆ VisibilityTimeoutHasBeenSet()

bool Aws::SQS::Model::ChangeMessageVisibilityBatchRequestEntry::VisibilityTimeoutHasBeenSet ( ) const
inline

The new value (in seconds) for the message's visibility timeout.

Definition at line 175 of file ChangeMessageVisibilityBatchRequestEntry.h.

◆ WithId() [1/3]

ChangeMessageVisibilityBatchRequestEntry& Aws::SQS::Model::ChangeMessageVisibilityBatchRequestEntry::WithId ( const Aws::String value)
inline

An identifier for this particular receipt handle used to communicate the result.

The Ids of a batch request need to be unique within a request.

This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).

Definition at line 105 of file ChangeMessageVisibilityBatchRequestEntry.h.

◆ WithId() [2/3]

ChangeMessageVisibilityBatchRequestEntry& Aws::SQS::Model::ChangeMessageVisibilityBatchRequestEntry::WithId ( Aws::String &&  value)
inline

An identifier for this particular receipt handle used to communicate the result.

The Ids of a batch request need to be unique within a request.

This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).

Definition at line 114 of file ChangeMessageVisibilityBatchRequestEntry.h.

◆ WithId() [3/3]

ChangeMessageVisibilityBatchRequestEntry& Aws::SQS::Model::ChangeMessageVisibilityBatchRequestEntry::WithId ( const char *  value)
inline

An identifier for this particular receipt handle used to communicate the result.

The Ids of a batch request need to be unique within a request.

This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).

Definition at line 123 of file ChangeMessageVisibilityBatchRequestEntry.h.

◆ WithReceiptHandle() [1/3]

ChangeMessageVisibilityBatchRequestEntry& Aws::SQS::Model::ChangeMessageVisibilityBatchRequestEntry::WithReceiptHandle ( const Aws::String value)
inline

A receipt handle.

Definition at line 154 of file ChangeMessageVisibilityBatchRequestEntry.h.

◆ WithReceiptHandle() [2/3]

ChangeMessageVisibilityBatchRequestEntry& Aws::SQS::Model::ChangeMessageVisibilityBatchRequestEntry::WithReceiptHandle ( Aws::String &&  value)
inline

A receipt handle.

Definition at line 159 of file ChangeMessageVisibilityBatchRequestEntry.h.

◆ WithReceiptHandle() [3/3]

ChangeMessageVisibilityBatchRequestEntry& Aws::SQS::Model::ChangeMessageVisibilityBatchRequestEntry::WithReceiptHandle ( const char *  value)
inline

A receipt handle.

Definition at line 164 of file ChangeMessageVisibilityBatchRequestEntry.h.

◆ WithVisibilityTimeout()

ChangeMessageVisibilityBatchRequestEntry& Aws::SQS::Model::ChangeMessageVisibilityBatchRequestEntry::WithVisibilityTimeout ( int  value)
inline

The new value (in seconds) for the message's visibility timeout.

Definition at line 185 of file ChangeMessageVisibilityBatchRequestEntry.h.


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