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

Class Configuration

java.lang.Object

software.amazon.awssdk.services.kafka.model.Configuration

All Implemented Interfaces:

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

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

Represents an MSK Configuration.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Configuration.Builder

Method Summary

Modifier and Type	Method	Description
String	arn()	The Amazon Resource Name (ARN) of the configuration.
static Configuration.Builder	builder()
Instant	creationTime()	The time when the configuration was created.
String	description()	The description of the configuration.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasKafkaVersions()	For responses, this returns true if the service returned a value for the KafkaVersions property.
List<String>	kafkaVersions()	An array of the versions of Apache Kafka with which you can use this MSK configuration.
ConfigurationRevision	latestRevision()	Latest revision of the configuration.
String	name()	The name of the configuration.
List<SdkField<?>>	sdkFields()
static Class<? extends Configuration.Builder>	serializableBuilderClass()
ConfigurationState	state()	The state of the configuration.
String	stateAsString()	The state of the configuration.
Configuration.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

arn

public final String arn()

The Amazon Resource Name (ARN) of the configuration.

Returns:

The Amazon Resource Name (ARN) of the configuration.

creationTime

public final Instant creationTime()

The time when the configuration was created.

Returns:

The time when the configuration was created.

description

public final String description()

The description of the configuration.

Returns:

The description of the configuration.

hasKafkaVersions

public final boolean hasKafkaVersions()

For responses, this returns true if the service returned a value for the KafkaVersions 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.

kafkaVersions

public final List<String> kafkaVersions()

An array of the versions of Apache Kafka with which you can use this MSK configuration. You can use this configuration for an MSK cluster only if the Apache Kafka version specified for the cluster appears in this array.

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

Returns:

An array of the versions of Apache Kafka with which you can use this MSK configuration. You can use this configuration for an MSK cluster only if the Apache Kafka version specified for the cluster appears in this array.

latestRevision

public final ConfigurationRevision latestRevision()

Latest revision of the configuration.

Returns:

Latest revision of the configuration.

name

public final String name()

The name of the configuration.

Returns:

The name of the configuration.

state

public final ConfigurationState state()

The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED.

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

Returns:

The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED.

See Also:

ConfigurationState

stateAsString

public final String stateAsString()

The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED.

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

Returns:

The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED.

See Also:

ConfigurationState

toBuilder

public Configuration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Configuration.Builder,Configuration>

builder

public static Configuration.Builder builder()

serializableBuilderClass

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