software.amazon.awssdk.services.mq.model

Class Configuration

java.lang.Object

software.amazon.awssdk.services.mq.model.Configuration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Configuration.Builder,Configuration>

@Generated(value="software.amazon.awssdk:codegen")
public final class Configuration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Configuration.Builder,Configuration>

Returns information about all configurations.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Configuration.Builder

Method Summary

Modifier and Type	Method and Description
String	arn() Required.
AuthenticationStrategy	authenticationStrategy() Optional.
String	authenticationStrategyAsString() Optional.
static Configuration.Builder	builder()
Instant	created() Required.
String	description() Required.
EngineType	engineType() Required.
String	engineTypeAsString() Required.
String	engineVersion() Required.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
String	id() Required.
ConfigurationRevision	latestRevision() Required.
String	name() Required.
List<SdkField<?>>	sdkFields()
static Class<? extends Configuration.Builder>	serializableBuilderClass()
Map<String,String>	tags() The list of all tags associated with this configuration.
Configuration.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

arn

public final String arn()

Required. The ARN of the configuration.

Returns:

Required. The ARN of the configuration.

authenticationStrategy

public final AuthenticationStrategy 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, authenticationStrategy will return AuthenticationStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authenticationStrategyAsString().

Returns:

Optional. The authentication strategy associated with the configuration. The default is SIMPLE.

See Also:

AuthenticationStrategy

authenticationStrategyAsString

public final String authenticationStrategyAsString()

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, authenticationStrategy will return AuthenticationStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authenticationStrategyAsString().

Returns:

Optional. The authentication strategy associated with the configuration. The default is SIMPLE.

See Also:

AuthenticationStrategy

created

public final Instant created()

Required. The date and time of the configuration revision.

Returns:

Required. The date and time of the configuration revision.

description

public final String description()

Required. The description of the configuration.

Returns:

Required. The description of the configuration.

engineType

public final EngineType 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, engineType will return EngineType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from engineTypeAsString().

Returns:

Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.

See Also:

EngineType

engineTypeAsString

public final String engineTypeAsString()

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, engineType will return EngineType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from engineTypeAsString().

Returns:

Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.

See Also:

EngineType

engineVersion

public final String engineVersion()

Required. The broker engine's version. For a list of supported engine versions, see, Supported engines.

Returns:

Required. The broker engine's version. For a list of supported engine versions, see, Supported engines.

id

public final String id()

Required. The unique ID that Amazon MQ generates for the configuration.

Returns:

Required. The unique ID that Amazon MQ generates for the configuration.

latestRevision

public final ConfigurationRevision latestRevision()

Required. The latest revision of the configuration.

Returns:

Required. The latest revision of the configuration.

name

public final String 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.

Returns:

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.

hasTags

public final boolean hasTags()

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 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.

tags

public final Map<String,String> tags()

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 hasTags() method.

Returns:

The list of all tags associated with this configuration.

toBuilder

public Configuration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Configuration.Builder,Configuration>

builder

public static Configuration.Builder builder()

serializableBuilderClass

public static Class<? extends Configuration.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo