Struct aws_sdk_glue::client::fluent_builders::GetPartitions

source ·

pub struct GetPartitions { /* private fields */ }

Expand description

Fluent builder constructing a request to GetPartitions.

Retrieves information about the partitions in a table.

Implementations§

source §

impl GetPartitions

source

pub async fn customize(
self
) -> Result<CustomizableOperation<GetPartitions, AwsResponseRetryClassifier>, SdkError<GetPartitionsError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

source

pub async fn send(
self
) -> Result<GetPartitionsOutput, SdkError<GetPartitionsError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

source

pub fn into_paginator(self) -> GetPartitionsPaginator

Create a paginator for this request

Paginators are used by calling send().await which returns a Stream.

source

pub fn catalog_id(self, input: impl Into<String>) -> Self

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.

source

pub fn set_catalog_id(self, input: Option<String>) -> Self

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.

source

pub fn database_name(self, input: impl Into<String>) -> Self

The name of the catalog database where the partitions reside.

source

pub fn set_database_name(self, input: Option<String>) -> Self

The name of the catalog database where the partitions reside.

source

pub fn table_name(self, input: impl Into<String>) -> Self

The name of the partitions' table.

source

pub fn set_table_name(self, input: Option<String>) -> Self

The name of the partitions' table.

source

pub fn expression(self, input: impl Into<String>) -> Self

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:

source

pub fn set_expression(self, input: Option<String>) -> Self

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:

source

pub fn next_token(self, input: impl Into<String>) -> Self

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

source

pub fn set_next_token(self, input: Option<String>) -> Self

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

source

pub fn segment(self, input: Segment) -> Self

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

source

pub fn set_segment(self, input: Option<Segment>) -> Self

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

source

pub fn max_results(self, input: i32) -> Self

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

source

pub fn set_max_results(self, input: Option<i32>) -> Self

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

source

pub fn exclude_column_schema(self, input: bool) -> Self

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.

source

pub fn set_exclude_column_schema(self, input: Option<bool>) -> Self

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.

source

pub fn transaction_id(self, input: impl Into<String>) -> Self

The transaction ID at which to read the partition contents.

source

pub fn set_transaction_id(self, input: Option<String>) -> Self

The transaction ID at which to read the partition contents.

source

pub fn query_as_of_time(self, input: DateTime) -> Self

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.

source

pub fn set_query_as_of_time(self, input: Option<DateTime>) -> Self

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.