public static interface GetPartitionsRequest.Builder extends GlueRequest.Builder, SdkPojo, CopyableBuilder<GetPartitionsRequest.Builder,GetPartitionsRequest>
| Modifier and Type | Method and Description |
|---|---|
GetPartitionsRequest.Builder |
catalogId(String catalogId)
The ID of the Data Catalog where the partitions in question reside.
|
GetPartitionsRequest.Builder |
databaseName(String databaseName)
The name of the catalog database where the partitions reside.
|
GetPartitionsRequest.Builder |
excludeColumnSchema(Boolean excludeColumnSchema)
When true, specifies not returning the partition column schema.
|
GetPartitionsRequest.Builder |
expression(String expression)
An expression that filters the partitions to be returned.
|
GetPartitionsRequest.Builder |
maxResults(Integer maxResults)
The maximum number of partitions to return in a single response.
|
GetPartitionsRequest.Builder |
nextToken(String nextToken)
A continuation token, if this is not the first call to retrieve these partitions.
|
GetPartitionsRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
GetPartitionsRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
GetPartitionsRequest.Builder |
queryAsOfTime(Instant queryAsOfTime)
The time as of when to read the partition contents.
|
default GetPartitionsRequest.Builder |
segment(Consumer<Segment.Builder> segment)
The segment of the table's partitions to scan in this request.
|
GetPartitionsRequest.Builder |
segment(Segment segment)
The segment of the table's partitions to scan in this request.
|
GetPartitionsRequest.Builder |
tableName(String tableName)
The name of the partitions' table.
|
GetPartitionsRequest.Builder |
transactionId(String transactionId)
The transaction ID at which to read the partition contents.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildGetPartitionsRequest.Builder catalogId(String catalogId)
The ID of the Data Catalog where the partitions in question reside. If none is provided, the Amazon Web Services account ID is used by default.
catalogId - The ID of the Data Catalog where the partitions in question reside. If none is provided, the Amazon
Web Services account ID is used by default.GetPartitionsRequest.Builder databaseName(String databaseName)
The name of the catalog database where the partitions reside.
databaseName - The name of the catalog database where the partitions reside.GetPartitionsRequest.Builder tableName(String tableName)
The name of the partitions' table.
tableName - The name of the partitions' table.GetPartitionsRequest.Builder expression(String expression)
An expression that filters the partitions to be returned.
The expression uses SQL syntax similar to the SQL WHERE filter clause. The SQL statement parser
JSQLParser parses the expression.
Operators: The following are the operators that you can use in the Expression API call:
Checks whether the values of the two operands are equal; if yes, then the condition becomes true.
Example: Assume 'variable a' holds 10 and 'variable b' holds 20.
(a = b) is not true.
Checks whether the values of two operands are equal; if the values are not equal, then the condition becomes true.
Example: (a < > b) is true.
Checks whether the value of the left operand is greater than the value of the right operand; if yes, then the condition becomes true.
Example: (a > b) is not true.
Checks whether the value of the left operand is less than the value of the right operand; if yes, then the condition becomes true.
Example: (a < b) is true.
Checks whether the value of the left operand is greater than or equal to the value of the right operand; if yes, then the condition becomes true.
Example: (a >= b) is not true.
Checks whether the value of the left operand is less than or equal to the value of the right operand; if yes, then the condition becomes true.
Example: (a <= b) is true.
Logical operators.
Supported Partition Key Types: The following are the supported partition keys.
string
date
timestamp
int
bigint
long
tinyint
smallint
decimal
If an type is encountered that is not valid, an exception is thrown.
The following list shows the valid operators on each type. When you define a crawler, the
partitionKey type is created as a STRING, to be compatible with the catalog
partitions.
Sample API Call:
expression - An expression that filters the partitions to be returned.
The expression uses SQL syntax similar to the SQL WHERE filter clause. The SQL statement
parser JSQLParser parses the expression.
Operators: The following are the operators that you can use in the Expression API
call:
Checks whether the values of the two operands are equal; if yes, then the condition becomes true.
Example: Assume 'variable a' holds 10 and 'variable b' holds 20.
(a = b) is not true.
Checks whether the values of two operands are equal; if the values are not equal, then the condition becomes true.
Example: (a < > b) is true.
Checks whether the value of the left operand is greater than the value of the right operand; if yes, then the condition becomes true.
Example: (a > b) is not true.
Checks whether the value of the left operand is less than the value of the right operand; if yes, then the condition becomes true.
Example: (a < b) is true.
Checks whether the value of the left operand is greater than or equal to the value of the right operand; if yes, then the condition becomes true.
Example: (a >= b) is not true.
Checks whether the value of the left operand is less than or equal to the value of the right operand; if yes, then the condition becomes true.
Example: (a <= b) is true.
Logical operators.
Supported Partition Key Types: The following are the supported partition keys.
string
date
timestamp
int
bigint
long
tinyint
smallint
decimal
If an type is encountered that is not valid, an exception is thrown.
The following list shows the valid operators on each type. When you define a crawler, the
partitionKey type is created as a STRING, to be compatible with the catalog
partitions.
Sample API Call:
GetPartitionsRequest.Builder nextToken(String nextToken)
A continuation token, if this is not the first call to retrieve these partitions.
nextToken - A continuation token, if this is not the first call to retrieve these partitions.GetPartitionsRequest.Builder segment(Segment segment)
The segment of the table's partitions to scan in this request.
segment - The segment of the table's partitions to scan in this request.default GetPartitionsRequest.Builder segment(Consumer<Segment.Builder> segment)
The segment of the table's partitions to scan in this request.
This is a convenience method that creates an instance of theSegment.Builder avoiding the need to
create one manually via Segment.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its result is
passed to segment(Segment).
segment - a consumer that will call methods on Segment.Buildersegment(Segment)GetPartitionsRequest.Builder maxResults(Integer maxResults)
The maximum number of partitions to return in a single response.
maxResults - The maximum number of partitions to return in a single response.GetPartitionsRequest.Builder excludeColumnSchema(Boolean excludeColumnSchema)
When true, specifies not returning the partition column schema. Useful when you are interested only in other partition attributes such as partition values or location. This approach avoids the problem of a large response by not returning duplicate data.
excludeColumnSchema - When true, specifies not returning the partition column schema. Useful when you are interested only in
other partition attributes such as partition values or location. This approach avoids the problem of a
large response by not returning duplicate data.GetPartitionsRequest.Builder transactionId(String transactionId)
The transaction ID at which to read the partition contents.
transactionId - The transaction ID at which to read the partition contents.GetPartitionsRequest.Builder queryAsOfTime(Instant queryAsOfTime)
The time as of when to read the partition contents. If not set, the most recent transaction commit time will
be used. Cannot be specified along with TransactionId.
queryAsOfTime - The time as of when to read the partition contents. If not set, the most recent transaction commit
time will be used. Cannot be specified along with TransactionId.GetPartitionsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderGetPartitionsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2023. All rights reserved.