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

Interface GetUnfilteredPartitionsMetadataRequest.Builder

    • Method Detail

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

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

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