Class ClusterInfo
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ClusterInfo.Builder,
ClusterInfo>
Returns information about a cluster.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
Arn of active cluster operation.final BrokerNodeGroupInfo
Information about the broker nodes.static ClusterInfo.Builder
builder()
final ClientAuthentication
Includes all client authentication information.final String
The Amazon Resource Name (ARN) that uniquely identifies the cluster.final String
The name of the cluster.final Instant
The time when the cluster was created.final BrokerSoftwareInfo
Information about the version of software currently deployed on the Apache Kafka brokers in the cluster.final String
The current version of the MSK cluster.final CustomerActionStatus
Determines if there is an action required from the customer.final String
Determines if there is an action required from the customer.final EncryptionInfo
Includes all encryption-related information.final EnhancedMonitoring
Specifies which metrics are gathered for the MSK cluster.final String
Specifies which metrics are gathered for the MSK cluster.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final LoggingInfo
Returns the value of the LoggingInfo property for this object.final Integer
The number of broker nodes in the cluster.final OpenMonitoring
Settings for open monitoring using Prometheus.static Class
<? extends ClusterInfo.Builder> final ClusterState
state()
The state of the cluster.final String
The state of the cluster.final StateInfo
Returns the value of the StateInfo property for this object.final StorageMode
This controls storage mode for supported storage tiers.final String
This controls storage mode for supported storage tiers.tags()
Tags attached to the cluster.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
The connection string to use to connect to the Apache ZooKeeper cluster.final String
The connection string to use to connect to zookeeper cluster on Tls port.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
activeOperationArn
Arn of active cluster operation.
- Returns:
Arn of active cluster operation.
-
brokerNodeGroupInfo
Information about the broker nodes.
- Returns:
Information about the broker nodes.
-
clientAuthentication
Includes all client authentication information.
- Returns:
Includes all client authentication information.
-
clusterArn
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
- Returns:
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
-
clusterName
The name of the cluster.
- Returns:
The name of the cluster.
-
creationTime
The time when the cluster was created.
- Returns:
The time when the cluster was created.
-
currentBrokerSoftwareInfo
Information about the version of software currently deployed on the Apache Kafka brokers in the cluster.
- Returns:
Information about the version of software currently deployed on the Apache Kafka brokers in the cluster.
-
currentVersion
The current version of the MSK cluster.
- Returns:
The current version of the MSK cluster.
-
encryptionInfo
Includes all encryption-related information.
- Returns:
Includes all encryption-related information.
-
enhancedMonitoring
Specifies which metrics are gathered for the MSK cluster. This property has the following possible values: DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION. For a list of the metrics associated with each of these levels of monitoring, see Monitoring.
If the service returns an enum value that is not available in the current SDK version,
enhancedMonitoring
will returnEnhancedMonitoring.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromenhancedMonitoringAsString()
.- Returns:
Specifies which metrics are gathered for the MSK cluster. This property has the following possible values: DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION. For a list of the metrics associated with each of these levels of monitoring, see Monitoring.
- See Also:
-
enhancedMonitoringAsString
Specifies which metrics are gathered for the MSK cluster. This property has the following possible values: DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION. For a list of the metrics associated with each of these levels of monitoring, see Monitoring.
If the service returns an enum value that is not available in the current SDK version,
enhancedMonitoring
will returnEnhancedMonitoring.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromenhancedMonitoringAsString()
.- Returns:
Specifies which metrics are gathered for the MSK cluster. This property has the following possible values: DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION. For a list of the metrics associated with each of these levels of monitoring, see Monitoring.
- See Also:
-
openMonitoring
Settings for open monitoring using Prometheus.
- Returns:
Settings for open monitoring using Prometheus.
-
loggingInfo
Returns the value of the LoggingInfo property for this object.- Returns:
- The value of the LoggingInfo property for this object.
-
numberOfBrokerNodes
The number of broker nodes in the cluster.
- Returns:
The number of broker nodes in the cluster.
-
state
The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.
If the service returns an enum value that is not available in the current SDK version,
state
will returnClusterState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.
- See Also:
-
stateAsString
The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.
If the service returns an enum value that is not available in the current SDK version,
state
will returnClusterState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.
- See Also:
-
stateInfo
Returns the value of the StateInfo property for this object.- Returns:
- The value of the StateInfo property for this object.
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
tags
Tags attached to the cluster.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()
method.- Returns:
Tags attached to the cluster.
-
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.
-
zookeeperConnectStringTls
The connection string to use to connect to zookeeper cluster on Tls port.
- Returns:
The connection string to use to connect to zookeeper cluster on Tls port.
-
storageMode
This controls storage mode for supported storage tiers.
If the service returns an enum value that is not available in the current SDK version,
storageMode
will returnStorageMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstorageModeAsString()
.- Returns:
This controls storage mode for supported storage tiers.
- See Also:
-
storageModeAsString
This controls storage mode for supported storage tiers.
If the service returns an enum value that is not available in the current SDK version,
storageMode
will returnStorageMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstorageModeAsString()
.- Returns:
This controls storage mode for supported storage tiers.
- See Also:
-
customerActionStatus
Determines if there is an action required from the customer.
If the service returns an enum value that is not available in the current SDK version,
customerActionStatus
will returnCustomerActionStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcustomerActionStatusAsString()
.- Returns:
Determines if there is an action required from the customer.
- See Also:
-
customerActionStatusAsString
Determines if there is an action required from the customer.
If the service returns an enum value that is not available in the current SDK version,
customerActionStatus
will returnCustomerActionStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcustomerActionStatusAsString()
.- Returns:
Determines if there is an action required from the customer.
- See Also:
-
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 interfaceToCopyableBuilder<ClusterInfo.Builder,
ClusterInfo> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-