GetPartitionsRequest (AWS Java SDK for AWS Glue 1.11.792 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.glue.model.GetPartitionsRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetPartitionsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

GetPartitionsRequest()

Constructors
Constructor and Description
`GetPartitionsRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GetPartitionsRequest`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getCatalogId()` The ID of the Data Catalog where the partitions in question reside.
`String`	`getDatabaseName()` The name of the catalog database where the partitions reside.
`String`	`getExpression()` An expression that filters the partitions to be returned.
`Integer`	`getMaxResults()` The maximum number of partitions to return in a single response.
`String`	`getNextToken()` A continuation token, if this is not the first call to retrieve these partitions.
`Segment`	`getSegment()` The segment of the table's partitions to scan in this request.
`String`	`getTableName()` The name of the partitions' table.
`int`	`hashCode()`
`void`	`setCatalogId(String catalogId)` The ID of the Data Catalog where the partitions in question reside.
`void`	`setDatabaseName(String databaseName)` The name of the catalog database where the partitions reside.
`void`	`setExpression(String expression)` An expression that filters the partitions to be returned.
`void`	`setMaxResults(Integer maxResults)` The maximum number of partitions to return in a single response.
`void`	`setNextToken(String nextToken)` A continuation token, if this is not the first call to retrieve these partitions.
`void`	`setSegment(Segment segment)` The segment of the table's partitions to scan in this request.
`void`	`setTableName(String tableName)` The name of the partitions' table.
`String`	`toString()` Returns a string representation of this object.
`GetPartitionsRequest`	`withCatalogId(String catalogId)` The ID of the Data Catalog where the partitions in question reside.
`GetPartitionsRequest`	`withDatabaseName(String databaseName)` The name of the catalog database where the partitions reside.
`GetPartitionsRequest`	`withExpression(String expression)` An expression that filters the partitions to be returned.
`GetPartitionsRequest`	`withMaxResults(Integer maxResults)` The maximum number of partitions to return in a single response.
`GetPartitionsRequest`	`withNextToken(String nextToken)` A continuation token, if this is not the first call to retrieve these partitions.
`GetPartitionsRequest`	`withSegment(Segment segment)` The segment of the table's partitions to scan in this request.
`GetPartitionsRequest`	`withTableName(String tableName)` The name of the partitions' table.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GetPartitionsRequest
```
public GetPartitionsRequest()
```
- Method Detail
  - setCatalogId
```
public void setCatalogId(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.
  - getCatalogId
```
public String getCatalogId()
```
    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.
  - withCatalogId
```
public GetPartitionsRequest withCatalogId(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.
  - setDatabaseName
```
public void setDatabaseName(String databaseName)
```
    The name of the catalog database where the partitions reside.
    
    Parameters:
    
    databaseName - The name of the catalog database where the partitions reside.
  - getDatabaseName
```
public String getDatabaseName()
```
    The name of the catalog database where the partitions reside.
    
    Returns:
    
    The name of the catalog database where the partitions reside.
  - withDatabaseName
```
public GetPartitionsRequest withDatabaseName(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.
  - setTableName
```
public void setTableName(String tableName)
```
    The name of the partitions' table.
    
    Parameters:
    
    tableName - The name of the partitions' table.
  - getTableName
```
public String getTableName()
```
    The name of the partitions' table.
    
    Returns:
    
    The name of the partitions' table.
  - withTableName
```
public GetPartitionsRequest withTableName(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.
  - setExpression
```
public void setExpression(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 invalid type is encountered, 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 invalid type is encountered, 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:
  - getExpression
```
public String getExpression()
```
    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 invalid type is encountered, 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 invalid type is encountered, 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:
  - withExpression
```
public GetPartitionsRequest withExpression(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 invalid type is encountered, 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 invalid type is encountered, 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.
  - setNextToken
```
public void setNextToken(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.
  - getNextToken
```
public String getNextToken()
```
    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.
  - withNextToken
```
public GetPartitionsRequest withNextToken(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.
  - setSegment
```
public void setSegment(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.
  - getSegment
```
public Segment getSegment()
```
    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.
  - withSegment
```
public GetPartitionsRequest withSegment(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.
  - setMaxResults
```
public void setMaxResults(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.
  - getMaxResults
```
public Integer getMaxResults()
```
    The maximum number of partitions to return in a single response.
    
    Returns:
    
    The maximum number of partitions to return in a single response.
  - withMaxResults
```
public GetPartitionsRequest withMaxResults(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.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public GetPartitionsRequest clone()
```
    Overrides:
    
    clone in class AmazonWebServiceRequest

Class GetPartitionsRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

GetPartitionsRequest

Method Detail

setCatalogId

getCatalogId

withCatalogId

setDatabaseName

getDatabaseName

withDatabaseName

setTableName

getTableName

withTableName

setExpression

getExpression

withExpression

setNextToken

getNextToken

withNextToken

setSegment

getSegment

withSegment

setMaxResults

getMaxResults

withMaxResults

toString

equals

hashCode

clone