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:

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.