Query Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| timeout | Integer | No | The timeout parameter is expressed in seconds. For more + * information, see + * <a + * href="https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations">Setting + * Timeouts for Queue Service Operations.</a> |
Header Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| Content-Type | String | No | The content type. Allowed values: + * "application/xml". |
Request Body Schema
+ * + *
+ * {@code
+ * {
+ * MessageText: String (Required)
+ * }
+ * }
+ *
*
- * @param queueName The queue name.
- * @param messageid The message ID name.
- * @param popReceipt Required. Specifies the valid pop receipt value returned from an earlier call to the Get
- * Messages or Update Message operation.
- * @param visibilitytimeout Optional. Specifies the new visibility timeout value, in seconds, relative to server
- * time. The default value is 30 seconds. A specified value must be larger than or equal to 1 second, and cannot be
- * larger than 7 days, or larger than 2 hours on REST protocol versions prior to version 2011-08-18. The visibility
- * timeout of a message can be set to a value later than the expiry time.
- * @param timeout The The timeout parameter is expressed in seconds. For more information, see <a
- * href="https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-queue-service-operations>Setting
- * Timeouts for Queue Service Operations.</a>.
- * @param requestId 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.
- * @param queueMessage A Message object which can be stored in a Queue.
- * @param context The context to associate with this operation.
- * @throws IllegalArgumentException thrown if parameters fail the validation.
- * @throws QueueStorageExceptionInternal thrown if the request is rejected by server.
- * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
- * @return A {@link Mono} that completes when a successful response is received.
- */
- @ServiceMethod(returns = ReturnType.SINGLE)
- public MonoQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| timeout | Integer | No | The timeout parameter is expressed in seconds. For more + * information, see + * <a + * href="https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations">Setting + * Timeouts for Queue Service Operations.</a> |
Header Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| Content-Type | String | No | The content type. Allowed values: + * "application/xml". |
Request Body Schema
+ * + *
+ * {@code
+ * {
+ * MessageText: String (Required)
+ * }
+ * }
+ *
*
- * @param queueName The queue name.
- * @param messageid The message ID name.
- * @param popReceipt Required. Specifies the valid pop receipt value returned from an earlier call to the Get
- * Messages or Update Message operation.
- * @param visibilitytimeout Optional. Specifies the new visibility timeout value, in seconds, relative to server
- * time. The default value is 30 seconds. A specified value must be larger than or equal to 1 second, and cannot be
- * larger than 7 days, or larger than 2 hours on REST protocol versions prior to version 2011-08-18. The visibility
- * timeout of a message can be set to a value later than the expiry time.
- * @param timeout The The timeout parameter is expressed in seconds. For more information, see <a
- * href="https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-queue-service-operations>Setting
- * Timeouts for Queue Service Operations.</a>.
- * @param requestId 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.
- * @param queueMessage A Message object which can be stored in a Queue.
- * @param context The context to associate with this operation.
- * @throws IllegalArgumentException thrown if parameters fail the validation.
- * @throws QueueStorageExceptionInternal thrown if the request is rejected by server.
- * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
- * @return the {@link Response} on successful completion of {@link Mono}.
- */
- @ServiceMethod(returns = ReturnType.SINGLE)
- public MonoQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| timeout | Integer | No | The timeout parameter is expressed in seconds. For more + * information, see + * <a + * href="https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations">Setting + * Timeouts for Queue Service Operations.</a> |
Query Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| timeout | Integer | No | The timeout parameter is expressed in seconds. For more + * information, see + * <a + * href="https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations">Setting + * Timeouts for Queue Service Operations.</a> |
Query Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| numofmessages | Integer | No | A nonzero integer value that specifies the number of + * messages to + * retrieve from the queue, up to a maximum of 32. If fewer are visible, the + * visible messages are returned. By default, a single message is retrieved from + * the queue with this operation. |
| visibilitytimeout | Integer | No | Specifies the new visibility timeout value, in + * seconds, relative to server time. A specified value must be + * larger than or equal to 1 second, and cannot be larger than 7 days. The visibility timeout of a message + * can be set to a value later than the expiry time. |
| timeout | Integer | No | The timeout parameter is expressed in seconds. For more + * information, see + * <a + * href="https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations">Setting + * Timeouts for Queue Service Operations.</a> |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * QueueMessage (Required): [
+ * (Required){
+ * MessageId: String (Required)
+ * InsertionTime: DateTimeRfc1123 (Required)
+ * ExpirationTime: DateTimeRfc1123 (Required)
+ * PopReceipt: String (Required)
+ * TimeNextVisible: DateTimeRfc1123 (Required)
+ * DequeueCount: long (Required)
+ * MessageText: String (Required)
+ * }
+ * ]
+ * }
+ * }
+ *
+ *
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response of receive messages along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| numofmessages | Integer | No | A nonzero integer value that specifies the number of + * messages to + * retrieve from the queue, up to a maximum of 32. If fewer are visible, the + * visible messages are returned. By default, a single message is retrieved from + * the queue with this operation. |
| visibilitytimeout | Integer | No | Specifies the new visibility timeout value, in + * seconds, relative to server time. A specified value must be + * larger than or equal to 1 second, and cannot be larger than 7 days. The visibility timeout of a message + * can be set to a value later than the expiry time. |
| timeout | Integer | No | The timeout parameter is expressed in seconds. For more + * information, see + * <a + * href="https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations">Setting + * Timeouts for Queue Service Operations.</a> |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * QueueMessage (Required): [
+ * (Required){
+ * MessageId: String (Required)
+ * InsertionTime: DateTimeRfc1123 (Required)
+ * ExpirationTime: DateTimeRfc1123 (Required)
+ * PopReceipt: String (Required)
+ * TimeNextVisible: DateTimeRfc1123 (Required)
+ * DequeueCount: long (Required)
+ * MessageText: String (Required)
+ * }
+ * ]
+ * }
+ * }
+ *
+ *
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response of receive messages along with {@link Response}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| timeout | Integer | No | The timeout parameter is expressed in seconds. For more + * information, see + * <a + * href="https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations">Setting + * Timeouts for Queue Service Operations.</a> |
Query Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| timeout | Integer | No | The timeout parameter is expressed in seconds. For more + * information, see + * <a + * href="https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations">Setting + * Timeouts for Queue Service Operations.</a> |