Interface Message.Builder
-
- All Superinterfaces:
Buildable
,CopyableBuilder<Message.Builder,Message>
,SdkBuilder<Message.Builder,Message>
,SdkPojo
- Enclosing class:
- Message
public static interface Message.Builder extends SdkPojo, CopyableBuilder<Message.Builder,Message>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Message.Builder
attributes(Map<MessageSystemAttributeName,String> attributes)
A map of the attributes requested inReceiveMessage
to their respective values.Message.Builder
attributesWithStrings(Map<String,String> attributes)
A map of the attributes requested inReceiveMessage
to their respective values.Message.Builder
body(String body)
The message's contents (not URL-encoded).Message.Builder
md5OfBody(String md5OfBody)
An MD5 digest of the non-URL-encoded message body string.Message.Builder
md5OfMessageAttributes(String md5OfMessageAttributes)
An MD5 digest of the non-URL-encoded message attribute string.Message.Builder
messageAttributes(Map<String,MessageAttributeValue> messageAttributes)
Each message attribute consists of aName
,Type
, andValue
.Message.Builder
messageId(String messageId)
A unique identifier for the message.Message.Builder
receiptHandle(String receiptHandle)
An identifier associated with the act of receiving the message.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
messageId
Message.Builder messageId(String messageId)
A unique identifier for the message. A
MessageId
is considered unique across all Amazon Web Services accounts for an extended period of time.- Parameters:
messageId
- A unique identifier for the message. AMessageId
is considered unique across all Amazon Web Services accounts for an extended period of time.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
receiptHandle
Message.Builder receiptHandle(String receiptHandle)
An identifier associated with the act of receiving the message. A new receipt handle is returned every time you receive a message. When deleting a message, you provide the last received receipt handle to delete the message.
- Parameters:
receiptHandle
- An identifier associated with the act of receiving the message. A new receipt handle is returned every time you receive a message. When deleting a message, you provide the last received receipt handle to delete the message.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
md5OfBody
Message.Builder md5OfBody(String md5OfBody)
An MD5 digest of the non-URL-encoded message body string.
- Parameters:
md5OfBody
- An MD5 digest of the non-URL-encoded message body string.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
body
Message.Builder body(String body)
The message's contents (not URL-encoded).
- Parameters:
body
- The message's contents (not URL-encoded).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
attributesWithStrings
Message.Builder attributesWithStrings(Map<String,String> attributes)
A map of the attributes requested in
ReceiveMessage
to their respective values. Supported attributes:-
ApproximateReceiveCount
-
ApproximateFirstReceiveTimestamp
-
MessageDeduplicationId
-
MessageGroupId
-
SenderId
-
SentTimestamp
-
SequenceNumber
ApproximateFirstReceiveTimestamp
andSentTimestamp
are each returned as an integer representing the epoch time in milliseconds.- Parameters:
attributes
- A map of the attributes requested inReceiveMessage
to their respective values. Supported attributes:-
ApproximateReceiveCount
-
ApproximateFirstReceiveTimestamp
-
MessageDeduplicationId
-
MessageGroupId
-
SenderId
-
SentTimestamp
-
SequenceNumber
ApproximateFirstReceiveTimestamp
andSentTimestamp
are each returned as an integer representing the epoch time in milliseconds.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
attributes
Message.Builder attributes(Map<MessageSystemAttributeName,String> attributes)
A map of the attributes requested in
ReceiveMessage
to their respective values. Supported attributes:-
ApproximateReceiveCount
-
ApproximateFirstReceiveTimestamp
-
MessageDeduplicationId
-
MessageGroupId
-
SenderId
-
SentTimestamp
-
SequenceNumber
ApproximateFirstReceiveTimestamp
andSentTimestamp
are each returned as an integer representing the epoch time in milliseconds.- Parameters:
attributes
- A map of the attributes requested inReceiveMessage
to their respective values. Supported attributes:-
ApproximateReceiveCount
-
ApproximateFirstReceiveTimestamp
-
MessageDeduplicationId
-
MessageGroupId
-
SenderId
-
SentTimestamp
-
SequenceNumber
ApproximateFirstReceiveTimestamp
andSentTimestamp
are each returned as an integer representing the epoch time in milliseconds.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
md5OfMessageAttributes
Message.Builder md5OfMessageAttributes(String md5OfMessageAttributes)
An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.
- Parameters:
md5OfMessageAttributes
- An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
messageAttributes
Message.Builder messageAttributes(Map<String,MessageAttributeValue> messageAttributes)
Each message attribute consists of a
Name
,Type
, andValue
. For more information, see Amazon SQS message attributes in the Amazon SQS Developer Guide.- Parameters:
messageAttributes
- Each message attribute consists of aName
,Type
, andValue
. For more information, see Amazon SQS message attributes in the Amazon SQS Developer Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-