JobListFromJobScheduleOptions Class
- java.
lang. Object - com.
microsoft. azure. batch. protocol. models. JobListFromJobScheduleOptions
- com.
public class JobListFromJobScheduleOptions
Additional parameters for listFromJobSchedule 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-jobs-in-a-job-schedule. |
Integer |
maxResults()
Get the maximum number of items to return in the response. A maximum of 1000 jobs 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. |
Job |
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. |
Job |
withExpand(String expand)
Set an OData $expand clause. |
Job |
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-in-a-job-schedule. |
Job |
withMaxResults(Integer maxResults)
Set the maximum number of items to return in the response. A maximum of 1000 jobs can be returned. |
Job |
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. |
Job |
withReturnClientRequestId(Boolean returnClientRequestId)
Set whether the server should return the client-request-id in the response. |
Job |
withSelect(String select)
Set an OData $select clause. |
Job |
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:
expand
public String expand()
Get an OData $expand clause.
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-jobs-in-a-job-schedule.
Returns:
maxResults
public Integer maxResults()
Get the maximum number of items to return in the response. A maximum of 1000 jobs 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:
select
public String select()
Get an OData $select clause.
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 JobListFromJobScheduleOptions 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:
withExpand
public JobListFromJobScheduleOptions withExpand(String expand)
Set an OData $expand clause.
Parameters:
Returns:
withFilter
public JobListFromJobScheduleOptions 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-in-a-job-schedule.
Parameters:
Returns:
withMaxResults
public JobListFromJobScheduleOptions withMaxResults(Integer maxResults)
Set the maximum number of items to return in the response. A maximum of 1000 jobs can be returned.
Parameters:
Returns:
withOcpDate
public JobListFromJobScheduleOptions 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 JobListFromJobScheduleOptions withReturnClientRequestId(Boolean returnClientRequestId)
Set whether the server should return the client-request-id in the response.
Parameters:
Returns:
withSelect
public JobListFromJobScheduleOptions withSelect(String select)
Set an OData $select clause.
Parameters:
Returns:
withTimeout
public JobListFromJobScheduleOptions 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