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

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:

  • Method Details

    • 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 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.

    • 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 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.

    • 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 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.

    • 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 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.

    • 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()
      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 interface ToCopyableBuilder<SchemaDefinition.Builder,SchemaDefinition>
      Returns:
      a builder for type T

    • builder

      public static SchemaDefinition.Builder builder()

    • serializableBuilderClass

      public static Class<? extends SchemaDefinition.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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.