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(value="software.amazon.awssdk:codegen")
public final class GetPartitionsRequest
extends GlueRequest
implements ToCopyableBuilder<GetPartitionsRequest.Builder,GetPartitionsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetPartitionsRequest.Builder

Method Summary

Modifier and Type	Method and 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)
String	expression() An expression filtering the partitions to be returned.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
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.
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() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

catalogId

public String catalogId()

The ID of the Data Catalog where the partitions in question reside. If none is supplied, the AWS account ID is used by default.

Returns:

The ID of the Data Catalog where the partitions in question reside. If none is supplied, the AWS account ID is used by default.

databaseName

public 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 String tableName()

The name of the partitions' table.

Returns:

The name of the partitions' table.

expression

public String expression()

An expression filtering 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 if the values of the two operands are equal or not; if yes, then the condition becomes true.

Example: Assume 'variable a' holds 10 and 'variable b' holds 20.

(a = b) is not true.

< >

Checks if the values of two operands are equal or not; if the values are not equal, then the condition becomes true.

Example: (a < > b) is true.

>

Checks if 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 if 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 if 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 if 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 the supported partition keys.

• string

• date

• timestamp

• int

• bigint

• long

• tinyint

• smallint

• decimal

If an invalid type is encountered, 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 filtering 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 if the values of the two operands are equal or not; if yes, then the condition becomes true.

Example: Assume 'variable a' holds 10 and 'variable b' holds 20.

(a = b) is not true.

< >

Checks if the values of two operands are equal or not; if the values are not equal, then the condition becomes true.

Example: (a < > b) is true.

>

Checks if 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 if 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 if 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 if 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 the supported partition keys.

• string

• date

• timestamp

• int

• bigint

• long

• tinyint

• smallint

• decimal

If an invalid type is encountered, 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 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 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 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.

toBuilder

public GetPartitionsRequest.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<GetPartitionsRequest.Builder,GetPartitionsRequest>

Specified by:

toBuilder in class GlueRequest

Returns:

a builder for type T

builder

public static GetPartitionsRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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