@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class GetPartitionsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP| Constructor and Description |
|---|
GetPartitionsRequest() |
| Modifier and Type | Method and Description |
|---|---|
GetPartitionsRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
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.
|
Boolean |
getExcludeColumnSchema()
When true, specifies not returning the partition column schema.
|
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.
|
Date |
getQueryAsOfTime()
The time as of when to read the partition contents.
|
Segment |
getSegment()
The segment of the table's partitions to scan in this request.
|
String |
getTableName()
The name of the partitions' table.
|
String |
getTransactionId()
The transaction ID at which to read the partition contents.
|
int |
hashCode() |
Boolean |
isExcludeColumnSchema()
When true, specifies not returning the partition column schema.
|
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 |
setExcludeColumnSchema(Boolean excludeColumnSchema)
When true, specifies not returning the partition column schema.
|
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 |
setQueryAsOfTime(Date queryAsOfTime)
The time as of when to read the partition contents.
|
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.
|
void |
setTransactionId(String transactionId)
The transaction ID at which to read the partition contents.
|
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 |
withExcludeColumnSchema(Boolean excludeColumnSchema)
When true, specifies not returning the partition column schema.
|
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 |
withQueryAsOfTime(Date queryAsOfTime)
The time as of when to read the partition contents.
|
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.
|
GetPartitionsRequest |
withTransactionId(String transactionId)
The transaction ID at which to read the partition contents.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeoutpublic void setCatalogId(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.
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.public String getCatalogId()
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.
public GetPartitionsRequest withCatalogId(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.
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.public void setDatabaseName(String databaseName)
The name of the catalog database where the partitions reside.
databaseName - The name of the catalog database where the partitions reside.public String getDatabaseName()
The name of the catalog database where the partitions reside.
public GetPartitionsRequest withDatabaseName(String databaseName)
The name of the catalog database where the partitions reside.
databaseName - The name of the catalog database where the partitions reside.public void setTableName(String tableName)
The name of the partitions' table.
tableName - The name of the partitions' table.public String getTableName()
The name of the partitions' table.
public GetPartitionsRequest withTableName(String tableName)
The name of the partitions' table.
tableName - The name of the partitions' table.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.
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:
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.
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:
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.
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:
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.
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:
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.
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:
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.
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:
public void setNextToken(String nextToken)
A continuation token, if this is not the first call to retrieve these partitions.
nextToken - A continuation token, if this is not the first call to retrieve these partitions.public String getNextToken()
A continuation token, if this is not the first call to retrieve these partitions.
public GetPartitionsRequest withNextToken(String nextToken)
A continuation token, if this is not the first call to retrieve these partitions.
nextToken - A continuation token, if this is not the first call to retrieve these partitions.public void setSegment(Segment segment)
The segment of the table's partitions to scan in this request.
segment - The segment of the table's partitions to scan in this request.public Segment getSegment()
The segment of the table's partitions to scan in this request.
public GetPartitionsRequest withSegment(Segment segment)
The segment of the table's partitions to scan in this request.
segment - The segment of the table's partitions to scan in this request.public void setMaxResults(Integer maxResults)
The maximum number of partitions to return in a single response.
maxResults - The maximum number of partitions to return in a single response.public Integer getMaxResults()
The maximum number of partitions to return in a single response.
public GetPartitionsRequest withMaxResults(Integer maxResults)
The maximum number of partitions to return in a single response.
maxResults - The maximum number of partitions to return in a single response.public void setExcludeColumnSchema(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.
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.public Boolean getExcludeColumnSchema()
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.
public GetPartitionsRequest withExcludeColumnSchema(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.
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.public Boolean isExcludeColumnSchema()
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.
public void setTransactionId(String transactionId)
The transaction ID at which to read the partition contents.
transactionId - The transaction ID at which to read the partition contents.public String getTransactionId()
The transaction ID at which to read the partition contents.
public GetPartitionsRequest withTransactionId(String transactionId)
The transaction ID at which to read the partition contents.
transactionId - The transaction ID at which to read the partition contents.public void setQueryAsOfTime(Date 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.
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.public Date getQueryAsOfTime()
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.
TransactionId.public GetPartitionsRequest withQueryAsOfTime(Date 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.
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.public String toString()
toString in class ObjectObject.toString()public GetPartitionsRequest clone()
AmazonWebServiceRequestclone in class AmazonWebServiceRequestObject.clone()