Interface GetTableObjectsRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<GetTableObjectsRequest.Builder,GetTableObjectsRequest>, LakeFormationRequest.Builder, SdkBuilder<GetTableObjectsRequest.Builder,GetTableObjectsRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
GetTableObjectsRequest
@Mutable @NotThreadSafe public static interface GetTableObjectsRequest.Builder extends LakeFormationRequest.Builder, SdkPojo, CopyableBuilder<GetTableObjectsRequest.Builder,GetTableObjectsRequest>

  • Method Details

    • catalogId

      GetTableObjectsRequest.Builder catalogId(String catalogId)

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

      Parameters:
      catalogId - The catalog containing the governed table. Defaults to the caller’s account.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • databaseName

      GetTableObjectsRequest.Builder databaseName(String databaseName)

      The database containing the governed table.

      Parameters:
      databaseName - The database containing the governed table.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tableName

      GetTableObjectsRequest.Builder tableName(String tableName)

      The governed table for which to retrieve objects.

      Parameters:
      tableName - The governed table for which to retrieve objects.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • transactionId

      GetTableObjectsRequest.Builder transactionId(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • queryAsOfTime

      GetTableObjectsRequest.Builder queryAsOfTime(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • partitionPredicate

      GetTableObjectsRequest.Builder partitionPredicate(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • maxResults

      GetTableObjectsRequest.Builder maxResults(Integer maxResults)

      Specifies how many values to return in a page.

      Parameters:
      maxResults - Specifies how many values to return in a page.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      GetTableObjectsRequest.Builder nextToken(String nextToken)

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

      Parameters:
      nextToken - A continuation token if this is not the first call to retrieve these objects.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      GetTableObjectsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      GetTableObjectsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.