ListBlobPrefixesSegmentedRequestOptions interface

Package:

azure-storage

Common request options for azure storage services

Extends

azure-storage.export=.services.blob.blobservice.BlobService.ListBlobsSegmentedRequestOptions

Inherited Properties

clientRequestId	{string} A string that represents the client request ID with a 1KB character limit.
clientRequestTimeoutInMs	{int} The timeout of client requests, in milliseconds, to use for the request.
delimiter	{string} Delimiter, i.e. '/', for specifying folder hierarchy.
include	{string} Specifies that the response should include one or more of the following subsets: '', 'metadata', 'snapshots', 'uncommittedblobs'). Multiple values can be added separated with a comma (,)
locationMode	{LocationMode} Specifies the location mode used to decide which location the request should be sent to.
maximumExecutionTimeInMs	{int} The maximum execution time, in milliseconds, across all potential retries, to use when making this request.
maxResults	{int} Specifies the maximum number of blobs to return per call to Azure ServiceClient. (maximum: 5000)
timeoutIntervalInMs	{int} The server timeout interval, in milliseconds, to use for the request.
useNagleAlgorithm	{bool} Determines whether the Nagle algorithm is used; true to use the Nagle algorithm; otherwise, false.

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 ListBlobsSegmentedRequestOptions.clientRequestId

clientRequestTimeoutInMs

{int} The timeout of client requests, in milliseconds, to use for the request.

clientRequestTimeoutInMs?: number

Property Value

number

Inherited From ListBlobsSegmentedRequestOptions.clientRequestTimeoutInMs

delimiter

{string} Delimiter, i.e. '/', for specifying folder hierarchy.

delimiter?: string

Property Value

string

Inherited From ListBlobsSegmentedRequestOptions.delimiter

include

{string} Specifies that the response should include one or more of the following subsets: '', 'metadata', 'snapshots', 'uncommittedblobs'). Multiple values can be added separated with a comma (,)

include?: string

Property Value

string

Inherited From ListBlobsSegmentedRequestOptions.include

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 ListBlobsSegmentedRequestOptions.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 ListBlobsSegmentedRequestOptions.maximumExecutionTimeInMs

maxResults

{int} Specifies the maximum number of blobs to return per call to Azure ServiceClient. (maximum: 5000)

maxResults?: number

Property Value

number

Inherited From ListBlobsSegmentedRequestOptions.maxResults

timeoutIntervalInMs

{int} The server timeout interval, in milliseconds, to use for the request.

timeoutIntervalInMs?: number

Property Value

number

Inherited From ListBlobsSegmentedRequestOptions.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 ListBlobsSegmentedRequestOptions.useNagleAlgorithm