Package software.amazon.awssdk.services.mq.model

Class DescribeBrokerResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.mq.model.MqResponse
software.amazon.awssdk.services.mq.model.DescribeBrokerResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeBrokerResponse.Builder,DescribeBrokerResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeBrokerResponse extends MqResponse implements ToCopyableBuilder<DescribeBrokerResponse.Builder,DescribeBrokerResponse>

  • Method Details

    • hasActionsRequired

      public final boolean hasActionsRequired()
      For responses, this returns true if the service returned a value for the ActionsRequired 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.

    • actionsRequired

      public final List<ActionRequired> actionsRequired()

      Actions required for a broker.

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

      Returns:
      Actions required for a broker.

    • authenticationStrategy

      public final AuthenticationStrategy authenticationStrategy()

      The authentication strategy used to secure the broker. 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:
      The authentication strategy used to secure the broker. The default is SIMPLE.
      See Also:

    • authenticationStrategyAsString

      public final String authenticationStrategyAsString()

      The authentication strategy used to secure the broker. 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:
      The authentication strategy used to secure the broker. The default is SIMPLE.
      See Also:

    • autoMinorVersionUpgrade

      public final Boolean autoMinorVersionUpgrade()

      Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window or after a manual broker reboot.

      Returns:
      Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window or after a manual broker reboot.

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

    • hasBrokerInstances

      public final boolean hasBrokerInstances()
      For responses, this returns true if the service returned a value for the BrokerInstances 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.

    • brokerInstances

      public final List<BrokerInstance> brokerInstances()

      A list of information about allocated brokers.

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

      Returns:
      A list of information about allocated brokers.

    • brokerName

      public final String brokerName()

      The broker's name. This value must be unique in your Amazon Web Services account account, 1-50 characters long, must contain 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 must be unique in your Amazon Web Services account account, 1-50 characters long, must contain 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:

    • configurations

      public final Configurations configurations()

      The list of all revisions for the specified configuration.

      Returns:
      The list of all revisions for the specified configuration.

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

    • encryptionOptions

      public final EncryptionOptions encryptionOptions()

      Encryption options for the broker.

      Returns:
      Encryption options for the broker.

    • engineType

      public final EngineType engineType()

      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:
      The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
      See Also:

    • engineTypeAsString

      public final String engineTypeAsString()

      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:
      The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
      See Also:

    • engineVersion

      public final String engineVersion()

      The broker engine version. For more information, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.

      Returns:
      The broker engine version. For more information, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.

    • hostInstanceType

      public final String hostInstanceType()

      The broker's instance type.

      Returns:
      The broker's instance type.

    • ldapServerMetadata

      public final LdapServerMetadataOutput ldapServerMetadata()

      The metadata of the LDAP server used to authenticate and authorize connections to the broker.

      Returns:
      The metadata of the LDAP server used to authenticate and authorize connections to the broker.

    • logs

      public final LogsSummary logs()

      The list of information about logs currently enabled and pending to be deployed for the specified broker.

      Returns:
      The list of information about logs currently enabled and pending to be deployed for the specified broker.

    • maintenanceWindowStartTime

      public final WeeklyStartTime maintenanceWindowStartTime()

      The parameters that determine the WeeklyStartTime.

      Returns:
      The parameters that determine the WeeklyStartTime.

    • pendingAuthenticationStrategy

      public final AuthenticationStrategy pendingAuthenticationStrategy()

      The authentication strategy that will be applied when the broker is rebooted. The default is SIMPLE.

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

      Returns:
      The authentication strategy that will be applied when the broker is rebooted. The default is SIMPLE.
      See Also:

    • pendingAuthenticationStrategyAsString

      public final String pendingAuthenticationStrategyAsString()

      The authentication strategy that will be applied when the broker is rebooted. The default is SIMPLE.

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

      Returns:
      The authentication strategy that will be applied when the broker is rebooted. The default is SIMPLE.
      See Also:

    • pendingEngineVersion

      public final String pendingEngineVersion()

      The broker engine version to upgrade to. For more information, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.

      Returns:
      The broker engine version to upgrade to. For more information, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.

    • pendingHostInstanceType

      public final String pendingHostInstanceType()

      The broker's host instance type to upgrade to. For a list of supported instance types, see Broker instance types.

      Returns:
      The broker's host instance type to upgrade to. For a list of supported instance types, see Broker instance types.

    • pendingLdapServerMetadata

      public final LdapServerMetadataOutput pendingLdapServerMetadata()

      The metadata of the LDAP server that will be used to authenticate and authorize connections to the broker after it is rebooted.

      Returns:
      The metadata of the LDAP server that will be used to authenticate and authorize connections to the broker after it is rebooted.

    • hasPendingSecurityGroups

      public final boolean hasPendingSecurityGroups()
      For responses, this returns true if the service returned a value for the PendingSecurityGroups 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.

    • pendingSecurityGroups

      public final List<String> pendingSecurityGroups()

      The list of pending security groups to authorize connections to brokers.

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

      Returns:
      The list of pending security groups to authorize connections to brokers.

    • publiclyAccessible

      public final Boolean publiclyAccessible()

      Enables connections from applications outside of the VPC that hosts the broker's subnets.

      Returns:
      Enables connections from applications outside of the VPC that hosts the broker's subnets.

    • hasSecurityGroups

      public final boolean hasSecurityGroups()
      For responses, this returns true if the service returned a value for the SecurityGroups 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.

    • securityGroups

      public final List<String> securityGroups()

      The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.

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

      Returns:
      The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.

    • storageType

      public final BrokerStorageType storageType()

      The broker's storage type.

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

      Returns:
      The broker's storage type.
      See Also:

    • storageTypeAsString

      public final String storageTypeAsString()

      The broker's storage type.

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

      Returns:
      The broker's storage type.
      See Also:

    • hasSubnetIds

      public final boolean hasSubnetIds()
      For responses, this returns true if the service returned a value for the SubnetIds 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.

    • subnetIds

      public final List<String> subnetIds()

      The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.

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

      Returns:
      The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.

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

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

    • hasUsers

      public final boolean hasUsers()
      For responses, this returns true if the service returned a value for the Users 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.

    • users

      public final List<UserSummary> users()

      The list of all broker usernames for the specified broker.

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

      Returns:
      The list of all broker usernames for the specified broker.

    • dataReplicationMetadata

      public final DataReplicationMetadataOutput dataReplicationMetadata()

      The replication details of the data replication-enabled broker. Only returned if dataReplicationMode is set to CRDR.

      Returns:
      The replication details of the data replication-enabled broker. Only returned if dataReplicationMode is set to CRDR.

    • dataReplicationMode

      public final DataReplicationMode dataReplicationMode()

      Describes whether this broker is a part of a data replication pair.

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

      Returns:
      Describes whether this broker is a part of a data replication pair.
      See Also:

    • dataReplicationModeAsString

      public final String dataReplicationModeAsString()

      Describes whether this broker is a part of a data replication pair.

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

      Returns:
      Describes whether this broker is a part of a data replication pair.
      See Also:

    • pendingDataReplicationMetadata

      public final DataReplicationMetadataOutput pendingDataReplicationMetadata()

      The pending replication details of the data replication-enabled broker. Only returned if pendingDataReplicationMode is set to CRDR.

      Returns:
      The pending replication details of the data replication-enabled broker. Only returned if pendingDataReplicationMode is set to CRDR.

    • pendingDataReplicationMode

      public final DataReplicationMode pendingDataReplicationMode()

      Describes whether this broker will be a part of a data replication pair after reboot.

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

      Returns:
      Describes whether this broker will be a part of a data replication pair after reboot.
      See Also:

    • pendingDataReplicationModeAsString

      public final String pendingDataReplicationModeAsString()

      Describes whether this broker will be a part of a data replication pair after reboot.

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

      Returns:
      Describes whether this broker will be a part of a data replication pair after reboot.
      See Also:

    • toBuilder

      public DescribeBrokerResponse.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<DescribeBrokerResponse.Builder,DescribeBrokerResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeBrokerResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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