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)`
`DescribeBrokerResult`	`clearTagsEntries()` Removes all the entries added into Tags.
`DescribeBrokerResult`	`clone()`
`boolean`	`equals(Object obj)`
`Boolean`	`getAutoMinorVersionUpgrade()` Required.
`String`	`getBrokerArn()` The Amazon Resource Name (ARN) of the broker.
`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 name of the broker.
`String`	`getBrokerState()` The status of the broker.
`Configurations`	`getConfigurations()` The list of all revisions for the specified configuration.
`Date`	`getCreated()` The time when the broker was created.
`String`	`getDeploymentMode()` Required.
`EncryptionOptions`	`getEncryptionOptions()` Encryption options for the broker.
`String`	`getEngineType()` Required.
`String`	`getEngineVersion()` The version of the broker engine.
`String`	`getHostInstanceType()` The broker's instance type.
`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`	`getPendingEngineVersion()` The version of the broker engine to upgrade to.
`String`	`getPendingHostInstanceType()` The host instance type of the broker to upgrade to.
`List<String>`	`getPendingSecurityGroups()` The list of pending security groups to authorize connections to brokers.
`Boolean`	`getPubliclyAccessible()` Required.
`List<String>`	`getSecurityGroups()` The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.
`String`	`getStorageType()` The broker's storage type.
`List<String>`	`getSubnetIds()` The list of groups (2 maximum) 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 ActiveMQ usernames for the specified broker.
`int`	`hashCode()`
`Boolean`	`isAutoMinorVersionUpgrade()` Required.
`Boolean`	`isPubliclyAccessible()` Required.
`void`	`setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)` Required.
`void`	`setBrokerArn(String brokerArn)` The Amazon Resource Name (ARN) of the broker.
`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 name of the broker.
`void`	`setBrokerState(String brokerState)` The status of the broker.
`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)` Required.
`void`	`setEncryptionOptions(EncryptionOptions encryptionOptions)` Encryption options for the broker.
`void`	`setEngineType(String engineType)` Required.
`void`	`setEngineVersion(String engineVersion)` The version of the broker engine.
`void`	`setHostInstanceType(String hostInstanceType)` The broker's instance type.
`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`	`setPendingEngineVersion(String pendingEngineVersion)` The version of the broker engine to upgrade to.
`void`	`setPendingHostInstanceType(String pendingHostInstanceType)` The host instance type of the broker to upgrade to.
`void`	`setPendingSecurityGroups(Collection<String> pendingSecurityGroups)` The list of pending security groups to authorize connections to brokers.
`void`	`setPubliclyAccessible(Boolean publiclyAccessible)` Required.
`void`	`setSecurityGroups(Collection<String> securityGroups)` The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.
`void`	`setStorageType(String storageType)` The broker's storage type.
`void`	`setSubnetIds(Collection<String> subnetIds)` The list of groups (2 maximum) 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 ActiveMQ usernames for the specified broker.
`String`	`toString()` Returns a string representation of this object.
`DescribeBrokerResult`	`withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)` Required.
`DescribeBrokerResult`	`withBrokerArn(String brokerArn)` The Amazon Resource Name (ARN) of the broker.
`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 name of the broker.
`DescribeBrokerResult`	`withBrokerState(BrokerState brokerState)` The status of the broker.
`DescribeBrokerResult`	`withBrokerState(String brokerState)` The status of the broker.
`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)` Required.
`DescribeBrokerResult`	`withDeploymentMode(String deploymentMode)` Required.
`DescribeBrokerResult`	`withEncryptionOptions(EncryptionOptions encryptionOptions)` Encryption options for the broker.
`DescribeBrokerResult`	`withEngineType(EngineType engineType)` Required.
`DescribeBrokerResult`	`withEngineType(String engineType)` Required.
`DescribeBrokerResult`	`withEngineVersion(String engineVersion)` The version of the broker engine.
`DescribeBrokerResult`	`withHostInstanceType(String hostInstanceType)` The broker's instance type.
`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`	`withPendingEngineVersion(String pendingEngineVersion)` The version of the broker engine to upgrade to.
`DescribeBrokerResult`	`withPendingHostInstanceType(String pendingHostInstanceType)` The host instance type of the broker to upgrade to.
`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)` Required.
`DescribeBrokerResult`	`withSecurityGroups(Collection<String> securityGroups)` The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.
`DescribeBrokerResult`	`withSecurityGroups(String... securityGroups)` The list of security groups (1 minimum, 5 maximum) that authorizes 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 (2 maximum) that define which subnets and IP ranges the broker can use from different Availability Zones.
`DescribeBrokerResult`	`withSubnetIds(String... subnetIds)` The list of groups (2 maximum) 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 ActiveMQ usernames for the specified broker.
`DescribeBrokerResult`	`withUsers(UserSummary... users)` The list of all ActiveMQ 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
  - setAutoMinorVersionUpgrade
```
public void setAutoMinorVersionUpgrade(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.
    
    Parameters:
    
    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.
  - getAutoMinorVersionUpgrade
```
public Boolean getAutoMinorVersionUpgrade()
```
    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.
  - withAutoMinorVersionUpgrade
```
public DescribeBrokerResult withAutoMinorVersionUpgrade(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - isAutoMinorVersionUpgrade
```
public Boolean isAutoMinorVersionUpgrade()
```
    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.
  - setBrokerArn
```
public void setBrokerArn(String brokerArn)
```
    The Amazon Resource Name (ARN) of the broker.
    
    Parameters:
    
    brokerArn - The Amazon Resource Name (ARN) of the broker.
  - getBrokerArn
```
public String getBrokerArn()
```
    The Amazon Resource Name (ARN) of the broker.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the broker.
  - withBrokerArn
```
public DescribeBrokerResult withBrokerArn(String brokerArn)
```
    The Amazon Resource Name (ARN) of the broker.
    
    Parameters:
    
    brokerArn - The Amazon Resource Name (ARN) of the broker.
    
    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 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.
    
    Parameters:
    
    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.
  - getBrokerName
```
public String getBrokerName()
```
    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.
  - withBrokerName
```
public DescribeBrokerResult withBrokerName(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBrokerState
```
public void setBrokerState(String brokerState)
```
    The status of the broker.
    
    Parameters:
    
    brokerState - The status of the broker.
    
    See Also:
    
    BrokerState
  - getBrokerState
```
public String getBrokerState()
```
    The status of the broker.
    
    Returns:
    
    The status of the broker.
    
    See Also:
    
    BrokerState
  - withBrokerState
```
public DescribeBrokerResult withBrokerState(String brokerState)
```
    The status of the broker.
    
    Parameters:
    
    brokerState - The status of the broker.
    
    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 status of the broker.
    
    Parameters:
    
    brokerState - The status of the broker.
    
    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)
```
    Required. The deployment mode of the broker.
    
    Parameters:
    
    deploymentMode - Required. The deployment mode of the broker.
    
    See Also:
    
    DeploymentMode
  - getDeploymentMode
```
public String getDeploymentMode()
```
    Required. The deployment mode of the broker.
    
    Returns:
    
    Required. The deployment mode of the broker.
    
    See Also:
    
    DeploymentMode
  - withDeploymentMode
```
public DescribeBrokerResult withDeploymentMode(String deploymentMode)
```
    Required. The deployment mode of the broker.
    
    Parameters:
    
    deploymentMode - Required. The deployment mode of the broker.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DeploymentMode
  - withDeploymentMode
```
public DescribeBrokerResult withDeploymentMode(DeploymentMode deploymentMode)
```
    Required. The deployment mode of the broker.
    
    Parameters:
    
    deploymentMode - Required. The deployment mode of the broker.
    
    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.
    
    Parameters:
    
    encryptionOptions - Encryption options for the broker.
  - getEncryptionOptions
```
public EncryptionOptions getEncryptionOptions()
```
    Encryption options for the broker.
    
    Returns:
    
    Encryption options for the broker.
  - withEncryptionOptions
```
public DescribeBrokerResult withEncryptionOptions(EncryptionOptions encryptionOptions)
```
    Encryption options for the broker.
    
    Parameters:
    
    encryptionOptions - Encryption options for the broker.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEngineType
```
public void setEngineType(String engineType)
```
    Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ.
    
    Parameters:
    
    engineType - Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ.
    
    See Also:
    
    EngineType
  - getEngineType
```
public String getEngineType()
```
    Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ.
    
    Returns:
    
    Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ.
    
    See Also:
    
    EngineType
  - withEngineType
```
public DescribeBrokerResult withEngineType(String engineType)
```
    Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ.
    
    Parameters:
    
    engineType - Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EngineType
  - withEngineType
```
public DescribeBrokerResult withEngineType(EngineType engineType)
```
    Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ.
    
    Parameters:
    
    engineType - Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ.
    
    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 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
    
    Parameters:
    
    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
  - getEngineVersion
```
public String getEngineVersion()
```
    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
  - withEngineVersion
```
public DescribeBrokerResult withEngineVersion(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
    
    Parameters:
    
    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:
    
    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.
  - 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.
  - setPendingEngineVersion
```
public void setPendingEngineVersion(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
    
    Parameters:
    
    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
  - getPendingEngineVersion
```
public String getPendingEngineVersion()
```
    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
  - withPendingEngineVersion
```
public DescribeBrokerResult withPendingEngineVersion(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
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPendingHostInstanceType
```
public void setPendingHostInstanceType(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
    
    Parameters:
    
    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
  - getPendingHostInstanceType
```
public String getPendingHostInstanceType()
```
    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
  - withPendingHostInstanceType
```
public DescribeBrokerResult withPendingHostInstanceType(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
    
    Parameters:
    
    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:
    
    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)
```
    Required. Enables connections from applications outside of the VPC that hosts the broker's subnets.
    
    Parameters:
    
    publiclyAccessible - Required. Enables connections from applications outside of the VPC that hosts the broker's subnets.
  - getPubliclyAccessible
```
public Boolean getPubliclyAccessible()
```
    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.
  - withPubliclyAccessible
```
public DescribeBrokerResult withPubliclyAccessible(Boolean publiclyAccessible)
```
    Required. Enables connections from applications outside of the VPC that hosts the broker's subnets.
    
    Parameters:
    
    publiclyAccessible - Required. 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()
```
    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.
  - getSecurityGroups
```
public List<String> getSecurityGroups()
```
    The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.
    
    Returns:
    
    The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.
  - setSecurityGroups
```
public void setSecurityGroups(Collection<String> securityGroups)
```
    The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.
    
    Parameters:
    
    securityGroups - The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.
  - withSecurityGroups
```
public DescribeBrokerResult withSecurityGroups(String... securityGroups)
```
    The list of security groups (1 minimum, 5 maximum) that authorizes 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 security groups (1 minimum, 5 maximum) that authorizes 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 security groups (1 minimum, 5 maximum) that authorizes connections to brokers.
    
    Parameters:
    
    securityGroups - The list of security groups (1 minimum, 5 maximum) that authorizes 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 (2 maximum) 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 requires two subnets.
    
    Returns:
    
    The list of groups (2 maximum) 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 requires two subnets.
  - setSubnetIds
```
public void setSubnetIds(Collection<String> subnetIds)
```
    The list of groups (2 maximum) 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 requires two subnets.
    
    Parameters:
    
    subnetIds - The list of groups (2 maximum) 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 requires two subnets.
  - withSubnetIds
```
public DescribeBrokerResult withSubnetIds(String... subnetIds)
```
    The list of groups (2 maximum) 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 requires two subnets.
    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 (2 maximum) 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 requires two subnets.
    
    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 (2 maximum) 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 requires two subnets.
    
    Parameters:
    
    subnetIds - The list of groups (2 maximum) 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 requires two subnets.
    
    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)
```
  - 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 ActiveMQ usernames for the specified broker.
    
    Returns:
    
    The list of all ActiveMQ usernames for the specified broker.
  - setUsers
```
public void setUsers(Collection<UserSummary> users)
```
    The list of all ActiveMQ usernames for the specified broker.
    
    Parameters:
    
    users - The list of all ActiveMQ usernames for the specified broker.
  - withUsers
```
public DescribeBrokerResult withUsers(UserSummary... users)
```
    The list of all ActiveMQ 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 ActiveMQ 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 ActiveMQ usernames for the specified broker.
    
    Parameters:
    
    users - The list of all ActiveMQ 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

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

setLogs

getLogs

withLogs

setMaintenanceWindowStartTime

getMaintenanceWindowStartTime

withMaintenanceWindowStartTime

setPendingEngineVersion

getPendingEngineVersion

withPendingEngineVersion

setPendingHostInstanceType

getPendingHostInstanceType

withPendingHostInstanceType

getPendingSecurityGroups

setPendingSecurityGroups

withPendingSecurityGroups

withPendingSecurityGroups

setPubliclyAccessible

getPubliclyAccessible

withPubliclyAccessible

isPubliclyAccessible

getSecurityGroups

setSecurityGroups

withSecurityGroups

withSecurityGroups

setStorageType

getStorageType

withStorageType