FileGetFromTaskOptions Class
- java.
lang. Object - com.
microsoft. azure. batch. protocol. models. FileGetFromTaskOptions
- com.
public class FileGetFromTaskOptions
Additional parameters for getFromTask operation.
Method Summary
| Modifier and Type | Method and Description |
|---|---|
| UUID |
clientRequestId()
Get 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. |
| DateTime |
ifModifiedSince()
Get 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. |
| DateTime |
ifUnmodifiedSince()
Get 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. |
| DateTime |
ocpDate()
Get 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. |
| String |
ocpRange()
Get the byte range to be retrieved. The default is to retrieve the entire file. The format is bytes=startRange-endRange. |
| Boolean |
returnClientRequestId()
Get whether the server should return the client-request-id in the response. |
| Integer |
timeout()
Get the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. |
|
File |
withClientRequestId(UUID clientRequestId)
Set 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. |
|
File |
withIfModifiedSince(DateTime ifModifiedSince)
Set 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. |
|
File |
withIfUnmodifiedSince(DateTime ifUnmodifiedSince)
Set 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. |
|
File |
withOcpDate(DateTime ocpDate)
Set 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. |
|
File |
withOcpRange(String ocpRange)
Set the byte range to be retrieved. The default is to retrieve the entire file. The format is bytes=startRange-endRange. |
|
File |
withReturnClientRequestId(Boolean returnClientRequestId)
Set whether the server should return the client-request-id in the response. |
|
File |
withTimeout(Integer timeout)
Set the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. |
Method Details
clientRequestId
public UUID clientRequestId()
Get 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.
Returns:
ifModifiedSince
public DateTime ifModifiedSince()
Get 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.
Returns:
ifUnmodifiedSince
public DateTime ifUnmodifiedSince()
Get 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.
Returns:
ocpDate
public DateTime ocpDate()
Get 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.
Returns:
ocpRange
public String ocpRange()
Get the byte range to be retrieved. The default is to retrieve the entire file. The format is bytes=startRange-endRange.
Returns:
returnClientRequestId
public Boolean returnClientRequestId()
Get whether the server should return the client-request-id in the response.
Returns:
timeout
public Integer timeout()
Get the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
Returns:
withClientRequestId
public FileGetFromTaskOptions withClientRequestId(UUID clientRequestId)
Set 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.
Parameters:
Returns:
withIfModifiedSince
public FileGetFromTaskOptions withIfModifiedSince(DateTime ifModifiedSince)
Set 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.
Parameters:
Returns:
withIfUnmodifiedSince
public FileGetFromTaskOptions withIfUnmodifiedSince(DateTime ifUnmodifiedSince)
Set 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.
Parameters:
Returns:
withOcpDate
public FileGetFromTaskOptions withOcpDate(DateTime ocpDate)
Set 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.
Parameters:
Returns:
withOcpRange
public FileGetFromTaskOptions withOcpRange(String ocpRange)
Set the byte range to be retrieved. The default is to retrieve the entire file. The format is bytes=startRange-endRange.
Parameters:
Returns:
withReturnClientRequestId
public FileGetFromTaskOptions withReturnClientRequestId(Boolean returnClientRequestId)
Set whether the server should return the client-request-id in the response.
Parameters:
Returns:
withTimeout
public FileGetFromTaskOptions withTimeout(Integer timeout)
Set the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
Parameters:
Returns:
