azure-storage-file\src\File\Models\ListSharesOptions.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\File\Models  

\MicrosoftAzure\Storage\File\Models\ListSharesOptions
jump to top

Package: MicrosoftAzure\Storage\File\Models
Options for listFiles API.
Parent(s)
\MicrosoftAzure\Storage\File\Models\FileServiceOptions < \MicrosoftAzure\Storage\Common\Models\ServiceOptions
Author
Azure Storage PHP SDK  
Category
Microsoft  
Copyright
2017 Microsoft Corporation  
Inherited_from
\MicrosoftAzure\Storage\File\Models\FileServiceOptions  
License
https://github.com/azure/azure-storage-php/LICENSE  
Link
https://github.com/azure/azure-storage-php  

Methods

methodpublic__construct( $options = null) : void
inherited

Initialize the properties to default value.

Inherited from:
Parameters
NameTypeDescription
$options
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
methodpublicgetContinuationToken() : \MicrosoftAzure\Storage\Common\Models\MarkerContinuationToken
inherited

Getter for continuationToken

Inherited from:
Returns
TypeDescription
\MicrosoftAzure\Storage\Common\Models\MarkerContinuationToken
methodpublicgetDecodeContent() : boolean
inherited

Gets the decodeContent value

Inherited from:
Returns
TypeDescription
boolean
methodpublicgetIncludeMetadata() : string

Indicates if metadata is included or not.

Returns
TypeDescription
string
methodpublicgetIsStreaming() : boolean
inherited

Gets the isStreaming value

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

Gets for location for previous request.

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

Gets the locationMode value

Inherited from:
Returns
TypeDescription
string
methodpublicgetMaxResults() : string

Gets max results which specifies the maximum number of Shares to return.

If the request does not specify maxresults, or specifies a value greater than 5,000, the server will return up to 5,000 items. If the parameter is set to a value less than or equal to zero, the server will return status code 400 (Bad Request).

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
methodpublicgetNextMarker() : string
inherited

Gets the next marker to list/query items.

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

Gets the number of concurrency value

Inherited from:
Returns
TypeDescription
integer
methodpublicgetPrefix() : string

Gets prefix - filters the results to return only Shares whose name begins with the specified prefix.

Returns
TypeDescription
string
methodpublicgetTimeout() : string
inherited

Gets the timeout value

Inherited from:
Returns
TypeDescription
string
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.

methodpublicsetContinuationToken(\MicrosoftAzure\Storage\Common\Models\MarkerContinuationToken | null $continuationToken = null) : void
inherited

Setter for continuationToken

Inherited from:
Parameters
NameTypeDescription
$continuationToken\MicrosoftAzure\Storage\Common\Models\MarkerContinuationToken | null

the continuation token to be set.

methodpublicsetDecodeContent(boolean $decodeContent) : void
inherited

Sets decodeContent.

Inherited from:
Parameters
NameTypeDescription
$decodeContentboolean

value.

methodpublicsetIncludeMetadata(boolean $includeMetadata) : void

Sets the include metadata flag.

Parameters
NameTypeDescription
$includeMetadataboolean

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.

methodpublicsetMarker( $marker) : void
inherited

Inherited from:
Parameters
NameTypeDescription
$marker
methodpublicsetMaxResults(string $maxResults) : void

Sets max results which specifies the maximum number of Shares to return.

If the request does not specify maxresults, or specifies a value greater than 5,000, the server will return up to 5,000 items. If the parameter is set to a value less than or equal to zero, the server will return status code 400 (Bad Request).

Parameters
NameTypeDescription
$maxResultsstring

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.

methodpublicsetNumberOfConcurrency(integer $numberOfConcurrency) : void
inherited

Sets number of concurrency.

Inherited from:
Parameters
NameTypeDescription
$numberOfConcurrencyinteger

value.

methodpublicsetPrefix(string $prefix) : void

Sets prefix - filters the results to return only Shares whose name begins with the specified prefix.

Parameters
NameTypeDescription
$prefixstring

value.

methodpublicsetTimeout(string $timeout) : void
inherited

Sets timeout.

Inherited from:
Parameters
NameTypeDescription
$timeoutstring

value.

Documentation was generated by phpDocumentor 2.9.1.