CreateMessageRequestOptions interface
Common request options for azure storage services
- Extends
-
azure-storage.export=.common.RequestOptions
Properties
message |
{int} The time-to-live interval for the message, in seconds. The maximum time-to-live allowed is 7 days. If this parameter is omitted, the default time-to-live is 7 days |
visibility |
{int} 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. visibilitytimeout should be set to a value smaller than the time-to-live value. |
Inherited Properties
client |
{string} A string that represents the client request ID with a 1KB character limit. |
client |
{int} The timeout of client requests, in milliseconds, to use for the request. |
location |
{LocationMode} Specifies the location mode used to decide which location the request should be sent to. |
maximum |
{int} The maximum execution time, in milliseconds, across all potential retries, to use when making this request. |
timeout |
{int} The server timeout interval, in milliseconds, to use for the request. |
use |
{bool} Determines whether the Nagle algorithm is used; true to use the Nagle algorithm; otherwise, false. |
Property Details
messageTimeToLive
{int} The time-to-live interval for the message, in seconds. The maximum time-to-live allowed is 7 days. If this parameter is omitted, the default time-to-live is 7 days
messageTimeToLive?: number
Property Value
number
visibilityTimeout
{int} 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. visibilitytimeout should be set to a value smaller than the time-to-live value.
visibilityTimeout?: number
Property Value
number
Inherited Property Details
clientRequestId
{string} A string that represents the client request ID with a 1KB character limit.
clientRequestId?: string
Property Value
string
Inherited From RequestOptions.clientRequestId
clientRequestTimeoutInMs
{int} The timeout of client requests, in milliseconds, to use for the request.
clientRequestTimeoutInMs?: number
Property Value
number
Inherited From RequestOptions.clientRequestTimeoutInMs
locationMode
{LocationMode} Specifies the location mode used to decide which location the request should be sent to.
locationMode?: LocationMode
Property Value
azure-storage.export=.common.util.storageutilities.LocationMode
Inherited From RequestOptions.locationMode
maximumExecutionTimeInMs
{int} The maximum execution time, in milliseconds, across all potential retries, to use when making this request.
maximumExecutionTimeInMs?: number
Property Value
number
Inherited From RequestOptions.maximumExecutionTimeInMs
timeoutIntervalInMs
{int} The server timeout interval, in milliseconds, to use for the request.
timeoutIntervalInMs?: number
Property Value
number
Inherited From RequestOptions.timeoutIntervalInMs
useNagleAlgorithm
{bool} Determines whether the Nagle algorithm is used; true to use the Nagle algorithm; otherwise, false.
useNagleAlgorithm?: boolean
Property Value
boolean
Inherited From RequestOptions.useNagleAlgorithm
Azure SDK for JavaScript
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for