software.amazon.awssdk.services.kafka.model

Class ClusterInfo

java.lang.Object

software.amazon.awssdk.services.kafka.model.ClusterInfo

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ClusterInfo.Builder,ClusterInfo>

@Generated(value="software.amazon.awssdk:codegen")
public final class ClusterInfo
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ClusterInfo.Builder,ClusterInfo>

Returns information about a cluster.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ClusterInfo.Builder

Method Summary

Modifier and Type	Method and Description
BrokerNodeGroupInfo	brokerNodeGroupInfo() Information about the broker nodes.
static ClusterInfo.Builder	builder()
String	clusterArn() The Amazon Resource Name (ARN) that uniquely identifies the cluster.
String	clusterName() The name of the cluster.
Instant	creationTime() The time when the cluster was created.
BrokerSoftwareInfo	currentBrokerSoftwareInfo() Information about the version of software currently deployed on the Kafka brokers in the cluster.
String	currentVersion() The current version of the MSK cluster.
EncryptionInfo	encryptionInfo() Includes all encryption-related information.
EnhancedMonitoring	enhancedMonitoring() Specifies which metrics are gathered for the MSK cluster.
String	enhancedMonitoringAsString() Specifies which metrics are gathered for the MSK cluster.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	numberOfBrokerNodes() The number of Kafka broker nodes in the cluster.
List<SdkField<?>>	sdkFields()
static Class<? extends ClusterInfo.Builder>	serializableBuilderClass()
ClusterState	state() The state of the cluster.
String	stateAsString() The state of the cluster.
ClusterInfo.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
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

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

copy

Method Detail

brokerNodeGroupInfo

public BrokerNodeGroupInfo brokerNodeGroupInfo()

Information about the broker nodes.

Returns:

Information about the broker nodes.

clusterArn

public String clusterArn()

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

Returns:

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

clusterName

public String clusterName()

The name of the cluster.

Returns:

The name of the cluster.

creationTime

public Instant creationTime()

The time when the cluster was created.

Returns:

The time when the cluster was created.

currentBrokerSoftwareInfo

public BrokerSoftwareInfo currentBrokerSoftwareInfo()

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.

currentVersion

public String currentVersion()

The current version of the MSK cluster.

Returns:

The current version of the MSK cluster.

encryptionInfo

public EncryptionInfo encryptionInfo()

Includes all encryption-related information.

Returns:

Includes all encryption-related information.

enhancedMonitoring

public 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.

If the service returns an enum value that is not available in the current SDK version, enhancedMonitoring will return EnhancedMonitoring.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from enhancedMonitoringAsString().

Returns:

Specifies which metrics are gathered for the MSK cluster. This property has three possible values: DEFAULT, PER_BROKER, and PER_TOPIC_PER_BROKER.

See Also:

EnhancedMonitoring

enhancedMonitoringAsString

public String enhancedMonitoringAsString()

Specifies which metrics are gathered for the MSK cluster. This property has three possible values: DEFAULT, PER_BROKER, and PER_TOPIC_PER_BROKER.

If the service returns an enum value that is not available in the current SDK version, enhancedMonitoring will return EnhancedMonitoring.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from enhancedMonitoringAsString().

Returns:

Specifies which metrics are gathered for the MSK cluster. This property has three possible values: DEFAULT, PER_BROKER, and PER_TOPIC_PER_BROKER.

See Also:

EnhancedMonitoring

numberOfBrokerNodes

public Integer numberOfBrokerNodes()

The number of Kafka broker nodes in the cluster.

Returns:

The number of Kafka broker nodes in the cluster.

state

public ClusterState state()

The state of the cluster. The possible states are CREATING, ACTIVE, and FAILED.

If the service returns an enum value that is not available in the current SDK version, state will return ClusterState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

Returns:

The state of the cluster. The possible states are CREATING, ACTIVE, and FAILED.

See Also:

ClusterState

stateAsString

public String stateAsString()

The state of the cluster. The possible states are CREATING, ACTIVE, and FAILED.

If the service returns an enum value that is not available in the current SDK version, state will return ClusterState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

Returns:

The state of the cluster. The possible states are CREATING, ACTIVE, and FAILED.

See Also:

ClusterState

zookeeperConnectString

public String zookeeperConnectString()

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.

toBuilder

public ClusterInfo.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ClusterInfo.Builder,ClusterInfo>

Returns:

a builder for type T

builder

public static ClusterInfo.Builder builder()

serializableBuilderClass

public static Class<? extends ClusterInfo.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.