software.amazon.awssdk.services.mq.model.DescribeConfigurationResponse 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.time.Instant;
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.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.traits.TimestampFormatTrait;
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;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class DescribeConfigurationResponse extends MqResponse implements
ToCopyableBuilder {
private static final SdkField ARN_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Arn")
.getter(getter(DescribeConfigurationResponse::arn)).setter(setter(Builder::arn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("arn").build()).build();
private static final SdkField AUTHENTICATION_STRATEGY_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("AuthenticationStrategy").getter(getter(DescribeConfigurationResponse::authenticationStrategyAsString))
.setter(setter(Builder::authenticationStrategy))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("authenticationStrategy").build())
.build();
private static final SdkField CREATED_FIELD = SdkField
. builder(MarshallingType.INSTANT)
.memberName("Created")
.getter(getter(DescribeConfigurationResponse::created))
.setter(setter(Builder::created))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("created").build(),
TimestampFormatTrait.create(TimestampFormatTrait.Format.ISO_8601)).build();
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Description").getter(getter(DescribeConfigurationResponse::description))
.setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("description").build()).build();
private static final SdkField ENGINE_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("EngineType").getter(getter(DescribeConfigurationResponse::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(DescribeConfigurationResponse::engineVersion))
.setter(setter(Builder::engineVersion))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("engineVersion").build()).build();
private static final SdkField ID_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Id")
.getter(getter(DescribeConfigurationResponse::id)).setter(setter(Builder::id))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("id").build()).build();
private static final SdkField LATEST_REVISION_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("LatestRevision")
.getter(getter(DescribeConfigurationResponse::latestRevision)).setter(setter(Builder::latestRevision))
.constructor(ConfigurationRevision::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("latestRevision").build()).build();
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Name")
.getter(getter(DescribeConfigurationResponse::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(DescribeConfigurationResponse::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(ARN_FIELD,
AUTHENTICATION_STRATEGY_FIELD, CREATED_FIELD, DESCRIPTION_FIELD, ENGINE_TYPE_FIELD, ENGINE_VERSION_FIELD, ID_FIELD,
LATEST_REVISION_FIELD, NAME_FIELD, TAGS_FIELD));
private final String arn;
private final String authenticationStrategy;
private final Instant created;
private final String description;
private final String engineType;
private final String engineVersion;
private final String id;
private final ConfigurationRevision latestRevision;
private final String name;
private final Map tags;
private DescribeConfigurationResponse(BuilderImpl builder) {
super(builder);
this.arn = builder.arn;
this.authenticationStrategy = builder.authenticationStrategy;
this.created = builder.created;
this.description = builder.description;
this.engineType = builder.engineType;
this.engineVersion = builder.engineVersion;
this.id = builder.id;
this.latestRevision = builder.latestRevision;
this.name = builder.name;
this.tags = builder.tags;
}
/**
*
* Required. The ARN of the configuration.
*
*
* @return Required. The ARN of the configuration.
*/
public final String arn() {
return arn;
}
/**
*
* 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 date and time of the configuration revision.
*
*
* @return Required. The date and time of the configuration revision.
*/
public final Instant created() {
return created;
}
/**
*
* Required. The description of the configuration.
*
*
* @return Required. The description of the configuration.
*/
public final String description() {
return description;
}
/**
*
* 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 a
* list of supported engine versions, 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 a list of supported engine versions, 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 unique ID that Amazon MQ generates for the configuration.
*
*
* @return Required. The unique ID that Amazon MQ generates for the configuration.
*/
public final String id() {
return id;
}
/**
*
* Required. The latest revision of the configuration.
*
*
* @return Required. The latest revision of the configuration.
*/
public final ConfigurationRevision latestRevision() {
return latestRevision;
}
/**
*
* 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);
}
/**
*
* The list of all tags associated with this 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 The list of all tags associated with this 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(arn());
hashCode = 31 * hashCode + Objects.hashCode(authenticationStrategyAsString());
hashCode = 31 * hashCode + Objects.hashCode(created());
hashCode = 31 * hashCode + Objects.hashCode(description());
hashCode = 31 * hashCode + Objects.hashCode(engineTypeAsString());
hashCode = 31 * hashCode + Objects.hashCode(engineVersion());
hashCode = 31 * hashCode + Objects.hashCode(id());
hashCode = 31 * hashCode + Objects.hashCode(latestRevision());
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 DescribeConfigurationResponse)) {
return false;
}
DescribeConfigurationResponse other = (DescribeConfigurationResponse) obj;
return Objects.equals(arn(), other.arn())
&& Objects.equals(authenticationStrategyAsString(), other.authenticationStrategyAsString())
&& Objects.equals(created(), other.created()) && Objects.equals(description(), other.description())
&& Objects.equals(engineTypeAsString(), other.engineTypeAsString())
&& Objects.equals(engineVersion(), other.engineVersion()) && Objects.equals(id(), other.id())
&& Objects.equals(latestRevision(), other.latestRevision()) && 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("DescribeConfigurationResponse").add("Arn", arn())
.add("AuthenticationStrategy", authenticationStrategyAsString()).add("Created", created())
.add("Description", description()).add("EngineType", engineTypeAsString()).add("EngineVersion", engineVersion())
.add("Id", id()).add("LatestRevision", latestRevision()).add("Name", name())
.add("Tags", hasTags() ? tags() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Arn":
return Optional.ofNullable(clazz.cast(arn()));
case "AuthenticationStrategy":
return Optional.ofNullable(clazz.cast(authenticationStrategyAsString()));
case "Created":
return Optional.ofNullable(clazz.cast(created()));
case "Description":
return Optional.ofNullable(clazz.cast(description()));
case "EngineType":
return Optional.ofNullable(clazz.cast(engineTypeAsString()));
case "EngineVersion":
return Optional.ofNullable(clazz.cast(engineVersion()));
case "Id":
return Optional.ofNullable(clazz.cast(id()));
case "LatestRevision":
return Optional.ofNullable(clazz.cast(latestRevision()));
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((DescribeConfigurationResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends MqResponse.Builder, SdkPojo, CopyableBuilder {
/**
*
* Required. The ARN of the configuration.
*
*
* @param arn
* Required. The ARN of the configuration.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder arn(String arn);
/**
*
* 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 date and time of the configuration revision.
*
*
* @param created
* Required. The date and time of the configuration revision.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder created(Instant created);
/**
*
* Required. The description of the configuration.
*
*
* @param description
* Required. The description of the configuration.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder description(String description);
/**
*
* 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
* a list of supported engine versions, 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 a list of supported engine versions, 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 unique ID that Amazon MQ generates for the configuration.
*
*
* @param id
* Required. The unique ID that Amazon MQ generates for the configuration.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder id(String id);
/**
*
* Required. The latest revision of the configuration.
*
*
* @param latestRevision
* Required. The latest revision of the configuration.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder latestRevision(ConfigurationRevision latestRevision);
/**
*
* Required. The latest revision of the configuration.
*
* This is a convenience method that creates an instance of the {@link ConfigurationRevision.Builder} avoiding
* the need to create one manually via {@link ConfigurationRevision#builder()}.
*
*
* When the {@link Consumer} completes, {@link ConfigurationRevision.Builder#build()} is called immediately and
* its result is passed to {@link #latestRevision(ConfigurationRevision)}.
*
* @param latestRevision
* a consumer that will call methods on {@link ConfigurationRevision.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #latestRevision(ConfigurationRevision)
*/
default Builder latestRevision(Consumer latestRevision) {
return latestRevision(ConfigurationRevision.builder().applyMutation(latestRevision).build());
}
/**
*
* 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);
/**
*
* The list of all tags associated with this configuration.
*
*
* @param tags
* The list of all tags associated with this configuration.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Map tags);
}
static final class BuilderImpl extends MqResponse.BuilderImpl implements Builder {
private String arn;
private String authenticationStrategy;
private Instant created;
private String description;
private String engineType;
private String engineVersion;
private String id;
private ConfigurationRevision latestRevision;
private String name;
private Map tags = DefaultSdkAutoConstructMap.getInstance();
private BuilderImpl() {
}
private BuilderImpl(DescribeConfigurationResponse model) {
super(model);
arn(model.arn);
authenticationStrategy(model.authenticationStrategy);
created(model.created);
description(model.description);
engineType(model.engineType);
engineVersion(model.engineVersion);
id(model.id);
latestRevision(model.latestRevision);
name(model.name);
tags(model.tags);
}
public final String getArn() {
return arn;
}
public final void setArn(String arn) {
this.arn = arn;
}
@Override
public final Builder arn(String arn) {
this.arn = arn;
return this;
}
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 Instant getCreated() {
return created;
}
public final void setCreated(Instant created) {
this.created = created;
}
@Override
public final Builder created(Instant created) {
this.created = created;
return this;
}
public final String getDescription() {
return description;
}
public final void setDescription(String description) {
this.description = description;
}
@Override
public final Builder description(String description) {
this.description = description;
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 getId() {
return id;
}
public final void setId(String id) {
this.id = id;
}
@Override
public final Builder id(String id) {
this.id = id;
return this;
}
public final ConfigurationRevision.Builder getLatestRevision() {
return latestRevision != null ? latestRevision.toBuilder() : null;
}
public final void setLatestRevision(ConfigurationRevision.BuilderImpl latestRevision) {
this.latestRevision = latestRevision != null ? latestRevision.build() : null;
}
@Override
public final Builder latestRevision(ConfigurationRevision latestRevision) {
this.latestRevision = latestRevision;
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 DescribeConfigurationResponse build() {
return new DescribeConfigurationResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}