Package software.amazon.awssdk.services.glue.model

Class GetPartitionsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.glue.model.GlueRequest

software.amazon.awssdk.services.glue.model.GetPartitionsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetPartitionsRequest.Builder,GetPartitionsRequest>

@Generated("software.amazon.awssdk:codegen")
public final class GetPartitionsRequest
extends GlueRequest
implements ToCopyableBuilder<GetPartitionsRequest.Builder,GetPartitionsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetPartitionsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static GetPartitionsRequest.Builder	builder()
String	catalogId()	The ID of the Data Catalog where the partitions in question reside.
String	databaseName()	The name of the catalog database where the partitions reside.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Boolean	excludeColumnSchema()	When true, specifies not returning the partition column schema.
String	expression()	An expression that filters the partitions to be returned.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxResults()	The maximum number of partitions to return in a single response.
String	nextToken()	A continuation token, if this is not the first call to retrieve these partitions.
Instant	queryAsOfTime()	The time as of when to read the partition contents.
List<SdkField<?>>	sdkFields()
Segment	segment()	The segment of the table's partitions to scan in this request.
static Class<? extends GetPartitionsRequest.Builder>	serializableBuilderClass()
String	tableName()	The name of the partitions' table.
GetPartitionsRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	transactionId()	The transaction ID at which to read the partition contents.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

catalogId

public final 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.

Returns:

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.

databaseName

public final String databaseName()

The name of the catalog database where the partitions reside.

Returns:

The name of the catalog database where the partitions reside.

tableName

public final String tableName()

The name of the partitions' table.

Returns:

The name of the partitions' table.

expression

public final 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.

AND, OR, IN, BETWEEN, LIKE, NOT, IS NULL

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:

Returns:

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.

AND, OR, IN, BETWEEN, LIKE, NOT, IS NULL

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:

nextToken

public final String nextToken()

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

Returns:

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

segment

public final Segment segment()

The segment of the table's partitions to scan in this request.

Returns:

The segment of the table's partitions to scan in this request.

maxResults

public final Integer maxResults()

The maximum number of partitions to return in a single response.

Returns:

The maximum number of partitions to return in a single response.

excludeColumnSchema

public final 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.

Returns:

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.

transactionId

public final String transactionId()

The transaction ID at which to read the partition contents.

Returns:

The transaction ID at which to read the partition contents.

queryAsOfTime

public final 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.

Returns:

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.

toBuilder

public GetPartitionsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetPartitionsRequest.Builder,GetPartitionsRequest>

Specified by:

toBuilder in class GlueRequest

builder

public static GetPartitionsRequest.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo