Package software.amazon.awssdk.services.keyspaces.model

Class KeyspaceSummary

java.lang.Object

software.amazon.awssdk.services.keyspaces.model.KeyspaceSummary

All Implemented Interfaces:

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

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

Represents the properties of a keyspace.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	KeyspaceSummary.Builder

Method Summary

Modifier and Type	Method	Description
static KeyspaceSummary.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasReplicationRegions()	For responses, this returns true if the service returned a value for the ReplicationRegions property.
String	keyspaceName()	The name of the keyspace.
List<String>	replicationRegions()	If the replicationStrategy of the keyspace is MULTI_REGION, a list of replication Regions is returned.
Rs	replicationStrategy()	This property specifies if a keyspace is a single Region keyspace or a multi-Region keyspace.
String	replicationStrategyAsString()	This property specifies if a keyspace is a single Region keyspace or a multi-Region keyspace.
String	resourceArn()	The unique identifier of the keyspace in the format of an Amazon Resource Name (ARN).
List<SdkField<?>>	sdkFields()
static Class<? extends KeyspaceSummary.Builder>	serializableBuilderClass()
KeyspaceSummary.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

keyspaceName

public final String keyspaceName()

The name of the keyspace.

Returns:

The name of the keyspace.

resourceArn

public final String resourceArn()

The unique identifier of the keyspace in the format of an Amazon Resource Name (ARN).

Returns:

The unique identifier of the keyspace in the format of an Amazon Resource Name (ARN).

replicationStrategy

public final Rs replicationStrategy()

This property specifies if a keyspace is a single Region keyspace or a multi-Region keyspace. The available values are SINGLE_REGION or MULTI_REGION.

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

Returns:

This property specifies if a keyspace is a single Region keyspace or a multi-Region keyspace. The available values are SINGLE_REGION or MULTI_REGION.

See Also:

Rs

replicationStrategyAsString

public final String replicationStrategyAsString()

This property specifies if a keyspace is a single Region keyspace or a multi-Region keyspace. The available values are SINGLE_REGION or MULTI_REGION.

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

Returns:

This property specifies if a keyspace is a single Region keyspace or a multi-Region keyspace. The available values are SINGLE_REGION or MULTI_REGION.

See Also:

Rs

hasReplicationRegions

public final boolean hasReplicationRegions()

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

replicationRegions

public final List<String> replicationRegions()

If the replicationStrategy of the keyspace is MULTI_REGION, a list of replication Regions is returned.

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

Returns:

If the replicationStrategy of the keyspace is MULTI_REGION, a list of replication Regions is returned.

toBuilder

public KeyspaceSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<KeyspaceSummary.Builder,KeyspaceSummary>

builder

public static KeyspaceSummary.Builder builder()

serializableBuilderClass

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