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>

  • Method Details

    • 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()
      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 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      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 final 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.