azure-storage-blob\src\Blob\Models\AccessCondition.php
inherited
Classes
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
- 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
appendPosition(integer $appendPosition) : \MicrosoftAzure\Storage\Blob\Models\AccessConditionReturns 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.
| Name | Type | Description |
|---|---|---|
| $appendPosition | integer | int that represents the append position |
| Type | Description |
|---|---|
| \MicrosoftAzure\Storage\Blob\Models\AccessCondition |
getHeader() : stringGets header type
| Type | Description |
|---|---|
| string |
getValue() : stringGets the header value
| Type | Description |
|---|---|
| string |
ifMatch(string $etag) : \MicrosoftAzure\Storage\Blob\Models\AccessConditionReturns 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.
| Name | Type | Description |
|---|---|---|
| $etag | string | a string that represents the ETag value to check. |
| Type | Description |
|---|---|
| \MicrosoftAzure\Storage\Blob\Models\AccessCondition |
ifModifiedSince(\DateTime $lastModified) : \MicrosoftAzure\Storage\Blob\Models\AccessConditionReturns 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.
| Name | Type | Description |
|---|---|---|
| $lastModified | \DateTime | date that represents the last-modified time to check for the resource. |
| Type | Description |
|---|---|
| \MicrosoftAzure\Storage\Blob\Models\AccessCondition |
ifNoneMatch(string $etag) : \MicrosoftAzure\Storage\Blob\Models\AccessConditionReturns 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.
| Name | Type | Description |
|---|---|---|
| $etag | string | string that represents the ETag value to check. |
| Type | Description |
|---|---|
| \MicrosoftAzure\Storage\Blob\Models\AccessCondition |
ifNotModifiedSince(\DateTime $lastModified) : \MicrosoftAzure\Storage\Blob\Models\AccessConditionReturns 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.
| Name | Type | Description |
|---|---|---|
| $lastModified | \DateTime | date that represents the last-modified time to check for the resource. |
| Type | Description |
|---|---|
| \MicrosoftAzure\Storage\Blob\Models\AccessCondition |
ifSequenceNumberEqual(integer $sequenceNumber) : \MicrosoftAzure\Storage\Blob\Models\AccessConditionReturns 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.
| Name | Type | Description |
|---|---|---|
| $sequenceNumber | integer | int that represents the sequence number value to check. |
| Type | Description |
|---|---|
| \MicrosoftAzure\Storage\Blob\Models\AccessCondition |
ifSequenceNumberLessThan(integer $sequenceNumber) : \MicrosoftAzure\Storage\Blob\Models\AccessConditionReturns 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.
| Name | Type | Description |
|---|---|---|
| $sequenceNumber | integer | int that represents the sequence number value to check. |
| Type | Description |
|---|---|
| \MicrosoftAzure\Storage\Blob\Models\AccessCondition |
ifSequenceNumberLessThanOrEqual(integer $sequenceNumber) : \MicrosoftAzure\Storage\Blob\Models\AccessConditionReturns 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.
| Name | Type | Description |
|---|---|---|
| $sequenceNumber | integer | int that represents the sequence number value to check. |
| Type | Description |
|---|---|
| \MicrosoftAzure\Storage\Blob\Models\AccessCondition |
maxBlobSize(integer $maxBlobSize) : \MicrosoftAzure\Storage\Blob\Models\AccessConditionReturns 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.
| Name | Type | Description |
|---|---|---|
| $maxBlobSize | integer | int that represents the max blob size |
| Type | Description |
|---|---|
| \MicrosoftAzure\Storage\Blob\Models\AccessCondition |
none() : \MicrosoftAzure\Storage\Blob\Models\AccessConditionSpecifies that no access condition is set.
| Type | Description |
|---|---|
| \MicrosoftAzure\Storage\Blob\Models\AccessCondition |
setHeader(string $headerType) : voidSets header type
| Name | Type | Description |
|---|---|---|
| $headerType | string | can be one of Resources |
setValue(string $value) : voidSets the header value
| Name | Type | Description |
|---|---|---|
| $value | string | the value to use |