#[non_exhaustive]pub struct SendMessageBatchRequestEntryBuilder { /* private fields */ }
Expand description
A builder for SendMessageBatchRequestEntry
.
Implementations§
source§impl SendMessageBatchRequestEntryBuilder
impl SendMessageBatchRequestEntryBuilder
sourcepub fn id(self, input: impl Into<String>) -> Self
pub fn id(self, input: impl Into<String>) -> Self
An identifier for a message in this batch used to communicate the result.
The Id
s 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 (_).
sourcepub fn set_id(self, input: Option<String>) -> Self
pub fn set_id(self, input: Option<String>) -> Self
An identifier for a message in this batch used to communicate the result.
The Id
s 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 (_).
sourcepub fn get_id(&self) -> &Option<String>
pub fn get_id(&self) -> &Option<String>
An identifier for a message in this batch used to communicate the result.
The Id
s 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 (_).
sourcepub fn message_body(self, input: impl Into<String>) -> Self
pub fn message_body(self, input: impl Into<String>) -> Self
The body of the message.
This field is required.sourcepub fn set_message_body(self, input: Option<String>) -> Self
pub fn set_message_body(self, input: Option<String>) -> Self
The body of the message.
sourcepub fn get_message_body(&self) -> &Option<String>
pub fn get_message_body(&self) -> &Option<String>
The body of the message.
sourcepub fn delay_seconds(self, input: i32) -> Self
pub fn delay_seconds(self, input: i32) -> Self
The length of time, in seconds, for which a specific message is delayed. Valid values: 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds
value become available for processing after the delay period is finished. If you don't specify a value, the default value for the queue is applied.
When you set FifoQueue
, you can't set DelaySeconds
per message. You can set this parameter only on a queue level.
sourcepub fn set_delay_seconds(self, input: Option<i32>) -> Self
pub fn set_delay_seconds(self, input: Option<i32>) -> Self
The length of time, in seconds, for which a specific message is delayed. Valid values: 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds
value become available for processing after the delay period is finished. If you don't specify a value, the default value for the queue is applied.
When you set FifoQueue
, you can't set DelaySeconds
per message. You can set this parameter only on a queue level.
sourcepub fn get_delay_seconds(&self) -> &Option<i32>
pub fn get_delay_seconds(&self) -> &Option<i32>
The length of time, in seconds, for which a specific message is delayed. Valid values: 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds
value become available for processing after the delay period is finished. If you don't specify a value, the default value for the queue is applied.
When you set FifoQueue
, you can't set DelaySeconds
per message. You can set this parameter only on a queue level.
sourcepub fn message_attributes(
self,
k: impl Into<String>,
v: MessageAttributeValue
) -> Self
pub fn message_attributes( self, k: impl Into<String>, v: MessageAttributeValue ) -> Self
Adds a key-value pair to message_attributes
.
To override the contents of this collection use set_message_attributes
.
Each message attribute consists of a Name
, Type
, and Value
. For more information, see Amazon SQS message attributes in the Amazon SQS Developer Guide.
sourcepub fn set_message_attributes(
self,
input: Option<HashMap<String, MessageAttributeValue>>
) -> Self
pub fn set_message_attributes( self, input: Option<HashMap<String, MessageAttributeValue>> ) -> Self
Each message attribute consists of a Name
, Type
, and Value
. For more information, see Amazon SQS message attributes in the Amazon SQS Developer Guide.
sourcepub fn get_message_attributes(
&self
) -> &Option<HashMap<String, MessageAttributeValue>>
pub fn get_message_attributes( &self ) -> &Option<HashMap<String, MessageAttributeValue>>
Each message attribute consists of a Name
, Type
, and Value
. For more information, see Amazon SQS message attributes in the Amazon SQS Developer Guide.
sourcepub fn message_system_attributes(
self,
k: MessageSystemAttributeNameForSends,
v: MessageSystemAttributeValue
) -> Self
pub fn message_system_attributes( self, k: MessageSystemAttributeNameForSends, v: MessageSystemAttributeValue ) -> Self
Adds a key-value pair to message_system_attributes
.
To override the contents of this collection use set_message_system_attributes
.
The message system attribute to send Each message system attribute consists of a Name
, Type
, and Value
.
-
Currently, the only supported message system attribute is
AWSTraceHeader
. Its type must beString
and its value must be a correctly formatted X-Ray trace header string. -
The size of a message system attribute doesn't count towards the total size of a message.
sourcepub fn set_message_system_attributes(
self,
input: Option<HashMap<MessageSystemAttributeNameForSends, MessageSystemAttributeValue>>
) -> Self
pub fn set_message_system_attributes( self, input: Option<HashMap<MessageSystemAttributeNameForSends, MessageSystemAttributeValue>> ) -> Self
The message system attribute to send Each message system attribute consists of a Name
, Type
, and Value
.
-
Currently, the only supported message system attribute is
AWSTraceHeader
. Its type must beString
and its value must be a correctly formatted X-Ray trace header string. -
The size of a message system attribute doesn't count towards the total size of a message.
sourcepub fn get_message_system_attributes(
&self
) -> &Option<HashMap<MessageSystemAttributeNameForSends, MessageSystemAttributeValue>>
pub fn get_message_system_attributes( &self ) -> &Option<HashMap<MessageSystemAttributeNameForSends, MessageSystemAttributeValue>>
The message system attribute to send Each message system attribute consists of a Name
, Type
, and Value
.
-
Currently, the only supported message system attribute is
AWSTraceHeader
. Its type must beString
and its value must be a correctly formatted X-Ray trace header string. -
The size of a message system attribute doesn't count towards the total size of a message.
sourcepub fn message_deduplication_id(self, input: impl Into<String>) -> Self
pub fn message_deduplication_id(self, input: impl Into<String>) -> Self
This parameter applies only to FIFO (first-in-first-out) queues.
The token used for deduplication of messages within a 5-minute minimum deduplication interval. If a message with a particular MessageDeduplicationId
is sent successfully, subsequent messages with the same MessageDeduplicationId
are accepted successfully but aren't delivered. For more information, see Exactly-once processing in the Amazon SQS Developer Guide.
-
Every message must have a unique
MessageDeduplicationId
,-
You may provide a
MessageDeduplicationId
explicitly. -
If you aren't able to provide a
MessageDeduplicationId
and you enableContentBasedDeduplication
for your queue, Amazon SQS uses a SHA-256 hash to generate theMessageDeduplicationId
using the body of the message (but not the attributes of the message). -
If you don't provide a
MessageDeduplicationId
and the queue doesn't haveContentBasedDeduplication
set, the action fails with an error. -
If the queue has
ContentBasedDeduplication
set, yourMessageDeduplicationId
overrides the generated one.
-
-
When
ContentBasedDeduplication
is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered. -
If you send one message with
ContentBasedDeduplication
enabled and then another message with aMessageDeduplicationId
that is the same as the one generated for the firstMessageDeduplicationId
, the two messages are treated as duplicates and only one copy of the message is delivered.
The MessageDeduplicationId
is available to the consumer of the message (this can be useful for troubleshooting delivery issues).
If a message is sent successfully but the acknowledgement is lost and the message is resent with the same MessageDeduplicationId
after the deduplication interval, Amazon SQS can't detect duplicate messages.
Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.
The length of MessageDeduplicationId
is 128 characters. MessageDeduplicationId
can contain alphanumeric characters (a-z
, A-Z
, 0-9
) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~
).
For best practices of using MessageDeduplicationId
, see Using the MessageDeduplicationId Property in the Amazon SQS Developer Guide.
sourcepub fn set_message_deduplication_id(self, input: Option<String>) -> Self
pub fn set_message_deduplication_id(self, input: Option<String>) -> Self
This parameter applies only to FIFO (first-in-first-out) queues.
The token used for deduplication of messages within a 5-minute minimum deduplication interval. If a message with a particular MessageDeduplicationId
is sent successfully, subsequent messages with the same MessageDeduplicationId
are accepted successfully but aren't delivered. For more information, see Exactly-once processing in the Amazon SQS Developer Guide.
-
Every message must have a unique
MessageDeduplicationId
,-
You may provide a
MessageDeduplicationId
explicitly. -
If you aren't able to provide a
MessageDeduplicationId
and you enableContentBasedDeduplication
for your queue, Amazon SQS uses a SHA-256 hash to generate theMessageDeduplicationId
using the body of the message (but not the attributes of the message). -
If you don't provide a
MessageDeduplicationId
and the queue doesn't haveContentBasedDeduplication
set, the action fails with an error. -
If the queue has
ContentBasedDeduplication
set, yourMessageDeduplicationId
overrides the generated one.
-
-
When
ContentBasedDeduplication
is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered. -
If you send one message with
ContentBasedDeduplication
enabled and then another message with aMessageDeduplicationId
that is the same as the one generated for the firstMessageDeduplicationId
, the two messages are treated as duplicates and only one copy of the message is delivered.
The MessageDeduplicationId
is available to the consumer of the message (this can be useful for troubleshooting delivery issues).
If a message is sent successfully but the acknowledgement is lost and the message is resent with the same MessageDeduplicationId
after the deduplication interval, Amazon SQS can't detect duplicate messages.
Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.
The length of MessageDeduplicationId
is 128 characters. MessageDeduplicationId
can contain alphanumeric characters (a-z
, A-Z
, 0-9
) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~
).
For best practices of using MessageDeduplicationId
, see Using the MessageDeduplicationId Property in the Amazon SQS Developer Guide.
sourcepub fn get_message_deduplication_id(&self) -> &Option<String>
pub fn get_message_deduplication_id(&self) -> &Option<String>
This parameter applies only to FIFO (first-in-first-out) queues.
The token used for deduplication of messages within a 5-minute minimum deduplication interval. If a message with a particular MessageDeduplicationId
is sent successfully, subsequent messages with the same MessageDeduplicationId
are accepted successfully but aren't delivered. For more information, see Exactly-once processing in the Amazon SQS Developer Guide.
-
Every message must have a unique
MessageDeduplicationId
,-
You may provide a
MessageDeduplicationId
explicitly. -
If you aren't able to provide a
MessageDeduplicationId
and you enableContentBasedDeduplication
for your queue, Amazon SQS uses a SHA-256 hash to generate theMessageDeduplicationId
using the body of the message (but not the attributes of the message). -
If you don't provide a
MessageDeduplicationId
and the queue doesn't haveContentBasedDeduplication
set, the action fails with an error. -
If the queue has
ContentBasedDeduplication
set, yourMessageDeduplicationId
overrides the generated one.
-
-
When
ContentBasedDeduplication
is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered. -
If you send one message with
ContentBasedDeduplication
enabled and then another message with aMessageDeduplicationId
that is the same as the one generated for the firstMessageDeduplicationId
, the two messages are treated as duplicates and only one copy of the message is delivered.
The MessageDeduplicationId
is available to the consumer of the message (this can be useful for troubleshooting delivery issues).
If a message is sent successfully but the acknowledgement is lost and the message is resent with the same MessageDeduplicationId
after the deduplication interval, Amazon SQS can't detect duplicate messages.
Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.
The length of MessageDeduplicationId
is 128 characters. MessageDeduplicationId
can contain alphanumeric characters (a-z
, A-Z
, 0-9
) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~
).
For best practices of using MessageDeduplicationId
, see Using the MessageDeduplicationId Property in the Amazon SQS Developer Guide.
sourcepub fn message_group_id(self, input: impl Into<String>) -> Self
pub fn message_group_id(self, input: impl Into<String>) -> Self
This parameter applies only to FIFO (first-in-first-out) queues.
The tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). To interleave multiple ordered streams within a single queue, use MessageGroupId
values (for example, session data for multiple users). In this scenario, multiple consumers can process the queue, but the session data of each user is processed in a FIFO fashion.
-
You must associate a non-empty
MessageGroupId
with a message. If you don't provide aMessageGroupId
, the action fails. -
ReceiveMessage
might return messages with multipleMessageGroupId
values. For eachMessageGroupId
, the messages are sorted by time sent. The caller can't specify aMessageGroupId
.
The length of MessageGroupId
is 128 characters. Valid values: alphanumeric characters and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)
.
For best practices of using MessageGroupId
, see Using the MessageGroupId Property in the Amazon SQS Developer Guide.
MessageGroupId
is required for FIFO queues. You can't use it for Standard queues.
sourcepub fn set_message_group_id(self, input: Option<String>) -> Self
pub fn set_message_group_id(self, input: Option<String>) -> Self
This parameter applies only to FIFO (first-in-first-out) queues.
The tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). To interleave multiple ordered streams within a single queue, use MessageGroupId
values (for example, session data for multiple users). In this scenario, multiple consumers can process the queue, but the session data of each user is processed in a FIFO fashion.
-
You must associate a non-empty
MessageGroupId
with a message. If you don't provide aMessageGroupId
, the action fails. -
ReceiveMessage
might return messages with multipleMessageGroupId
values. For eachMessageGroupId
, the messages are sorted by time sent. The caller can't specify aMessageGroupId
.
The length of MessageGroupId
is 128 characters. Valid values: alphanumeric characters and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)
.
For best practices of using MessageGroupId
, see Using the MessageGroupId Property in the Amazon SQS Developer Guide.
MessageGroupId
is required for FIFO queues. You can't use it for Standard queues.
sourcepub fn get_message_group_id(&self) -> &Option<String>
pub fn get_message_group_id(&self) -> &Option<String>
This parameter applies only to FIFO (first-in-first-out) queues.
The tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). To interleave multiple ordered streams within a single queue, use MessageGroupId
values (for example, session data for multiple users). In this scenario, multiple consumers can process the queue, but the session data of each user is processed in a FIFO fashion.
-
You must associate a non-empty
MessageGroupId
with a message. If you don't provide aMessageGroupId
, the action fails. -
ReceiveMessage
might return messages with multipleMessageGroupId
values. For eachMessageGroupId
, the messages are sorted by time sent. The caller can't specify aMessageGroupId
.
The length of MessageGroupId
is 128 characters. Valid values: alphanumeric characters and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)
.
For best practices of using MessageGroupId
, see Using the MessageGroupId Property in the Amazon SQS Developer Guide.
MessageGroupId
is required for FIFO queues. You can't use it for Standard queues.
sourcepub fn build(self) -> Result<SendMessageBatchRequestEntry, BuildError>
pub fn build(self) -> Result<SendMessageBatchRequestEntry, BuildError>
Consumes the builder and constructs a SendMessageBatchRequestEntry
.
This method will fail if any of the following fields are not set:
Trait Implementations§
source§impl Clone for SendMessageBatchRequestEntryBuilder
impl Clone for SendMessageBatchRequestEntryBuilder
source§fn clone(&self) -> SendMessageBatchRequestEntryBuilder
fn clone(&self) -> SendMessageBatchRequestEntryBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Default for SendMessageBatchRequestEntryBuilder
impl Default for SendMessageBatchRequestEntryBuilder
source§fn default() -> SendMessageBatchRequestEntryBuilder
fn default() -> SendMessageBatchRequestEntryBuilder
source§impl PartialEq for SendMessageBatchRequestEntryBuilder
impl PartialEq for SendMessageBatchRequestEntryBuilder
source§fn eq(&self, other: &SendMessageBatchRequestEntryBuilder) -> bool
fn eq(&self, other: &SendMessageBatchRequestEntryBuilder) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for SendMessageBatchRequestEntryBuilder
Auto Trait Implementations§
impl Freeze for SendMessageBatchRequestEntryBuilder
impl RefUnwindSafe for SendMessageBatchRequestEntryBuilder
impl Send for SendMessageBatchRequestEntryBuilder
impl Sync for SendMessageBatchRequestEntryBuilder
impl Unpin for SendMessageBatchRequestEntryBuilder
impl UnwindSafe for SendMessageBatchRequestEntryBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more