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