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

Show:

inherited

Classes
- \MicrosoftAzure\Storage\Table\Models\QueryEntitiesOptions

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
jump to top

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

__construct() : void

Constructs new QueryEntitiesOptions object.

__construct( $options = null) : void

inherited

Initialize the properties to default value.

Inherited from:

Parameters

Name	Type	Description
$options

addSelectField(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

Name	Type	Description
$field	string	The value of the field.

generateRequestOptions(array $options) : array

inherited

Generate request options using the input options and saved properties.

Inherited from:

Parameters

Name	Type	Description
$options	array	The options to be merged for the request options.

Returns

Type	Description
array

getAccept() : string

inherited

Gets accept content type.

Inherited from:

Returns

Type	Description
string

getContinuationToken() : \MicrosoftAzure\Storage\Table\Models\TableContinuationToken

inherited

Getter for continuationToken

Inherited from:

Returns

Type	Description
\MicrosoftAzure\Storage\Table\Models\TableContinuationToken

getDecodeContent() : boolean

inherited

Gets the decodeContent value

Inherited from:

Returns

Type	Description
boolean

getFilter() : \MicrosoftAzure\Storage\Table\Models\Filters\Filter

Gets filter.

Returns

Type	Description
\MicrosoftAzure\Storage\Table\Models\Filters\Filter

getIsStreaming() : boolean

inherited

Gets the isStreaming value

Inherited from:

Returns

Type	Description
boolean

getLocation() : string | null

inherited

Gets for location for previous request.

Inherited from:

Returns

Type	Description
string \| null

getLocationMode() : string

inherited

Gets the locationMode value

Inherited from:

Returns

Type	Description
string

getMiddlewareStack() : \MicrosoftAzure\Storage\Common\Middlewares\MiddlewareStack

inherited

Gets the middleware stack

Inherited from:

Returns

Type	Description
\MicrosoftAzure\Storage\Common\Middlewares\MiddlewareStack

getMiddlewares() : array

inherited

Gets the middlewares.

Inherited from:

Returns

Type	Description
array

getNextPartitionKey() : string | null

inherited

Gets entity next partition key.

Inherited from:

Returns

Type	Description
string \| null

getNextRowKey() : string | null

inherited

Gets entity next row key.

Inherited from:

Returns

Type	Description
string \| null

getNextTableName() : string | null

inherited

Gets nextTableName

Inherited from:

Returns

Type	Description
string \| null

getNumberOfConcurrency() : integer

inherited

Gets the number of concurrency value

Inherited from:

Returns

Type	Description
integer

getQuery() : \MicrosoftAzure\Storage\Table\Models\Query

Gets query.

Returns

Type	Description
\MicrosoftAzure\Storage\Table\Models\Query

getSelectFields() : array

Gets selectFields.

Returns

Type	Description
array

getTimeout() : string

inherited

Gets the timeout value

Inherited from:

Returns

Type	Description
string

getTop() : integer

Gets top.

Returns

Type	Description
integer

pushMiddleware(callable | \MicrosoftAzure\Storage\Common\Middlewares\IMiddleware $middleware) : void

inherited

Push a middleware into the middlewares.

Inherited from:

Parameters

Name	Type	Description
$middleware	callable \| \MicrosoftAzure\Storage\Common\Middlewares\IMiddleware	middleware to be pushed.

setAccept(string $accept) : void

inherited

Sets accept content type.

Inherited from:

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

Parameters

Name	Type	Description
$accept	string	The accept content type to be set.

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

inherited

Setter for continuationToken

Inherited from:

Parameters

Name	Type	Description
$continuationToken	\MicrosoftAzure\Storage\Table\Models\TableContinuationToken	the continuation token to be set.

setDecodeContent(boolean $decodeContent) : void

inherited

Sets decodeContent.

Inherited from:

Parameters

Name	Type	Description
$decodeContent	boolean	value.

setFilter(\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

Name	Type	Description
$filter	\MicrosoftAzure\Storage\Table\Models\Filters\Filter	value.

setIsStreaming(boolean $isStreaming) : void

inherited

Sets isStreaming.

Inherited from:

Parameters

Name	Type	Description
$isStreaming	boolean	value.

setLocationMode(string $locationMode) : void

inherited

Sets locationMode.

Inherited from:

Parameters

Name	Type	Description
$locationMode	string	value.

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

inherited

Sets the middleware stack.

Inherited from:

Parameters

Name	Type	Description
$middlewareStack	\MicrosoftAzure\Storage\Common\Middlewares\MiddlewareStack	value.

setMiddlewares(array $middlewares) : void

inherited

Sets middlewares.

Inherited from:

Parameters

Name	Type	Description
$middlewares	array	value.

setNextPartitionKey(string $nextPartitionKey) : void

inherited

Sets entity next partition key.

Inherited from:

Parameters

Name	Type	Description
$nextPartitionKey	string	The entity next partition key value.

setNextRowKey(string $nextRowKey) : void

inherited

Sets entity next row key.

Inherited from:

Parameters

Name	Type	Description
$nextRowKey	string	The entity next row key value.

setNextTableName(string $nextTableName) : void

inherited

Sets nextTableName

Inherited from:

Parameters

Name	Type	Description
$nextTableName	string	value

setNumberOfConcurrency(integer $numberOfConcurrency) : void

inherited

Sets number of concurrency.

Inherited from:

Parameters

Name	Type	Description
$numberOfConcurrency	integer	value.

setQuery(\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

Name	Type	Description
$query	\MicrosoftAzure\Storage\Table\Models\Query	The query instance.

setSelectFields(array $selectFields = null) : void

Sets selectFields.

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

Parameters

Name	Type	Description
$selectFields	array	value.

setTimeout(string $timeout) : void

inherited

Sets timeout.

Inherited from:

Parameters

Name	Type	Description
$timeout	string	value.

setTop(integer $top) : void

Sets top.

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

Parameters

Name	Type	Description
$top	integer	value.

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

\MicrosoftAzure\Storage\Table\Models\QueryEntitiesOptionsjump to top

Methods

\MicrosoftAzure\Storage\Table\Models\QueryEntitiesOptions
jump to top