azure-storage-common\src\Common\Models\ServiceOptions.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
2017 Microsoft Corporation  
License
https://github.com/azure/azure-storage-php/LICENSE  
Link
https://github.com/azure/azure-storage-php  
Package
MicrosoftAzure\Storage\Common\Models  

\MicrosoftAzure\Storage\Common\Models\ServiceOptions

Package: MicrosoftAzure\Storage\Common\Models
This class provides the base structure of service options, granting user to send with different options for each individual API call.
Children
\MicrosoftAzure\Storage\Blob\Models\BlobServiceOptions
\MicrosoftAzure\Storage\Blob\Models\SetBlobTierOptions
\MicrosoftAzure\Storage\Table\Models\TableServiceOptions
\MicrosoftAzure\Storage\Queue\Models\QueueServiceOptions
\MicrosoftAzure\Storage\File\Models\FileServiceOptions
Author
Azure Storage PHP SDK  
Category
Microsoft  
Copyright
2017 Microsoft Corporation  
License
https://github.com/azure/azure-storage-php/LICENSE  
Link
https://github.com/azure/azure-storage-php  

Methods

methodpublic__construct( $options = null) : void

Initialize the properties to default value.

Parameters
NameTypeDescription
$options
methodpublicgenerateRequestOptions(array $options) : array

Generate request options using the input options and saved properties.

Parameters
NameTypeDescription
$optionsarray

The options to be merged for the request options.

Returns
TypeDescription
array
methodpublicgetDecodeContent() : boolean

Gets the decodeContent value

Returns
TypeDescription
boolean
methodpublicgetIsStreaming() : boolean

Gets the isStreaming value

Returns
TypeDescription
boolean
methodpublicgetLocationMode() : string

Gets the locationMode value

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

Gets the middleware stack

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

Gets the middlewares.

Returns
TypeDescription
array
methodpublicgetNumberOfConcurrency() : integer

Gets the number of concurrency value

Returns
TypeDescription
integer
methodpublicgetTimeout() : string

Gets the timeout value

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

Push a middleware into the middlewares.

Parameters
NameTypeDescription
$middlewarecallable | \MicrosoftAzure\Storage\Common\Middlewares\IMiddleware

middleware to be pushed.

methodpublicsetDecodeContent(boolean $decodeContent) : void

Sets decodeContent.

Parameters
NameTypeDescription
$decodeContentboolean

value.

methodpublicsetIsStreaming(boolean $isStreaming) : void

Sets isStreaming.

Parameters
NameTypeDescription
$isStreamingboolean

value.

methodpublicsetLocationMode(string $locationMode) : void

Sets locationMode.

Parameters
NameTypeDescription
$locationModestring

value.

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

Sets the middleware stack.

Parameters
NameTypeDescription
$middlewareStack\MicrosoftAzure\Storage\Common\Middlewares\MiddlewareStack

value.

methodpublicsetMiddlewares(array $middlewares) : void

Sets middlewares.

Parameters
NameTypeDescription
$middlewaresarray

value.

methodpublicsetNumberOfConcurrency(integer $numberOfConcurrency) : void

Sets number of concurrency.

Parameters
NameTypeDescription
$numberOfConcurrencyinteger

value.

methodpublicsetTimeout(string $timeout) : void

Sets timeout.

Parameters
NameTypeDescription
$timeoutstring

value.

Documentation was generated by phpDocumentor 2.9.1.