Class Configuration
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Configuration.Builder,
Configuration>
Represents an MSK Configuration.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
The Amazon Resource Name (ARN) of the configuration.static Configuration.Builder
builder()
final Instant
The time when the configuration was created.final String
The description of the configuration.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
For responses, this returns true if the service returned a value for the KafkaVersions property.An array of the versions of Apache Kafka with which you can use this MSK configuration.final ConfigurationRevision
Latest revision of the configuration.final String
name()
The name of the configuration.static Class
<? extends Configuration.Builder> final ConfigurationState
state()
The state of the configuration.final String
The state of the configuration.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.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
arn
The Amazon Resource Name (ARN) of the configuration.
- Returns:
The Amazon Resource Name (ARN) of the configuration.
-
creationTime
The time when the configuration was created.
- Returns:
The time when the configuration was created.
-
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 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. -
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
Latest revision of the configuration.
- Returns:
Latest revision of the configuration.
-
name
The name of the configuration.
- Returns:
The name of the configuration.
-
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 returnConfigurationState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED.
- See Also:
-
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 returnConfigurationState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED.
- 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<Configuration.Builder,
Configuration> - 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
-