FileListFromComputeNodeOptions interface

Package:

@azure/batch

Additional parameters for listFromComputeNode operation.

Properties

clientRequestId	The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
filter	An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-compute-node-files.
maxResults	The maximum number of items to return in the response. A maximum of 1000 files can be returned. Default value: 1000.
ocpDate	The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
returnClientRequestId	Whether the server should return the client-request-id in the response. Default value: false.
timeout	The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

Property Details

clientRequestId

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

clientRequestId?: string

Property Value

string

filter

An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-compute-node-files.

filter?: string

Property Value

string

maxResults

The maximum number of items to return in the response. A maximum of 1000 files can be returned. Default value: 1000.

maxResults?: number

Property Value

number

ocpDate

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

ocpDate?: Date

Property Value

Date

returnClientRequestId

Whether the server should return the client-request-id in the response. Default value: false.

returnClientRequestId?: boolean

Property Value

boolean

timeout

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

timeout?: number

Property Value

number