Class TaskListOptions
- java.lang.Object
-
- com.microsoft.azure.batch.protocol.models.TaskListOptions
-
public class TaskListOptions extends Object
Additional parameters for list operation.
-
-
Constructor Summary
Constructors Constructor Description TaskListOptions()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description UUID
clientRequestId()
Get the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.String
expand()
Get an OData $expand clause.String
filter()
Get an OData $filter clause.Integer
maxResults()
Get the maximum number of items to return in the response.org.joda.time.DateTime
ocpDate()
Get the time the request was issued.Boolean
returnClientRequestId()
Get whether the server should return the client-request-id in the response.String
select()
Get an OData $select clause.Integer
timeout()
Get the maximum time that the server can spend processing the request, in seconds.TaskListOptions
withClientRequestId(UUID clientRequestId)
Set the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.TaskListOptions
withExpand(String expand)
Set an OData $expand clause.TaskListOptions
withFilter(String filter)
Set an OData $filter clause.TaskListOptions
withMaxResults(Integer maxResults)
Set the maximum number of items to return in the response.TaskListOptions
withOcpDate(org.joda.time.DateTime ocpDate)
Set the time the request was issued.TaskListOptions
withReturnClientRequestId(Boolean returnClientRequestId)
Set whether the server should return the client-request-id in the response.TaskListOptions
withSelect(String select)
Set an OData $select clause.TaskListOptions
withTimeout(Integer timeout)
Set the maximum time that the server can spend processing the request, in seconds.
-
-
-
Method Detail
-
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-tasks.- Returns:
- the filter value
-
withFilter
public TaskListOptions 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-tasks.- Parameters:
filter
- the filter value to set- Returns:
- the TaskListOptions object itself.
-
select
public String select()
Get an OData $select clause.- Returns:
- the select value
-
withSelect
public TaskListOptions withSelect(String select)
Set an OData $select clause.- Parameters:
select
- the select value to set- Returns:
- the TaskListOptions object itself.
-
expand
public String expand()
Get an OData $expand clause.- Returns:
- the expand value
-
withExpand
public TaskListOptions withExpand(String expand)
Set an OData $expand clause.- Parameters:
expand
- the expand value to set- Returns:
- the TaskListOptions object itself.
-
maxResults
public Integer maxResults()
Get the maximum number of items to return in the response. A maximum of 1000 Tasks can be returned.- Returns:
- the maxResults value
-
withMaxResults
public TaskListOptions withMaxResults(Integer maxResults)
Set the maximum number of items to return in the response. A maximum of 1000 Tasks can be returned.- Parameters:
maxResults
- the maxResults value to set- Returns:
- the TaskListOptions object itself.
-
timeout
public Integer timeout()
Get the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.- Returns:
- the timeout value
-
withTimeout
public TaskListOptions withTimeout(Integer timeout)
Set the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.- Parameters:
timeout
- the timeout value to set- Returns:
- the TaskListOptions object itself.
-
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:
- the clientRequestId value
-
withClientRequestId
public TaskListOptions 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:
clientRequestId
- the clientRequestId value to set- Returns:
- the TaskListOptions object itself.
-
returnClientRequestId
public Boolean returnClientRequestId()
Get whether the server should return the client-request-id in the response.- Returns:
- the returnClientRequestId value
-
withReturnClientRequestId
public TaskListOptions withReturnClientRequestId(Boolean returnClientRequestId)
Set whether the server should return the client-request-id in the response.- Parameters:
returnClientRequestId
- the returnClientRequestId value to set- Returns:
- the TaskListOptions object itself.
-
ocpDate
public org.joda.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.- Returns:
- the ocpDate value
-
withOcpDate
public TaskListOptions withOcpDate(org.joda.time.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:
ocpDate
- the ocpDate value to set- Returns:
- the TaskListOptions object itself.
-
-