Package 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("software.amazon.awssdk:codegen")
public final class BrokerSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<BrokerSummary.Builder,BrokerSummary>

Returns information about all brokers.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BrokerSummary.Builder

Method Summary

Modifier and Type	Method	Description
String	brokerArn()	The broker's Amazon Resource Name (ARN).
String	brokerId()	The unique ID that Amazon MQ generates for the broker.
String	brokerName()	The broker's name.
BrokerState	brokerState()	The broker's status.
String	brokerStateAsString()	The broker's status.
static BrokerSummary.Builder	builder()
Instant	created()	The time when the broker was created.
DeploymentMode	deploymentMode()	The broker's deployment mode.
String	deploymentModeAsString()	The broker's deployment mode.
EngineType	engineType()	The type of broker engine.
String	engineTypeAsString()	The type of broker engine.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<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()
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

brokerArn

public final String brokerArn()

The broker's Amazon Resource Name (ARN).

Returns:

The broker's Amazon Resource Name (ARN).

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 broker's name. This value is unique in your Amazon Web Services account, 1-50 characters long, and containing only letters, numbers, dashes, and underscores, and must not contain white spaces, brackets, wildcard characters, or special characters.

Returns:

The broker's name. This value is unique in your Amazon Web Services account, 1-50 characters long, and containing only letters, numbers, dashes, and underscores, and must not contain white spaces, brackets, wildcard characters, or special characters.

brokerState

public final BrokerState brokerState()

The broker's status.

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 broker's status.

See Also:

BrokerState

brokerStateAsString

public final String brokerStateAsString()

The broker's status.

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 broker's status.

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()

The broker's deployment mode.

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:

The broker's deployment mode.

See Also:

DeploymentMode

deploymentModeAsString

public final String deploymentModeAsString()

The broker's deployment mode.

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:

The broker's deployment mode.

See Also:

DeploymentMode

engineType

public final EngineType engineType()

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:

The type of broker engine.

See Also:

EngineType

engineTypeAsString

public final String engineTypeAsString()

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:

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()

Specified by:

toBuilder in interface ToCopyableBuilder<BrokerSummary.Builder,BrokerSummary>

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)

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