DescribeBrokerResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.mq.model.DescribeBrokerResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeBrokerResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DescribeBrokerResult()

Constructors
Constructor and Description
`DescribeBrokerResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DescribeBrokerResult`	`addTagsEntry(String key, String value)` Add a single Tags entry
`DescribeBrokerResult`	`clearTagsEntries()` Removes all the entries added into Tags.
`DescribeBrokerResult`	`clone()`
`boolean`	`equals(Object obj)`
`List<ActionRequired>`	`getActionsRequired()` A list of actions required for a broker.
`String`	`getAuthenticationStrategy()` The authentication strategy used to secure the broker.
`Boolean`	`getAutoMinorVersionUpgrade()` Enables automatic upgrades to new minor versions for brokers, as new versions are released and supported by Amazon MQ.
`String`	`getBrokerArn()` The broker's Amazon Resource Name (ARN).
`String`	`getBrokerId()` The unique ID that Amazon MQ generates for the broker.
`List<BrokerInstance>`	`getBrokerInstances()` A list of information about allocated brokers.
`String`	`getBrokerName()` The broker's name.
`String`	`getBrokerState()` The broker's status.
`Configurations`	`getConfigurations()` The list of all revisions for the specified configuration.
`Date`	`getCreated()` The time when the broker was created.
`String`	`getDeploymentMode()` The broker's deployment mode.
`EncryptionOptions`	`getEncryptionOptions()` Encryption options for the broker.
`String`	`getEngineType()` The type of broker engine.
`String`	`getEngineVersion()` The broker engine's version.
`String`	`getHostInstanceType()` The broker's instance type.
`LdapServerMetadataOutput`	`getLdapServerMetadata()` The metadata of the LDAP server used to authenticate and authorize connections to the broker.
`LogsSummary`	`getLogs()` The list of information about logs currently enabled and pending to be deployed for the specified broker.
`WeeklyStartTime`	`getMaintenanceWindowStartTime()` The parameters that determine the WeeklyStartTime.
`String`	`getPendingAuthenticationStrategy()` The authentication strategy that will be applied when the broker is rebooted.
`String`	`getPendingEngineVersion()` The broker engine version to upgrade to.
`String`	`getPendingHostInstanceType()` The broker's host instance type to upgrade to.
`LdapServerMetadataOutput`	`getPendingLdapServerMetadata()` The metadata of the LDAP server that will be used to authenticate and authorize connections to the broker after it is rebooted.
`List<String>`	`getPendingSecurityGroups()` The list of pending security groups to authorize connections to brokers.
`Boolean`	`getPubliclyAccessible()` Enables connections from applications outside of the VPC that hosts the broker's subnets.
`List<String>`	`getSecurityGroups()` The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
`String`	`getStorageType()` The broker's storage type.
`List<String>`	`getSubnetIds()` The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.
`Map<String,String>`	`getTags()` The list of all tags associated with this broker.
`List<UserSummary>`	`getUsers()` The list of all broker usernames for the specified broker.
`int`	`hashCode()`
`Boolean`	`isAutoMinorVersionUpgrade()` Enables automatic upgrades to new minor versions for brokers, as new versions are released and supported by Amazon MQ.
`Boolean`	`isPubliclyAccessible()` Enables connections from applications outside of the VPC that hosts the broker's subnets.
`void`	`setActionsRequired(Collection<ActionRequired> actionsRequired)` A list of actions required for a broker.
`void`	`setAuthenticationStrategy(String authenticationStrategy)` The authentication strategy used to secure the broker.
`void`	`setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)` Enables automatic upgrades to new minor versions for brokers, as new versions are released and supported by Amazon MQ.
`void`	`setBrokerArn(String brokerArn)` The broker's Amazon Resource Name (ARN).
`void`	`setBrokerId(String brokerId)` The unique ID that Amazon MQ generates for the broker.
`void`	`setBrokerInstances(Collection<BrokerInstance> brokerInstances)` A list of information about allocated brokers.
`void`	`setBrokerName(String brokerName)` The broker's name.
`void`	`setBrokerState(String brokerState)` The broker's status.
`void`	`setConfigurations(Configurations configurations)` The list of all revisions for the specified configuration.
`void`	`setCreated(Date created)` The time when the broker was created.
`void`	`setDeploymentMode(String deploymentMode)` The broker's deployment mode.
`void`	`setEncryptionOptions(EncryptionOptions encryptionOptions)` Encryption options for the broker.
`void`	`setEngineType(String engineType)` The type of broker engine.
`void`	`setEngineVersion(String engineVersion)` The broker engine's version.
`void`	`setHostInstanceType(String hostInstanceType)` The broker's instance type.
`void`	`setLdapServerMetadata(LdapServerMetadataOutput ldapServerMetadata)` The metadata of the LDAP server used to authenticate and authorize connections to the broker.
`void`	`setLogs(LogsSummary logs)` The list of information about logs currently enabled and pending to be deployed for the specified broker.
`void`	`setMaintenanceWindowStartTime(WeeklyStartTime maintenanceWindowStartTime)` The parameters that determine the WeeklyStartTime.
`void`	`setPendingAuthenticationStrategy(String pendingAuthenticationStrategy)` The authentication strategy that will be applied when the broker is rebooted.
`void`	`setPendingEngineVersion(String pendingEngineVersion)` The broker engine version to upgrade to.
`void`	`setPendingHostInstanceType(String pendingHostInstanceType)` The broker's host instance type to upgrade to.
`void`	`setPendingLdapServerMetadata(LdapServerMetadataOutput pendingLdapServerMetadata)` The metadata of the LDAP server that will be used to authenticate and authorize connections to the broker after it is rebooted.
`void`	`setPendingSecurityGroups(Collection<String> pendingSecurityGroups)` The list of pending security groups to authorize connections to brokers.
`void`	`setPubliclyAccessible(Boolean publiclyAccessible)` Enables connections from applications outside of the VPC that hosts the broker's subnets.
`void`	`setSecurityGroups(Collection<String> securityGroups)` The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
`void`	`setStorageType(String storageType)` The broker's storage type.
`void`	`setSubnetIds(Collection<String> subnetIds)` The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.
`void`	`setTags(Map<String,String> tags)` The list of all tags associated with this broker.
`void`	`setUsers(Collection<UserSummary> users)` The list of all broker usernames for the specified broker.
`String`	`toString()` Returns a string representation of this object.
`DescribeBrokerResult`	`withActionsRequired(ActionRequired... actionsRequired)` A list of actions required for a broker.
`DescribeBrokerResult`	`withActionsRequired(Collection<ActionRequired> actionsRequired)` A list of actions required for a broker.
`DescribeBrokerResult`	`withAuthenticationStrategy(AuthenticationStrategy authenticationStrategy)` The authentication strategy used to secure the broker.
`DescribeBrokerResult`	`withAuthenticationStrategy(String authenticationStrategy)` The authentication strategy used to secure the broker.
`DescribeBrokerResult`	`withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)` Enables automatic upgrades to new minor versions for brokers, as new versions are released and supported by Amazon MQ.
`DescribeBrokerResult`	`withBrokerArn(String brokerArn)` The broker's Amazon Resource Name (ARN).
`DescribeBrokerResult`	`withBrokerId(String brokerId)` The unique ID that Amazon MQ generates for the broker.
`DescribeBrokerResult`	`withBrokerInstances(BrokerInstance... brokerInstances)` A list of information about allocated brokers.
`DescribeBrokerResult`	`withBrokerInstances(Collection<BrokerInstance> brokerInstances)` A list of information about allocated brokers.
`DescribeBrokerResult`	`withBrokerName(String brokerName)` The broker's name.
`DescribeBrokerResult`	`withBrokerState(BrokerState brokerState)` The broker's status.
`DescribeBrokerResult`	`withBrokerState(String brokerState)` The broker's status.
`DescribeBrokerResult`	`withConfigurations(Configurations configurations)` The list of all revisions for the specified configuration.
`DescribeBrokerResult`	`withCreated(Date created)` The time when the broker was created.
`DescribeBrokerResult`	`withDeploymentMode(DeploymentMode deploymentMode)` The broker's deployment mode.
`DescribeBrokerResult`	`withDeploymentMode(String deploymentMode)` The broker's deployment mode.
`DescribeBrokerResult`	`withEncryptionOptions(EncryptionOptions encryptionOptions)` Encryption options for the broker.
`DescribeBrokerResult`	`withEngineType(EngineType engineType)` The type of broker engine.
`DescribeBrokerResult`	`withEngineType(String engineType)` The type of broker engine.
`DescribeBrokerResult`	`withEngineVersion(String engineVersion)` The broker engine's version.
`DescribeBrokerResult`	`withHostInstanceType(String hostInstanceType)` The broker's instance type.
`DescribeBrokerResult`	`withLdapServerMetadata(LdapServerMetadataOutput ldapServerMetadata)` The metadata of the LDAP server used to authenticate and authorize connections to the broker.
`DescribeBrokerResult`	`withLogs(LogsSummary logs)` The list of information about logs currently enabled and pending to be deployed for the specified broker.
`DescribeBrokerResult`	`withMaintenanceWindowStartTime(WeeklyStartTime maintenanceWindowStartTime)` The parameters that determine the WeeklyStartTime.
`DescribeBrokerResult`	`withPendingAuthenticationStrategy(AuthenticationStrategy pendingAuthenticationStrategy)` The authentication strategy that will be applied when the broker is rebooted.
`DescribeBrokerResult`	`withPendingAuthenticationStrategy(String pendingAuthenticationStrategy)` The authentication strategy that will be applied when the broker is rebooted.
`DescribeBrokerResult`	`withPendingEngineVersion(String pendingEngineVersion)` The broker engine version to upgrade to.
`DescribeBrokerResult`	`withPendingHostInstanceType(String pendingHostInstanceType)` The broker's host instance type to upgrade to.
`DescribeBrokerResult`	`withPendingLdapServerMetadata(LdapServerMetadataOutput pendingLdapServerMetadata)` The metadata of the LDAP server that will be used to authenticate and authorize connections to the broker after it is rebooted.
`DescribeBrokerResult`	`withPendingSecurityGroups(Collection<String> pendingSecurityGroups)` The list of pending security groups to authorize connections to brokers.
`DescribeBrokerResult`	`withPendingSecurityGroups(String... pendingSecurityGroups)` The list of pending security groups to authorize connections to brokers.
`DescribeBrokerResult`	`withPubliclyAccessible(Boolean publiclyAccessible)` Enables connections from applications outside of the VPC that hosts the broker's subnets.
`DescribeBrokerResult`	`withSecurityGroups(Collection<String> securityGroups)` The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
`DescribeBrokerResult`	`withSecurityGroups(String... securityGroups)` The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
`DescribeBrokerResult`	`withStorageType(BrokerStorageType storageType)` The broker's storage type.
`DescribeBrokerResult`	`withStorageType(String storageType)` The broker's storage type.
`DescribeBrokerResult`	`withSubnetIds(Collection<String> subnetIds)` The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.
`DescribeBrokerResult`	`withSubnetIds(String... subnetIds)` The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.
`DescribeBrokerResult`	`withTags(Map<String,String> tags)` The list of all tags associated with this broker.
`DescribeBrokerResult`	`withUsers(Collection<UserSummary> users)` The list of all broker usernames for the specified broker.
`DescribeBrokerResult`	`withUsers(UserSummary... users)` The list of all broker usernames for the specified broker.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DescribeBrokerResult
```
public DescribeBrokerResult()
```
- Method Detail
  - getActionsRequired
```
public List<ActionRequired> getActionsRequired()
```
    A list of actions required for a broker.
    
    Returns:
    
    A list of actions required for a broker.
  - setActionsRequired
```
public void setActionsRequired(Collection<ActionRequired> actionsRequired)
```
    A list of actions required for a broker.
    
    Parameters:
    
    actionsRequired - A list of actions required for a broker.
  - withActionsRequired
```
public DescribeBrokerResult withActionsRequired(ActionRequired... actionsRequired)
```
    A list of actions required for a broker.
    
    NOTE: This method appends the values to the existing list (if any). Use setActionsRequired(java.util.Collection) or withActionsRequired(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    actionsRequired - A list of actions required for a broker.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withActionsRequired
```
public DescribeBrokerResult withActionsRequired(Collection<ActionRequired> actionsRequired)
```
    A list of actions required for a broker.
    
    Parameters:
    
    actionsRequired - A list of actions required for a broker.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAuthenticationStrategy
```
public void setAuthenticationStrategy(String authenticationStrategy)
```
    The authentication strategy used to secure the broker. The default is SIMPLE.
    
    Parameters:
    
    authenticationStrategy - The authentication strategy used to secure the broker. The default is SIMPLE.
    
    See Also:
    
    AuthenticationStrategy
  - getAuthenticationStrategy
```
public String getAuthenticationStrategy()
```
    The authentication strategy used to secure the broker. The default is SIMPLE.
    
    Returns:
    
    The authentication strategy used to secure the broker. The default is SIMPLE.
    
    See Also:
    
    AuthenticationStrategy
  - withAuthenticationStrategy
```
public DescribeBrokerResult withAuthenticationStrategy(String authenticationStrategy)
```
    The authentication strategy used to secure the broker. The default is SIMPLE.
    
    Parameters:
    
    authenticationStrategy - The authentication strategy used to secure the broker. The default is SIMPLE.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AuthenticationStrategy
  - withAuthenticationStrategy
```
public DescribeBrokerResult withAuthenticationStrategy(AuthenticationStrategy authenticationStrategy)
```
    The authentication strategy used to secure the broker. The default is SIMPLE.
    
    Parameters:
    
    authenticationStrategy - The authentication strategy used to secure the broker. The default is SIMPLE.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AuthenticationStrategy
  - setAutoMinorVersionUpgrade
```
public void setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
```
    Enables automatic upgrades to new minor versions for brokers, as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window of the broker or after a manual broker reboot.
    
    Parameters:
    
    autoMinorVersionUpgrade - Enables automatic upgrades to new minor versions for brokers, as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window of the broker or after a manual broker reboot.
  - getAutoMinorVersionUpgrade
```
public Boolean getAutoMinorVersionUpgrade()
```
    Enables automatic upgrades to new minor versions for brokers, as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window of the broker or after a manual broker reboot.
    
    Returns:
    
    Enables automatic upgrades to new minor versions for brokers, as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window of the broker or after a manual broker reboot.
  - withAutoMinorVersionUpgrade
```
public DescribeBrokerResult withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
```
    Enables automatic upgrades to new minor versions for brokers, as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window of the broker or after a manual broker reboot.
    
    Parameters:
    
    autoMinorVersionUpgrade - Enables automatic upgrades to new minor versions for brokers, as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window of the broker or after a manual broker reboot.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isAutoMinorVersionUpgrade
```
public Boolean isAutoMinorVersionUpgrade()
```
    Enables automatic upgrades to new minor versions for brokers, as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window of the broker or after a manual broker reboot.
    
    Returns:
    
    Enables automatic upgrades to new minor versions for brokers, as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window of the broker or after a manual broker reboot.
  - setBrokerArn
```
public void setBrokerArn(String brokerArn)
```
    The broker's Amazon Resource Name (ARN).
    
    Parameters:
    
    brokerArn - The broker's Amazon Resource Name (ARN).
  - getBrokerArn
```
public String getBrokerArn()
```
    The broker's Amazon Resource Name (ARN).
    
    Returns:
    
    The broker's Amazon Resource Name (ARN).
  - withBrokerArn
```
public DescribeBrokerResult withBrokerArn(String brokerArn)
```
    The broker's Amazon Resource Name (ARN).
    
    Parameters:
    
    brokerArn - The broker's Amazon Resource Name (ARN).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBrokerId
```
public void setBrokerId(String brokerId)
```
    The unique ID that Amazon MQ generates for the broker.
    
    Parameters:
    
    brokerId - The unique ID that Amazon MQ generates for the broker.
  - getBrokerId
```
public String getBrokerId()
```
    The unique ID that Amazon MQ generates for the broker.
    
    Returns:
    
    The unique ID that Amazon MQ generates for the broker.
  - withBrokerId
```
public DescribeBrokerResult withBrokerId(String brokerId)
```
    The unique ID that Amazon MQ generates for the broker.
    
    Parameters:
    
    brokerId - The unique ID that Amazon MQ generates for the broker.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getBrokerInstances
```
public List<BrokerInstance> getBrokerInstances()
```
    A list of information about allocated brokers.
    
    Returns:
    
    A list of information about allocated brokers.
  - setBrokerInstances
```
public void setBrokerInstances(Collection<BrokerInstance> brokerInstances)
```
    A list of information about allocated brokers.
    
    Parameters:
    
    brokerInstances - A list of information about allocated brokers.
  - withBrokerInstances
```
public DescribeBrokerResult withBrokerInstances(BrokerInstance... brokerInstances)
```
    A list of information about allocated brokers.
    
    NOTE: This method appends the values to the existing list (if any). Use setBrokerInstances(java.util.Collection) or withBrokerInstances(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    brokerInstances - A list of information about allocated brokers.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withBrokerInstances
```
public DescribeBrokerResult withBrokerInstances(Collection<BrokerInstance> brokerInstances)
```
    A list of information about allocated brokers.
    
    Parameters:
    
    brokerInstances - A list of information about allocated brokers.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBrokerName
```
public void setBrokerName(String brokerName)
```
    The broker's name. 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 white spaces, brackets, wildcard characters, or special characters.
    
    Parameters:
    
    brokerName - The broker's name. 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 white spaces, brackets, wildcard characters, or special characters.
  - getBrokerName
```
public String getBrokerName()
```
    The broker's name. 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 white spaces, brackets, wildcard characters, or special characters.
    
    Returns:
    
    The broker's name. 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 white spaces, brackets, wildcard characters, or special characters.
  - withBrokerName
```
public DescribeBrokerResult withBrokerName(String brokerName)
```
    The broker's name. 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 white spaces, brackets, wildcard characters, or special characters.
    
    Parameters:
    
    brokerName - The broker's name. 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 white spaces, brackets, wildcard characters, or special characters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBrokerState
```
public void setBrokerState(String brokerState)
```
    The broker's status.
    
    Parameters:
    
    brokerState - The broker's status.
    
    See Also:
    
    BrokerState
  - getBrokerState
```
public String getBrokerState()
```
    The broker's status.
    
    Returns:
    
    The broker's status.
    
    See Also:
    
    BrokerState
  - withBrokerState
```
public DescribeBrokerResult withBrokerState(String brokerState)
```
    The broker's status.
    
    Parameters:
    
    brokerState - The broker's status.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    BrokerState
  - withBrokerState
```
public DescribeBrokerResult withBrokerState(BrokerState brokerState)
```
    The broker's status.
    
    Parameters:
    
    brokerState - The broker's status.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    BrokerState
  - setConfigurations
```
public void setConfigurations(Configurations configurations)
```
    The list of all revisions for the specified configuration.
    
    Parameters:
    
    configurations - The list of all revisions for the specified configuration.
  - getConfigurations
```
public Configurations getConfigurations()
```
    The list of all revisions for the specified configuration.
    
    Returns:
    
    The list of all revisions for the specified configuration.
  - withConfigurations
```
public DescribeBrokerResult withConfigurations(Configurations configurations)
```
    The list of all revisions for the specified configuration.
    
    Parameters:
    
    configurations - The list of all revisions for the specified configuration.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreated
```
public void setCreated(Date created)
```
    The time when the broker was created.
    
    Parameters:
    
    created - The time when the broker was created.
  - getCreated
```
public Date getCreated()
```
    The time when the broker was created.
    
    Returns:
    
    The time when the broker was created.
  - withCreated
```
public DescribeBrokerResult withCreated(Date created)
```
    The time when the broker was created.
    
    Parameters:
    
    created - The time when the broker was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDeploymentMode
```
public void setDeploymentMode(String deploymentMode)
```
    The broker's deployment mode.
    
    Parameters:
    
    deploymentMode - The broker's deployment mode.
    
    See Also:
    
    DeploymentMode
  - getDeploymentMode
```
public String getDeploymentMode()
```
    The broker's deployment mode.
    
    Returns:
    
    The broker's deployment mode.
    
    See Also:
    
    DeploymentMode
  - withDeploymentMode
```
public DescribeBrokerResult withDeploymentMode(String deploymentMode)
```
    The broker's deployment mode.
    
    Parameters:
    
    deploymentMode - The broker's deployment mode.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DeploymentMode
  - withDeploymentMode
```
public DescribeBrokerResult withDeploymentMode(DeploymentMode deploymentMode)
```
    The broker's deployment mode.
    
    Parameters:
    
    deploymentMode - The broker's deployment mode.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DeploymentMode
  - setEncryptionOptions
```
public void setEncryptionOptions(EncryptionOptions encryptionOptions)
```
    Encryption options for the broker. Does not apply to RabbitMQ brokers.
    
    Parameters:
    
    encryptionOptions - Encryption options for the broker. Does not apply to RabbitMQ brokers.
  - getEncryptionOptions
```
public EncryptionOptions getEncryptionOptions()
```
    Encryption options for the broker. Does not apply to RabbitMQ brokers.
    
    Returns:
    
    Encryption options for the broker. Does not apply to RabbitMQ brokers.
  - withEncryptionOptions
```
public DescribeBrokerResult withEncryptionOptions(EncryptionOptions encryptionOptions)
```
    Encryption options for the broker. Does not apply to RabbitMQ brokers.
    
    Parameters:
    
    encryptionOptions - Encryption options for the broker. Does not apply to RabbitMQ brokers.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEngineType
```
public void setEngineType(String engineType)
```
    The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
    
    Parameters:
    
    engineType - The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
    
    See Also:
    
    EngineType
  - getEngineType
```
public String getEngineType()
```
    The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
    
    Returns:
    
    The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
    
    See Also:
    
    EngineType
  - withEngineType
```
public DescribeBrokerResult withEngineType(String engineType)
```
    The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
    
    Parameters:
    
    engineType - The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EngineType
  - withEngineType
```
public DescribeBrokerResult withEngineType(EngineType engineType)
```
    The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
    
    Parameters:
    
    engineType - The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EngineType
  - setEngineVersion
```
public void setEngineVersion(String engineVersion)
```
    The broker engine's version. For a list of supported engine versions, see Supported engines.
    
    Parameters:
    
    engineVersion - The broker engine's version. For a list of supported engine versions, see Supported engines.
  - getEngineVersion
```
public String getEngineVersion()
```
    The broker engine's version. For a list of supported engine versions, see Supported engines.
    
    Returns:
    
    The broker engine's version. For a list of supported engine versions, see Supported engines.
  - withEngineVersion
```
public DescribeBrokerResult withEngineVersion(String engineVersion)
```
    The broker engine's version. For a list of supported engine versions, see Supported engines.
    
    Parameters:
    
    engineVersion - The broker engine's version. For a list of supported engine versions, see Supported engines.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHostInstanceType
```
public void setHostInstanceType(String hostInstanceType)
```
    The broker's instance type.
    
    Parameters:
    
    hostInstanceType - The broker's instance type.
  - getHostInstanceType
```
public String getHostInstanceType()
```
    The broker's instance type.
    
    Returns:
    
    The broker's instance type.
  - withHostInstanceType
```
public DescribeBrokerResult withHostInstanceType(String hostInstanceType)
```
    The broker's instance type.
    
    Parameters:
    
    hostInstanceType - The broker's instance type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLdapServerMetadata
```
public void setLdapServerMetadata(LdapServerMetadataOutput ldapServerMetadata)
```
    The metadata of the LDAP server used to authenticate and authorize connections to the broker.
    
    Parameters:
    
    ldapServerMetadata - The metadata of the LDAP server used to authenticate and authorize connections to the broker.
  - getLdapServerMetadata
```
public LdapServerMetadataOutput getLdapServerMetadata()
```
    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.
  - withLdapServerMetadata
```
public DescribeBrokerResult withLdapServerMetadata(LdapServerMetadataOutput ldapServerMetadata)
```
    The metadata of the LDAP server used to authenticate and authorize connections to the broker.
    
    Parameters:
    
    ldapServerMetadata - The metadata of the LDAP server used to authenticate and authorize connections to the broker.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLogs
```
public void setLogs(LogsSummary logs)
```
    The list of information about logs currently enabled and pending to be deployed for the specified broker.
    
    Parameters:
    
    logs - The list of information about logs currently enabled and pending to be deployed for the specified broker.
  - getLogs
```
public LogsSummary getLogs()
```
    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.
  - withLogs
```
public DescribeBrokerResult withLogs(LogsSummary logs)
```
    The list of information about logs currently enabled and pending to be deployed for the specified broker.
    
    Parameters:
    
    logs - The list of information about logs currently enabled and pending to be deployed for the specified broker.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMaintenanceWindowStartTime
```
public void setMaintenanceWindowStartTime(WeeklyStartTime maintenanceWindowStartTime)
```
    The parameters that determine the WeeklyStartTime.
    
    Parameters:
    
    maintenanceWindowStartTime - The parameters that determine the WeeklyStartTime.
  - getMaintenanceWindowStartTime
```
public WeeklyStartTime getMaintenanceWindowStartTime()
```
    The parameters that determine the WeeklyStartTime.
    
    Returns:
    
    The parameters that determine the WeeklyStartTime.
  - withMaintenanceWindowStartTime
```
public DescribeBrokerResult withMaintenanceWindowStartTime(WeeklyStartTime maintenanceWindowStartTime)
```
    The parameters that determine the WeeklyStartTime.
    
    Parameters:
    
    maintenanceWindowStartTime - The parameters that determine the WeeklyStartTime.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPendingAuthenticationStrategy
```
public void setPendingAuthenticationStrategy(String pendingAuthenticationStrategy)
```
    The authentication strategy that will be applied when the broker is rebooted. The default is SIMPLE.
    
    Parameters:
    
    pendingAuthenticationStrategy - The authentication strategy that will be applied when the broker is rebooted. The default is SIMPLE.
    
    See Also:
    
    AuthenticationStrategy
  - getPendingAuthenticationStrategy
```
public String getPendingAuthenticationStrategy()
```
    The authentication strategy that will be applied when the broker is rebooted. The default is SIMPLE.
    
    Returns:
    
    The authentication strategy that will be applied when the broker is rebooted. The default is SIMPLE.
    
    See Also:
    
    AuthenticationStrategy
  - withPendingAuthenticationStrategy
```
public DescribeBrokerResult withPendingAuthenticationStrategy(String pendingAuthenticationStrategy)
```
    The authentication strategy that will be applied when the broker is rebooted. The default is SIMPLE.
    
    Parameters:
    
    pendingAuthenticationStrategy - The authentication strategy that will be applied when the broker is rebooted. The default is SIMPLE.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AuthenticationStrategy
  - withPendingAuthenticationStrategy
```
public DescribeBrokerResult withPendingAuthenticationStrategy(AuthenticationStrategy pendingAuthenticationStrategy)
```
    The authentication strategy that will be applied when the broker is rebooted. The default is SIMPLE.
    
    Parameters:
    
    pendingAuthenticationStrategy - The authentication strategy that will be applied when the broker is rebooted. The default is SIMPLE.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AuthenticationStrategy
  - setPendingEngineVersion
```
public void setPendingEngineVersion(String pendingEngineVersion)
```
    The broker engine version to upgrade to. For a list of supported engine versions, see Supported engines.
    
    Parameters:
    
    pendingEngineVersion - The broker engine version to upgrade to. For a list of supported engine versions, see Supported engines.
  - getPendingEngineVersion
```
public String getPendingEngineVersion()
```
    The broker engine version to upgrade to. For a list of supported engine versions, see Supported engines.
    
    Returns:
    
    The broker engine version to upgrade to. For a list of supported engine versions, see Supported engines.
  - withPendingEngineVersion
```
public DescribeBrokerResult withPendingEngineVersion(String pendingEngineVersion)
```
    The broker engine version to upgrade to. For a list of supported engine versions, see Supported engines.
    
    Parameters:
    
    pendingEngineVersion - The broker engine version to upgrade to. For a list of supported engine versions, see Supported engines.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPendingHostInstanceType
```
public void setPendingHostInstanceType(String pendingHostInstanceType)
```
    The broker's host instance type to upgrade to. For a list of supported instance types, see Broker instance types.
    
    Parameters:
    
    pendingHostInstanceType - The broker's host instance type to upgrade to. For a list of supported instance types, see Broker instance types.
  - getPendingHostInstanceType
```
public String getPendingHostInstanceType()
```
    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.
  - withPendingHostInstanceType
```
public DescribeBrokerResult withPendingHostInstanceType(String pendingHostInstanceType)
```
    The broker's host instance type to upgrade to. For a list of supported instance types, see Broker instance types.
    
    Parameters:
    
    pendingHostInstanceType - The broker's host instance type to upgrade to. For a list of supported instance types, see Broker instance types.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPendingLdapServerMetadata
```
public void setPendingLdapServerMetadata(LdapServerMetadataOutput pendingLdapServerMetadata)
```
    The metadata of the LDAP server that will be used to authenticate and authorize connections to the broker after it is rebooted.
    
    Parameters:
    
    pendingLdapServerMetadata - The metadata of the LDAP server that will be used to authenticate and authorize connections to the broker after it is rebooted.
  - getPendingLdapServerMetadata
```
public LdapServerMetadataOutput getPendingLdapServerMetadata()
```
    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.
  - withPendingLdapServerMetadata
```
public DescribeBrokerResult withPendingLdapServerMetadata(LdapServerMetadataOutput pendingLdapServerMetadata)
```
    The metadata of the LDAP server that will be used to authenticate and authorize connections to the broker after it is rebooted.
    
    Parameters:
    
    pendingLdapServerMetadata - The metadata of the LDAP server that will be used to authenticate and authorize connections to the broker after it is rebooted.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getPendingSecurityGroups
```
public List<String> getPendingSecurityGroups()
```
    The list of pending security groups to authorize connections to brokers.
    
    Returns:
    
    The list of pending security groups to authorize connections to brokers.
  - setPendingSecurityGroups
```
public void setPendingSecurityGroups(Collection<String> pendingSecurityGroups)
```
    The list of pending security groups to authorize connections to brokers.
    
    Parameters:
    
    pendingSecurityGroups - The list of pending security groups to authorize connections to brokers.
  - withPendingSecurityGroups
```
public DescribeBrokerResult withPendingSecurityGroups(String... pendingSecurityGroups)
```
    The list of pending security groups to authorize connections to brokers.
    
    NOTE: This method appends the values to the existing list (if any). Use setPendingSecurityGroups(java.util.Collection) or withPendingSecurityGroups(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    pendingSecurityGroups - The list of pending security groups to authorize connections to brokers.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withPendingSecurityGroups
```
public DescribeBrokerResult withPendingSecurityGroups(Collection<String> pendingSecurityGroups)
```
    The list of pending security groups to authorize connections to brokers.
    
    Parameters:
    
    pendingSecurityGroups - The list of pending security groups to authorize connections to brokers.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPubliclyAccessible
```
public void setPubliclyAccessible(Boolean publiclyAccessible)
```
    Enables connections from applications outside of the VPC that hosts the broker's subnets.
    
    Parameters:
    
    publiclyAccessible - Enables connections from applications outside of the VPC that hosts the broker's subnets.
  - getPubliclyAccessible
```
public Boolean getPubliclyAccessible()
```
    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.
  - withPubliclyAccessible
```
public DescribeBrokerResult withPubliclyAccessible(Boolean publiclyAccessible)
```
    Enables connections from applications outside of the VPC that hosts the broker's subnets.
    
    Parameters:
    
    publiclyAccessible - Enables connections from applications outside of the VPC that hosts the broker's subnets.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isPubliclyAccessible
```
public Boolean isPubliclyAccessible()
```
    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.
  - getSecurityGroups
```
public List<String> getSecurityGroups()
```
    The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
    
    Returns:
    
    The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
  - setSecurityGroups
```
public void setSecurityGroups(Collection<String> securityGroups)
```
    The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
    
    Parameters:
    
    securityGroups - The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
  - withSecurityGroups
```
public DescribeBrokerResult withSecurityGroups(String... securityGroups)
```
    The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
    
    NOTE: This method appends the values to the existing list (if any). Use setSecurityGroups(java.util.Collection) or withSecurityGroups(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    securityGroups - The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withSecurityGroups
```
public DescribeBrokerResult withSecurityGroups(Collection<String> securityGroups)
```
    The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
    
    Parameters:
    
    securityGroups - The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStorageType
```
public void setStorageType(String storageType)
```
    The broker's storage type.
    
    Parameters:
    
    storageType - The broker's storage type.
    
    See Also:
    
    BrokerStorageType
  - getStorageType
```
public String getStorageType()
```
    The broker's storage type.
    
    Returns:
    
    The broker's storage type.
    
    See Also:
    
    BrokerStorageType
  - withStorageType
```
public DescribeBrokerResult withStorageType(String storageType)
```
    The broker's storage type.
    
    Parameters:
    
    storageType - The broker's storage type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    BrokerStorageType
  - withStorageType
```
public DescribeBrokerResult withStorageType(BrokerStorageType storageType)
```
    The broker's storage type.
    
    Parameters:
    
    storageType - The broker's storage type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    BrokerStorageType
  - getSubnetIds
```
public List<String> getSubnetIds()
```
    The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.
    
    Returns:
    
    The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.
  - setSubnetIds
```
public void setSubnetIds(Collection<String> subnetIds)
```
    The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.
    
    Parameters:
    
    subnetIds - The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.
  - withSubnetIds
```
public DescribeBrokerResult withSubnetIds(String... subnetIds)
```
    The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.
    
    NOTE: This method appends the values to the existing list (if any). Use setSubnetIds(java.util.Collection) or withSubnetIds(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    subnetIds - The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withSubnetIds
```
public DescribeBrokerResult withSubnetIds(Collection<String> subnetIds)
```
    The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.
    
    Parameters:
    
    subnetIds - The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public Map<String,String> getTags()
```
    The list of all tags associated with this broker.
    
    Returns:
    
    The list of all tags associated with this broker.
  - setTags
```
public void setTags(Map<String,String> tags)
```
    The list of all tags associated with this broker.
    
    Parameters:
    
    tags - The list of all tags associated with this broker.
  - withTags
```
public DescribeBrokerResult withTags(Map<String,String> tags)
```
    The list of all tags associated with this broker.
    
    Parameters:
    
    tags - The list of all tags associated with this broker.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public DescribeBrokerResult addTagsEntry(String key,
                                         String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public DescribeBrokerResult clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getUsers
```
public List<UserSummary> getUsers()
```
    The list of all broker usernames for the specified broker.
    
    Returns:
    
    The list of all broker usernames for the specified broker.
  - setUsers
```
public void setUsers(Collection<UserSummary> users)
```
    The list of all broker usernames for the specified broker.
    
    Parameters:
    
    users - The list of all broker usernames for the specified broker.
  - withUsers
```
public DescribeBrokerResult withUsers(UserSummary... users)
```
    The list of all broker usernames for the specified broker.
    
    NOTE: This method appends the values to the existing list (if any). Use setUsers(java.util.Collection) or withUsers(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    users - The list of all broker usernames for the specified broker.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withUsers
```
public DescribeBrokerResult withUsers(Collection<UserSummary> users)
```
    The list of all broker usernames for the specified broker.
    
    Parameters:
    
    users - The list of all broker usernames for the specified broker.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public DescribeBrokerResult clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class DescribeBrokerResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

DescribeBrokerResult

Method Detail

getActionsRequired

setActionsRequired

withActionsRequired

withActionsRequired

setAuthenticationStrategy

getAuthenticationStrategy

withAuthenticationStrategy

withAuthenticationStrategy

setAutoMinorVersionUpgrade

getAutoMinorVersionUpgrade

withAutoMinorVersionUpgrade

isAutoMinorVersionUpgrade

setBrokerArn

getBrokerArn

withBrokerArn

setBrokerId

getBrokerId

withBrokerId

getBrokerInstances

setBrokerInstances

withBrokerInstances

withBrokerInstances

setBrokerName

getBrokerName

withBrokerName

setBrokerState

getBrokerState

withBrokerState

withBrokerState

setConfigurations

getConfigurations

withConfigurations

setCreated

getCreated

withCreated

setDeploymentMode

getDeploymentMode

withDeploymentMode

withDeploymentMode

setEncryptionOptions

getEncryptionOptions

withEncryptionOptions

setEngineType

getEngineType

withEngineType

withEngineType

setEngineVersion

getEngineVersion

withEngineVersion

setHostInstanceType

getHostInstanceType

withHostInstanceType

setLdapServerMetadata

getLdapServerMetadata

withLdapServerMetadata

setLogs

getLogs

withLogs

setMaintenanceWindowStartTime

getMaintenanceWindowStartTime

withMaintenanceWindowStartTime

setPendingAuthenticationStrategy

getPendingAuthenticationStrategy

withPendingAuthenticationStrategy

withPendingAuthenticationStrategy

setPendingEngineVersion

getPendingEngineVersion

withPendingEngineVersion

setPendingHostInstanceType

getPendingHostInstanceType

withPendingHostInstanceType