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

Class GetUnfilteredPartitionsMetadataRequest

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.GetUnfilteredPartitionsMetadataRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetUnfilteredPartitionsMetadataRequest.Builder,GetUnfilteredPartitionsMetadataRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetUnfilteredPartitionsMetadataRequest extends GlueRequest implements ToCopyableBuilder<GetUnfilteredPartitionsMetadataRequest.Builder,GetUnfilteredPartitionsMetadataRequest>

  • Method Details

    • region

      public final String region()

      Specified only if the base tables belong to a different Amazon Web Services Region.

      Returns:
      Specified only if the base tables belong to a different Amazon Web Services Region.

    • catalogId

      public final String catalogId()

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

      Returns:
      The ID of the Data Catalog where the partitions in question reside. If none is provided, the AWS 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 table that contains the partition.

      Returns:
      The name of the table that contains the partition.

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

      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.

    • auditContext

      public final AuditContext auditContext()

      A structure containing Lake Formation audit context information.

      Returns:
      A structure containing Lake Formation audit context information.

    • supportedPermissionTypes

      public final List<PermissionType> supportedPermissionTypes()

      A list of supported permission types.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSupportedPermissionTypes() method.

      Returns:
      A list of supported permission types.

    • hasSupportedPermissionTypes

      public final boolean hasSupportedPermissionTypes()
      For responses, this returns true if the service returned a value for the SupportedPermissionTypes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • supportedPermissionTypesAsStrings

      public final List<String> supportedPermissionTypesAsStrings()

      A list of supported permission types.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSupportedPermissionTypes() method.

      Returns:
      A list of supported permission types.

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

    • querySessionContext

      public final QuerySessionContext querySessionContext()

      A structure used as a protocol between query engines and Lake Formation or Glue. Contains both a Lake Formation generated authorization identifier and information from the request's authorization context.

      Returns:
      A structure used as a protocol between query engines and Lake Formation or Glue. Contains both a Lake Formation generated authorization identifier and information from the request's authorization context.

    • toBuilder

      public GetUnfilteredPartitionsMetadataRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<GetUnfilteredPartitionsMetadataRequest.Builder,GetUnfilteredPartitionsMetadataRequest>
      Specified by:
      toBuilder in class GlueRequest

    • builder

      public static GetUnfilteredPartitionsMetadataRequest.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo