FileGetFromComputeNodeOptions interface

Package:

@azure/batch

Additional parameters for getFromComputeNode 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.
ifModifiedSince	A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
ifUnmodifiedSince	A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
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.
ocpRange	The byte range to be retrieved. The default is to retrieve the entire file. The format is bytes=startRange-endRange.
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

ifModifiedSince

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.

ifModifiedSince?: Date

Property Value

Date

ifUnmodifiedSince

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.

ifUnmodifiedSince?: Date

Property Value

Date

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

ocpRange

The byte range to be retrieved. The default is to retrieve the entire file. The format is bytes=startRange-endRange.

ocpRange?: string

Property Value

string

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