PoolGetOptions Class
- java.
lang. Object - com.
microsoft. azure. batch. protocol. models. PoolGetOptions
- com.
public class PoolGetOptions
Additional parameters for get 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 |
ifMatch()
Get an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client. |
| DateTime |
ifModifiedSince()
Get a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time. |
| String |
ifNoneMatch()
Get an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client. |
| DateTime |
ifUnmodifiedSince()
Get a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified 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. |
| 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. |
|
Pool |
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. |
|
Pool |
withExpand(String expand)
Set an OData $expand clause. |
|
Pool |
withIfMatch(String ifMatch)
Set an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client. |
|
Pool |
withIfModifiedSince(DateTime ifModifiedSince)
Set a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time. |
|
Pool |
withIfNoneMatch(String ifNoneMatch)
Set an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client. |
|
Pool |
withIfUnmodifiedSince(DateTime ifUnmodifiedSince)
Set a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time. |
|
Pool |
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. |
|
Pool |
withReturnClientRequestId(Boolean returnClientRequestId)
Set whether the server should return the client-request-id in the response. |
|
Pool |
withSelect(String select)
Set an OData $select clause. |
|
Pool |
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:
ifMatch
public String ifMatch()
Get an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
Returns:
ifModifiedSince
public DateTime ifModifiedSince()
Get a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
Returns:
ifNoneMatch
public String ifNoneMatch()
Get an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
Returns:
ifUnmodifiedSince
public DateTime ifUnmodifiedSince()
Get a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
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 PoolGetOptions 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 PoolGetOptions withExpand(String expand)
Set an OData $expand clause.
Parameters:
Returns:
withIfMatch
public PoolGetOptions withIfMatch(String ifMatch)
Set an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
Parameters:
Returns:
withIfModifiedSince
public PoolGetOptions withIfModifiedSince(DateTime ifModifiedSince)
Set a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
Parameters:
Returns:
withIfNoneMatch
public PoolGetOptions withIfNoneMatch(String ifNoneMatch)
Set an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
Parameters:
Returns:
withIfUnmodifiedSince
public PoolGetOptions withIfUnmodifiedSince(DateTime ifUnmodifiedSince)
Set a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
Parameters:
Returns:
withOcpDate
public PoolGetOptions 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 PoolGetOptions withReturnClientRequestId(Boolean returnClientRequestId)
Set whether the server should return the client-request-id in the response.
Parameters:
Returns:
withSelect
public PoolGetOptions withSelect(String select)
Set an OData $select clause.
Parameters:
Returns:
withTimeout
public PoolGetOptions withTimeout(Integer timeout)
Set the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
Parameters:
Returns:
