azure-storage-blob\src\Blob\Models\CreateContainerOptions.php

Show:

inherited

Classes
- \MicrosoftAzure\Storage\Blob\Models\CreateContainerOptions

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\Blob\Models

\MicrosoftAzure\Storage\Blob\Models\CreateContainerOptions
jump to top

Package: MicrosoftAzure\Storage\Blob\Models

Optional parameters for createContainer API

Parent(s): \MicrosoftAzure\Storage\Blob\Models\BlobServiceOptions < \MicrosoftAzure\Storage\Common\Models\ServiceOptions
Author: Azure Storage PHP SDK
Category: Microsoft
Copyright: 2016 Microsoft Corporation
Inherited_from: \MicrosoftAzure\Storage\Blob\Models\BlobServiceOptions
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

addMetadata(string $key, string $value) : void

Adds new metadata element. This element should be added without the header prefix (x-ms-meta-*).

Parameters

Name	Type	Description
$key	string	metadata key element.
$value	string	metadata value element.

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

getAccessConditions() : array<mixed,\MicrosoftAzure\Storage\Blob\Models\AccessCondition>

inherited

Gets access condition

Inherited from:

Returns

Type	Description
array<mixed,\MicrosoftAzure\Storage\Blob\Models\AccessCondition>

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

getLeaseId() : string

inherited

Gets lease Id for the blob

Inherited from:

Returns

Type	Description
string

getLocationMode() : string

inherited

Gets the locationMode value

Inherited from:

Returns

Type	Description
string

getMetadata() : array

Gets user defined 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

getPublicAccess() : string

Gets container public access.

Returns

Type	Description
string

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.

setAccessConditions(mixed $accessConditions) : void

inherited

Sets access condition

Inherited from:

Parameters

Name	Type	Description
$accessConditions	mixed	value to use.

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.

setLeaseId(string $leaseId) : void

inherited

Sets lease Id for the blob

Inherited from:

Parameters

Name	Type	Description
$leaseId	string	the blob lease id.

setLocationMode(string $locationMode) : void

inherited

Sets locationMode.

Inherited from:

Parameters

Name	Type	Description
$locationMode	string	value.

setMetadata(array $metadata) : void

Sets user defined metadata. This metadata should be added without the header prefix (x-ms-meta-*).

Parameters

Name	Type	Description
$metadata	array	user defined metadata object in array form.

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.

setPublicAccess(string $publicAccess) : void

Specifies whether data in the container may be accessed publicly and the level of access. Possible values include: 1) container: Specifies full public read access for container and blob data.

Clients can enumerate blobs within the container via anonymous request, but cannot enumerate containers within the storage account. 2) blob: Specifies public read access for blobs. Blob data within this container can be read via anonymous request, but container data is not available. Clients cannot enumerate blobs within the container via anonymous request. If this value is not specified in the request, container data is private to the account owner.

Parameters

Name	Type	Description
$publicAccess	string	access modifier for the container

setTimeout(string $timeout) : void

inherited

Sets timeout.

Inherited from:

Parameters

Name	Type	Description
$timeout	string	value.

azure-storage-blob\src\Blob\Models\CreateContainerOptions.php

\MicrosoftAzure\Storage\Blob\Models\CreateContainerOptionsjump to top

Methods

\MicrosoftAzure\Storage\Blob\Models\CreateContainerOptions
jump to top