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

Interface GetPartitionsRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<GetPartitionsRequest.Builder,GetPartitionsRequest>, GlueRequest.Builder, SdkBuilder<GetPartitionsRequest.Builder,GetPartitionsRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
GetPartitionsRequest
public static interface GetPartitionsRequest.Builder extends GlueRequest.Builder, SdkPojo, CopyableBuilder<GetPartitionsRequest.Builder,GetPartitionsRequest>

  • Method Details

    • catalogId

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

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

    • databaseName

      GetPartitionsRequest.Builder databaseName(String databaseName)

      The name of the catalog database where the partitions reside.

      Parameters:
      databaseName - The name of the catalog database where the partitions reside.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tableName

      GetPartitionsRequest.Builder tableName(String tableName)

      The name of the partitions' table.

      Parameters:
      tableName - The name of the partitions' table.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • expression

      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.

      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:

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

    • nextToken

      GetPartitionsRequest.Builder nextToken(String nextToken)

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

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

    • segment

      GetPartitionsRequest.Builder segment(Segment segment)

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

      Parameters:
      segment - The segment of the table's partitions to scan in this request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • segment

      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 the Segment.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).

      Parameters:
      segment - a consumer that will call methods on Segment.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • maxResults

      GetPartitionsRequest.Builder maxResults(Integer maxResults)

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

      Parameters:
      maxResults - The maximum number of partitions to return in a single response.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • excludeColumnSchema

      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.

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

    • transactionId

      GetPartitionsRequest.Builder transactionId(String transactionId)

      The transaction ID at which to read the partition contents.

      Parameters:
      transactionId - The transaction ID at which to read the partition contents.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • queryAsOfTime

      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.

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

    • overrideConfiguration

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

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