software.amazon.awssdk.services.sqs.model.CreateQueueRequest Maven / Gradle / Ivy
/*
* Copyright 2014-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.sqs.model;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.runtime.TypeConverter;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.traits.MapTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructMap;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class CreateQueueRequest extends SqsRequest implements
ToCopyableBuilder {
private static final SdkField QUEUE_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(CreateQueueRequest::queueName)).setter(setter(Builder::queueName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("QueueName").build()).build();
private static final SdkField> ATTRIBUTES_FIELD = SdkField
.> builder(MarshallingType.MAP)
.getter(getter(CreateQueueRequest::attributesAsStrings))
.setter(setter(Builder::attributesWithStrings))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Attribute").build(),
MapTrait.builder()
.keyLocationName("Name")
.valueLocationName("Value")
.valueFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("Value").build()).build()).isFlattened(true).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(QUEUE_NAME_FIELD,
ATTRIBUTES_FIELD));
private final String queueName;
private final Map attributes;
private CreateQueueRequest(BuilderImpl builder) {
super(builder);
this.queueName = builder.queueName;
this.attributes = builder.attributes;
}
/**
*
* The name of the new queue. The following limits apply to this name:
*
*
* -
*
* A queue name can have up to 80 characters.
*
*
* -
*
* Valid values: alphanumeric characters, hyphens (-), and underscores (_).
*
*
* -
*
* A FIFO queue name must end with the .fifo suffix.
*
*
*
*
* Queue URLs and names are case-sensitive.
*
*
* @return The name of the new queue. The following limits apply to this name:
*
* -
*
* A queue name can have up to 80 characters.
*
*
* -
*
* Valid values: alphanumeric characters, hyphens (-), and underscores (_).
*
*
* -
*
* A FIFO queue name must end with the .fifo suffix.
*
*
*
*
* Queue URLs and names are case-sensitive.
*/
public String queueName() {
return queueName;
}
/**
*
* A map of attributes with their corresponding values.
*
*
* The following lists the names, descriptions, and values of the special request parameters that the
* CreateQueue action uses:
*
*
* -
*
* DelaySeconds - The length of time, in seconds, for which the delivery of all messages in the queue
* is delayed. Valid values: An integer from 0 to 900 seconds (15 minutes). Default: 0.
*
*
* -
*
* MaximumMessageSize - The limit of how many bytes a message can contain before Amazon SQS rejects it.
* Valid values: An integer from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB).
*
*
* -
*
* MessageRetentionPeriod - The length of time, in seconds, for which Amazon SQS retains a message.
* Valid values: An integer from 60 seconds (1 minute) to 1,209,600 seconds (14 days). Default: 345,600 (4 days).
*
*
* -
*
* Policy - The queue's policy. A valid AWS policy. For more information about policy structure, see Overview of AWS IAM Policies in
* the Amazon IAM User Guide.
*
*
* -
*
* ReceiveMessageWaitTimeSeconds - The length of time, in seconds, for which a
* ReceiveMessage action waits for a message to arrive. Valid values: An integer from 0 to 20
* (seconds). Default: 0.
*
*
* -
*
* RedrivePolicy - The string that includes the parameters for the dead-letter queue functionality of
* the source queue. For more information about the redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon Simple Queue Service Developer Guide.
*
*
* -
*
* deadLetterTargetArn - The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS
* moves messages after the value of maxReceiveCount is exceeded.
*
*
* -
*
* maxReceiveCount - The number of times a message is delivered to the source queue before being moved
* to the dead-letter queue. When the ReceiveCount for a message exceeds the
* maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.
*
*
*
*
*
* The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard
* queue must also be a standard queue.
*
*
* -
*
* VisibilityTimeout - The visibility timeout for the queue, in seconds. Valid values: An integer from
* 0 to 43,200 (12 hours). Default: 30. For more information about the visibility timeout, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide.
*
*
*
*
* The following attributes apply only to server-side-encryption:
*
*
* -
*
* KmsMasterKeyId - The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK.
* For more information, see Key Terms. While the alias of the AWS-managed CMK for Amazon SQS is always alias/aws/sqs, the
* alias of a custom CMK can, for example, be alias/MyAlias . For more examples, see KeyId in the AWS Key Management Service API Reference.
*
*
* -
*
* KmsDataKeyReusePeriodSeconds - The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or
* decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and
* 86,400 seconds (24 hours). Default: 300 (5 minutes). A shorter time period provides better security but results
* in more calls to KMS which might incur charges after Free Tier. For more information, see How Does the Data Key Reuse Period Work?.
*
*
*
*
* The following attributes apply only to FIFO
* (first-in-first-out) queues:
*
*
* -
*
* FifoQueue - Designates a queue as FIFO. Valid values: true, false. You can
* provide this attribute only during queue creation. You can't change it for an existing queue. When you set this
* attribute, you must also provide the MessageGroupId for your messages explicitly.
*
*
* For more information, see FIFO Queue Logic in the Amazon Simple Queue Service Developer Guide.
*
*
* -
*
* ContentBasedDeduplication - Enables content-based deduplication. Valid values: true,
* false. For more information, see Exactly-Once Processing in the Amazon Simple Queue Service 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 enable
* ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the
* MessageDeduplicationId 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 have
* ContentBasedDeduplication set, the action fails with an error.
*
*
* -
*
* If the queue has ContentBasedDeduplication set, your MessageDeduplicationId 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 a
* MessageDeduplicationId that is the same as the one generated for the first
* MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message
* is delivered.
*
*
*
*
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* @return A map of attributes with their corresponding values.
*
* The following lists the names, descriptions, and values of the special request parameters that the
* CreateQueue action uses:
*
*
* -
*
* DelaySeconds - The length of time, in seconds, for which the delivery of all messages in the
* queue is delayed. Valid values: An integer from 0 to 900 seconds (15 minutes). Default: 0.
*
*
* -
*
* MaximumMessageSize - The limit of how many bytes a message can contain before Amazon SQS
* rejects it. Valid values: An integer from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). Default:
* 262,144 (256 KiB).
*
*
* -
*
* MessageRetentionPeriod - The length of time, in seconds, for which Amazon SQS retains a
* message. Valid values: An integer from 60 seconds (1 minute) to 1,209,600 seconds (14 days). Default:
* 345,600 (4 days).
*
*
* -
*
* Policy - The queue's policy. A valid AWS policy. For more information about policy
* structure, see Overview
* of AWS IAM Policies in the Amazon IAM User Guide.
*
*
* -
*
* ReceiveMessageWaitTimeSeconds - The length of time, in seconds, for which a
* ReceiveMessage action waits for a message to arrive. Valid values: An integer from
* 0 to 20 (seconds). Default: 0.
*
*
* -
*
* RedrivePolicy - The string that includes the parameters for the dead-letter queue
* functionality of the source queue. For more information about the redrive policy and dead-letter queues,
* see Using Amazon SQS Dead-Letter Queues in the Amazon Simple Queue Service Developer Guide.
*
*
* -
*
* deadLetterTargetArn - The Amazon Resource Name (ARN) of the dead-letter queue to which
* Amazon SQS moves messages after the value of maxReceiveCount is exceeded.
*
*
* -
*
* maxReceiveCount - The number of times a message is delivered to the source queue before
* being moved to the dead-letter queue. When the ReceiveCount for a message exceeds the
* maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.
*
*
*
*
*
* The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a
* standard queue must also be a standard queue.
*
*
* -
*
* VisibilityTimeout - The visibility timeout for the queue, in seconds. Valid values: An
* integer from 0 to 43,200 (12 hours). Default: 30. For more information about the visibility timeout, see
* Visibility Timeout in the Amazon Simple Queue Service Developer Guide.
*
*
*
*
* The following attributes apply only to server-side-encryption:
*
*
* -
*
* KmsMasterKeyId - The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a
* custom CMK. For more information, see Key Terms. While the alias of the AWS-managed CMK for Amazon SQS is always
* alias/aws/sqs, the alias of a custom CMK can, for example, be
* alias/MyAlias . For more examples, see KeyId in the AWS Key Management Service API Reference.
*
*
* -
*
* KmsDataKeyReusePeriodSeconds - The length of time, in seconds, for which Amazon SQS can
* reuse a data
* key to encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds,
* between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes). A shorter time
* period provides better security but results in more calls to KMS which might incur charges after Free
* Tier. For more information, see How Does the Data Key Reuse Period Work?.
*
*
*
*
* The following attributes apply only to FIFO
* (first-in-first-out) queues:
*
*
* -
*
* FifoQueue - Designates a queue as FIFO. Valid values: true, false.
* You can provide this attribute only during queue creation. You can't change it for an existing queue.
* When you set this attribute, you must also provide the MessageGroupId for your messages
* explicitly.
*
*
* For more information, see FIFO Queue Logic in the Amazon Simple Queue Service Developer Guide.
*
*
* -
*
* ContentBasedDeduplication - Enables content-based deduplication. Valid values:
* true, false. For more information, see Exactly-Once Processing in the Amazon Simple Queue Service 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 enable
* ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the
* MessageDeduplicationId 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 have
* ContentBasedDeduplication set, the action fails with an error.
*
*
* -
*
* If the queue has ContentBasedDeduplication set, your MessageDeduplicationId
* 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
* a MessageDeduplicationId that is the same as the one generated for the first
* MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the
* message is delivered.
*
*
*
*
*/
public Map attributes() {
return TypeConverter.convert(attributes, QueueAttributeName::fromValue, Function.identity(),
(k, v) -> !Objects.equals(k, QueueAttributeName.UNKNOWN_TO_SDK_VERSION));
}
/**
*
* A map of attributes with their corresponding values.
*
*
* The following lists the names, descriptions, and values of the special request parameters that the
* CreateQueue action uses:
*
*
* -
*
* DelaySeconds - The length of time, in seconds, for which the delivery of all messages in the queue
* is delayed. Valid values: An integer from 0 to 900 seconds (15 minutes). Default: 0.
*
*
* -
*
* MaximumMessageSize - The limit of how many bytes a message can contain before Amazon SQS rejects it.
* Valid values: An integer from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB).
*
*
* -
*
* MessageRetentionPeriod - The length of time, in seconds, for which Amazon SQS retains a message.
* Valid values: An integer from 60 seconds (1 minute) to 1,209,600 seconds (14 days). Default: 345,600 (4 days).
*
*
* -
*
* Policy - The queue's policy. A valid AWS policy. For more information about policy structure, see Overview of AWS IAM Policies in
* the Amazon IAM User Guide.
*
*
* -
*
* ReceiveMessageWaitTimeSeconds - The length of time, in seconds, for which a
* ReceiveMessage action waits for a message to arrive. Valid values: An integer from 0 to 20
* (seconds). Default: 0.
*
*
* -
*
* RedrivePolicy - The string that includes the parameters for the dead-letter queue functionality of
* the source queue. For more information about the redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon Simple Queue Service Developer Guide.
*
*
* -
*
* deadLetterTargetArn - The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS
* moves messages after the value of maxReceiveCount is exceeded.
*
*
* -
*
* maxReceiveCount - The number of times a message is delivered to the source queue before being moved
* to the dead-letter queue. When the ReceiveCount for a message exceeds the
* maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.
*
*
*
*
*
* The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard
* queue must also be a standard queue.
*
*
* -
*
* VisibilityTimeout - The visibility timeout for the queue, in seconds. Valid values: An integer from
* 0 to 43,200 (12 hours). Default: 30. For more information about the visibility timeout, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide.
*
*
*
*
* The following attributes apply only to server-side-encryption:
*
*
* -
*
* KmsMasterKeyId - The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK.
* For more information, see Key Terms. While the alias of the AWS-managed CMK for Amazon SQS is always alias/aws/sqs, the
* alias of a custom CMK can, for example, be alias/MyAlias . For more examples, see KeyId in the AWS Key Management Service API Reference.
*
*
* -
*
* KmsDataKeyReusePeriodSeconds - The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or
* decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and
* 86,400 seconds (24 hours). Default: 300 (5 minutes). A shorter time period provides better security but results
* in more calls to KMS which might incur charges after Free Tier. For more information, see How Does the Data Key Reuse Period Work?.
*
*
*
*
* The following attributes apply only to FIFO
* (first-in-first-out) queues:
*
*
* -
*
* FifoQueue - Designates a queue as FIFO. Valid values: true, false. You can
* provide this attribute only during queue creation. You can't change it for an existing queue. When you set this
* attribute, you must also provide the MessageGroupId for your messages explicitly.
*
*
* For more information, see FIFO Queue Logic in the Amazon Simple Queue Service Developer Guide.
*
*
* -
*
* ContentBasedDeduplication - Enables content-based deduplication. Valid values: true,
* false. For more information, see Exactly-Once Processing in the Amazon Simple Queue Service 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 enable
* ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the
* MessageDeduplicationId 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 have
* ContentBasedDeduplication set, the action fails with an error.
*
*
* -
*
* If the queue has ContentBasedDeduplication set, your MessageDeduplicationId 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 a
* MessageDeduplicationId that is the same as the one generated for the first
* MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message
* is delivered.
*
*
*
*
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* @return A map of attributes with their corresponding values.
*
* The following lists the names, descriptions, and values of the special request parameters that the
* CreateQueue action uses:
*
*
* -
*
* DelaySeconds - The length of time, in seconds, for which the delivery of all messages in the
* queue is delayed. Valid values: An integer from 0 to 900 seconds (15 minutes). Default: 0.
*
*
* -
*
* MaximumMessageSize - The limit of how many bytes a message can contain before Amazon SQS
* rejects it. Valid values: An integer from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). Default:
* 262,144 (256 KiB).
*
*
* -
*
* MessageRetentionPeriod - The length of time, in seconds, for which Amazon SQS retains a
* message. Valid values: An integer from 60 seconds (1 minute) to 1,209,600 seconds (14 days). Default:
* 345,600 (4 days).
*
*
* -
*
* Policy - The queue's policy. A valid AWS policy. For more information about policy
* structure, see Overview
* of AWS IAM Policies in the Amazon IAM User Guide.
*
*
* -
*
* ReceiveMessageWaitTimeSeconds - The length of time, in seconds, for which a
* ReceiveMessage action waits for a message to arrive. Valid values: An integer from
* 0 to 20 (seconds). Default: 0.
*
*
* -
*
* RedrivePolicy - The string that includes the parameters for the dead-letter queue
* functionality of the source queue. For more information about the redrive policy and dead-letter queues,
* see Using Amazon SQS Dead-Letter Queues in the Amazon Simple Queue Service Developer Guide.
*
*
* -
*
* deadLetterTargetArn - The Amazon Resource Name (ARN) of the dead-letter queue to which
* Amazon SQS moves messages after the value of maxReceiveCount is exceeded.
*
*
* -
*
* maxReceiveCount - The number of times a message is delivered to the source queue before
* being moved to the dead-letter queue. When the ReceiveCount for a message exceeds the
* maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.
*
*
*
*
*
* The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a
* standard queue must also be a standard queue.
*
*
* -
*
* VisibilityTimeout - The visibility timeout for the queue, in seconds. Valid values: An
* integer from 0 to 43,200 (12 hours). Default: 30. For more information about the visibility timeout, see
* Visibility Timeout in the Amazon Simple Queue Service Developer Guide.
*
*
*
*
* The following attributes apply only to server-side-encryption:
*
*
* -
*
* KmsMasterKeyId - The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a
* custom CMK. For more information, see Key Terms. While the alias of the AWS-managed CMK for Amazon SQS is always
* alias/aws/sqs, the alias of a custom CMK can, for example, be
* alias/MyAlias . For more examples, see KeyId in the AWS Key Management Service API Reference.
*
*
* -
*
* KmsDataKeyReusePeriodSeconds - The length of time, in seconds, for which Amazon SQS can
* reuse a data
* key to encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds,
* between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes). A shorter time
* period provides better security but results in more calls to KMS which might incur charges after Free
* Tier. For more information, see How Does the Data Key Reuse Period Work?.
*
*
*
*
* The following attributes apply only to FIFO
* (first-in-first-out) queues:
*
*
* -
*
* FifoQueue - Designates a queue as FIFO. Valid values: true, false.
* You can provide this attribute only during queue creation. You can't change it for an existing queue.
* When you set this attribute, you must also provide the MessageGroupId for your messages
* explicitly.
*
*
* For more information, see FIFO Queue Logic in the Amazon Simple Queue Service Developer Guide.
*
*
* -
*
* ContentBasedDeduplication - Enables content-based deduplication. Valid values:
* true, false. For more information, see Exactly-Once Processing in the Amazon Simple Queue Service 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 enable
* ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the
* MessageDeduplicationId 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 have
* ContentBasedDeduplication set, the action fails with an error.
*
*
* -
*
* If the queue has ContentBasedDeduplication set, your MessageDeduplicationId
* 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
* a MessageDeduplicationId that is the same as the one generated for the first
* MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the
* message is delivered.
*
*
*
*
*/
public Map attributesAsStrings() {
return attributes;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(queueName());
hashCode = 31 * hashCode + Objects.hashCode(attributesAsStrings());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof CreateQueueRequest)) {
return false;
}
CreateQueueRequest other = (CreateQueueRequest) obj;
return Objects.equals(queueName(), other.queueName())
&& Objects.equals(attributesAsStrings(), other.attributesAsStrings());
}
@Override
public String toString() {
return ToString.builder("CreateQueueRequest").add("QueueName", queueName()).add("Attributes", attributesAsStrings())
.build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "QueueName":
return Optional.ofNullable(clazz.cast(queueName()));
case "Attributes":
return Optional.ofNullable(clazz.cast(attributesAsStrings()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CreateQueueRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SqsRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The name of the new queue. The following limits apply to this name:
*
*
* -
*
* A queue name can have up to 80 characters.
*
*
* -
*
* Valid values: alphanumeric characters, hyphens (-), and underscores (_).
*
*
* -
*
* A FIFO queue name must end with the .fifo suffix.
*
*
*
*
* Queue URLs and names are case-sensitive.
*
*
* @param queueName
* The name of the new queue. The following limits apply to this name:
*
* -
*
* A queue name can have up to 80 characters.
*
*
* -
*
* Valid values: alphanumeric characters, hyphens (-), and underscores (_).
*
*
* -
*
* A FIFO queue name must end with the .fifo suffix.
*
*
*
*
* Queue URLs and names are case-sensitive.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder queueName(String queueName);
/**
*
* A map of attributes with their corresponding values.
*
*
* The following lists the names, descriptions, and values of the special request parameters that the
* CreateQueue action uses:
*
*
* -
*
* DelaySeconds - The length of time, in seconds, for which the delivery of all messages in the
* queue is delayed. Valid values: An integer from 0 to 900 seconds (15 minutes). Default: 0.
*
*
* -
*
* MaximumMessageSize - The limit of how many bytes a message can contain before Amazon SQS rejects
* it. Valid values: An integer from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB).
*
*
* -
*
* MessageRetentionPeriod - The length of time, in seconds, for which Amazon SQS retains a message.
* Valid values: An integer from 60 seconds (1 minute) to 1,209,600 seconds (14 days). Default: 345,600 (4
* days).
*
*
* -
*
* Policy - The queue's policy. A valid AWS policy. For more information about policy structure,
* see Overview of AWS IAM
* Policies in the Amazon IAM User Guide.
*
*
* -
*
* ReceiveMessageWaitTimeSeconds - The length of time, in seconds, for which a
* ReceiveMessage action waits for a message to arrive. Valid values: An integer from 0 to
* 20 (seconds). Default: 0.
*
*
* -
*
* RedrivePolicy - The string that includes the parameters for the dead-letter queue functionality
* of the source queue. For more information about the redrive policy and dead-letter queues, see Using
* Amazon SQS Dead-Letter Queues in the Amazon Simple Queue Service Developer Guide.
*
*
* -
*
* deadLetterTargetArn - The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon
* SQS moves messages after the value of maxReceiveCount is exceeded.
*
*
* -
*
* maxReceiveCount - The number of times a message is delivered to the source queue before being
* moved to the dead-letter queue. When the ReceiveCount for a message exceeds the
* maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.
*
*
*
*
*
* The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a
* standard queue must also be a standard queue.
*
*
* -
*
* VisibilityTimeout - The visibility timeout for the queue, in seconds. Valid values: An integer
* from 0 to 43,200 (12 hours). Default: 30. For more information about the visibility timeout, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide.
*
*
*
*
* The following attributes apply only to server-side-encryption:
*
*
* -
*
* KmsMasterKeyId - The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom
* CMK. For more information, see Key Terms. While the alias of the AWS-managed CMK for Amazon SQS is always alias/aws/sqs,
* the alias of a custom CMK can, for example, be alias/MyAlias . For more examples, see KeyId in the AWS Key Management Service API Reference.
*
*
* -
*
* KmsDataKeyReusePeriodSeconds - The length of time, in seconds, for which Amazon SQS can reuse a
* data key to
* encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds
* (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes). A shorter time period provides better
* security but results in more calls to KMS which might incur charges after Free Tier. For more information,
* see How Does the Data Key Reuse Period Work?.
*
*
*
*
* The following attributes apply only to FIFO
* (first-in-first-out) queues:
*
*
* -
*
* FifoQueue - Designates a queue as FIFO. Valid values: true, false. You
* can provide this attribute only during queue creation. You can't change it for an existing queue. When you
* set this attribute, you must also provide the MessageGroupId for your messages explicitly.
*
*
* For more information, see FIFO Queue Logic in the Amazon Simple Queue Service Developer Guide.
*
*
* -
*
* ContentBasedDeduplication - Enables content-based deduplication. Valid values: true, false. For more information, see Exactly-Once Processing in the Amazon Simple Queue Service 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 enable
* ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the
* MessageDeduplicationId 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 have
* ContentBasedDeduplication set, the action fails with an error.
*
*
* -
*
* If the queue has ContentBasedDeduplication set, your MessageDeduplicationId
* 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 a
* MessageDeduplicationId that is the same as the one generated for the first
* MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the
* message is delivered.
*
*
*
*
*
*
* @param attributes
* A map of attributes with their corresponding values.
*
* The following lists the names, descriptions, and values of the special request parameters that the
* CreateQueue action uses:
*
*
* -
*
* DelaySeconds - The length of time, in seconds, for which the delivery of all messages in
* the queue is delayed. Valid values: An integer from 0 to 900 seconds (15 minutes). Default: 0.
*
*
* -
*
* MaximumMessageSize - The limit of how many bytes a message can contain before Amazon SQS
* rejects it. Valid values: An integer from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). Default:
* 262,144 (256 KiB).
*
*
* -
*
* MessageRetentionPeriod - The length of time, in seconds, for which Amazon SQS retains a
* message. Valid values: An integer from 60 seconds (1 minute) to 1,209,600 seconds (14 days). Default:
* 345,600 (4 days).
*
*
* -
*
* Policy - The queue's policy. A valid AWS policy. For more information about policy
* structure, see Overview of AWS IAM
* Policies in the Amazon IAM User Guide.
*
*
* -
*
* ReceiveMessageWaitTimeSeconds - The length of time, in seconds, for which a
* ReceiveMessage action waits for a message to arrive. Valid values: An integer
* from 0 to 20 (seconds). Default: 0.
*
*
* -
*
* RedrivePolicy - The string that includes the parameters for the dead-letter queue
* functionality of the source queue. For more information about the redrive policy and dead-letter
* queues, see Using Amazon SQS Dead-Letter Queues in the Amazon Simple Queue Service Developer Guide.
*
*
* -
*
* deadLetterTargetArn - The Amazon Resource Name (ARN) of the dead-letter queue to which
* Amazon SQS moves messages after the value of maxReceiveCount is exceeded.
*
*
* -
*
* maxReceiveCount - The number of times a message is delivered to the source queue before
* being moved to the dead-letter queue. When the ReceiveCount for a message exceeds the
* maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.
*
*
*
*
*
* The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a
* standard queue must also be a standard queue.
*
*
* -
*
* VisibilityTimeout - The visibility timeout for the queue, in seconds. Valid values: An
* integer from 0 to 43,200 (12 hours). Default: 30. For more information about the visibility timeout,
* see Visibility Timeout in the Amazon Simple Queue Service Developer Guide.
*
*
*
*
* The following attributes apply only to server-side-encryption:
*
*
* -
*
* KmsMasterKeyId - The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a
* custom CMK. For more information, see Key Terms. While the alias of the AWS-managed CMK for Amazon SQS is always
* alias/aws/sqs, the alias of a custom CMK can, for example, be
* alias/MyAlias . For more examples, see KeyId in the AWS Key Management Service API Reference.
*
*
* -
*
* KmsDataKeyReusePeriodSeconds - The length of time, in seconds, for which Amazon SQS can
* reuse a data
* key to encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds,
* between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes). A shorter time
* period provides better security but results in more calls to KMS which might incur charges after Free
* Tier. For more information, see How Does the Data Key Reuse Period Work?.
*
*
*
*
* The following attributes apply only to FIFO
* (first-in-first-out) queues:
*
*
* -
*
* FifoQueue - Designates a queue as FIFO. Valid values: true,
* false. You can provide this attribute only during queue creation. You can't change it for
* an existing queue. When you set this attribute, you must also provide the MessageGroupId
* for your messages explicitly.
*
*
* For more information, see FIFO Queue Logic in the Amazon Simple Queue Service Developer Guide.
*
*
* -
*
* ContentBasedDeduplication - Enables content-based deduplication. Valid values:
* true, false. For more information, see Exactly-Once Processing in the Amazon Simple Queue Service 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 enable
* ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the
* MessageDeduplicationId 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 have
* ContentBasedDeduplication set, the action fails with an error.
*
*
* -
*
* If the queue has ContentBasedDeduplication set, your MessageDeduplicationId
* 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 a MessageDeduplicationId that is the same as the one generated for the first
* MessageDeduplicationId, the two messages are treated as duplicates and only one copy of
* the message is delivered.
*
*
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder attributesWithStrings(Map attributes);
/**
*
* A map of attributes with their corresponding values.
*
*
* The following lists the names, descriptions, and values of the special request parameters that the
* CreateQueue action uses:
*
*
* -
*
* DelaySeconds - The length of time, in seconds, for which the delivery of all messages in the
* queue is delayed. Valid values: An integer from 0 to 900 seconds (15 minutes). Default: 0.
*
*
* -
*
* MaximumMessageSize - The limit of how many bytes a message can contain before Amazon SQS rejects
* it. Valid values: An integer from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB).
*
*
* -
*
* MessageRetentionPeriod - The length of time, in seconds, for which Amazon SQS retains a message.
* Valid values: An integer from 60 seconds (1 minute) to 1,209,600 seconds (14 days). Default: 345,600 (4
* days).
*
*
* -
*
* Policy - The queue's policy. A valid AWS policy. For more information about policy structure,
* see Overview of AWS IAM
* Policies in the Amazon IAM User Guide.
*
*
* -
*
* ReceiveMessageWaitTimeSeconds - The length of time, in seconds, for which a
* ReceiveMessage action waits for a message to arrive. Valid values: An integer from 0 to
* 20 (seconds). Default: 0.
*
*
* -
*
* RedrivePolicy - The string that includes the parameters for the dead-letter queue functionality
* of the source queue. For more information about the redrive policy and dead-letter queues, see Using
* Amazon SQS Dead-Letter Queues in the Amazon Simple Queue Service Developer Guide.
*
*
* -
*
* deadLetterTargetArn - The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon
* SQS moves messages after the value of maxReceiveCount is exceeded.
*
*
* -
*
* maxReceiveCount - The number of times a message is delivered to the source queue before being
* moved to the dead-letter queue. When the ReceiveCount for a message exceeds the
* maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.
*
*
*
*
*
* The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a
* standard queue must also be a standard queue.
*
*
* -
*
* VisibilityTimeout - The visibility timeout for the queue, in seconds. Valid values: An integer
* from 0 to 43,200 (12 hours). Default: 30. For more information about the visibility timeout, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide.
*
*
*
*
* The following attributes apply only to server-side-encryption:
*
*
* -
*
* KmsMasterKeyId - The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom
* CMK. For more information, see Key Terms. While the alias of the AWS-managed CMK for Amazon SQS is always alias/aws/sqs,
* the alias of a custom CMK can, for example, be alias/MyAlias . For more examples, see KeyId in the AWS Key Management Service API Reference.
*
*
* -
*
* KmsDataKeyReusePeriodSeconds - The length of time, in seconds, for which Amazon SQS can reuse a
* data key to
* encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds
* (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes). A shorter time period provides better
* security but results in more calls to KMS which might incur charges after Free Tier. For more information,
* see How Does the Data Key Reuse Period Work?.
*
*
*
*
* The following attributes apply only to FIFO
* (first-in-first-out) queues:
*
*
* -
*
* FifoQueue - Designates a queue as FIFO. Valid values: true, false. You
* can provide this attribute only during queue creation. You can't change it for an existing queue. When you
* set this attribute, you must also provide the MessageGroupId for your messages explicitly.
*
*
* For more information, see FIFO Queue Logic in the Amazon Simple Queue Service Developer Guide.
*
*
* -
*
* ContentBasedDeduplication - Enables content-based deduplication. Valid values: true, false. For more information, see Exactly-Once Processing in the Amazon Simple Queue Service 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 enable
* ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the
* MessageDeduplicationId 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 have
* ContentBasedDeduplication set, the action fails with an error.
*
*
* -
*
* If the queue has ContentBasedDeduplication set, your MessageDeduplicationId
* 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 a
* MessageDeduplicationId that is the same as the one generated for the first
* MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the
* message is delivered.
*
*
*
*
*
*
* @param attributes
* A map of attributes with their corresponding values.
*
* The following lists the names, descriptions, and values of the special request parameters that the
* CreateQueue action uses:
*
*
* -
*
* DelaySeconds - The length of time, in seconds, for which the delivery of all messages in
* the queue is delayed. Valid values: An integer from 0 to 900 seconds (15 minutes). Default: 0.
*
*
* -
*
* MaximumMessageSize - The limit of how many bytes a message can contain before Amazon SQS
* rejects it. Valid values: An integer from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). Default:
* 262,144 (256 KiB).
*
*
* -
*
* MessageRetentionPeriod - The length of time, in seconds, for which Amazon SQS retains a
* message. Valid values: An integer from 60 seconds (1 minute) to 1,209,600 seconds (14 days). Default:
* 345,600 (4 days).
*
*
* -
*
* Policy - The queue's policy. A valid AWS policy. For more information about policy
* structure, see Overview of AWS IAM
* Policies in the Amazon IAM User Guide.
*
*
* -
*
* ReceiveMessageWaitTimeSeconds - The length of time, in seconds, for which a
* ReceiveMessage action waits for a message to arrive. Valid values: An integer
* from 0 to 20 (seconds). Default: 0.
*
*
* -
*
* RedrivePolicy - The string that includes the parameters for the dead-letter queue
* functionality of the source queue. For more information about the redrive policy and dead-letter
* queues, see Using Amazon SQS Dead-Letter Queues in the Amazon Simple Queue Service Developer Guide.
*
*
* -
*
* deadLetterTargetArn - The Amazon Resource Name (ARN) of the dead-letter queue to which
* Amazon SQS moves messages after the value of maxReceiveCount is exceeded.
*
*
* -
*
* maxReceiveCount - The number of times a message is delivered to the source queue before
* being moved to the dead-letter queue. When the ReceiveCount for a message exceeds the
* maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.
*
*
*
*
*
* The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a
* standard queue must also be a standard queue.
*
*
* -
*
* VisibilityTimeout - The visibility timeout for the queue, in seconds. Valid values: An
* integer from 0 to 43,200 (12 hours). Default: 30. For more information about the visibility timeout,
* see Visibility Timeout in the Amazon Simple Queue Service Developer Guide.
*
*
*
*
* The following attributes apply only to server-side-encryption:
*
*
* -
*
* KmsMasterKeyId - The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a
* custom CMK. For more information, see Key Terms. While the alias of the AWS-managed CMK for Amazon SQS is always
* alias/aws/sqs, the alias of a custom CMK can, for example, be
* alias/MyAlias . For more examples, see KeyId in the AWS Key Management Service API Reference.
*
*
* -
*
* KmsDataKeyReusePeriodSeconds - The length of time, in seconds, for which Amazon SQS can
* reuse a data
* key to encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds,
* between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes). A shorter time
* period provides better security but results in more calls to KMS which might incur charges after Free
* Tier. For more information, see How Does the Data Key Reuse Period Work?.
*
*
*
*
* The following attributes apply only to FIFO
* (first-in-first-out) queues:
*
*
* -
*
* FifoQueue - Designates a queue as FIFO. Valid values: true,
* false. You can provide this attribute only during queue creation. You can't change it for
* an existing queue. When you set this attribute, you must also provide the MessageGroupId
* for your messages explicitly.
*
*
* For more information, see FIFO Queue Logic in the Amazon Simple Queue Service Developer Guide.
*
*
* -
*
* ContentBasedDeduplication - Enables content-based deduplication. Valid values:
* true, false. For more information, see Exactly-Once Processing in the Amazon Simple Queue Service 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 enable
* ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the
* MessageDeduplicationId 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 have
* ContentBasedDeduplication set, the action fails with an error.
*
*
* -
*
* If the queue has ContentBasedDeduplication set, your MessageDeduplicationId
* 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 a MessageDeduplicationId that is the same as the one generated for the first
* MessageDeduplicationId, the two messages are treated as duplicates and only one copy of
* the message is delivered.
*
*
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder attributes(Map attributes);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends SqsRequest.BuilderImpl implements Builder {
private String queueName;
private Map attributes = DefaultSdkAutoConstructMap.getInstance();
private BuilderImpl() {
}
private BuilderImpl(CreateQueueRequest model) {
super(model);
queueName(model.queueName);
attributesWithStrings(model.attributes);
}
public final String getQueueName() {
return queueName;
}
@Override
public final Builder queueName(String queueName) {
this.queueName = queueName;
return this;
}
public final void setQueueName(String queueName) {
this.queueName = queueName;
}
public final Map getAttributesAsStrings() {
return attributes;
}
@Override
public final Builder attributesWithStrings(Map attributes) {
this.attributes = QueueAttributeMapCopier.copy(attributes);
return this;
}
@Override
public final Builder attributes(Map attributes) {
this.attributes = QueueAttributeMapCopier.copyEnumToString(attributes);
return this;
}
public final void setAttributesWithStrings(Map attributes) {
this.attributes = QueueAttributeMapCopier.copy(attributes);
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public CreateQueueRequest build() {
return new CreateQueueRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}