Share via

TaskListOptions Class

  • Reference
Package:
com.microsoft.azure.batch.protocol.models
  • java.lang.Object
    • com.microsoft.azure.batch.protocol.models.TaskListOptions

public class TaskListOptions

Additional parameters for list 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 expand()

Get an OData $expand clause.
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.
Integer maxResults()

Get the maximum number of items to return in the response. A maximum of 1000 tasks 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.
String select()

Get an OData $select clause.
Integer timeout()

Get the maximum time that the server can spend processing the request, in seconds. The default is 30 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. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
TaskListOptions withExpand(String expand)

Set an OData $expand clause.
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.
TaskListOptions withMaxResults(Integer maxResults)

Set the maximum number of items to return in the response. A maximum of 1000 tasks can be returned.
TaskListOptions 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.
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. 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:

the clientRequestId value

expand

public String expand()

Get an OData $expand clause.

Returns:

the expand value

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

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

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:

the ocpDate value

returnClientRequestId

public Boolean returnClientRequestId()

Get whether the server should return the client-request-id in the response.

Returns:

the returnClientRequestId value

select

public String select()

Get an OData $select clause.

Returns:

the select value

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

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.

withExpand

public TaskListOptions withExpand(String expand)

Set an OData $expand clause.

Parameters:

expand - the expand value to set

Returns:

the TaskListOptions object itself.

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.

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.

withOcpDate

public TaskListOptions 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:

ocpDate - the ocpDate value to set

Returns:

the TaskListOptions object itself.

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.

withSelect

public TaskListOptions withSelect(String select)

Set an OData $select clause.

Parameters:

select - the select value to set

Returns:

the TaskListOptions object itself.

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.

Applies to