FileListFromTaskOptions Class
- java.
lang. Object - com.
microsoft. azure. batch. protocol. models. FileListFromTaskOptions
- com.
public class FileListFromTaskOptions
Additional parameters for listFromTask 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. |
String |
filter()
Get 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-task-files. |
Integer |
maxResults()
Get the maximum number of items to return in the response. A maximum of 1000 files can be returned. |
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. |
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 |
withFilter(String filter)
Set 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-task-files. |
File |
withMaxResults(Integer maxResults)
Set the maximum number of items to return in the response. A maximum of 1000 files can be returned. |
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 |
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:
filter
public String filter()
Get 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-task-files.
Returns:
maxResults
public Integer maxResults()
Get the maximum number of items to return in the response. A maximum of 1000 files can be returned.
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:
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 FileListFromTaskOptions 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:
withFilter
public FileListFromTaskOptions withFilter(String filter)
Set 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-task-files.
Parameters:
Returns:
withMaxResults
public FileListFromTaskOptions withMaxResults(Integer maxResults)
Set the maximum number of items to return in the response. A maximum of 1000 files can be returned.
Parameters:
Returns:
withOcpDate
public FileListFromTaskOptions 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:
withReturnClientRequestId
public FileListFromTaskOptions withReturnClientRequestId(Boolean returnClientRequestId)
Set whether the server should return the client-request-id in the response.
Parameters:
Returns:
withTimeout
public FileListFromTaskOptions withTimeout(Integer timeout)
Set the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
Parameters:
Returns:
Applies to
Azure SDK for Java