BrokerSummary (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.mq.model.BrokerSummary

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class BrokerSummary
extends Object
implements Serializable, Cloneable, StructuredPojo

The Amazon Resource Name (ARN) of the broker.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

BrokerSummary()

Constructors
Constructor and Description
`BrokerSummary()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BrokerSummary`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getBrokerArn()` The Amazon Resource Name (ARN) of the broker.
`String`	`getBrokerId()` The unique ID that Amazon MQ generates for the broker.
`String`	`getBrokerName()` The name of the broker.
`String`	`getBrokerState()` The status of the broker.
`String`	`getDeploymentMode()` Required.
`String`	`getHostInstanceType()` The broker's instance type.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`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`	`setBrokerName(String brokerName)` The name of the broker.
`void`	`setBrokerState(String brokerState)` The status of the broker.
`void`	`setDeploymentMode(String deploymentMode)` Required.
`void`	`setHostInstanceType(String hostInstanceType)` The broker's instance type.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`BrokerSummary`	`withBrokerArn(String brokerArn)` The Amazon Resource Name (ARN) of the broker.
`BrokerSummary`	`withBrokerId(String brokerId)` The unique ID that Amazon MQ generates for the broker.
`BrokerSummary`	`withBrokerName(String brokerName)` The name of the broker.
`BrokerSummary`	`withBrokerState(BrokerState brokerState)` The status of the broker.
`BrokerSummary`	`withBrokerState(String brokerState)` The status of the broker.
`BrokerSummary`	`withDeploymentMode(DeploymentMode deploymentMode)` Required.
`BrokerSummary`	`withDeploymentMode(String deploymentMode)` Required.
`BrokerSummary`	`withHostInstanceType(String hostInstanceType)` The broker's instance type.

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

- Constructor Detail
  - BrokerSummary
```
public BrokerSummary()
```
- Method Detail
  - 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 BrokerSummary 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 BrokerSummary 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.
  - 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 BrokerSummary 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. Possible values: CREATION_IN_PROGRESS, CREATION_FAILED, DELETION_IN_PROGRESS, RUNNING, REBOOT_IN_PROGRESS
    
    Parameters:
    
    brokerState - The status of the broker. Possible values: CREATION_IN_PROGRESS, CREATION_FAILED, DELETION_IN_PROGRESS, RUNNING, REBOOT_IN_PROGRESS
    
    See Also:
    
    BrokerState
  - getBrokerState
```
public String getBrokerState()
```
    The status of the broker. Possible values: CREATION_IN_PROGRESS, CREATION_FAILED, DELETION_IN_PROGRESS, RUNNING, REBOOT_IN_PROGRESS
    
    Returns:
    
    The status of the broker. Possible values: CREATION_IN_PROGRESS, CREATION_FAILED, DELETION_IN_PROGRESS, RUNNING, REBOOT_IN_PROGRESS
    
    See Also:
    
    BrokerState
  - withBrokerState
```
public BrokerSummary withBrokerState(String brokerState)
```
    The status of the broker. Possible values: CREATION_IN_PROGRESS, CREATION_FAILED, DELETION_IN_PROGRESS, RUNNING, REBOOT_IN_PROGRESS
    
    Parameters:
    
    brokerState - The status of the broker. Possible values: CREATION_IN_PROGRESS, CREATION_FAILED, DELETION_IN_PROGRESS, RUNNING, REBOOT_IN_PROGRESS
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    BrokerState
  - withBrokerState
```
public BrokerSummary withBrokerState(BrokerState brokerState)
```
    The status of the broker. Possible values: CREATION_IN_PROGRESS, CREATION_FAILED, DELETION_IN_PROGRESS, RUNNING, REBOOT_IN_PROGRESS
    
    Parameters:
    
    brokerState - The status of the broker. Possible values: CREATION_IN_PROGRESS, CREATION_FAILED, DELETION_IN_PROGRESS, RUNNING, REBOOT_IN_PROGRESS
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    BrokerState
  - setDeploymentMode
```
public void setDeploymentMode(String deploymentMode)
```
    Required. The deployment mode of the broker. Possible values: SINGLE_INSTANCE, ACTIVE_STANDBY_MULTI_AZ SINGLE_INSTANCE creates a single-instance broker in a single Availability Zone. ACTIVE_STANDBY_MULTI_AZ creates an active/standby broker for high availability.
    
    Parameters:
    
    deploymentMode - Required. The deployment mode of the broker. Possible values: SINGLE_INSTANCE, ACTIVE_STANDBY_MULTI_AZ SINGLE_INSTANCE creates a single-instance broker in a single Availability Zone. ACTIVE_STANDBY_MULTI_AZ creates an active/standby broker for high availability.
    
    See Also:
    
    DeploymentMode
  - getDeploymentMode
```
public String getDeploymentMode()
```
    Required. The deployment mode of the broker. Possible values: SINGLE_INSTANCE, ACTIVE_STANDBY_MULTI_AZ SINGLE_INSTANCE creates a single-instance broker in a single Availability Zone. ACTIVE_STANDBY_MULTI_AZ creates an active/standby broker for high availability.
    
    Returns:
    
    Required. The deployment mode of the broker. Possible values: SINGLE_INSTANCE, ACTIVE_STANDBY_MULTI_AZ SINGLE_INSTANCE creates a single-instance broker in a single Availability Zone. ACTIVE_STANDBY_MULTI_AZ creates an active/standby broker for high availability.
    
    See Also:
    
    DeploymentMode
  - withDeploymentMode
```
public BrokerSummary withDeploymentMode(String deploymentMode)
```
    Required. The deployment mode of the broker. Possible values: SINGLE_INSTANCE, ACTIVE_STANDBY_MULTI_AZ SINGLE_INSTANCE creates a single-instance broker in a single Availability Zone. ACTIVE_STANDBY_MULTI_AZ creates an active/standby broker for high availability.
    
    Parameters:
    
    deploymentMode - Required. The deployment mode of the broker. Possible values: SINGLE_INSTANCE, ACTIVE_STANDBY_MULTI_AZ SINGLE_INSTANCE creates a single-instance broker in a single Availability Zone. ACTIVE_STANDBY_MULTI_AZ creates an active/standby broker for high availability.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DeploymentMode
  - withDeploymentMode
```
public BrokerSummary withDeploymentMode(DeploymentMode deploymentMode)
```
    Required. The deployment mode of the broker. Possible values: SINGLE_INSTANCE, ACTIVE_STANDBY_MULTI_AZ SINGLE_INSTANCE creates a single-instance broker in a single Availability Zone. ACTIVE_STANDBY_MULTI_AZ creates an active/standby broker for high availability.
    
    Parameters:
    
    deploymentMode - Required. The deployment mode of the broker. Possible values: SINGLE_INSTANCE, ACTIVE_STANDBY_MULTI_AZ SINGLE_INSTANCE creates a single-instance broker in a single Availability Zone. ACTIVE_STANDBY_MULTI_AZ creates an active/standby broker for high availability.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DeploymentMode
  - setHostInstanceType
```
public void setHostInstanceType(String hostInstanceType)
```
    The broker's instance type. Possible values: mq.t2.micro, mq.m4.large
    
    Parameters:
    
    hostInstanceType - The broker's instance type. Possible values: mq.t2.micro, mq.m4.large
  - getHostInstanceType
```
public String getHostInstanceType()
```
    The broker's instance type. Possible values: mq.t2.micro, mq.m4.large
    
    Returns:
    
    The broker's instance type. Possible values: mq.t2.micro, mq.m4.large
  - withHostInstanceType
```
public BrokerSummary withHostInstanceType(String hostInstanceType)
```
    The broker's instance type. Possible values: mq.t2.micro, mq.m4.large
    
    Parameters:
    
    hostInstanceType - The broker's instance type. Possible values: mq.t2.micro, mq.m4.large
    
    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; useful for testing and debugging.
    
    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 BrokerSummary clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class BrokerSummary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BrokerSummary

Method Detail

setBrokerArn

getBrokerArn

withBrokerArn

setBrokerId

getBrokerId

withBrokerId

setBrokerName

getBrokerName

withBrokerName

setBrokerState

getBrokerState

withBrokerState

withBrokerState

setDeploymentMode

getDeploymentMode

withDeploymentMode

withDeploymentMode

setHostInstanceType

getHostInstanceType

withHostInstanceType

toString

equals

hashCode

clone

marshall