java.lang.Object
- software.amazon.awssdk.services.kafka.model.Cluster

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<Cluster.Builder,Cluster>

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

Returns information about a cluster.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface Cluster.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`activeOperationArn()`	The Amazon Resource Name (ARN) that uniquely identifies a cluster operation.
`static Cluster.Builder`	`builder()`
`String`	`clusterArn()`	The Amazon Resource Name (ARN) that uniquely identifies the cluster.
`String`	`clusterName()`	The name of the cluster.
`ClusterType`	`clusterType()`	Cluster Type.
`String`	`clusterTypeAsString()`	Cluster Type.
`Instant`	`creationTime()`	The time when the cluster was created.
`String`	`currentVersion()`	The current version of the MSK cluster.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`Provisioned`	`provisioned()`	Information about the provisioned cluster.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Cluster.Builder>`	`serializableBuilderClass()`
`Serverless`	`serverless()`	Information about the serverless cluster.
`ClusterState`	`state()`	The state of the cluster.
`String`	`stateAsString()`	The state of the cluster.
`StateInfo`	`stateInfo()`	State Info for the Amazon MSK cluster.
`Map<String,String>`	`tags()`	Tags attached to the cluster.
`Cluster.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
  - activeOperationArn
```
public final String activeOperationArn()
```
    The Amazon Resource Name (ARN) that uniquely identifies a cluster operation.
    
    Returns:
    
    The Amazon Resource Name (ARN) that uniquely identifies a cluster operation.
  - clusterType
```
public final ClusterType clusterType()
```
    Cluster Type.
    
    If the service returns an enum value that is not available in the current SDK version, clusterType will return ClusterType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from clusterTypeAsString().
    
    Returns:
    
    Cluster Type.
    
    See Also:
    
    ClusterType
  - clusterTypeAsString
```
public final String clusterTypeAsString()
```
    Cluster Type.
    
    If the service returns an enum value that is not available in the current SDK version, clusterType will return ClusterType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from clusterTypeAsString().
    
    Returns:
    
    Cluster Type.
    
    See Also:
    
    ClusterType
  - 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.
  - currentVersion
```
public final String currentVersion()
```
    The current version of the MSK cluster.
    
    Returns:
    
    The current version of the MSK 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:
    
    ClusterState
  - 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:
    
    ClusterState
  - stateInfo
```
public final StateInfo stateInfo()
```
    State Info for the Amazon MSK cluster.
    
    Returns:
    
    State Info for the Amazon MSK cluster.
  - 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.
  - provisioned
```
public final Provisioned provisioned()
```
    Information about the provisioned cluster.
    
    Returns:
    
    Information about the provisioned cluster.
  - serverless
```
public final Serverless serverless()
```
    Information about the serverless cluster.
    
    Returns:
    
    Information about the serverless cluster.
  - toBuilder
```
public Cluster.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Cluster.Builder,Cluster>
  - builder
```
public static Cluster.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Cluster.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

Class Cluster

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

activeOperationArn

clusterType

clusterTypeAsString

clusterArn

clusterName

creationTime

currentVersion

state

stateAsString

stateInfo

hasTags

tags

provisioned

serverless

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields