ServiceListSharesSegmentOptionalParams interface
Optional Parameters.
- Extends
-
RequestOptionsBase
Properties
abort |
The signal which can be used to abort requests. |
custom |
{object} [customHeaders] User defined custom request headers that will be applied before the request is sent. |
include | Include this parameter to specify one or more datasets to include in the response. |
marker | A string value that identifies the portion of the list to be returned with the next list operation. The operation returns a marker value within the response body if the list returned was not complete. The marker value may then be used in a subsequent call to request the next set of list items. The marker value is opaque to the client. |
maxresults | Specifies the maximum number of entries to return. If the request does not specify maxresults, or specifies a value greater than 5,000, the server will return up to 5,000 items. |
on |
Callback which fires upon download progress. |
on |
Callback which fires upon upload progress. |
prefix | Filters the results to return only entries whose name begins with the specified prefix. |
timeout | The number of milliseconds a request can take before automatically being terminated. |
timeout |
The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations. |
Property Details
abortSignal
The signal which can be used to abort requests.
abortSignal?: AbortSignalLike
Property Value
AbortSignalLike
customHeaders
{object} [customHeaders] User defined custom request headers that will be applied before the request is sent.
customHeaders?: undefined | [key: string]: string
Property Value
undefined | [key: string]: string
include
Include this parameter to specify one or more datasets to include in the response.
include?: ListSharesIncludeType[]
Property Value
marker
A string value that identifies the portion of the list to be returned with the next list operation. The operation returns a marker value within the response body if the list returned was not complete. The marker value may then be used in a subsequent call to request the next set of list items. The marker value is opaque to the client.
marker?: undefined | string
Property Value
undefined | string
maxresults
Specifies the maximum number of entries to return. If the request does not specify maxresults, or specifies a value greater than 5,000, the server will return up to 5,000 items.
maxresults?: undefined | number
Property Value
undefined | number
onDownloadProgress
Callback which fires upon download progress.
onDownloadProgress?: undefined | (progress: TransferProgressEvent) => void
Property Value
undefined | (progress: TransferProgressEvent) => void
onUploadProgress
Callback which fires upon upload progress.
onUploadProgress?: undefined | (progress: TransferProgressEvent) => void
Property Value
undefined | (progress: TransferProgressEvent) => void
prefix
Filters the results to return only entries whose name begins with the specified prefix.
prefix?: undefined | string
Property Value
undefined | string
timeout
The number of milliseconds a request can take before automatically being terminated.
timeout?: undefined | number
Property Value
undefined | number
timeoutParameter
The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.
timeoutParameter?: undefined | number
Property Value
undefined | number
Azure SDK for JavaScript