azure-storage-blob\src\Blob\Models\AccessCondition.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
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\AccessCondition

Package: MicrosoftAzure\Storage\Blob\Models
Represents a set of access conditions to be used for operations against the storage services.
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  

Methods

methodpublicappendPosition(integer $appendPosition) : \MicrosoftAzure\Storage\Blob\Models\AccessCondition
static

Returns an access condition such that an operation will be performed only if the operation would cause the blob to exceed that limit or if the append position is equal to this number.

Setting this access condition modifies the request to include the HTTP x-ms-blob-condition-appendpos conditional header. If this access condition is set, the operation is performed only if the append position is equal to this number

For more information, see Specifying Conditional Headers for Blob Service Operations.

Parameters
NameTypeDescription
$appendPositioninteger

int that represents the append position

Returns
TypeDescription
\MicrosoftAzure\Storage\Blob\Models\AccessCondition
methodpublicgetHeader() : string

Gets header type

Returns
TypeDescription
string
methodpublicgetValue() : string

Gets the header value

Returns
TypeDescription
string
methodpublicifMatch(string $etag) : \MicrosoftAzure\Storage\Blob\Models\AccessCondition
static

Returns an access condition such that an operation will be performed only if the resource's ETag value matches the specified ETag value.

Setting this access condition modifies the request to include the HTTP If-Match conditional header. If this access condition is set, the operation is performed only if the ETag of the resource matches the specified ETag.

For more information, see Specifying Conditional Headers for Blob Service Operations.

Parameters
NameTypeDescription
$etagstring

a string that represents the ETag value to check.

Returns
TypeDescription
\MicrosoftAzure\Storage\Blob\Models\AccessCondition
methodpublicifModifiedSince(\DateTime $lastModified) : \MicrosoftAzure\Storage\Blob\Models\AccessCondition
static

Returns an access condition such that an operation will be performed only if the resource has been modified since the specified time.

Setting this access condition modifies the request to include the HTTP If-Modified-Since conditional header. If this access condition is set, the operation is performed only if the resource has been modified since the specified time.

For more information, see Specifying Conditional Headers for Blob Service Operations.

Parameters
NameTypeDescription
$lastModified\DateTime

date that represents the last-modified time to check for the resource.

Returns
TypeDescription
\MicrosoftAzure\Storage\Blob\Models\AccessCondition
methodpublicifNoneMatch(string $etag) : \MicrosoftAzure\Storage\Blob\Models\AccessCondition
static

Returns an access condition such that an operation will be performed only if the resource's ETag value does not match the specified ETag value.

Setting this access condition modifies the request to include the HTTP If-None-Match conditional header. If this access condition is set, the operation is performed only if the ETag of the resource does not match the specified ETag.

For more information, see Specifying Conditional Headers for Blob Service Operations.

Parameters
NameTypeDescription
$etagstring

string that represents the ETag value to check.

Returns
TypeDescription
\MicrosoftAzure\Storage\Blob\Models\AccessCondition
methodpublicifNotModifiedSince(\DateTime $lastModified) : \MicrosoftAzure\Storage\Blob\Models\AccessCondition
static

Returns an access condition such that an operation will be performed only if the resource has not been modified since the specified time.

Setting this access condition modifies the request to include the HTTP If-Unmodified-Since conditional header. If this access condition is set, the operation is performed only if the resource has not been modified since the specified time.

For more information, see Specifying Conditional Headers for Blob Service Operations.

Parameters
NameTypeDescription
$lastModified\DateTime

date that represents the last-modified time to check for the resource.

Returns
TypeDescription
\MicrosoftAzure\Storage\Blob\Models\AccessCondition
methodpublicifSequenceNumberEqual(integer $sequenceNumber) : \MicrosoftAzure\Storage\Blob\Models\AccessCondition
static

Returns an access condition such that an operation will be performed only if the blob’s sequence number is equal to the specified value.

Setting this access condition modifies the request to include the HTTP x-ms-if-sequence-number-eq conditional header. If this access condition is set, the operation is performed only if the blob’s sequence number is equal to the specified value.

For more information, see Specifying Conditional Headers for Blob Service Operations.

Parameters
NameTypeDescription
$sequenceNumberinteger

int that represents the sequence number value to check.

Returns
TypeDescription
\MicrosoftAzure\Storage\Blob\Models\AccessCondition
methodpublicifSequenceNumberLessThan(integer $sequenceNumber) : \MicrosoftAzure\Storage\Blob\Models\AccessCondition
static

Returns an access condition such that an operation will be performed only if the blob’s sequence number is less than the specified value.

Setting this access condition modifies the request to include the HTTP x-ms-if-sequence-number-lt conditional header. If this access condition is set, the operation is performed only if the blob’s sequence number is less than the specified value.

For more information, see Specifying Conditional Headers for Blob Service Operations.

Parameters
NameTypeDescription
$sequenceNumberinteger

int that represents the sequence number value to check.

Returns
TypeDescription
\MicrosoftAzure\Storage\Blob\Models\AccessCondition
methodpublicifSequenceNumberLessThanOrEqual(integer $sequenceNumber) : \MicrosoftAzure\Storage\Blob\Models\AccessCondition
static

Returns an access condition such that an operation will be performed only if the blob’s sequence number is less than or equal to the specified value.

Setting this access condition modifies the request to include the HTTP x-ms-if-sequence-number-le conditional header. If this access condition is set, the operation is performed only if the blob’s sequence number is less than or equal to the specified value.

For more information, see Specifying Conditional Headers for Blob Service Operations.

Parameters
NameTypeDescription
$sequenceNumberinteger

int that represents the sequence number value to check.

Returns
TypeDescription
\MicrosoftAzure\Storage\Blob\Models\AccessCondition
methodpublicmaxBlobSize(integer $maxBlobSize) : \MicrosoftAzure\Storage\Blob\Models\AccessCondition
static

Returns an access condition such that an operation will be performed only if the operation would cause the blob to exceed that limit or if the blob size is already greater than the value specified in this header.

Setting this access condition modifies the request to include the HTTP x-ms-blob-condition-maxsize conditional header. If this access condition is set, the operation is performed only if the operation would cause the blob to exceed that limit or if the blob size is already greater than the value specified in this header.

For more information, see Specifying Conditional Headers for Blob Service Operations.

Parameters
NameTypeDescription
$maxBlobSizeinteger

int that represents the max blob size

Returns
TypeDescription
\MicrosoftAzure\Storage\Blob\Models\AccessCondition
methodpublicnone() : \MicrosoftAzure\Storage\Blob\Models\AccessCondition
static

Specifies that no access condition is set.

Returns
TypeDescription
\MicrosoftAzure\Storage\Blob\Models\AccessCondition
methodpublicsetHeader(string $headerType) : void

Sets header type

Parameters
NameTypeDescription
$headerTypestring

can be one of Resources

methodpublicsetValue(string $value) : void

Sets the header value

Parameters
NameTypeDescription
$valuestring

the value to use

Documentation was generated by phpDocumentor 2.9.1.