Class: Azure::Storage::Queue::QueueService

Inherits:
StorageService
  • Object
show all
Defined in:
lib/azure/storage/queue/queue_service.rb

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}, &block) ⇒ QueueService

Public: Initializes an instance of [Azure::Storage::Queue::QueueService]

Attributes

  • options - Hash. Optional parameters.

Options

Accepted key/value pairs in options parameter are:

  • :use_development_storage - TrueClass|FalseClass. Whether to use storage emulator.

  • :development_storage_proxy_uri - String. Used with :use_development_storage if emulator is hosted other than localhost.

  • :storage_connection_string - String. The storage connection string.

  • :storage_account_name - String. The name of the storage account.

  • :storage_access_key - Base64 String. The access key of the storage account.

  • :storage_sas_token - String. The signed access signature for the storage account or one of its service.

  • :storage_queue_host - String. Specified Queue serivce endpoint or hostname

  • :storage_dns_suffix - String. The suffix of a regional Storage Serivce, to

  • :default_endpoints_protocol - String. http or https

  • :use_path_style_uri - String. Whether use path style URI for specified endpoints

  • :ca_file - String. File path of the CA file if having issue with SSL

  • :user_agent_prefix - String. The user agent prefix that can identify the application calls the library

  • :client - Azure::Storage::Common::Client. The common client used to initalize the service.

The valid set of options include:

  • Storage Emulator: :use_development_storage required, :development_storage_proxy_uri optionally

  • Storage account name and key: :storage_account_name and :storage_access_key required, set :storage_dns_suffix necessarily

  • Storage account name and SAS token: :storage_account_name and :storage_sas_token required, set :storage_dns_suffix necessarily

  • Specified hosts and SAS token: At least one of the service host and SAS token. It’s up to user to ensure the SAS token is suitable for the serivce

  • Azure::Storage::Common::Client: The common client used to initalize the service. This client can be initalized and used repeatedly.

  • Anonymous Queue: only :storage_queue_host, if it is to only access queues within a container

Additional notes:

  • Specified hosts can be set when use account name with access key or sas token

  • :default_endpoints_protocol can be set if the scheme is not specified in hosts

  • Storage emulator always use path style URI

  • :ca_file is independent.

When empty options are given, it will try to read settings from Environment Variables. Refer to [Azure::Storage::Common::ClientOptions.env_vars_mapping] for the mapping relationship



149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/azure/storage/queue/queue_service.rb', line 149

def initialize(options = {}, &block)
  service_options = options.clone
  client_config = service_options[:client] ||= Azure::Storage::Common::Client::create(service_options, &block)
  @user_agent_prefix = service_options[:user_agent_prefix] if service_options[:user_agent_prefix]
  @api_version = service_options[:api_version] || Azure::Storage::Queue::Default::STG_VERSION
  signer = service_options[:signer] || client_config.signer || Azure::Storage::Common::Core::Auth::SharedKey.new(client_config., client_config.storage_access_key)
  signer.api_ver = @api_version if signer.is_a? Azure::Storage::Common::Core::Auth::SharedAccessSignatureSigner
  super(signer, client_config., service_options, &block)
  @storage_service_host[:primary] = client.storage_queue_host
  @storage_service_host[:secondary] = client.storage_queue_host true
end

Class Method Details

.create(options = {}, &block) ⇒ Azure::Storage::Queue::QueueService

Public: Creates an instance of [Azure::Storage::Queue::QueueService]

Attributes

  • options - Hash. Optional parameters.

Options

Accepted key/value pairs in options parameter are:

  • :use_development_storage - TrueClass|FalseClass. Whether to use storage emulator.

  • :development_storage_proxy_uri - String. Used with :use_development_storage if emulator is hosted other than localhost.

  • :storage_account_name - String. The name of the storage account.

  • :storage_access_key - Base64 String. The access key of the storage account.

  • :storage_sas_token - String. The signed access signature for the storage account or one of its service.

  • :storage_queue_host - String. Specified Queue service endpoint or hostname

  • :storage_dns_suffix - String. The suffix of a regional Storage Service, to

  • :default_endpoints_protocol - String. http or https

  • :use_path_style_uri - String. Whether use path style URI for specified endpoints

  • :ca_file - String. File path of the CA file if having issue with SSL

  • :user_agent_prefix - String. The user agent prefix that can identify the application calls the library

The valid set of options include:

  • Storage Emulator: :use_development_storage required, :development_storage_proxy_uri optionally

  • Storage account name and key: :storage_account_name and :storage_access_key required, set :storage_dns_suffix necessarily

  • Storage account name and SAS token: :storage_account_name and :storage_sas_token required, set :storage_dns_suffix necessarily

  • Specified hosts and SAS token: At least one of the service host and SAS token. It’s up to user to ensure the SAS token is suitable for the serivce

  • Anonymous Queue: only :storage_queue_host, if it is to only access queues within a container

Additional notes:

  • Specified hosts can be set when use account name with access key or sas token

  • :default_endpoints_protocol can be set if the scheme is not specified in hosts

  • Storage emulator always use path style URI

  • :ca_file is independent.

When empty options are given, it will try to read settings from Environment Variables. Refer to [Azure::Storage::Common::ClientOptions.env_vars_mapping] for the mapping relationship

Returns:



71
72
73
74
75
 
# File 'lib/azure/storage/queue/queue_service.rb', line 71

def create(options = {}, &block)
  service_options = { client: Azure::Storage::Common::Client::create(options, &block), api_version: Azure::Storage::Queue::Default::STG_VERSION }
  service_options[:user_agent_prefix] = options[:user_agent_prefix] if options[:user_agent_prefix]
  Azure::Storage::Queue::QueueService.new(service_options, &block)
end

.create_development(proxy_uri = nil, &block) ⇒ Azure::Storage::Queue::QueueService

Public: Creates an instance of [Azure::Storage::Queue::QueueService] with Storage Emulator

Attributes

  • proxy_uri - String. Used with :use_development_storage if emulator is hosted other than localhost.

Returns:



84
85
86
87
 
# File 'lib/azure/storage/queue/queue_service.rb', line 84

def create_development(proxy_uri = nil, &block)
  service_options = { client: Azure::Storage::Common::Client::create_development(proxy_uri, &block), api_version: Azure::Storage::Queue::Default::STG_VERSION }
  Azure::Storage::Queue::QueueService.new(service_options, &block)
end

.create_from_connection_string(connection_string, &block) ⇒ Azure::Storage::Queue::QueueService

Public: Creates an instance of [Azure::Storage::Queue::QueueService] from Environment Variables

Attributes

Returns:



104
105
106
107
 
# File 'lib/azure/storage/queue/queue_service.rb', line 104

def create_from_connection_string(connection_string, &block)
  service_options = { client: Azure::Storage::Common::Client::create_from_connection_string(connection_string, &block), api_version: Azure::Storage::Queue::Default::STG_VERSION }
  Azure::Storage::Queue::QueueService.new(service_options, &block)
end

.create_from_env(&block) ⇒ Azure::Storage::Queue::QueueService

Public: Creates an instance of [Azure::Storage::Queue::QueueService] from Environment Variables

Returns:



92
93
94
95
 
# File 'lib/azure/storage/queue/queue_service.rb', line 92

def create_from_env(&block)
  service_options = { client: Azure::Storage::Common::Client::create_from_env(&block), api_version: Azure::Storage::Queue::Default::STG_VERSION }
  Azure::Storage::Queue::QueueService.new(service_options, &block)
end

Instance Method Details

#clear_messages(queue_name, options = {}) ⇒ Object

Public: 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.

Attributes

  • queue_name - String. The name of the queue.

  • options - Hash. Optional parameters.

Options

Accepted key/value pairs in options parameter are:

  • :timeout - Integer. A timeout in seconds.

  • :request_id - String. Provides a client-generated, opaque value with a 1 KB character limit that is recorded

    in the analytics logs when storage analytics logging is enabled.

See msdn.microsoft.com/en-us/library/azure/dd179454

Returns nil on success



242
243
244
245
246
247
248
 
# File 'lib/azure/storage/queue/queue_service.rb', line 242

def clear_messages(queue_name, options = {})
  query = {}
  query["timeout"] = options[:timeout].to_s if options[:timeout]
  uri = messages_uri(queue_name, query)
  call(:delete, uri, nil, {}, options)
  nil
end

#create_message(queue_name, message_text, options = {}) ⇒ Object

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

Attributes

  • queue_name - String. The queue name.

  • message_text - String. The message contents. Note that the message content must be in a format that may be encoded with UTF-8.

  • options - Hash. Optional parameters.

Options

Accepted key/value pairs in options parameter are:

  • :visibility_timeout - 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. :visibility_timeout should be set to a value smaller than the
time-to-live value. If not specified, the default value is 0.

  • :message_ttl - Integer. Specifies the time-to-live interval for the message, in seconds. The maximum

    time-to-live allowed is 7 days. If not specified, the default time-to-live is 7 days.

  • :encode - Boolean. If set to true, the message will be base64 encoded.

  • :timeout - Integer. A timeout in seconds.

  • :request_id - String. Provides a client-generated, opaque value with a 1 KB character limit that is recorded

    in the analytics logs when storage analytics logging is enabled.

See msdn.microsoft.com/en-us/library/azure/dd179346

Returns a list of Azure::Storage::Queue::Message object containing only the echo of request on success



465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
 
# File 'lib/azure/storage/queue/queue_service.rb', line 465

def create_message(queue_name, message_text, options = {})
  query = {}

  unless options.empty?
    query["visibilitytimeout"] = options[:visibility_timeout] if options[:visibility_timeout]
    query["messagettl"] = options[:message_ttl] if options[:message_ttl]
    query["timeout"] = options[:timeout].to_s if options[:timeout]
  end

  uri = messages_uri(queue_name, query)
  body = Serialization.message_to_xml(message_text, options[:encode])

  response = call(:post, uri, body, {}, options)
  Serialization.queue_messages_from_xml(response.body, options[:decode])
end

#create_queue(queue_name, options = {}) ⇒ Object

Public: Creates a new queue under the storage account.

Attributes

  • queue_name - String. The queue name.

  • options - Hash. Optional parameters.

Options

Accepted key/value pairs in options parameter are:

  • :metadata - Hash. A hash of user defined metadata.

  • :timeout - Integer. A timeout in seconds.

  • :request_id - String. Provides a client-generated, opaque value with a 1 KB character limit that is recorded

    in the analytics logs when storage analytics logging is enabled.

See msdn.microsoft.com/en-us/library/azure/dd179342

Returns nil on success



268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/azure/storage/queue/queue_service.rb', line 268

def create_queue(queue_name, options = {})
  query = {}
  query["timeout"] = options[:timeout].to_s if options[:timeout]

  uri = queue_uri(queue_name, query)

  headers = {}
  StorageService.add_metadata_to_headers(options[:metadata] || {}, headers) if options[:metadata]

  call(:put, uri, nil, headers, options)
  nil
end

#delete_message(queue_name, message_id, pop_receipt, options = {}) ⇒ Object

Public: Deletes a specified message from the queue.

Attributes

  • queue_name - String. The queue name.

  • message_id - String. The id of the message.

  • pop_receipt - String. The valid pop receipt value returned from an earlier call to the Get Messages or

    Update Message operation.

  • options - Hash. Optional parameters.

Options

Accepted key/value pairs in options parameter are:

  • :timeout - Integer. A timeout in seconds.

  • :request_id - String. Provides a client-generated, opaque value with a 1 KB character limit that is recorded

    in the analytics logs when storage analytics logging is enabled.

See msdn.microsoft.com/en-us/library/azure/dd179347

Returns nil on success

Remarks:

When a message is successfully deleted, it is immediately marked for deletion and is no longer accessible to clients. The message is later removed from the queue during garbage collection.

After a client retrieves a message with the Get Messages operation, the client is expected to process and delete the message. To delete the message, you must have two items of data returned in the response body of the Get Messages operation:

  • The message ID, an opaque GUID value that identifies the message in the queue.

  • A valid pop receipt, an opaque value that indicates that the message has been retrieved.

The message ID is returned from the previous Get Messages operation. The pop receipt is returned from the most recent Get Messages or Update Message operation. In order for the Delete Message operation to succeed, the pop receipt specified on the request must match the pop receipt returned from the Get Messages or Update Message operation.

Pop receipts remain valid until one of the following events occurs:

  • The message has expired.

  • The message has been deleted using the last pop receipt received either from Get Messages or Update Message.

  • The invisibility time has elapsed and the message has been dequeued by a Get Messages request. When the

invisibility time elapses, the message becomes visible again. If it is retrieved by another Get Messages request, the returned pop receipt can be used to delete or update the message.

  • The message has been updated with a new visibility timeout. When the message is updated, a new pop receipt

will be returned.

If the message has already been deleted when Delete Message is called, the Queue service returns status code 404 (Not Found).

If a message with a matching pop receipt is not found, the service returns status code 400 (Bad Request), with additional error information indicating that the cause of the failure was a mismatched pop receipt.



539
540
541
542
543
544
545
546
547
 
# File 'lib/azure/storage/queue/queue_service.rb', line 539

def delete_message(queue_name, message_id, pop_receipt, options = {})
  query = { "popreceipt" => pop_receipt }
  query["timeout"] = options[:timeout].to_s if options[:timeout]

  uri = message_uri(queue_name, message_id, query)

  call(:delete, uri, nil, {}, options)
  nil
end

#delete_queue(queue_name, options = {}) ⇒ Object

Public: Deletes a queue.

Attributes

  • queue_name - String. The queue name.

  • options - Hash. Optional parameters.

Options

Accepted key/value pairs in options parameter are:

  • :timeout - Integer. A timeout in seconds.

  • :request_id - String. Provides a client-generated, opaque value with a 1 KB character limit that is recorded

    in the analytics logs when storage analytics logging is enabled.

See msdn.microsoft.com/en-us/library/azure/dd179436

Returns nil on success



298
299
300
301
302
303
304
305
306
 
# File 'lib/azure/storage/queue/queue_service.rb', line 298

def delete_queue(queue_name, options = {})
  query = {}
  query["timeout"] = options[:timeout].to_s if options[:timeout]

  uri = queue_uri(queue_name, query)

  call(:delete, uri, nil, {}, options)
  nil
end

#get_queue_acl(queue_name, options = {}) ⇒ Object

Public: Gets the access control list (ACL) for the queue.

Attributes

  • queue_name - String. The queue name.

  • options - Hash. Optional parameters.

Options

Accepted key/value pairs in options parameter are:

  • :timeout - Integer. A timeout in seconds.

  • :request_id - String. Provides a client-generated, opaque value with a 1 KB character limit that is recorded

    in the analytics logs when storage analytics logging is enabled.

  • :location_mode - LocationMode. Specifies the location mode used to decide

    which location the request should be sent to.

See msdn.microsoft.com/en-us/library/azure/jj159101

Returns a list of Azure::Storage::Entity::SignedIdentifier instances



397
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/azure/storage/queue/queue_service.rb', line 397

def get_queue_acl(queue_name, options = {})
  query = { "comp" => "acl" }
  query["timeout"] = options[:timeout].to_s if options[:timeout]

  options[:request_location_mode] = Azure::Storage::Common::RequestLocationMode::PRIMARY_OR_SECONDARY
  response = call(:get, queue_uri(queue_name, query, options), nil, {}, options)

  signed_identifiers = []
  signed_identifiers = Serialization.signed_identifiers_from_xml(response.body) unless response.body == (nil) || response.body.length < (1)
  signed_identifiers
end

#get_queue_metadata(queue_name, options = {}) ⇒ Object

Public: Returns queue properties, including user-defined metadata.

Attributes

  • queue_name - String. The queue name.

  • options - Hash. Optional parameters.

Options

Accepted key/value pairs in options parameter are:

  • :timeout - Integer. A timeout in seconds.

  • :request_id - String. Provides a client-generated, opaque value with a 1 KB character limit that is recorded

    in the analytics logs when storage analytics logging is enabled.

  • :location_mode - LocationMode. Specifies the location mode used to decide

    which location the request should be sent to.

See msdn.microsoft.com/en-us/library/azure/dd179384

Returns a tuple of (approximate_message_count, metadata)

  • approximate_messages_count - Integer. The approximate number of messages in the queue. This number is not lower than the actual number of messages in the queue, but could be higher.

  • metadata - Hash. The queue metadata (Default: {})



331
332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/azure/storage/queue/queue_service.rb', line 331

def get_queue_metadata(queue_name, options = {})
  query = { "comp" => "metadata" }
  query["timeout"] = options[:timeout].to_s if options[:timeout]

  options[:request_location_mode] = Azure::Storage::Common::RequestLocationMode::PRIMARY_OR_SECONDARY
  uri = queue_uri(queue_name, query, options)

  response = call(:get, uri, nil, {}, options)

  approximate_messages_count = response.headers["x-ms-approximate-messages-count"]
  metadata = Serialization.metadata_from_headers(response.headers)

  return approximate_messages_count.to_i, metadata
end

#list_messages(queue_name, visibility_timeout, options = {}) ⇒ Object

Public: Retrieves one or more messages from the front of the queue.

Attributes

  • queue_name - String. The queue name.

  • visibility_timeout - Integer. The new visibility timeout value, in seconds, relative to server time.

  • options - Hash. Optional parameters.

Options

Accepted key/value pairs in options parameter are:

  • :number_of_messages - Integer. How many messages to return. (optional, Default: 1)

  • :timeout - Integer. A timeout in seconds.

  • :request_id - String. Provides a client-generated, opaque value with a 1 KB character limit that is recorded

    in the analytics logs when storage analytics logging is enabled.

  • :decode - Boolean. Boolean value indicating if the message should be base64 decoded.

See msdn.microsoft.com/en-us/library/azure/dd179474

Returns a list of Azure::Storage::Entity::Queue::Message instances



605
606
607
608
609
610
611
612
613
614
615
616
617
 
# File 'lib/azure/storage/queue/queue_service.rb', line 605

def list_messages(queue_name, visibility_timeout, options = {})
  number_of_messages = 1
  number_of_messages = options[:number_of_messages] if options[:number_of_messages]

  query = { "visibilitytimeout" => visibility_timeout.to_s, "numofmessages" => number_of_messages.to_s }
  query["timeout"] = options[:timeout].to_s if options[:timeout]

  uri = messages_uri(queue_name, query)
  response = call(:get, uri, nil, {}, options)

  messages = Serialization.queue_messages_from_xml(response.body, options[:decode])
  messages
end

#list_queues(options = {}) ⇒ Object

Public: Get a list of Queues from the server

Attributes

  • options - Hash. Optional parameters.

Options

Accepted key/value pairs in options parameter are:

  • :prefix - String. Filters the results to return only containers

    whose name begins with the specified prefix. (optional)

  • :marker - String. An identifier the specifies the portion of the

    list to be returned. This value comes from the property
Azure::Service::EnumerationResults.continuation_token when there
are more containers available than were returned. The
marker value may then be used here to request the next set
of list items. (optional)

  • :max_results - Integer. Specifies the maximum number of containers to return.

    If max_results is not specified, or is a value greater than
5,000, the server will return up to 5,000 items. If it is set
to a value less than or equal to zero, the server will return
status code 400 (Bad Request). (optional)

  • :metadata - Boolean. Specifies whether or not to return the container metadata.

    (optional, Default=false)

  • :timeout - Integer. A timeout in seconds.

  • :request_id - String. Provides a client-generated, opaque value with a 1 KB character limit that is recorded

    in the analytics logs when storage analytics logging is enabled.

  • :location_mode - LocationMode. Specifies the location mode used to decide

    which location the request should be sent to.

NOTE: Metadata requested with the :metadata parameter must have been stored in accordance with the naming restrictions imposed by the 2009-09-19 version of the queue service. Beginning with that version, all metadata names must adhere to the naming conventions for C# identifiers.

See msdn.microsoft.com/en-us/library/azure/dd179466

Any metadata with invalid names which were previously stored, will be returned with the key “x-ms-invalid-name” in the metadata hash. This may contain multiple values and be an Array (vs a String if it only contains a single value).

Returns an Azure::Storage::Common::EnumerationResults



203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/azure/storage/queue/queue_service.rb', line 203

def list_queues(options = {})
  query = {}
  query["prefix"] = options[:prefix] if options[:prefix]
  query["marker"] = options[:marker] if options[:marker]
  query["maxresults"] = options[:max_results].to_s if options[:max_results]
  query["include"] = "metadata" if options[:metadata] == true
  query["timeout"] = options[:timeout].to_s if options[:timeout]

  options[:request_location_mode] = Azure::Storage::Common::RequestLocationMode::PRIMARY_OR_SECONDARY
  uri = collection_uri(query, options)
  response = call(:get, uri, nil, {}, options)

  Serialization.queue_enumeration_results_from_xml(response.body)
end

#peek_messages(queue_name, options = {}) ⇒ Object

Public: Retrieves one or more messages from the front of the queue, without changing the message visibility.

Attributes

  • queue_name - String. The queue name.

  • options - Hash. Optional parameters.

Options

Accepted key/value pairs in options parameter are:

  • :number_of_messages - Integer. How many messages to return. (optional, Default: 1)

  • :decode - Boolean. Boolean value indicating if the message should be base64 decoded.

  • :timeout - Integer. A timeout in seconds.

  • :request_id - String. Provides a client-generated, opaque value with a 1 KB character limit that is recorded

    in the analytics logs when storage analytics logging is enabled.

  • :location_mode - LocationMode. Specifies the location mode used to decide

    which location the request should be sent to.

See msdn.microsoft.com/en-us/library/azure/dd179472

Returns a list of Azure::Storage::Entity::Queue::Message instances



570
571
572
573
574
575
576
577
578
579
580
581
582
583
 
# File 'lib/azure/storage/queue/queue_service.rb', line 570

def peek_messages(queue_name, options = {})
  number_of_messages = 1
  number_of_messages = options[:number_of_messages] if options[:number_of_messages]

  query = { "peekonly" => "true", "numofmessages" => number_of_messages.to_s }
  query["timeout"] = options[:timeout].to_s if options[:timeout]

  options[:request_location_mode] = Azure::Storage::Common::RequestLocationMode::PRIMARY_OR_SECONDARY
  uri = messages_uri(queue_name, query, options)
  response = call(:get, uri, nil, {}, options)

  messages = Serialization.queue_messages_from_xml(response.body, options[:decode])
  messages
end

#set_queue_acl(queue_name, options = {}) ⇒ Object

Public: Sets the access control list (ACL) for the queue.

Attributes

  • queue_name - String. The queue name.

  • options - Hash. Optional parameters.

Options

Accepted key/value pairs in options parameter are:

  • :signed_identifiers - Array. A list of Azure::Storage::Entity::SignedIdentifier instances

  • :timeout - Integer. A timeout in seconds.

  • :request_id - String. Provides a client-generated, opaque value with a 1 KB character limit that is recorded

    in the analytics logs when storage analytics logging is enabled.

See msdn.microsoft.com/en-us/library/azure/jj159099

Returns nil on success



427
428
429
430
431
432
433
434
435
436
437
 
# File 'lib/azure/storage/queue/queue_service.rb', line 427

def set_queue_acl(queue_name, options = {})
  query = { "comp" => "acl" }
  query["timeout"] = options[:timeout].to_s if options[:timeout]

  uri = queue_uri(queue_name, query)
  body = nil
  body = Serialization.signed_identifiers_to_xml(options[:signed_identifiers]) if options[:signed_identifiers] && options[:signed_identifiers].length > 0

  call(:put, uri, body, {}, options)
  nil
end

#set_queue_metadata(queue_name, metadata, options = {}) ⇒ Object

Public: Sets user-defined metadata on the queue. To delete queue metadata, call this API with an empty hash in the metadata parameter.

Attributes

  • queue_name - String. The queue name.

  • metadata - Hash. A hash of user defined metadata

  • options - Hash. Optional parameters.

Options

Accepted key/value pairs in options parameter are:

  • :timeout - Integer. A timeout in seconds.

  • :request_id - String. Provides a client-generated, opaque value with a 1 KB character limit that is recorded

    in the analytics logs when storage analytics logging is enabled.

See msdn.microsoft.com/en-us/library/azure/dd179348

Returns nil on success



365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/azure/storage/queue/queue_service.rb', line 365

def set_queue_metadata(queue_name, metadata, options = {})
  query = { "comp" => "metadata" }
  query["timeout"] = options[:timeout].to_s if options[:timeout]

  uri = queue_uri(queue_name, query)

  headers = {}
  StorageService.add_metadata_to_headers(metadata || {}, headers)

  call(:put, uri, nil, headers, options)
  nil
end

#update_message(queue_name, message_id, pop_receipt, message_text, visibility_timeout, options = {}) ⇒ Object

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

Attributes

  • queue_name - String. The queue name.

  • message_id - String. The id of the message.

  • pop_receipt - String. The valid pop receipt value returned from an earlier call to the Get Messages or

    update Message operation.

  • message_text - String. The message contents. Note that the message content must be in a format that may

    be encoded with UTF-8.

  • visibility_timeout - Integer. The new visibility timeout value, in seconds, relative to server time.

  • options - Hash. Optional parameters.

Options

Accepted key/value pairs in options parameter are:

  • :encode - Boolean. If set to true, the message will be base64 encoded.

  • :timeout - Integer. A timeout in seconds.

  • :request_id - String. Provides a client-generated, opaque value with a 1 KB character limit that is recorded

    in the analytics logs when storage analytics logging is enabled.

See msdn.microsoft.com/en-us/library/azure/hh452234

Returns a tuple of (pop_receipt, time_next_visible)

  • pop_receipt - String. The pop receipt of the queue message.

  • time_next_visible - String. A UTC date/time value that represents when the message will be visible on the queue.

Remarks:

An Update Message operation will fail if the specified message does not exist in the queue, or if the specified pop receipt does not match the message.

A pop receipt is returned by the Get Messages operation or the Update Message operation. Pop receipts remain valid until one of the following events occurs:

  • The message has expired.

  • The message has been deleted using the last pop receipt received either from Get Messages or

Update Message.

  • The invisibility time has elapsed and the message has been dequeued by a Get Messages request. When

the invisibility time elapses, the message becomes visible again. If it is retrieved by another Get Messages request, the returned pop receipt can be used to delete or update the message.

  • The message has been updated with a new visibility timeout. When the message is updated, a new pop

receipt will be returned.

The Update Message operation can be used to continually extend the invisibility of a queue message. This functionality can be useful if you want a worker role to “lease” a queue message. For example, if a worker role calls Get Messages and recognizes that it needs more time to process a message, it can continually extend the message’s invisibility until it is processed. If the worker role were to fail during processing, eventually the message would become visible again and another worker role could process it.



672
673
674
675
676
677
678
679
680
681
682
683
 
# File 'lib/azure/storage/queue/queue_service.rb', line 672

def update_message(queue_name, message_id, pop_receipt, message_text, visibility_timeout, options = {})
  query = { "visibilitytimeout" => visibility_timeout.to_s, "popreceipt" => pop_receipt }
  query["timeout"] = options[:timeout].to_s if options[:timeout]

  uri = message_uri(queue_name, message_id, query)
  body = Serialization.message_to_xml(message_text, options[:encode])

  response = call(:put, uri, body, {}, options)
  new_pop_receipt = response.headers["x-ms-popreceipt"]
  time_next_visible = response.headers["x-ms-time-next-visible"]
  return new_pop_receipt, time_next_visible
end