azure-storage-queue\src\Queue\QueueRestProxy.php

Show:

inherited

Classes
- \MicrosoftAzure\Storage\Queue\QueueRestProxy

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\Queue

\MicrosoftAzure\Storage\Queue\QueueRestProxy
jump to top

Package: MicrosoftAzure\Storage\Queue

This class constructs HTTP requests and receive HTTP responses for queue service layer.

Implements
Parent(s): \MicrosoftAzure\Storage\Common\Internal\ServiceRestProxy
Author: Azure Storage PHP SDK
Category: Microsoft
Copyright: 2016 Microsoft Corporation
Inherited_from: \MicrosoftAzure\Storage\Common\Internal\ServiceRestProxy
License: https://github.com/azure/azure-storage-php/LICENSE
Link: https://github.com/azure/azure-storage-php

Properties

\MicrosoftAzure\Storage\Common\Internal\Serialization\ISerializer $dataSerializer

Details

Type: \MicrosoftAzure\Storage\Common\Internal\Serialization\ISerializer

Methods

__construct(\MicrosoftAzure\Storage\Common\Internal\Serialization\ISerializer $dataSerializer = null) : void

inherited

Initializes new RestProxy object.

Inherited from:

Parameters

Name	Type	Description
$dataSerializer	\MicrosoftAzure\Storage\Common\Internal\Serialization\ISerializer	The data serializer.

addMetadataHeaders(array $headers, array $metadata = null) : array

inherited

Adds metadata elements to headers array

Inherited from:

Parameters

Name	Type	Description
$headers	array	HTTP request headers
$metadata	array	user specified metadata

Returns

Type	Description
array

addOptionalHeader(array $headers, string $key, string $value) : void

inherited

Adds optional header.

Inherited from:

Doesn't add the value if it satisfies empty().

Parameters

Name	Type	Description
$headers	array	&$headers The HTTP header parameters.
$key	string	The HTTP header name.
$value	string	The HTTP header value.

addOptionalQueryParam(array $queryParameters, string $key, string $value) : void

inherited

Adds optional query parameter.

Inherited from:

Doesn't add the value if it satisfies empty().

Parameters

Name	Type	Description
$queryParameters	array	&$queryParameters The query parameters.
$key	string	The query variable name.
$value	string	The query variable value.

addPostParameter(array $postParameters, string $key, string $value) : array

inherited

Adds HTTP POST parameter to the specified

Inherited from:

Parameters

Name	Type	Description
$postParameters	array	An array of HTTP POST parameters.
$key	string	The key of a HTTP POST parameter.
$value	string	the value of a HTTP POST parameter.

Returns

Type	Description
array

clearMessages(string $queueName, \MicrosoftAzure\Storage\Queue\Models\QueueServiceOptions $options = null) : void

Clears all messages from the queue.

If a queue contains a large number of messages, Clear Messages may time out before all messages have been deleted. In this case the Queue service will return status code 500 (Internal Server Error), with the additional error code OperationTimedOut. If the operation times out, the client should continue to retry Clear Messages until it succeeds, to ensure that all messages have been deleted.

Parameters

Name	Type	Description
$queueName	string	The name of the queue.
$options	\MicrosoftAzure\Storage\Queue\Models\QueueServiceOptions	The optional parameters.

clearMessagesAsync(string $queueName, \MicrosoftAzure\Storage\Queue\Models\QueueServiceOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface

Creates promise to clear all messages from the queue.

Parameters

Name	Type	Description
$queueName	string	The name of the queue.
$options	\MicrosoftAzure\Storage\Queue\Models\QueueServiceOptions	The optional parameters.

Returns

Type	Description
\GuzzleHttp\Promise\PromiseInterface

createMessage(string $queueName, string $messageText, \MicrosoftAzure\Storage\Queue\Models\CreateMessageOptions $options = null) : \MicrosoftAzure\Storage\Queue\Models\CreateMessageResult

Adds a message to the queue and optionally sets a visibility timeout for the message.

Parameters

Name	Type	Description
$queueName	string	The name of the queue.
$messageText	string	The message contents.
$options	\MicrosoftAzure\Storage\Queue\Models\CreateMessageOptions	The optional parameters.

Returns

Type	Description
\MicrosoftAzure\Storage\Queue\Models\CreateMessageResult

createMessageAsync(string $queueName, string $messageText, \MicrosoftAzure\Storage\Queue\Models\CreateMessageOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface

Creates promise to add a message to the queue and optionally sets a visibility timeout for the message.

Parameters

Name	Type	Description
$queueName	string	The name of the queue.
$messageText	string	The message contents.
$options	\MicrosoftAzure\Storage\Queue\Models\CreateMessageOptions	The optional parameters.

Returns

Type	Description
\GuzzleHttp\Promise\PromiseInterface

createMiddlewareStack(\MicrosoftAzure\Storage\Common\Models\ServiceOptions $serviceOptions) : \MicrosoftAzure\Storage\Common\Middlewares\MiddlewareStack

inherited

Create a middleware stack with given middleware.

Inherited from:

Parameters

Name	Type	Description
$serviceOptions	\MicrosoftAzure\Storage\Common\Models\ServiceOptions	The options user passed in.

Returns

Type	Description
\MicrosoftAzure\Storage\Common\Middlewares\MiddlewareStack

createQueue(string $queueName, \MicrosoftAzure\Storage\Queue\Models\CreateQueueOptions $options = null) : void

Creates a new queue under the storage account.

Parameters

Name	Type	Description
$queueName	string	The queue name.
$options	\MicrosoftAzure\Storage\Queue\Models\CreateQueueOptions	The Optional parameters.

createQueueAsync(string $queueName, \MicrosoftAzure\Storage\Queue\Models\CreateQueueOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface

Creates promise to create a new queue under the storage account.

Parameters

Name	Type	Description
$queueName	string	The queue name.
$options	\MicrosoftAzure\Storage\Queue\Models\CreateQueueOptions	The Optional parameters.

Returns

Type	Description
\GuzzleHttp\Promise\PromiseInterface

createQueueService(string $connectionString, array $options = array()) : \MicrosoftAzure\Storage\Queue\QueueRestProxy

static

Builds a queue service object, it accepts the following options:

http: (array) the underlying guzzle options. refer to http://docs.guzzlephp.org/en/latest/request-options.html for detailed available options
middlewares: (mixed) the middleware should be either an instance of a sub-class that implements \MicrosoftAzure\Storage\Queue\MicrosoftAzure\Storage\Common\Middlewares\IMiddleware, or a callable that follows the Guzzle middleware implementation convention

Please refer to https://azure.microsoft.com/en-us/documentation/articles/storage-configure-connection-string for how to construct a connection string with storage account name/key, or with a shared access signature (SAS Token).

Parameters

Name	Type	Description
$connectionString	string	The configuration connection string.
$options	array	Array of options to pass to the service

Returns

Type	Description
\MicrosoftAzure\Storage\Queue\QueueRestProxy

createQueueServiceWithTokenCredential(string $token, string $connectionString, array $options = array()) : \MicrosoftAzure\Storage\Queue\QueueRestProxy

static

Builds a queue service object, it accepts the following options:

http: (array) the underlying guzzle options. refer to http://docs.guzzlephp.org/en/latest/request-options.html for detailed available options
middlewares: (mixed) the middleware should be either an instance of a sub-class that implements \MicrosoftAzure\Storage\Queue\MicrosoftAzure\Storage\Common\Middlewares\IMiddleware, or a callable that follows the Guzzle middleware implementation convention

Please refer to https://docs.microsoft.com/en-us/azure/storage/common/storage-auth-aad for authenticate access to Azure blobs and queues using Azure Active Directory.

Parameters

Name	Type	Description
$token	string	The bearer token passed as reference.
$connectionString	string	The configuration connection string.
$options	array	Array of options to pass to the service

Returns

Type	Description
\MicrosoftAzure\Storage\Queue\QueueRestProxy

createRequest(string $method, array $headers, array $queryParams, array $postParameters, string $path,  $locationMode, string $body = \MicrosoftAzure\Storage\Common\Internal\Resources::EMPTY_STRING) : \GuzzleHttp\Psr7\Request

inherited

Create the request to be sent.

Inherited from:

Parameters

Name	Type	Description
$method	string	The method of the HTTP request
$headers	array	The header field of the request
$queryParams	array	The query parameter of the request
$postParameters	array	The HTTP POST parameters
$path	string	URL path
$locationMode
$body	string	Request body

Returns

Type	Description
\GuzzleHttp\Psr7\Request

deleteMessage(string $queueName, string $messageId, string $popReceipt, \MicrosoftAzure\Storage\Queue\Models\QueueServiceOptions $options = null) : void

Deletes a specified message from the queue.

Parameters

Name	Type	Description
$queueName	string	The name of the queue.
$messageId	string	The id of the message.
$popReceipt	string	The valid pop receipt value returned from an earlier call to the Get Messages or Update Message operation.
$options	\MicrosoftAzure\Storage\Queue\Models\QueueServiceOptions	The optional parameters.

deleteMessageAsync(string $queueName, string $messageId, string $popReceipt, \MicrosoftAzure\Storage\Queue\Models\QueueServiceOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface

Creates promise to delete a specified message from the queue.

Parameters

Name	Type	Description
$queueName	string	The name of the queue.
$messageId	string	The id of the message.
$popReceipt	string	The valid pop receipt value returned from an earlier call to the Get Messages or Update Message operation.
$options	\MicrosoftAzure\Storage\Queue\Models\QueueServiceOptions	The optional parameters.

Returns

Type	Description
\GuzzleHttp\Promise\PromiseInterface

deleteQueue(string $queueName, \MicrosoftAzure\Storage\Queue\Models\QueueServiceOptions $options = null) : void

Deletes a queue.

Parameters

Name	Type	Description
$queueName	string	The queue name.
$options	\MicrosoftAzure\Storage\Queue\Models\QueueServiceOptions	The optional parameters.

deleteQueueAsync(string $queueName, \MicrosoftAzure\Storage\Queue\Models\QueueServiceOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface

Creates promise to delete a queue.

Parameters

Name	Type	Description
$queueName	string	The queue name.
$options	\MicrosoftAzure\Storage\Queue\Models\QueueServiceOptions	The optional parameters.

Returns

Type	Description
\GuzzleHttp\Promise\PromiseInterface

generateMetadataHeaders(array $metadata = null) : array

inherited

Generates metadata headers by prefixing each element with 'x-ms-meta'.

Inherited from:

Parameters

Name	Type	Description
$metadata	array	user defined metadata.

Returns

Type	Description
array

generateRequestOptions(\MicrosoftAzure\Storage\Common\Models\ServiceOptions $serviceOptions, callable $handler) : array

inherited

Generate the request options using the given service options and stored information.

Inherited from:

Parameters

Name	Type	Description
$serviceOptions	\MicrosoftAzure\Storage\Common\Models\ServiceOptions	The service options used to generate request options.
$handler	callable	The handler used to send the request.

Returns

Type	Description
array

getAccountName() : string

inherited

Gets the account name.

Inherited from:

Returns

Type	Description
string

getMiddlewares() : array

inherited

Gets middlewares that will be handling the request and response.

Inherited from:

Returns

Type	Description
array

getPsrPrimaryUri() : \GuzzleHttp\Psr7\Uri

inherited

Get the primary URI in PSR form.

Inherited from:

Returns

Type	Description
\GuzzleHttp\Psr7\Uri

getPsrSecondaryUri() : \GuzzleHttp\Psr7\Uri

inherited

Get the secondary URI in PSR form.

Inherited from:

Returns

Type	Description
\GuzzleHttp\Psr7\Uri

getQueueAcl(string $queue, \MicrosoftAzure\Storage\Queue\Models\QueueServiceOptions $options = null) : \MicrosoftAzure\Storage\Queue\Models\QueueACL

Gets the access control list (ACL)

Parameters

Name	Type	Description
$queue	string	The queue name.
$options	\MicrosoftAzure\Storage\Queue\Models\QueueServiceOptions	The optional parameters.

Returns

Type	Description
\MicrosoftAzure\Storage\Queue\Models\QueueACL

Details

See

getQueueAclAsync(string $queue, \MicrosoftAzure\Storage\Queue\Models\QueueServiceOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface

Creates the promise to gets the access control list (ACL)

Parameters

Name	Type	Description
$queue	string	The queue name.
$options	\MicrosoftAzure\Storage\Queue\Models\QueueServiceOptions	The optional parameters.

Returns

Type	Description
\GuzzleHttp\Promise\PromiseInterface

Details

See

getQueueMetadata(string $queueName, \MicrosoftAzure\Storage\Queue\Models\QueueServiceOptions $options = null) : \MicrosoftAzure\Storage\Queue\Models\GetQueueMetadataResult

Returns queue properties, including user-defined metadata.

Parameters

Name	Type	Description
$queueName	string	The queue name.
$options	\MicrosoftAzure\Storage\Queue\Models\QueueServiceOptions	The optional parameters.

Returns

Type	Description
\MicrosoftAzure\Storage\Queue\Models\GetQueueMetadataResult

getQueueMetadataAsync(string $queueName, \MicrosoftAzure\Storage\Queue\Models\QueueServiceOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface

Creates promise to return queue properties, including user-defined metadata.

Parameters

Name	Type	Description
$queueName	string	The queue name.
$options	\MicrosoftAzure\Storage\Queue\Models\QueueServiceOptions	The optional parameters.

Returns

Type	Description
\GuzzleHttp\Promise\PromiseInterface

getServiceProperties(\MicrosoftAzure\Storage\Common\Models\ServiceOptions $options = null) : \MicrosoftAzure\Storage\Common\Models\GetServicePropertiesResult

inherited

Gets the properties of the service.

Inherited from:

Parameters

Name	Type	Description
$options	\MicrosoftAzure\Storage\Common\Models\ServiceOptions	The optional parameters.

Returns

Type	Description
\MicrosoftAzure\Storage\Common\Models\GetServicePropertiesResult

Details

See

getServicePropertiesAsync(\MicrosoftAzure\Storage\Common\Models\ServiceOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface

inherited

Creates promise to get the properties of the service.

Inherited from:

Parameters

Name	Type	Description
$options	\MicrosoftAzure\Storage\Common\Models\ServiceOptions	The optional parameters.

Returns

Type	Description
\GuzzleHttp\Promise\PromiseInterface

Details

See

getServiceStats(\MicrosoftAzure\Storage\Common\Models\ServiceOptions | null $options = null) : \MicrosoftAzure\Storage\Common\Models\GetServiceStatsResult

inherited

Retrieves statistics related to replication for the service. The operation will only be sent to secondary location endpoint.

Inherited from:

Parameters

Name	Type	Description
$options	\MicrosoftAzure\Storage\Common\Models\ServiceOptions \| null	The options this operation sends with.

Returns

Type	Description
\MicrosoftAzure\Storage\Common\Models\GetServiceStatsResult

getServiceStatsAsync(\MicrosoftAzure\Storage\Common\Models\ServiceOptions | null $options = null) : \GuzzleHttp\Promise\PromiseInterface

inherited

Creates promise that retrieves statistics related to replication for the service. The operation will only be sent to secondary location endpoint.

Inherited from:

Parameters

Name	Type	Description
$options	\MicrosoftAzure\Storage\Common\Models\ServiceOptions \| null	The options this operation sends with.

Returns

Type	Description
\GuzzleHttp\Promise\PromiseInterface

groupQueryValues(array $values) : string

staticinherited

Groups set of values into one value separated with Resources::SEPARATOR

Inherited from:

Parameters

Name	Type	Description
$values	array	array of values to be grouped.

Returns

Type	Description
string

listMessages(string $queueName, \MicrosoftAzure\Storage\Queue\Models\ListMessagesOptions $options = null) : \MicrosoftAzure\Storage\Queue\Models\ListMessagesResult

Lists all messages in the queue.

Parameters

Name	Type	Description
$queueName	string	The queue name.
$options	\MicrosoftAzure\Storage\Queue\Models\ListMessagesOptions	The optional parameters.

Returns

Type	Description
\MicrosoftAzure\Storage\Queue\Models\ListMessagesResult

listMessagesAsync(string $queueName, \MicrosoftAzure\Storage\Queue\Models\ListMessagesOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface

Creates promise to list all messages in the queue.

Parameters

Name	Type	Description
$queueName	string	The queue name.
$options	\MicrosoftAzure\Storage\Queue\Models\ListMessagesOptions	The optional parameters.

Returns

Type	Description
\GuzzleHttp\Promise\PromiseInterface

listQueues(\MicrosoftAzure\Storage\Queue\Models\ListQueuesOptions $options = null) : \MicrosoftAzure\Storage\Queue\Models\ListQueuesResult

Lists all queues in the storage account.

Parameters

Name	Type	Description
$options	\MicrosoftAzure\Storage\Queue\Models\ListQueuesOptions	The optional list queue options.

Returns

Type	Description
\MicrosoftAzure\Storage\Queue\Models\ListQueuesResult

listQueuesAsync(\MicrosoftAzure\Storage\Queue\Models\ListQueuesOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface

Creates promise to list all queues in the storage account.

Parameters

Name	Type	Description
$options	\MicrosoftAzure\Storage\Queue\Models\ListQueuesOptions	The optional list queue options.

Returns

Type	Description
\GuzzleHttp\Promise\PromiseInterface

onRejected(string | \Exception $reason, array | integer $expected) : \Psr\Http\Message\ResponseInterface

inherited

Inherited from:

Parameters

Name	Type	Description
$reason	string \| \Exception	Rejection reason.
$expected	array \| integer	Expected Status Codes.

Returns

Type	Description
\Psr\Http\Message\ResponseInterface

peekMessages(string $queueName, \MicrosoftAzure\Storage\Queue\Models\PeekMessagesOptions $options = null) : \MicrosoftAzure\Storage\Queue\Models\PeekMessagesResult

Retrieves a message from the front of the queue, without changing the message visibility.

Parameters

Name	Type	Description
$queueName	string	The queue name.
$options	\MicrosoftAzure\Storage\Queue\Models\PeekMessagesOptions	The optional parameters.

Returns

Type	Description
\MicrosoftAzure\Storage\Queue\Models\PeekMessagesResult

peekMessagesAsync(string $queueName, \MicrosoftAzure\Storage\Queue\Models\PeekMessagesOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface

Creates promise to retrieve a message from the front of the queue, without changing the message visibility.

Parameters

Name	Type	Description
$queueName	string	The queue name.
$options	\MicrosoftAzure\Storage\Queue\Models\PeekMessagesOptions	The optional parameters.

Returns

Type	Description
\GuzzleHttp\Promise\PromiseInterface

pushMiddleware(callable | \MicrosoftAzure\Storage\Common\Internal\IMiddleware $middleware) : void

inherited

Push a new middleware into the middlewares array. The newly added middleware will be the most inner middleware when executed.

Inherited from:

Parameters

Name	Type	Description
$middleware	callable \| \MicrosoftAzure\Storage\Common\Internal\IMiddleware	the middleware to be added.

sendAsync(string $method, array $headers, array $queryParams, array $postParameters, string $path, array | integer $expected = \MicrosoftAzure\Storage\Common\Internal\Resources::STATUS_OK, string $body = \MicrosoftAzure\Storage\Common\Internal\Resources::EMPTY_STRING, \MicrosoftAzure\Storage\Common\Models\ServiceOptions $serviceOptions = null) : \GuzzleHttp\Promise\PromiseInterface

inherited

Create promise of sending HTTP request with the specified parameters.

Inherited from:

Parameters

Name	Type	Description
$method	string	HTTP method used in the request
$headers	array	HTTP headers.
$queryParams	array	URL query parameters.
$postParameters	array	The HTTP POST parameters.
$path	string	URL path
$expected	array \| integer	Expected Status Codes.
$body	string	Request body
$serviceOptions	\MicrosoftAzure\Storage\Common\Models\ServiceOptions	Service options

Returns

Type	Description
\GuzzleHttp\Promise\PromiseInterface

sendConcurrentAsync(callable $generator, integer $statusCode, \MicrosoftAzure\Storage\Common\Models\ServiceOptions $options) : \GuzzleHttp\Promise\Promise | \GuzzleHttp\Promise\PromiseInterface

inherited

Send the requests concurrently. Number of concurrency can be modified by inserting a new key/value pair with the key 'number_of_concurrency' into the $requestOptions of $serviceOptions. Return only the promise.

Inherited from:

Parameters

Name	Type	Description
$generator	callable	the generator function to generate request upon fulfillment
$statusCode	integer	The expected status code for each of the request generated by generator.
$options	\MicrosoftAzure\Storage\Common\Models\ServiceOptions	The service options for the concurrent requests.

Returns

Type	Description
\GuzzleHttp\Promise\Promise \| \GuzzleHttp\Promise\PromiseInterface

sendContext(\MicrosoftAzure\Storage\Common\Internal\Http\HttpCallContext $context) : \GuzzleHttp\Psr7\Response

inherited

Sends the context.

Inherited from:

Parameters

Name	Type	Description
$context	\MicrosoftAzure\Storage\Common\Internal\Http\HttpCallContext	The context of the request.

Returns

Type	Description
\GuzzleHttp\Psr7\Response

sendContextAsync(\MicrosoftAzure\Storage\Common\Internal\Http\HttpCallContext $context) : \GuzzleHttp\Promise\PromiseInterface

inherited

Creates the promise to send the context.

Inherited from:

Parameters

Name	Type	Description
$context	\MicrosoftAzure\Storage\Common\Internal\Http\HttpCallContext	The context of the request.

Returns

Type	Description
\GuzzleHttp\Promise\PromiseInterface

setQueueAcl(string $queue, \MicrosoftAzure\Storage\Queue\Models\QueueACL $acl, \MicrosoftAzure\Storage\Queue\Models\QueueServiceOptions $options = null) : void

Sets the ACL.

Parameters

Name	Type	Description
$queue	string	name
$acl	\MicrosoftAzure\Storage\Queue\Models\QueueACL	access control list for Queue
$options	\MicrosoftAzure\Storage\Queue\Models\QueueServiceOptions	optional parameters

Details

See

setQueueAclAsync(string $queue, \MicrosoftAzure\Storage\Queue\Models\QueueACL $acl, \MicrosoftAzure\Storage\Queue\Models\QueueServiceOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface

Creates promise to set the ACL

Parameters

Name	Type	Description
$queue	string	name
$acl	\MicrosoftAzure\Storage\Queue\Models\QueueACL	access control list for Queue
$options	\MicrosoftAzure\Storage\Queue\Models\QueueServiceOptions	optional parameters

Returns

Type	Description
\GuzzleHttp\Promise\PromiseInterface

Details

See

setQueueMetadata(string $queueName, array $metadata = null, \MicrosoftAzure\Storage\Queue\Models\QueueServiceOptions $options = null) : void

Sets user-defined metadata on the queue. To delete queue metadata, call this API without specifying any metadata in $metadata.

Parameters

Name	Type	Description
$queueName	string	The queue name.
$metadata	array	The metadata array.
$options	\MicrosoftAzure\Storage\Queue\Models\QueueServiceOptions	The optional parameters.

setQueueMetadataAsync(string $queueName, array $metadata = null, \MicrosoftAzure\Storage\Queue\Models\QueueServiceOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface

Creates promise to set user-defined metadata on the queue. To delete queue metadata, call this API without specifying any metadata in $metadata.

Parameters

Name	Type	Description
$queueName	string	The queue name.
$metadata	array	The metadata array.
$options	\MicrosoftAzure\Storage\Queue\Models\QueueServiceOptions	The optional parameters.

Returns

Type	Description
\GuzzleHttp\Promise\PromiseInterface

setServiceProperties(\MicrosoftAzure\Storage\Common\Models\ServiceProperties $serviceProperties, \MicrosoftAzure\Storage\Common\Models\ServiceOptions $options = null) : void

inherited

Sets the properties of the service.

Inherited from:

It's recommended to use getServiceProperties, alter the returned object and then use setServiceProperties with this altered object.

Parameters

Name	Type	Description
$serviceProperties	\MicrosoftAzure\Storage\Common\Models\ServiceProperties	The service properties.
$options	\MicrosoftAzure\Storage\Common\Models\ServiceOptions	The optional parameters.

Details

See

setServicePropertiesAsync(\MicrosoftAzure\Storage\Common\Models\ServiceProperties $serviceProperties, \MicrosoftAzure\Storage\Common\Models\ServiceOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface

inherited

Creates the promise to set the properties of the service.

Inherited from:

It's recommended to use getServiceProperties, alter the returned object and then use setServiceProperties with this altered object.

Parameters

Name	Type	Description
$serviceProperties	\MicrosoftAzure\Storage\Common\Models\ServiceProperties	The service properties.
$options	\MicrosoftAzure\Storage\Common\Models\ServiceOptions	The optional parameters.

Returns

Type	Description
\GuzzleHttp\Promise\PromiseInterface

Details

See

throwIfError(\Psr\Http\Message\ResponseInterface $response, array | integer $expected) : void

staticinherited

Throws ServiceException if the received status code is not expected.

Inherited from:

Parameters

Name	Type	Description
$response	\Psr\Http\Message\ResponseInterface	The response received
$expected	array \| integer	The expected status codes.

Throws

Exception	Description
\MicrosoftAzure\Storage\Common\Exceptions\ServiceException

updateMessage(string $queueName, string $messageId, string $popReceipt, string $messageText, integer $visibilityTimeoutInSeconds, \MicrosoftAzure\Storage\Queue\Models\QueueServiceOptions $options = null) : \MicrosoftAzure\Storage\Queue\Models\UpdateMessageResult

Updates the visibility timeout of a message and/or the message contents.

Parameters

Name	Type	Description
$queueName	string	The queue name.
$messageId	string	The id of the message.
$popReceipt	string	The valid pop receipt value returned from an earlier call to the Get Messages or Update Message operation.
$messageText	string	The message contents.
$visibilityTimeoutInSeconds	integer	Specifies the new visibility timeout value, in seconds, relative to server time. The new value must be larger than or equal to 0, and cannot be larger than 7 days. The visibility timeout of a message cannot be set to a value later than the expiry time. A message can be updated until it has been deleted or has expired.
$options	\MicrosoftAzure\Storage\Queue\Models\QueueServiceOptions	The optional parameters.

Returns

Type	Description
\MicrosoftAzure\Storage\Queue\Models\UpdateMessageResult

updateMessageAsync(string $queueName, string $messageId, string $popReceipt, string $messageText, integer $visibilityTimeoutInSeconds, \MicrosoftAzure\Storage\Queue\Models\QueueServiceOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface

Creates promise to update the visibility timeout of a message and/or the message contents.

Parameters

Name	Type	Description
$queueName	string	The queue name.
$messageId	string	The id of the message.
$popReceipt	string	The valid pop receipt value returned from an earlier call to the Get Messages or Update Message operation.
$messageText	string	The message contents.
$visibilityTimeoutInSeconds	integer	Specifies the new visibility timeout value, in seconds, relative to server time. The new value must be larger than or equal to 0, and cannot be larger than 7 days. The visibility timeout of a message cannot be set to a value later than the expiry time. A message can be updated until it has been deleted or has expired.
$options	\MicrosoftAzure\Storage\Queue\Models\QueueServiceOptions	The optional parameters.

Returns

Type	Description
\GuzzleHttp\Promise\PromiseInterface

azure-storage-queue\src\Queue\QueueRestProxy.php

\MicrosoftAzure\Storage\Queue\QueueRestProxyjump to top

Properties

Methods

\MicrosoftAzure\Storage\Queue\QueueRestProxy
jump to top