PoolGetOptions Class

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

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.
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.
PoolGetOptions withExpand(String expand)

Set an OData $expand clause.
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.
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.
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.
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.
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.
PoolGetOptions withReturnClientRequestId(Boolean returnClientRequestId)

Set whether the server should return the client-request-id in the response.
PoolGetOptions withSelect(String select)

Set an OData $select clause.
PoolGetOptions 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

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:

the ifMatch value

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:

the ifModifiedSince value

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:

the ifNoneMatch value

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:

the ifUnmodifiedSince 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 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:

clientRequestId - the clientRequestId value to set

Returns:

the PoolGetOptions object itself.

withExpand

public PoolGetOptions withExpand(String expand)

Set an OData $expand clause.

Parameters:

expand - the expand value to set

Returns:

the PoolGetOptions object itself.

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:

ifMatch - the ifMatch value to set

Returns:

the PoolGetOptions object itself.

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:

ifModifiedSince - the ifModifiedSince value to set

Returns:

the PoolGetOptions object itself.

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:

ifNoneMatch - the ifNoneMatch value to set

Returns:

the PoolGetOptions object itself.

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:

ifUnmodifiedSince - the ifUnmodifiedSince value to set

Returns:

the PoolGetOptions object itself.

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:

ocpDate - the ocpDate value to set

Returns:

the PoolGetOptions object itself.

withReturnClientRequestId

public PoolGetOptions 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 PoolGetOptions object itself.

withSelect

public PoolGetOptions withSelect(String select)

Set an OData $select clause.

Parameters:

select - the select value to set

Returns:

the PoolGetOptions object itself.

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:

timeout - the timeout value to set

Returns:

the PoolGetOptions object itself.

Applies to