DescribeBrokerResponse (AWS Java SDK :: Services

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(value="software.amazon.awssdk:codegen")
public final class DescribeBrokerResponse
extends MqResponse
implements ToCopyableBuilder<DescribeBrokerResponse.Builder,DescribeBrokerResponse>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DescribeBrokerResponse.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DescribeBrokerResponse.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AuthenticationStrategy`	`authenticationStrategy()` The authentication strategy used to secure the broker.
`String`	`authenticationStrategyAsString()` The authentication strategy used to secure the broker.
`Boolean`	`autoMinorVersionUpgrade()` Required.
`String`	`brokerArn()` The Amazon Resource Name (ARN) of the broker.
`String`	`brokerId()` The unique ID that Amazon MQ generates for the broker.
`List<BrokerInstance>`	`brokerInstances()` A list of information about allocated brokers.
`String`	`brokerName()` The name of the broker.
`BrokerState`	`brokerState()` The status of the broker.
`String`	`brokerStateAsString()` The status of the broker.
`static DescribeBrokerResponse.Builder`	`builder()`
`Configurations`	`configurations()` The list of all revisions for the specified configuration.
`Instant`	`created()` The time when the broker was created.
`DeploymentMode`	`deploymentMode()` Required.
`String`	`deploymentModeAsString()` Required.
`EncryptionOptions`	`encryptionOptions()` Encryption options for the broker.
`EngineType`	`engineType()` Required.
`String`	`engineTypeAsString()` Required.
`String`	`engineVersion()` The version of the broker engine.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasBrokerInstances()` Returns true if the BrokerInstances property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasPendingSecurityGroups()` Returns true if the PendingSecurityGroups property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasSecurityGroups()` Returns true if the SecurityGroups property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasSubnetIds()` Returns true if the SubnetIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasTags()` Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasUsers()` Returns true if the Users property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`String`	`hostInstanceType()` The broker's instance type.
`LdapServerMetadataOutput`	`ldapServerMetadata()` The metadata of the LDAP server used to authenticate and authorize connections to the broker.
`LogsSummary`	`logs()` The list of information about logs currently enabled and pending to be deployed for the specified broker.
`WeeklyStartTime`	`maintenanceWindowStartTime()` The parameters that determine the WeeklyStartTime.
`AuthenticationStrategy`	`pendingAuthenticationStrategy()` The authentication strategy that will be applied when the broker is rebooted.
`String`	`pendingAuthenticationStrategyAsString()` The authentication strategy that will be applied when the broker is rebooted.
`String`	`pendingEngineVersion()` The version of the broker engine to upgrade to.
`String`	`pendingHostInstanceType()` The host instance type of the broker to upgrade to.
`LdapServerMetadataOutput`	`pendingLdapServerMetadata()` The metadata of the LDAP server that will be used to authenticate and authorize connections to the broker once it is rebooted.
`List<String>`	`pendingSecurityGroups()` The list of pending security groups to authorize connections to brokers.
`Boolean`	`publiclyAccessible()` Required.
`List<SdkField<?>>`	`sdkFields()`
`List<String>`	`securityGroups()` The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.
`static Class<? extends DescribeBrokerResponse.Builder>`	`serializableBuilderClass()`
`BrokerStorageType`	`storageType()` The broker's storage type.
`String`	`storageTypeAsString()` The broker's storage type.
`List<String>`	`subnetIds()` The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.
`Map<String,String>`	`tags()` The list of all tags associated with this broker.
`DescribeBrokerResponse.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`List<UserSummary>`	`users()` The list of all broker usernames for the specified broker.

Methods inherited from class software.amazon.awssdk.services.mq.model.MqResponse
responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse

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
  - authenticationStrategy
```
public final AuthenticationStrategy authenticationStrategy()
```
    The authentication strategy used to secure the broker.
    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.
    
    See Also:
    
    AuthenticationStrategy
  - authenticationStrategyAsString
```
public final String authenticationStrategyAsString()
```
    The authentication strategy used to secure the broker.
    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.
    
    See Also:
    
    AuthenticationStrategy
  - autoMinorVersionUpgrade
```
public final Boolean autoMinorVersionUpgrade()
```
    Required. Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions. The automatic upgrades occur during the maintenance window of the broker or after a manual broker reboot.
    
    Returns:
    
    Required. Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions. The automatic upgrades occur during the maintenance window of the broker or after a manual broker reboot.
  - 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.
  - hasBrokerInstances
```
public final boolean hasBrokerInstances()
```
    Returns true if the BrokerInstances property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    You can use hasBrokerInstances() to see if a value was sent in this field.
    
    Returns:
    
    A list of information about allocated brokers.
  - 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
  - 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()
```
    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
  - encryptionOptions
```
public final EncryptionOptions encryptionOptions()
```
    Encryption options for the broker.
    
    Returns:
    
    Encryption options for the broker.
  - engineType
```
public final EngineType engineType()
```
    Required. The type of broker engine. Note: 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. Note: Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
    
    See Also:
    
    EngineType
  - engineTypeAsString
```
public final String engineTypeAsString()
```
    Required. The type of broker engine. Note: 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. Note: Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
    
    See Also:
    
    EngineType
  - engineVersion
```
public final String engineVersion()
```
    The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html
    
    Returns:
    
    The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html
  - 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.
    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.
    
    See Also:
    
    AuthenticationStrategy
  - pendingAuthenticationStrategyAsString
```
public final String pendingAuthenticationStrategyAsString()
```
    The authentication strategy that will be applied when the broker is rebooted.
    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.
    
    See Also:
    
    AuthenticationStrategy
  - pendingEngineVersion
```
public final String pendingEngineVersion()
```
    The version of the broker engine to upgrade to. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html
    
    Returns:
    
    The version of the broker engine to upgrade to. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html
  - pendingHostInstanceType
```
public final String pendingHostInstanceType()
```
    The host instance type of the broker to upgrade to. For a list of supported instance types, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide//broker.html#broker-instance-types
    
    Returns:
    
    The host instance type of the broker to upgrade to. For a list of supported instance types, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide//broker.html#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 once it is rebooted.
    
    Returns:
    
    The metadata of the LDAP server that will be used to authenticate and authorize connections to the broker once it is rebooted.
  - hasPendingSecurityGroups
```
public final boolean hasPendingSecurityGroups()
```
    Returns true if the PendingSecurityGroups property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    You can use hasPendingSecurityGroups() to see if a value was sent in this field.
    
    Returns:
    
    The list of pending security groups to authorize connections to brokers.
  - publiclyAccessible
```
public final Boolean publiclyAccessible()
```
    Required. Enables connections from applications outside of the VPC that hosts the broker's subnets.
    
    Returns:
    
    Required. Enables connections from applications outside of the VPC that hosts the broker's subnets.
  - hasSecurityGroups
```
public final boolean hasSecurityGroups()
```
    Returns true if the SecurityGroups property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - securityGroups
```
public final List<String> securityGroups()
```
    The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasSecurityGroups() to see if a value was sent in this field.
    
    Returns:
    
    The list of security groups (1 minimum, 5 maximum) that authorizes 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:
    
    BrokerStorageType
  - 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:
    
    BrokerStorageType
  - hasSubnetIds
```
public final boolean hasSubnetIds()
```
    Returns true if the SubnetIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ deployment (ACTIVEMQ) requires two subnets. A CLUSTER_MULTI_AZ deployment (RABBITMQ) has no subnet requirements when deployed with public accessibility, deployment without public accessibility requires at least one subnet.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasSubnetIds() to see if a value was sent in this field.
    
    Returns:
    
    The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ deployment (ACTIVEMQ) requires two subnets. A CLUSTER_MULTI_AZ deployment (RABBITMQ) has no subnet requirements when deployed with public accessibility, deployment without public accessibility requires at least one subnet.
  - hasTags
```
public final boolean hasTags()
```
    Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    You can use hasTags() to see if a value was sent in this field.
    
    Returns:
    
    The list of all tags associated with this broker.
  - hasUsers
```
public final boolean hasUsers()
```
    Returns true if the Users property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    You can use hasUsers() to see if a value was sent in this field.
    
    Returns:
    
    The list of all broker usernames for the specified broker.
  - toBuilder
```
public DescribeBrokerResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeBrokerResponse.Builder,DescribeBrokerResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - 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)
```
    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)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DescribeBrokerResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.mq.model.MqResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

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

Method Detail

authenticationStrategy

authenticationStrategyAsString

autoMinorVersionUpgrade

brokerArn

brokerId

hasBrokerInstances

brokerInstances

brokerName

brokerState

brokerStateAsString

configurations

created

deploymentMode

deploymentModeAsString

encryptionOptions

engineType

engineTypeAsString

engineVersion

hostInstanceType

ldapServerMetadata

logs

maintenanceWindowStartTime

pendingAuthenticationStrategy

pendingAuthenticationStrategyAsString

pendingEngineVersion

pendingHostInstanceType

pendingLdapServerMetadata

hasPendingSecurityGroups

pendingSecurityGroups

publiclyAccessible

hasSecurityGroups

securityGroups

storageType

storageTypeAsString

hasSubnetIds

subnetIds

hasTags

tags

hasUsers

users

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields