public class CreateQueueOptions extends QueueServiceOptions
createQueue request. These options include a server response timeout for the
request and the metadata to associate with the created queue.| Constructor and Description |
|---|
CreateQueueOptions() |
| Modifier and Type | Method and Description |
|---|---|
CreateQueueOptions |
addMetadata(String key,
String value)
Adds a key-value pair of
String to the metadata collection to set
on a queue when the queue is created. |
HashMap<String,String> |
getMetadata()
Gets the metadata collection of key-value
String pairs to set on
a queue when the queue is created. |
CreateQueueOptions |
setMetadata(HashMap<String,String> metadata)
Sets the metadata collection of key-value
String pairs to set on
a queue when the queue is created. |
CreateQueueOptions |
setTimeout(Integer timeout)
Sets the server request timeout value associated with this
CreateQueueOptions instance. |
getTimeoutpublic CreateQueueOptions setTimeout(Integer timeout)
CreateQueueOptions instance.
The timeout value only affects calls made on methods where this
CreateQueueOptions instance is passed as a parameter.
setTimeout in class QueueServiceOptionstimeout - The server request timeout value to set in milliseconds.CreateQueueOptions instance.public HashMap<String,String> getMetadata()
String pairs to set on
a queue when the queue is created.public CreateQueueOptions setMetadata(HashMap<String,String> metadata)
String pairs to set on
a queue when the queue is created. Queue metadata is a user-defined
collection of key-value pairs that is opaque to the server.
The metadata value is only added to a newly created queue where
this CreateQueueOptions instance is passed as a parameter.
metadata - The HashMap of key-value String
pairs containing the metadata to set on the queue.CreateQueueOptions instance.public CreateQueueOptions addMetadata(String key, String value)
String to the metadata collection to set
on a queue when the queue is created. Queue metadata is a user-defined
collection of key-value pairs that is opaque to the server. If the key
already exists in the metadata collection, the value parameter will
overwrite the existing value paired with that key without notification.
The updated metadata is only added to a newly created queue where this
CreateQueueOptions instance is passed as a parameter.
key - A String containing the key part of the key-value pair
to add to the metadata.value - A String containing the value part of the key-value
pair to add to the metadata.CreateQueueOptions instance./**
* Copyright Microsoft Corporation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/