Class GetTableObjectsRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.lakeformation.model.LakeFormationRequest
software.amazon.awssdk.services.lakeformation.model.GetTableObjectsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetTableObjectsRequest.Builder,GetTableObjectsRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetTableObjectsRequest extends LakeFormationRequest implements ToCopyableBuilder<GetTableObjectsRequest.Builder,GetTableObjectsRequest>

  • Method Details

    • catalogId

      public final String catalogId()

      The catalog containing the governed table. Defaults to the caller’s account.

      Returns:
      The catalog containing the governed table. Defaults to the caller’s account.

    • databaseName

      public final String databaseName()

      The database containing the governed table.

      Returns:
      The database containing the governed table.

    • tableName

      public final String tableName()

      The governed table for which to retrieve objects.

      Returns:
      The governed table for which to retrieve objects.

    • transactionId

      public final String transactionId()

      The transaction ID at which to read the governed table contents. If this transaction has aborted, an error is returned. If not set, defaults to the most recent committed transaction. Cannot be specified along with QueryAsOfTime.

      Returns:
      The transaction ID at which to read the governed table contents. If this transaction has aborted, an error is returned. If not set, defaults to the most recent committed transaction. Cannot be specified along with QueryAsOfTime.

    • queryAsOfTime

      public final Instant queryAsOfTime()

      The time as of when to read the governed table contents. If not set, the most recent transaction commit time is used. Cannot be specified along with TransactionId.

      Returns:
      The time as of when to read the governed table contents. If not set, the most recent transaction commit time is used. Cannot be specified along with TransactionId.

    • partitionPredicate

      public final String partitionPredicate()

      A predicate to filter the objects returned based on the partition keys defined in the governed table.

      • The comparison operators supported are: =, >, <, >=, <=

      • The logical operators supported are: AND

      • The data types supported are integer, long, date(yyyy-MM-dd), timestamp(yyyy-MM-dd HH:mm:ssXXX or yyyy-MM-dd HH:mm:ss"), string and decimal.

      Returns:
      A predicate to filter the objects returned based on the partition keys defined in the governed table.

      • The comparison operators supported are: =, >, <, >=, <=

      • The logical operators supported are: AND

      • The data types supported are integer, long, date(yyyy-MM-dd), timestamp(yyyy-MM-dd HH:mm:ssXXX or yyyy-MM-dd HH:mm:ss"), string and decimal.

    • maxResults

      public final Integer maxResults()

      Specifies how many values to return in a page.

      Returns:
      Specifies how many values to return in a page.

    • nextToken

      public final String nextToken()

      A continuation token if this is not the first call to retrieve these objects.

      Returns:
      A continuation token if this is not the first call to retrieve these objects.

    • toBuilder

      public GetTableObjectsRequest.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<GetTableObjectsRequest.Builder,GetTableObjectsRequest>
      Specified by:
      toBuilder in class LakeFormationRequest
      Returns:
      a builder for type T

    • builder

      public static GetTableObjectsRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetTableObjectsRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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