Class ClusterInfo

java.lang.Object
software.amazon.awssdk.services.kafka.model.ClusterInfo
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ClusterInfo.Builder,ClusterInfo>
@Generated("software.amazon.awssdk:codegen") public final class ClusterInfo extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ClusterInfo.Builder,ClusterInfo>

Returns information about a cluster.

See Also:

  • Method Details

    • activeOperationArn

      public final String activeOperationArn()

      Arn of active cluster operation.

      Returns:

      Arn of active cluster operation.

    • brokerNodeGroupInfo

      public final BrokerNodeGroupInfo brokerNodeGroupInfo()

      Information about the broker nodes.

      Returns:

      Information about the broker nodes.

    • clientAuthentication

      public final ClientAuthentication clientAuthentication()

      Includes all client authentication information.

      Returns:

      Includes all client authentication information.

    • clusterArn

      public final 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 final String clusterName()

      The name of the cluster.

      Returns:

      The name of the cluster.

    • creationTime

      public final Instant creationTime()

      The time when the cluster was created.

      Returns:

      The time when the cluster was created.

    • currentBrokerSoftwareInfo

      public final BrokerSoftwareInfo 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

      public final String currentVersion()

      The current version of the MSK cluster.

      Returns:

      The current version of the MSK cluster.

    • encryptionInfo

      public final EncryptionInfo encryptionInfo()

      Includes all encryption-related information.

      Returns:

      Includes all encryption-related information.

    • enhancedMonitoring

      public final EnhancedMonitoring 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 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 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

      public final String 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 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 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

      public final OpenMonitoring openMonitoring()

      Settings for open monitoring using Prometheus.

      Returns:

      Settings for open monitoring using Prometheus.

    • loggingInfo

      public final LoggingInfo loggingInfo()
      Returns the value of the LoggingInfo property for this object.
      Returns:
      The value of the LoggingInfo property for this object.

    • numberOfBrokerNodes

      public final Integer numberOfBrokerNodes()

      The number of broker nodes in the cluster.

      Returns:

      The number of broker nodes in the cluster.

    • state

      public final ClusterState 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 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 ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.

      See Also:

    • stateAsString

      public final String 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 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 ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.

      See Also:

    • stateInfo

      public final StateInfo 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 the isEmpty() 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

      public final Map<String,String> 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

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

    • zookeeperConnectStringTls

      public final String 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

      public final StorageMode 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 return StorageMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from storageModeAsString().

      Returns:

      This controls storage mode for supported storage tiers.

      See Also:

    • storageModeAsString

      public final String 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 return StorageMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from storageModeAsString().

      Returns:

      This controls storage mode for supported storage tiers.

      See Also:

    • customerActionStatus

      public final CustomerActionStatus 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 return CustomerActionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from customerActionStatusAsString().

      Returns:

      Determines if there is an action required from the customer.

      See Also:

    • customerActionStatusAsString

      public final String 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 return CustomerActionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from customerActionStatusAsString().

      Returns:

      Determines if there is an action required from the customer.

      See Also:

    • 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 final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

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

    • getValueForField

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

    • sdkFields

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