Class MutableClusterInfo

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

Information about cluster attributes that can be updated via update APIs.

See Also:

  • Method Details

    • hasBrokerEBSVolumeInfo

      public final boolean hasBrokerEBSVolumeInfo()
      For responses, this returns true if the service returned a value for the BrokerEBSVolumeInfo 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.

    • brokerEBSVolumeInfo

      public final List<BrokerEBSVolumeInfo> brokerEBSVolumeInfo()

      Specifies the size of the EBS volume and the ID of the associated broker.

      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 hasBrokerEBSVolumeInfo() method.

      Returns:

      Specifies the size of the EBS volume and the ID of the associated broker.

    • configurationInfo

      public final ConfigurationInfo configurationInfo()

      Information about the changes in the configuration of the brokers.

      Returns:

      Information about the changes in the configuration of the brokers.

    • numberOfBrokerNodes

      public final Integer numberOfBrokerNodes()

      The number of broker nodes in the cluster.

      Returns:

      The number of broker nodes in the cluster.

    • enhancedMonitoring

      public final EnhancedMonitoring enhancedMonitoring()

      Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.

      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 Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.

      See Also:

    • enhancedMonitoringAsString

      public final String enhancedMonitoringAsString()

      Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.

      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 Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.

      See Also:

    • openMonitoring

      public final OpenMonitoring openMonitoring()

      The settings for open monitoring.

      Returns:

      The settings for open monitoring.

    • kafkaVersion

      public final String kafkaVersion()

      The Apache Kafka version.

      Returns:

      The Apache Kafka version.

    • loggingInfo

      public final LoggingInfo loggingInfo()

      You can configure your MSK cluster to send broker logs to different destination types. This is a container for the configuration details related to broker logs.

      Returns:

      You can configure your MSK cluster to send broker logs to different destination types. This is a container for the configuration details related to broker logs.

    • instanceType

      public final String instanceType()

      Information about the Amazon MSK broker type.

      Returns:

      Information about the Amazon MSK broker type.

    • clientAuthentication

      public final ClientAuthentication clientAuthentication()

      Includes all client authentication information.

      Returns:

      Includes all client authentication information.

    • encryptionInfo

      public final EncryptionInfo encryptionInfo()

      Includes all encryption-related information.

      Returns:

      Includes all encryption-related information.

    • connectivityInfo

      public final ConnectivityInfo connectivityInfo()

      Information about the broker access configuration.

      Returns:

      Information about the broker access configuration.

    • 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:

    • brokerCountUpdateInfo

      public final BrokerCountUpdateInfo brokerCountUpdateInfo()

      Describes brokers being changed during a broker count update.

      Returns:

      Describes brokers being changed during a broker count update.

    • toBuilder

      public MutableClusterInfo.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<MutableClusterInfo.Builder,MutableClusterInfo>
      Returns:
      a builder for type T

    • builder

      public static MutableClusterInfo.Builder builder()

    • serializableBuilderClass

      public static Class<? extends MutableClusterInfo.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.