azure-storage-file\src\File\Models\CreateFileOptions.php

Show:

inherited

Classes
- \MicrosoftAzure\Storage\File\Models\CreateFileOptions

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

Package: MicrosoftAzure\Storage\File\Models

Optional parameters for createFile.

Parent(s): \MicrosoftAzure\Storage\File\Models\FileServiceOptions < \MicrosoftAzure\Storage\Common\Models\ServiceOptions
Children: \MicrosoftAzure\Storage\File\Models\CreateFileFromContentOptions
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

__construct( $options = null) : void

inherited

Initialize the properties to default value.

Inherited from:

Parameters

Name	Type	Description
$options

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

getCacheControl() : string

Gets cacheControl.

Returns

Type	Description
string

getContentDisposition() : string

Gets content disposition.

Returns

Type	Description
string

getContentEncoding() : string

Gets contentEncoding.

Returns

Type	Description
string

getContentLanguage() : string

Gets contentLanguage.

Returns

Type	Description
string

getContentLength() : integer

Gets File contentLength.

Returns

Type	Description
integer

getContentMD5() : string

Gets contentMD5.

Returns

Type	Description
string

getContentType() : string

Gets File contentType.

Returns

Type	Description
string

getDecodeContent() : boolean

inherited

Gets the decodeContent value

Inherited from:

Returns

Type	Description
boolean

getIsStreaming() : boolean

inherited

Gets the isStreaming value

Inherited from:

Returns

Type	Description
boolean

getLocationMode() : string

inherited

Gets the locationMode value

Inherited from:

Returns

Type	Description
string

getMetadata() : array

Gets File metadata.

Returns

Type	Description
array

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

getNumberOfConcurrency() : integer

inherited

Gets the number of concurrency value

Inherited from:

Returns

Type	Description
integer

getTimeout() : string

inherited

Gets the timeout value

Inherited from:

Returns

Type	Description
string

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.

setCacheControl(string $cacheControl) : void

Sets cacheControl.

Parameters

Name	Type	Description
$cacheControl	string	value to use.

setContentDisposition(string $contentDisposition) : void

Sets content disposition.

Parameters

Name	Type	Description
$contentDisposition	string	value to use.

setContentEncoding(string $contentEncoding) : void

Sets contentEncoding.

Parameters

Name	Type	Description
$contentEncoding	string	value.

setContentLanguage(string $contentLanguage) : void

Sets contentLanguage.

Parameters

Name	Type	Description
$contentLanguage	string	value.

setContentLength(integer $contentLength) : void

Sets File contentLength.

Parameters

Name	Type	Description
$contentLength	integer	value.

setContentMD5(string $contentMD5) : void

Sets contentMD5.

Parameters

Name	Type	Description
$contentMD5	string	value.

setContentType(string $contentType) : void

Sets File contentType.

Parameters

Name	Type	Description
$contentType	string	value.

setDecodeContent(boolean $decodeContent) : void

inherited

Sets decodeContent.

Inherited from:

Parameters

Name	Type	Description
$decodeContent	boolean	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.

setMetadata(array $metadata) : void

Sets File metadata.

Parameters

Name	Type	Description
$metadata	array	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.

setNumberOfConcurrency(integer $numberOfConcurrency) : void

inherited

Sets number of concurrency.

Inherited from:

Parameters

Name	Type	Description
$numberOfConcurrency	integer	value.

setTimeout(string $timeout) : void

inherited

Sets timeout.

Inherited from:

Parameters

Name	Type	Description
$timeout	string	value.

azure-storage-file\src\File\Models\CreateFileOptions.php

\MicrosoftAzure\Storage\File\Models\CreateFileOptionsjump to top

Methods

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