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

Interface GetUnfilteredPartitionsMetadataRequest.Builder

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

  • Method Details

    • region

      GetUnfilteredPartitionsMetadataRequest.Builder region(String region)

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

      Parameters:
      region - Specified only if the base tables belong to a different Amazon Web Services Region.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • catalogId

      GetUnfilteredPartitionsMetadataRequest.Builder catalogId(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.

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

    • databaseName

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

      GetUnfilteredPartitionsMetadataRequest.Builder tableName(String tableName)

      The name of the table that contains the partition.

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

    • expression

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

      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • auditContext

      GetUnfilteredPartitionsMetadataRequest.Builder auditContext(AuditContext auditContext)

      A structure containing Lake Formation audit context information.

      Parameters:
      auditContext - A structure containing Lake Formation audit context information.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • auditContext

      default GetUnfilteredPartitionsMetadataRequest.Builder auditContext(Consumer<AuditContext.Builder> auditContext)

      A structure containing Lake Formation audit context information.

      This is a convenience method that creates an instance of the AuditContext.Builder avoiding the need to create one manually via AuditContext.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to auditContext(AuditContext).

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

    • supportedPermissionTypesWithStrings

      GetUnfilteredPartitionsMetadataRequest.Builder supportedPermissionTypesWithStrings(Collection<String> supportedPermissionTypes)

      A list of supported permission types.

      Parameters:
      supportedPermissionTypes - A list of supported permission types.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • supportedPermissionTypesWithStrings

      GetUnfilteredPartitionsMetadataRequest.Builder supportedPermissionTypesWithStrings(String... supportedPermissionTypes)

      A list of supported permission types.

      Parameters:
      supportedPermissionTypes - A list of supported permission types.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • supportedPermissionTypes

      GetUnfilteredPartitionsMetadataRequest.Builder supportedPermissionTypes(Collection<PermissionType> supportedPermissionTypes)

      A list of supported permission types.

      Parameters:
      supportedPermissionTypes - A list of supported permission types.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • supportedPermissionTypes

      GetUnfilteredPartitionsMetadataRequest.Builder supportedPermissionTypes(PermissionType... supportedPermissionTypes)

      A list of supported permission types.

      Parameters:
      supportedPermissionTypes - A list of supported permission types.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

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

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

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

    • querySessionContext

      GetUnfilteredPartitionsMetadataRequest.Builder querySessionContext(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.

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

    • querySessionContext

      default GetUnfilteredPartitionsMetadataRequest.Builder querySessionContext(Consumer<QuerySessionContext.Builder> 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.

      This is a convenience method that creates an instance of the QuerySessionContext.Builder avoiding the need to create one manually via QuerySessionContext.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to querySessionContext(QuerySessionContext).

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

    • overrideConfiguration

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

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