software.amazon.awssdk.services.mq.model.CreateConfigurationRequest Maven / Gradle / Ivy
Show all versions of mq Show documentation
/*
* Copyright 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.mq.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.traits.LocationTrait;
import software.amazon.awssdk.core.traits.MapTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructMap;
import software.amazon.awssdk.core.util.SdkAutoConstructMap;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the
* engine type and version).
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class CreateConfigurationRequest extends MqRequest implements
ToCopyableBuilder {
private static final SdkField AUTHENTICATION_STRATEGY_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("AuthenticationStrategy").getter(getter(CreateConfigurationRequest::authenticationStrategyAsString))
.setter(setter(Builder::authenticationStrategy))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("authenticationStrategy").build())
.build();
private static final SdkField ENGINE_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("EngineType").getter(getter(CreateConfigurationRequest::engineTypeAsString))
.setter(setter(Builder::engineType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("engineType").build()).build();
private static final SdkField ENGINE_VERSION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("EngineVersion").getter(getter(CreateConfigurationRequest::engineVersion))
.setter(setter(Builder::engineVersion))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("engineVersion").build()).build();
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Name")
.getter(getter(CreateConfigurationRequest::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("name").build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("Tags")
.getter(getter(CreateConfigurationRequest::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("tags").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(AUTHENTICATION_STRATEGY_FIELD,
ENGINE_TYPE_FIELD, ENGINE_VERSION_FIELD, NAME_FIELD, TAGS_FIELD));
private final String authenticationStrategy;
private final String engineType;
private final String engineVersion;
private final String name;
private final Map tags;
private CreateConfigurationRequest(BuilderImpl builder) {
super(builder);
this.authenticationStrategy = builder.authenticationStrategy;
this.engineType = builder.engineType;
this.engineVersion = builder.engineVersion;
this.name = builder.name;
this.tags = builder.tags;
}
/**
*
* Optional. The authentication strategy associated with the configuration. The default is SIMPLE.
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #authenticationStrategy} will return {@link AuthenticationStrategy#UNKNOWN_TO_SDK_VERSION}. The raw value
* returned by the service is available from {@link #authenticationStrategyAsString}.
*
*
* @return Optional. The authentication strategy associated with the configuration. The default is SIMPLE.
* @see AuthenticationStrategy
*/
public final AuthenticationStrategy authenticationStrategy() {
return AuthenticationStrategy.fromValue(authenticationStrategy);
}
/**
*
* Optional. The authentication strategy associated with the configuration. The default is SIMPLE.
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #authenticationStrategy} will return {@link AuthenticationStrategy#UNKNOWN_TO_SDK_VERSION}. The raw value
* returned by the service is available from {@link #authenticationStrategyAsString}.
*
*
* @return Optional. The authentication strategy associated with the configuration. The default is SIMPLE.
* @see AuthenticationStrategy
*/
public final String authenticationStrategyAsString() {
return authenticationStrategy;
}
/**
*
* Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #engineType} will
* return {@link EngineType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #engineTypeAsString}.
*
*
* @return Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
* @see EngineType
*/
public final EngineType engineType() {
return EngineType.fromValue(engineType);
}
/**
*
* Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #engineType} will
* return {@link EngineType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #engineTypeAsString}.
*
*
* @return Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
* @see EngineType
*/
public final String engineTypeAsString() {
return engineType;
}
/**
*
* The broker engine version. Defaults to the latest available version for the specified broker engine type. For
* more information, see the ActiveMQ
* version management and the RabbitMQ
* version management sections in the Amazon MQ Developer Guide.
*
*
* @return The broker engine version. Defaults to the latest available version for the specified broker engine type.
* For more information, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.
*/
public final String engineVersion() {
return engineVersion;
}
/**
*
* Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods,
* underscores, and tildes (- . _ ~). This value must be 1-150 characters long.
*
*
* @return Required. The name of the configuration. This value can contain only alphanumeric characters, dashes,
* periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long.
*/
public final String name() {
return name;
}
/**
* For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that
* the value is non-empty (for which, you should check the {@code isEmpty()} method on the property). This is useful
* because the SDK will never return a null collection or map, but you may need to differentiate between the service
* returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true
* if a value for the property was specified in the request builder, and false if a value was not specified.
*/
public final boolean hasTags() {
return tags != null && !(tags instanceof SdkAutoConstructMap);
}
/**
*
* Create tags when creating the configuration.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasTags} method.
*
*
* @return Create tags when creating the configuration.
*/
public final Map tags() {
return tags;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(authenticationStrategyAsString());
hashCode = 31 * hashCode + Objects.hashCode(engineTypeAsString());
hashCode = 31 * hashCode + Objects.hashCode(engineVersion());
hashCode = 31 * hashCode + Objects.hashCode(name());
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof CreateConfigurationRequest)) {
return false;
}
CreateConfigurationRequest other = (CreateConfigurationRequest) obj;
return Objects.equals(authenticationStrategyAsString(), other.authenticationStrategyAsString())
&& Objects.equals(engineTypeAsString(), other.engineTypeAsString())
&& Objects.equals(engineVersion(), other.engineVersion()) && Objects.equals(name(), other.name())
&& hasTags() == other.hasTags() && Objects.equals(tags(), other.tags());
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*/
@Override
public final String toString() {
return ToString.builder("CreateConfigurationRequest").add("AuthenticationStrategy", authenticationStrategyAsString())
.add("EngineType", engineTypeAsString()).add("EngineVersion", engineVersion()).add("Name", name())
.add("Tags", hasTags() ? tags() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "AuthenticationStrategy":
return Optional.ofNullable(clazz.cast(authenticationStrategyAsString()));
case "EngineType":
return Optional.ofNullable(clazz.cast(engineTypeAsString()));
case "EngineVersion":
return Optional.ofNullable(clazz.cast(engineVersion()));
case "Name":
return Optional.ofNullable(clazz.cast(name()));
case "Tags":
return Optional.ofNullable(clazz.cast(tags()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CreateConfigurationRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends MqRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* Optional. The authentication strategy associated with the configuration. The default is SIMPLE.
*
*
* @param authenticationStrategy
* Optional. The authentication strategy associated with the configuration. The default is SIMPLE.
* @see AuthenticationStrategy
* @return Returns a reference to this object so that method calls can be chained together.
* @see AuthenticationStrategy
*/
Builder authenticationStrategy(String authenticationStrategy);
/**
*
* Optional. The authentication strategy associated with the configuration. The default is SIMPLE.
*
*
* @param authenticationStrategy
* Optional. The authentication strategy associated with the configuration. The default is SIMPLE.
* @see AuthenticationStrategy
* @return Returns a reference to this object so that method calls can be chained together.
* @see AuthenticationStrategy
*/
Builder authenticationStrategy(AuthenticationStrategy authenticationStrategy);
/**
*
* Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
*
*
* @param engineType
* Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
* @see EngineType
* @return Returns a reference to this object so that method calls can be chained together.
* @see EngineType
*/
Builder engineType(String engineType);
/**
*
* Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
*
*
* @param engineType
* Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
* @see EngineType
* @return Returns a reference to this object so that method calls can be chained together.
* @see EngineType
*/
Builder engineType(EngineType engineType);
/**
*
* The broker engine version. Defaults to the latest available version for the specified broker engine type. For
* more information, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.
*
*
* @param engineVersion
* The broker engine version. Defaults to the latest available version for the specified broker engine
* type. For more information, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder engineVersion(String engineVersion);
/**
*
* Required. The name of the configuration. This value can contain only alphanumeric characters, dashes,
* periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long.
*
*
* @param name
* Required. The name of the configuration. This value can contain only alphanumeric characters, dashes,
* periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* Create tags when creating the configuration.
*
*
* @param tags
* Create tags when creating the configuration.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Map tags);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends MqRequest.BuilderImpl implements Builder {
private String authenticationStrategy;
private String engineType;
private String engineVersion;
private String name;
private Map tags = DefaultSdkAutoConstructMap.getInstance();
private BuilderImpl() {
}
private BuilderImpl(CreateConfigurationRequest model) {
super(model);
authenticationStrategy(model.authenticationStrategy);
engineType(model.engineType);
engineVersion(model.engineVersion);
name(model.name);
tags(model.tags);
}
public final String getAuthenticationStrategy() {
return authenticationStrategy;
}
public final void setAuthenticationStrategy(String authenticationStrategy) {
this.authenticationStrategy = authenticationStrategy;
}
@Override
public final Builder authenticationStrategy(String authenticationStrategy) {
this.authenticationStrategy = authenticationStrategy;
return this;
}
@Override
public final Builder authenticationStrategy(AuthenticationStrategy authenticationStrategy) {
this.authenticationStrategy(authenticationStrategy == null ? null : authenticationStrategy.toString());
return this;
}
public final String getEngineType() {
return engineType;
}
public final void setEngineType(String engineType) {
this.engineType = engineType;
}
@Override
public final Builder engineType(String engineType) {
this.engineType = engineType;
return this;
}
@Override
public final Builder engineType(EngineType engineType) {
this.engineType(engineType == null ? null : engineType.toString());
return this;
}
public final String getEngineVersion() {
return engineVersion;
}
public final void setEngineVersion(String engineVersion) {
this.engineVersion = engineVersion;
}
@Override
public final Builder engineVersion(String engineVersion) {
this.engineVersion = engineVersion;
return this;
}
public final String getName() {
return name;
}
public final void setName(String name) {
this.name = name;
}
@Override
public final Builder name(String name) {
this.name = name;
return this;
}
public final Map getTags() {
if (tags instanceof SdkAutoConstructMap) {
return null;
}
return tags;
}
public final void setTags(Map tags) {
this.tags = ___mapOf__stringCopier.copy(tags);
}
@Override
public final Builder tags(Map tags) {
this.tags = ___mapOf__stringCopier.copy(tags);
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public CreateConfigurationRequest build() {
return new CreateConfigurationRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}