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