Class SchemaDefinition
- java.lang.Object
-
- software.amazon.awssdk.services.keyspaces.model.SchemaDefinition
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<SchemaDefinition.Builder,SchemaDefinition>
@Generated("software.amazon.awssdk:codegen") public final class SchemaDefinition extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SchemaDefinition.Builder,SchemaDefinition>
Describes the schema of the table.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceSchemaDefinition.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<ColumnDefinition>allColumns()The regular columns of the table.static SchemaDefinition.Builderbuilder()List<ClusteringKey>clusteringKeys()The columns that are part of the clustering key of the table.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasAllColumns()For responses, this returns true if the service returned a value for the AllColumns property.booleanhasClusteringKeys()For responses, this returns true if the service returned a value for the ClusteringKeys property.inthashCode()booleanhasPartitionKeys()For responses, this returns true if the service returned a value for the PartitionKeys property.booleanhasStaticColumns()For responses, this returns true if the service returned a value for the StaticColumns property.List<PartitionKey>partitionKeys()The columns that are part of the partition key of the table .List<SdkField<?>>sdkFields()static Class<? extends SchemaDefinition.Builder>serializableBuilderClass()List<StaticColumn>staticColumns()The columns that have been defined asSTATIC.SchemaDefinition.BuildertoBuilder()StringtoString()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
-
hasAllColumns
public final boolean hasAllColumns()
For responses, this returns true if the service returned a value for the AllColumns 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.
-
allColumns
public final List<ColumnDefinition> allColumns()
The regular columns of the table.
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
hasAllColumns()method.- Returns:
- The regular columns of the table.
-
hasPartitionKeys
public final boolean hasPartitionKeys()
For responses, this returns true if the service returned a value for the PartitionKeys 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.
-
partitionKeys
public final List<PartitionKey> partitionKeys()
The columns that are part of the partition key of the table .
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
hasPartitionKeys()method.- Returns:
- The columns that are part of the partition key of the table .
-
hasClusteringKeys
public final boolean hasClusteringKeys()
For responses, this returns true if the service returned a value for the ClusteringKeys 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.
-
clusteringKeys
public final List<ClusteringKey> clusteringKeys()
The columns that are part of the clustering key of the table.
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
hasClusteringKeys()method.- Returns:
- The columns that are part of the clustering key of the table.
-
hasStaticColumns
public final boolean hasStaticColumns()
For responses, this returns true if the service returned a value for the StaticColumns 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.
-
staticColumns
public final List<StaticColumn> staticColumns()
The columns that have been defined as
STATIC. Static columns store values that are shared by all rows in the same partition.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
hasStaticColumns()method.- Returns:
- The columns that have been defined as
STATIC. Static columns store values that are shared by all rows in the same partition.
-
toBuilder
public SchemaDefinition.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<SchemaDefinition.Builder,SchemaDefinition>
-
builder
public static SchemaDefinition.Builder builder()
-
serializableBuilderClass
public static Class<? extends SchemaDefinition.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-