software.amazon.awssdk.services.mq.model

Class BrokerSummary

java.lang.Object

software.amazon.awssdk.services.mq.model.BrokerSummary

All Implemented Interfaces:

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

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

The Amazon Resource Name (ARN) of the broker.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BrokerSummary.Builder

Method Summary

Modifier and Type	Method and Description
String	brokerArn() The Amazon Resource Name (ARN) of the broker.
String	brokerId() The unique ID that Amazon MQ generates for the broker.
String	brokerName() The name of the broker.
BrokerState	brokerState() The status of the broker.
String	brokerStateAsString() The status of the broker.
static BrokerSummary.Builder	builder()
Instant	created() The time when the broker was created.
DeploymentMode	deploymentMode() Required.
String	deploymentModeAsString() Required.
EngineType	engineType() Required.
String	engineTypeAsString() Required.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	hostInstanceType() The broker's instance type.
List<SdkField<?>>	sdkFields()
static Class<? extends BrokerSummary.Builder>	serializableBuilderClass()
BrokerSummary.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

brokerArn

public final String brokerArn()

The Amazon Resource Name (ARN) of the broker.

Returns:

The Amazon Resource Name (ARN) of the broker.

brokerId

public final String brokerId()

The unique ID that Amazon MQ generates for the broker.

Returns:

The unique ID that Amazon MQ generates for the broker.

brokerName

public final String brokerName()

The name of the broker. This value must be unique in your AWS account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain whitespaces, brackets, wildcard characters, or special characters.

Returns:

The name of the broker. This value must be unique in your AWS account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain whitespaces, brackets, wildcard characters, or special characters.

brokerState

public final BrokerState brokerState()

The status of the broker.

If the service returns an enum value that is not available in the current SDK version, brokerState will return BrokerState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from brokerStateAsString().

Returns:

The status of the broker.

See Also:

BrokerState

brokerStateAsString

public final String brokerStateAsString()

The status of the broker.

If the service returns an enum value that is not available in the current SDK version, brokerState will return BrokerState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from brokerStateAsString().

Returns:

The status of the broker.

See Also:

BrokerState

created

public final Instant created()

The time when the broker was created.

Returns:

The time when the broker was created.

deploymentMode

public final DeploymentMode deploymentMode()

Required. The deployment mode of the broker.

If the service returns an enum value that is not available in the current SDK version, deploymentMode will return DeploymentMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deploymentModeAsString().

Returns:

Required. The deployment mode of the broker.

See Also:

DeploymentMode

deploymentModeAsString

public final String deploymentModeAsString()

Required. The deployment mode of the broker.

If the service returns an enum value that is not available in the current SDK version, deploymentMode will return DeploymentMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deploymentModeAsString().

Returns:

Required. The deployment mode of the broker.

See Also:

DeploymentMode

engineType

public final EngineType engineType()

Required. The type of broker engine.

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.

See Also:

EngineType

engineTypeAsString

public final String engineTypeAsString()

Required. The type of broker engine.

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.

See Also:

EngineType

hostInstanceType

public final String hostInstanceType()

The broker's instance type.

Returns:

The broker's instance type.

toBuilder

public BrokerSummary.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<BrokerSummary.Builder,BrokerSummary>

Returns:

a builder for type T

builder

public static BrokerSummary.Builder builder()

serializableBuilderClass

public static Class<? extends BrokerSummary.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)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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

Returns:

List of SdkField in this POJO. May be empty list but should never be null.