Package software.amazon.awssdk.services.kafka.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MutableClusterInfo.Builder

Method Summary

Modifier and Type	Method	Description
BrokerCountUpdateInfo	brokerCountUpdateInfo()	Describes brokers being changed during a broker count update.
List<BrokerEBSVolumeInfo>	brokerEBSVolumeInfo()	Specifies the size of the EBS volume and the ID of the associated broker.
static MutableClusterInfo.Builder	builder()
ClientAuthentication	clientAuthentication()	Includes all client authentication information.
ConfigurationInfo	configurationInfo()	Information about the changes in the configuration of the brokers.
ConnectivityInfo	connectivityInfo()	Information about the broker access configuration.
EncryptionInfo	encryptionInfo()	Includes all encryption-related information.
EnhancedMonitoring	enhancedMonitoring()	Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.
String	enhancedMonitoringAsString()	Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasBrokerEBSVolumeInfo()	For responses, this returns true if the service returned a value for the BrokerEBSVolumeInfo property.
int	hashCode()
String	instanceType()	Information about the Amazon MSK broker type.
String	kafkaVersion()	The Apache Kafka version.
LoggingInfo	loggingInfo()	You can configure your MSK cluster to send broker logs to different destination types.
Integer	numberOfBrokerNodes()	The number of broker nodes in the cluster.
OpenMonitoring	openMonitoring()	The settings for open monitoring.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends MutableClusterInfo.Builder>	serializableBuilderClass()
StorageMode	storageMode()	This controls storage mode for supported storage tiers.
String	storageModeAsString()	This controls storage mode for supported storage tiers.
MutableClusterInfo.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

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:

EnhancedMonitoring

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:

EnhancedMonitoring

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:

StorageMode

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:

StorageMode

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()

Specified by:

toBuilder in interface ToCopyableBuilder<MutableClusterInfo.Builder,MutableClusterInfo>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo