ClusterInfo (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.kafka.model.ClusterInfo

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

Returns information about a cluster.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ClusterInfo()

Constructors
Constructor and Description
`ClusterInfo()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ClusterInfo`	`addTagsEntry(String key, String value)`
`ClusterInfo`	`clearTagsEntries()` Removes all the entries added into Tags.
`ClusterInfo`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getActiveOperationArn()` Arn of active cluster operation.
`BrokerNodeGroupInfo`	`getBrokerNodeGroupInfo()` Information about the broker nodes.
`ClientAuthentication`	`getClientAuthentication()` Includes all client authentication information.
`String`	`getClusterArn()` The Amazon Resource Name (ARN) that uniquely identifies the cluster.
`String`	`getClusterName()` The name of the cluster.
`Date`	`getCreationTime()` The time when the cluster was created.
`BrokerSoftwareInfo`	`getCurrentBrokerSoftwareInfo()` Information about the version of software currently deployed on the Kafka brokers in the cluster.
`String`	`getCurrentVersion()` The current version of the MSK cluster.
`EncryptionInfo`	`getEncryptionInfo()` Includes all encryption-related information.
`String`	`getEnhancedMonitoring()` Specifies which metrics are gathered for the MSK cluster.
`Integer`	`getNumberOfBrokerNodes()` The number of broker nodes in the cluster.
`String`	`getState()` The state of the cluster.
`Map<String,String>`	`getTags()` Tags attached to the cluster.
`String`	`getZookeeperConnectString()` The connection string to use to connect to the Apache ZooKeeper cluster.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setActiveOperationArn(String activeOperationArn)` Arn of active cluster operation.
`void`	`setBrokerNodeGroupInfo(BrokerNodeGroupInfo brokerNodeGroupInfo)` Information about the broker nodes.
`void`	`setClientAuthentication(ClientAuthentication clientAuthentication)` Includes all client authentication information.
`void`	`setClusterArn(String clusterArn)` The Amazon Resource Name (ARN) that uniquely identifies the cluster.
`void`	`setClusterName(String clusterName)` The name of the cluster.
`void`	`setCreationTime(Date creationTime)` The time when the cluster was created.
`void`	`setCurrentBrokerSoftwareInfo(BrokerSoftwareInfo currentBrokerSoftwareInfo)` Information about the version of software currently deployed on the Kafka brokers in the cluster.
`void`	`setCurrentVersion(String currentVersion)` The current version of the MSK cluster.
`void`	`setEncryptionInfo(EncryptionInfo encryptionInfo)` Includes all encryption-related information.
`void`	`setEnhancedMonitoring(String enhancedMonitoring)` Specifies which metrics are gathered for the MSK cluster.
`void`	`setNumberOfBrokerNodes(Integer numberOfBrokerNodes)` The number of broker nodes in the cluster.
`void`	`setState(String state)` The state of the cluster.
`void`	`setTags(Map<String,String> tags)` Tags attached to the cluster.
`void`	`setZookeeperConnectString(String zookeeperConnectString)` The connection string to use to connect to the Apache ZooKeeper cluster.
`String`	`toString()` Returns a string representation of this object.
`ClusterInfo`	`withActiveOperationArn(String activeOperationArn)` Arn of active cluster operation.
`ClusterInfo`	`withBrokerNodeGroupInfo(BrokerNodeGroupInfo brokerNodeGroupInfo)` Information about the broker nodes.
`ClusterInfo`	`withClientAuthentication(ClientAuthentication clientAuthentication)` Includes all client authentication information.
`ClusterInfo`	`withClusterArn(String clusterArn)` The Amazon Resource Name (ARN) that uniquely identifies the cluster.
`ClusterInfo`	`withClusterName(String clusterName)` The name of the cluster.
`ClusterInfo`	`withCreationTime(Date creationTime)` The time when the cluster was created.
`ClusterInfo`	`withCurrentBrokerSoftwareInfo(BrokerSoftwareInfo currentBrokerSoftwareInfo)` Information about the version of software currently deployed on the Kafka brokers in the cluster.
`ClusterInfo`	`withCurrentVersion(String currentVersion)` The current version of the MSK cluster.
`ClusterInfo`	`withEncryptionInfo(EncryptionInfo encryptionInfo)` Includes all encryption-related information.
`ClusterInfo`	`withEnhancedMonitoring(EnhancedMonitoring enhancedMonitoring)` Specifies which metrics are gathered for the MSK cluster.
`ClusterInfo`	`withEnhancedMonitoring(String enhancedMonitoring)` Specifies which metrics are gathered for the MSK cluster.
`ClusterInfo`	`withNumberOfBrokerNodes(Integer numberOfBrokerNodes)` The number of broker nodes in the cluster.
`ClusterInfo`	`withState(ClusterState state)` The state of the cluster.
`ClusterInfo`	`withState(String state)` The state of the cluster.
`ClusterInfo`	`withTags(Map<String,String> tags)` Tags attached to the cluster.
`ClusterInfo`	`withZookeeperConnectString(String zookeeperConnectString)` The connection string to use to connect to the Apache ZooKeeper cluster.

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

- Constructor Detail
  - ClusterInfo
```
public ClusterInfo()
```
- Method Detail
  - setActiveOperationArn
```
public void setActiveOperationArn(String activeOperationArn)
```
    Arn of active cluster operation.
    
    Parameters:
    
    activeOperationArn -
    Arn of active cluster operation.
  - getActiveOperationArn
```
public String getActiveOperationArn()
```
    Arn of active cluster operation.
    
    Returns:
    
    Arn of active cluster operation.
  - withActiveOperationArn
```
public ClusterInfo withActiveOperationArn(String activeOperationArn)
```
    Arn of active cluster operation.
    
    Parameters:
    
    activeOperationArn -
    Arn of active cluster operation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBrokerNodeGroupInfo
```
public void setBrokerNodeGroupInfo(BrokerNodeGroupInfo brokerNodeGroupInfo)
```
    Information about the broker nodes.
    
    Parameters:
    
    brokerNodeGroupInfo -
    Information about the broker nodes.
  - getBrokerNodeGroupInfo
```
public BrokerNodeGroupInfo getBrokerNodeGroupInfo()
```
    Information about the broker nodes.
    
    Returns:
    
    Information about the broker nodes.
  - withBrokerNodeGroupInfo
```
public ClusterInfo withBrokerNodeGroupInfo(BrokerNodeGroupInfo brokerNodeGroupInfo)
```
    Information about the broker nodes.
    
    Parameters:
    
    brokerNodeGroupInfo -
    Information about the broker nodes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setClientAuthentication
```
public void setClientAuthentication(ClientAuthentication clientAuthentication)
```
    Includes all client authentication information.
    
    Parameters:
    
    clientAuthentication -
    Includes all client authentication information.
  - getClientAuthentication
```
public ClientAuthentication getClientAuthentication()
```
    Includes all client authentication information.
    
    Returns:
    
    Includes all client authentication information.
  - withClientAuthentication
```
public ClusterInfo withClientAuthentication(ClientAuthentication clientAuthentication)
```
    Includes all client authentication information.
    
    Parameters:
    
    clientAuthentication -
    Includes all client authentication information.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setClusterArn
```
public void setClusterArn(String clusterArn)
```
    The Amazon Resource Name (ARN) that uniquely identifies the cluster.
    
    Parameters:
    
    clusterArn -
    The Amazon Resource Name (ARN) that uniquely identifies the cluster.
  - getClusterArn
```
public String getClusterArn()
```
    The Amazon Resource Name (ARN) that uniquely identifies the cluster.
    
    Returns:
    
    The Amazon Resource Name (ARN) that uniquely identifies the cluster.
  - withClusterArn
```
public ClusterInfo withClusterArn(String clusterArn)
```
    The Amazon Resource Name (ARN) that uniquely identifies the cluster.
    
    Parameters:
    
    clusterArn -
    The Amazon Resource Name (ARN) that uniquely identifies the cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setClusterName
```
public void setClusterName(String clusterName)
```
    The name of the cluster.
    
    Parameters:
    
    clusterName -
    The name of the cluster.
  - getClusterName
```
public String getClusterName()
```
    The name of the cluster.
    
    Returns:
    
    The name of the cluster.
  - withClusterName
```
public ClusterInfo withClusterName(String clusterName)
```
    The name of the cluster.
    
    Parameters:
    
    clusterName -
    The name of the cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationTime
```
public void setCreationTime(Date creationTime)
```
    The time when the cluster was created.
    
    Parameters:
    
    creationTime -
    The time when the cluster was created.
  - getCreationTime
```
public Date getCreationTime()
```
    The time when the cluster was created.
    
    Returns:
    
    The time when the cluster was created.
  - withCreationTime
```
public ClusterInfo withCreationTime(Date creationTime)
```
    The time when the cluster was created.
    
    Parameters:
    
    creationTime -
    The time when the cluster was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCurrentBrokerSoftwareInfo
```
public void setCurrentBrokerSoftwareInfo(BrokerSoftwareInfo currentBrokerSoftwareInfo)
```
    Information about the version of software currently deployed on the Kafka brokers in the cluster.
    
    Parameters:
    
    currentBrokerSoftwareInfo -
    Information about the version of software currently deployed on the Kafka brokers in the cluster.
  - getCurrentBrokerSoftwareInfo
```
public BrokerSoftwareInfo getCurrentBrokerSoftwareInfo()
```
    Information about the version of software currently deployed on the Kafka brokers in the cluster.
    
    Returns:
    
    Information about the version of software currently deployed on the Kafka brokers in the cluster.
  - withCurrentBrokerSoftwareInfo
```
public ClusterInfo withCurrentBrokerSoftwareInfo(BrokerSoftwareInfo currentBrokerSoftwareInfo)
```
    Information about the version of software currently deployed on the Kafka brokers in the cluster.
    
    Parameters:
    
    currentBrokerSoftwareInfo -
    Information about the version of software currently deployed on the Kafka brokers in the cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCurrentVersion
```
public void setCurrentVersion(String currentVersion)
```
    The current version of the MSK cluster.
    
    Parameters:
    
    currentVersion -
    The current version of the MSK cluster.
  - getCurrentVersion
```
public String getCurrentVersion()
```
    The current version of the MSK cluster.
    
    Returns:
    
    The current version of the MSK cluster.
  - withCurrentVersion
```
public ClusterInfo withCurrentVersion(String currentVersion)
```
    The current version of the MSK cluster.
    
    Parameters:
    
    currentVersion -
    The current version of the MSK cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEncryptionInfo
```
public void setEncryptionInfo(EncryptionInfo encryptionInfo)
```
    Includes all encryption-related information.
    
    Parameters:
    
    encryptionInfo -
    Includes all encryption-related information.
  - getEncryptionInfo
```
public EncryptionInfo getEncryptionInfo()
```
    Includes all encryption-related information.
    
    Returns:
    
    Includes all encryption-related information.
  - withEncryptionInfo
```
public ClusterInfo withEncryptionInfo(EncryptionInfo encryptionInfo)
```
    Includes all encryption-related information.
    
    Parameters:
    
    encryptionInfo -
    Includes all encryption-related information.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEnhancedMonitoring
```
public void setEnhancedMonitoring(String enhancedMonitoring)
```
    Specifies which metrics are gathered for the MSK cluster. This property has three possible values: DEFAULT, PER_BROKER, and PER_TOPIC_PER_BROKER. For a list of the metrics associated with each of these three levels of monitoring, see Monitoring.
    
    Parameters:
    
    enhancedMonitoring -
    Specifies which metrics are gathered for the MSK cluster. This property has three possible values: DEFAULT, PER_BROKER, and PER_TOPIC_PER_BROKER. For a list of the metrics associated with each of these three levels of monitoring, see Monitoring.
    
    See Also:
    
    EnhancedMonitoring
  - getEnhancedMonitoring
```
public String getEnhancedMonitoring()
```
    Specifies which metrics are gathered for the MSK cluster. This property has three possible values: DEFAULT, PER_BROKER, and PER_TOPIC_PER_BROKER. For a list of the metrics associated with each of these three levels of monitoring, see Monitoring.
    
    Returns:
    
    Specifies which metrics are gathered for the MSK cluster. This property has three possible values: DEFAULT, PER_BROKER, and PER_TOPIC_PER_BROKER. For a list of the metrics associated with each of these three levels of monitoring, see Monitoring.
    
    See Also:
    
    EnhancedMonitoring
  - withEnhancedMonitoring
```
public ClusterInfo withEnhancedMonitoring(String enhancedMonitoring)
```
    Specifies which metrics are gathered for the MSK cluster. This property has three possible values: DEFAULT, PER_BROKER, and PER_TOPIC_PER_BROKER. For a list of the metrics associated with each of these three levels of monitoring, see Monitoring.
    
    Parameters:
    
    enhancedMonitoring -
    Specifies which metrics are gathered for the MSK cluster. This property has three possible values: DEFAULT, PER_BROKER, and PER_TOPIC_PER_BROKER. For a list of the metrics associated with each of these three levels of monitoring, see Monitoring.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EnhancedMonitoring
  - withEnhancedMonitoring
```
public ClusterInfo withEnhancedMonitoring(EnhancedMonitoring enhancedMonitoring)
```
    Specifies which metrics are gathered for the MSK cluster. This property has three possible values: DEFAULT, PER_BROKER, and PER_TOPIC_PER_BROKER. For a list of the metrics associated with each of these three levels of monitoring, see Monitoring.
    
    Parameters:
    
    enhancedMonitoring -
    Specifies which metrics are gathered for the MSK cluster. This property has three possible values: DEFAULT, PER_BROKER, and PER_TOPIC_PER_BROKER. For a list of the metrics associated with each of these three levels of monitoring, see Monitoring.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EnhancedMonitoring
  - setNumberOfBrokerNodes
```
public void setNumberOfBrokerNodes(Integer numberOfBrokerNodes)
```
    The number of broker nodes in the cluster.
    
    Parameters:
    
    numberOfBrokerNodes -
    The number of broker nodes in the cluster.
  - getNumberOfBrokerNodes
```
public Integer getNumberOfBrokerNodes()
```
    The number of broker nodes in the cluster.
    
    Returns:
    
    The number of broker nodes in the cluster.
  - withNumberOfBrokerNodes
```
public ClusterInfo withNumberOfBrokerNodes(Integer numberOfBrokerNodes)
```
    The number of broker nodes in the cluster.
    
    Parameters:
    
    numberOfBrokerNodes -
    The number of broker nodes in the cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setState
```
public void setState(String state)
```
    The state of the cluster. The possible states are CREATING, ACTIVE, and FAILED.
    
    Parameters:
    
    state -
    The state of the cluster. The possible states are CREATING, ACTIVE, and FAILED.
    
    See Also:
    
    ClusterState
  - getState
```
public String getState()
```
    The state of the cluster. The possible states are CREATING, ACTIVE, and FAILED.
    
    Returns:
    
    The state of the cluster. The possible states are CREATING, ACTIVE, and FAILED.
    
    See Also:
    
    ClusterState
  - withState
```
public ClusterInfo withState(String state)
```
    The state of the cluster. The possible states are CREATING, ACTIVE, and FAILED.
    
    Parameters:
    
    state -
    The state of the cluster. The possible states are CREATING, ACTIVE, and FAILED.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ClusterState
  - withState
```
public ClusterInfo withState(ClusterState state)
```
    The state of the cluster. The possible states are CREATING, ACTIVE, and FAILED.
    
    Parameters:
    
    state -
    The state of the cluster. The possible states are CREATING, ACTIVE, and FAILED.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ClusterState
  - getTags
```
public Map<String,String> getTags()
```
    Tags attached to the cluster.
    
    Returns:
    
    Tags attached to the cluster.
  - setTags
```
public void setTags(Map<String,String> tags)
```
    Tags attached to the cluster.
    
    Parameters:
    
    tags -
    Tags attached to the cluster.
  - withTags
```
public ClusterInfo withTags(Map<String,String> tags)
```
    Tags attached to the cluster.
    
    Parameters:
    
    tags -
    Tags attached to the cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public ClusterInfo addTagsEntry(String key,
                                String value)
```
  - clearTagsEntries
```
public ClusterInfo clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setZookeeperConnectString
```
public void setZookeeperConnectString(String zookeeperConnectString)
```
    The connection string to use to connect to the Apache ZooKeeper cluster.
    
    Parameters:
    
    zookeeperConnectString -
    The connection string to use to connect to the Apache ZooKeeper cluster.
  - getZookeeperConnectString
```
public String getZookeeperConnectString()
```
    The connection string to use to connect to the Apache ZooKeeper cluster.
    
    Returns:
    
    The connection string to use to connect to the Apache ZooKeeper cluster.
  - withZookeeperConnectString
```
public ClusterInfo withZookeeperConnectString(String zookeeperConnectString)
```
    The connection string to use to connect to the Apache ZooKeeper cluster.
    
    Parameters:
    
    zookeeperConnectString -
    The connection string to use to connect to the Apache ZooKeeper cluster.
    
    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 ClusterInfo 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 ClusterInfo

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ClusterInfo

Method Detail

setActiveOperationArn

getActiveOperationArn

withActiveOperationArn

setBrokerNodeGroupInfo

getBrokerNodeGroupInfo

withBrokerNodeGroupInfo

setClientAuthentication

getClientAuthentication

withClientAuthentication

setClusterArn

getClusterArn

withClusterArn

setClusterName

getClusterName

withClusterName

setCreationTime

getCreationTime

withCreationTime

setCurrentBrokerSoftwareInfo

getCurrentBrokerSoftwareInfo

withCurrentBrokerSoftwareInfo

setCurrentVersion

getCurrentVersion

withCurrentVersion

setEncryptionInfo

getEncryptionInfo

withEncryptionInfo

setEnhancedMonitoring

getEnhancedMonitoring

withEnhancedMonitoring

withEnhancedMonitoring

setNumberOfBrokerNodes

getNumberOfBrokerNodes

withNumberOfBrokerNodes

setState

getState

withState

withState

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

setZookeeperConnectString

getZookeeperConnectString

withZookeeperConnectString

toString

equals

hashCode

clone

marshall