public class QueryTablesOptions extends TableServiceOptions
queryTables
request. These options include a filter to limit results to tables with certain properties, the next table name
continuation token to use to resume the query tables request from, and a prefix string to match table names with.| Constructor and Description |
|---|
QueryTablesOptions() |
| Modifier and Type | Method and Description |
|---|---|
Filter |
getFilter()
Gets the filter to use to limit table entries returned set in this
TableServiceOptions instance. |
String |
getNextTableName()
Gets the next table name continuation token set in this
TableServiceOptions instance. |
String |
getPrefix()
Gets the prefix filter associated with this
QueryTablesOptions instance. |
QueryTablesOptions |
setFilter(Filter filter)
Sets the filter to use to limit table entries returned by the request to those that match the filter properties.
|
QueryTablesOptions |
setNextTableName(String nextTableName)
Sets the next table name continuation token to resume a query tables request with.
|
QueryTablesOptions |
setPrefix(String prefix)
Sets the optional table name prefix filter value to use in a request.
|
public Filter getFilter()
TableServiceOptions instance.Filter instance containing the filter options to use.public QueryTablesOptions setFilter(Filter filter)
This value only affects calls made on methods where this QueryTablesOptions instance is passed as a
parameter.
filter - A Filter instance containing the filter options to use.QueryTablesOptions instance.public String getNextTableName()
TableServiceOptions instance.String containing the next table name continuation token to use to resume a query tables
request with.public QueryTablesOptions setNextTableName(String nextTableName)
A query against the Table service may return a maximum of 1,000 items at one time and may execute for a maximum of five seconds. If the result set contains more than 1,000 items, if the query did not complete within five seconds, or if the query crosses the partition boundary, the response includes values which provide the client with continuation tokens to use in order to resume the query at the next item in the result set.
Use the QueryTablesResult.getNextTableName() method on the result of a query tables request to determine
if there are more results to retrieve. If so, pass the value returned as the nextTableName parameter to
this method to set the next table name continuation token option, and resume the query with another call to
TableContract.queryTables(QueryTablesOptions) to get the next set of results.
It is possible for a query to return no results but to still return a continuation token.
This value only affects calls made on methods where this QueryTablesOptions instance is passed as a
parameter.
nextTableName - A String containing the next table name continuation token to use to resume a query tables
request with.QueryTablesOptions instance.public String getPrefix()
QueryTablesOptions instance. This value is used to return
only tables from the storage account with names that begin with the prefix in the response to a query tables
request.String containing the prefix used to filter the table names returned, if any.public QueryTablesOptions setPrefix(String prefix)
The prefix value only affects calls made on methods where this QueryTablesOptions instance is
passed as a parameter.
prefix - A String containing a prefix to use to filter the table names returned./**
* Copyright Microsoft Corporation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/