azure-storage-table\src\Table\Models\QueryEntitiesOptions.php

Show: PublicProtectedPrivateinherited
Table of Contents
LICENSE: The MIT License (the "License") you may not use this file except in compliance with the License.

You may obtain a copy of the License at https://github.com/azure/azure-storage-php/LICENSE

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.

PHP version 5

Author
Azure Storage PHP SDK  
Category
Microsoft  
Copyright
2016 Microsoft Corporation  
License
https://github.com/azure/azure-storage-php/LICENSE  
Link
https://github.com/azure/azure-storage-php  
Package
MicrosoftAzure\Storage\Table\Models  

\MicrosoftAzure\Storage\Table\Models\QueryEntitiesOptions

Package: MicrosoftAzure\Storage\Table\Models
Holds optional parameters for queryEntities API
Parent(s)
\MicrosoftAzure\Storage\Table\Models\TableServiceOptions < \MicrosoftAzure\Storage\Common\Models\ServiceOptions
Author
Azure Storage PHP SDK  
Category
Microsoft  
Copyright
2016 Microsoft Corporation  
Inherited_from
\MicrosoftAzure\Storage\Table\Models\TableServiceOptions  
License
https://github.com/azure/azure-storage-php/LICENSE  
Link
https://github.com/azure/azure-storage-php  

Methods

methodpublic__construct() : void

Constructs new QueryEntitiesOptions object.

methodpublic__construct( $options = null) : void
inherited

Initialize the properties to default value.

Inherited from:
Parameters
NameTypeDescription
$options
methodpublicaddSelectField(string $field) : void

Adds a field to select fields.

You can either use this individual function or use setQuery to set the whole query object.

Parameters
NameTypeDescription
$fieldstring

The value of the field.

methodpublicgenerateRequestOptions(array $options) : array
inherited

Generate request options using the input options and saved properties.

Inherited from:
Parameters
NameTypeDescription
$optionsarray

The options to be merged for the request options.

Returns
TypeDescription
array
methodpublicgetAccept() : string
inherited

Gets accept content type.

Inherited from:
Returns
TypeDescription
string
methodpublicgetContinuationToken() : \MicrosoftAzure\Storage\Table\Models\TableContinuationToken
inherited

Getter for continuationToken

Inherited from:
Returns
TypeDescription
\MicrosoftAzure\Storage\Table\Models\TableContinuationToken
methodpublicgetDecodeContent() : boolean
inherited

Gets the decodeContent value

Inherited from:
Returns
TypeDescription
boolean
methodpublicgetFilter() : \MicrosoftAzure\Storage\Table\Models\Filters\Filter

Gets filter.

Returns
TypeDescription
\MicrosoftAzure\Storage\Table\Models\Filters\Filter
methodpublicgetIsStreaming() : boolean
inherited

Gets the isStreaming value

Inherited from:
Returns
TypeDescription
boolean
methodpublicgetLocation() : string | null
inherited

Gets for location for previous request.

Inherited from:
Returns
TypeDescription
string | null
methodpublicgetLocationMode() : string
inherited

Gets the locationMode value

Inherited from:
Returns
TypeDescription
string
methodpublicgetMiddlewareStack() : \MicrosoftAzure\Storage\Common\Middlewares\MiddlewareStack
inherited

Gets the middleware stack

Inherited from:
Returns
TypeDescription
\MicrosoftAzure\Storage\Common\Middlewares\MiddlewareStack
methodpublicgetMiddlewares() : array
inherited

Gets the middlewares.

Inherited from:
Returns
TypeDescription
array
methodpublicgetNextPartitionKey() : string | null
inherited

Gets entity next partition key.

Inherited from:
Returns
TypeDescription
string | null
methodpublicgetNextRowKey() : string | null
inherited

Gets entity next row key.

Inherited from:
Returns
TypeDescription
string | null
methodpublicgetNextTableName() : string | null
inherited

Gets nextTableName

Inherited from:
Returns
TypeDescription
string | null
methodpublicgetNumberOfConcurrency() : integer
inherited

Gets the number of concurrency value

Inherited from:
Returns
TypeDescription
integer
methodpublicgetQuery() : \MicrosoftAzure\Storage\Table\Models\Query

Gets query.

Returns
TypeDescription
\MicrosoftAzure\Storage\Table\Models\Query
methodpublicgetSelectFields() : array

Gets selectFields.

Returns
TypeDescription
array
methodpublicgetTimeout() : string
inherited

Gets the timeout value

Inherited from:
Returns
TypeDescription
string
methodpublicgetTop() : integer

Gets top.

Returns
TypeDescription
integer
methodpublicpushMiddleware(callable | \MicrosoftAzure\Storage\Common\Middlewares\IMiddleware $middleware) : void
inherited

Push a middleware into the middlewares.

Inherited from:
Parameters
NameTypeDescription
$middlewarecallable | \MicrosoftAzure\Storage\Common\Middlewares\IMiddleware

middleware to be pushed.

methodpublicsetAccept(string $accept) : void
inherited

Sets accept content type.

Inherited from:

AcceptableJSONContentType::NO_METADATA AcceptableJSONContentType::MINIMAL_METADATA AcceptableJSONContentType::FULL_METADATA

Parameters
NameTypeDescription
$acceptstring

The accept content type to be set.

methodpublicsetContinuationToken(\MicrosoftAzure\Storage\Table\Models\TableContinuationToken $continuationToken) : void
inherited

Setter for continuationToken

Inherited from:
Parameters
NameTypeDescription
$continuationToken\MicrosoftAzure\Storage\Table\Models\TableContinuationToken

the continuation token to be set.

methodpublicsetDecodeContent(boolean $decodeContent) : void
inherited

Sets decodeContent.

Inherited from:
Parameters
NameTypeDescription
$decodeContentboolean

value.

methodpublicsetFilter(\MicrosoftAzure\Storage\Table\Models\Filters\Filter $filter) : void

Sets filter.

You can either use this individual function or use setQuery to set the whole query object.

Parameters
NameTypeDescription
$filter\MicrosoftAzure\Storage\Table\Models\Filters\Filter

value.

methodpublicsetIsStreaming(boolean $isStreaming) : void
inherited

Sets isStreaming.

Inherited from:
Parameters
NameTypeDescription
$isStreamingboolean

value.

methodpublicsetLocationMode(string $locationMode) : void
inherited

Sets locationMode.

Inherited from:
Parameters
NameTypeDescription
$locationModestring

value.

methodpublicsetMiddlewareStack(\MicrosoftAzure\Storage\Common\Middlewares\MiddlewareStack $middlewareStack) : void
inherited

Sets the middleware stack.

Inherited from:
Parameters
NameTypeDescription
$middlewareStack\MicrosoftAzure\Storage\Common\Middlewares\MiddlewareStack

value.

methodpublicsetMiddlewares(array $middlewares) : void
inherited

Sets middlewares.

Inherited from:
Parameters
NameTypeDescription
$middlewaresarray

value.

methodpublicsetNextPartitionKey(string $nextPartitionKey) : void
inherited

Sets entity next partition key.

Inherited from:
Parameters
NameTypeDescription
$nextPartitionKeystring

The entity next partition key value.

methodpublicsetNextRowKey(string $nextRowKey) : void
inherited

Sets entity next row key.

Inherited from:
Parameters
NameTypeDescription
$nextRowKeystring

The entity next row key value.

methodpublicsetNextTableName(string $nextTableName) : void
inherited

Sets nextTableName

Inherited from:
Parameters
NameTypeDescription
$nextTableNamestring

value

methodpublicsetNumberOfConcurrency(integer $numberOfConcurrency) : void
inherited

Sets number of concurrency.

Inherited from:
Parameters
NameTypeDescription
$numberOfConcurrencyinteger

value.

methodpublicsetQuery(\MicrosoftAzure\Storage\Table\Models\Query $query) : void

Sets query.

You can either sets the whole query or use the individual query functions like (setTop).

Parameters
NameTypeDescription
$query\MicrosoftAzure\Storage\Table\Models\Query

The query instance.

methodpublicsetSelectFields(array $selectFields = null) : void

Sets selectFields.

You can either use this individual function or use setQuery to set the whole query object.

Parameters
NameTypeDescription
$selectFieldsarray

value.

methodpublicsetTimeout(string $timeout) : void
inherited

Sets timeout.

Inherited from:
Parameters
NameTypeDescription
$timeoutstring

value.

methodpublicsetTop(integer $top) : void

Sets top.

You can either use this individual function or use setQuery to set the whole query object.

Parameters
NameTypeDescription
$topinteger

value.

Documentation was generated by phpDocumentor 2.9.1.