Package software.amazon.awssdk.services.lakeformation.model

Class DataCellsFilter

java.lang.Object
software.amazon.awssdk.services.lakeformation.model.DataCellsFilter
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<DataCellsFilter.Builder,DataCellsFilter>
@Generated("software.amazon.awssdk:codegen") public final class DataCellsFilter extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DataCellsFilter.Builder,DataCellsFilter>

A structure that describes certain columns on certain rows.

See Also:

  • Method Details

    • tableCatalogId

      public final String tableCatalogId()

      The ID of the catalog to which the table belongs.

      Returns:
      The ID of the catalog to which the table belongs.

    • databaseName

      public final String databaseName()

      A database in the Glue Data Catalog.

      Returns:
      A database in the Glue Data Catalog.

    • tableName

      public final String tableName()

      A table in the database.

      Returns:
      A table in the database.

    • name

      public final String name()

      The name given by the user to the data filter cell.

      Returns:
      The name given by the user to the data filter cell.

    • rowFilter

      public final RowFilter rowFilter()

      A PartiQL predicate.

      Returns:
      A PartiQL predicate.

    • hasColumnNames

      public final boolean hasColumnNames()
      For responses, this returns true if the service returned a value for the ColumnNames 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.

    • columnNames

      public final List<String> columnNames()

      A list of column names and/or nested column attributes. When specifying nested attributes, use a qualified dot (.) delimited format such as "address"."zip". Nested attributes within this list may not exceed a depth of 5.

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

      Returns:
      A list of column names and/or nested column attributes. When specifying nested attributes, use a qualified dot (.) delimited format such as "address"."zip". Nested attributes within this list may not exceed a depth of 5.

    • columnWildcard

      public final ColumnWildcard columnWildcard()

      A wildcard with exclusions.

      You must specify either a ColumnNames list or the ColumnWildCard.

      Returns:
      A wildcard with exclusions.

      You must specify either a ColumnNames list or the ColumnWildCard.

    • versionId

      public final String versionId()

      The ID of the data cells filter version.

      Returns:
      The ID of the data cells filter version.

    • toBuilder

      public DataCellsFilter.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<DataCellsFilter.Builder,DataCellsFilter>
      Returns:
      a builder for type T

    • builder

      public static DataCellsFilter.Builder builder()

    • serializableBuilderClass

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