AccountListSupportedImagesOptions Class

  • Reference
Package:
com.microsoft.azure.batch.protocol.models
Maven Artifact:
com.microsoft.azure:azure-batch:11.2.0
  • java.lang.Object
    • com.microsoft.azure.batch.protocol.models.AccountListSupportedImagesOptions

public class AccountListSupportedImagesOptions

Additional parameters for listSupportedImages operation.

Constructor Summary

Constructor Description
AccountListSupportedImagesOptions()

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.
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.
Integer timeout()

Get the maximum time that the server can spend processing the request, in seconds.
AccountListSupportedImagesOptions withClientRequestId(UUID clientRequestId)

Set the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.
AccountListSupportedImagesOptions withFilter(String filter)

Set an OData $filter clause.
AccountListSupportedImagesOptions withMaxResults(Integer maxResults)

Set the maximum number of items to return in the response.
AccountListSupportedImagesOptions withOcpDate(DateTime ocpDate)

Set the time the request was issued.
AccountListSupportedImagesOptions withReturnClientRequestId(Boolean returnClientRequestId)

Set whether the server should return the client-request-id in the response.
AccountListSupportedImagesOptions withTimeout(Integer timeout)

Set the maximum time that the server can spend processing the request, in seconds.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

AccountListSupportedImagesOptions

public AccountListSupportedImagesOptions()

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

filter

public String filter()

Get an OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/rest/api/batchservice/odata-filters-in-batch\#list-support-images.

Returns:

the filter value

maxResults

public Integer maxResults()

Get the maximum number of items to return in the response. A maximum of 1000 results will be returned.

Returns:

the maxResults 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

timeout

public Integer timeout()

Get the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.

Returns:

the timeout value

withClientRequestId

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

withFilter

public AccountListSupportedImagesOptions withFilter(String filter)

Set an OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/rest/api/batchservice/odata-filters-in-batch\#list-support-images.

Parameters:

filter - the filter value to set

Returns:

the AccountListSupportedImagesOptions object itself.

withMaxResults

public AccountListSupportedImagesOptions withMaxResults(Integer maxResults)

Set the maximum number of items to return in the response. A maximum of 1000 results will be returned.

Parameters:

maxResults - the maxResults value to set

Returns:

the AccountListSupportedImagesOptions object itself.

withOcpDate

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

withReturnClientRequestId

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

withTimeout

public AccountListSupportedImagesOptions withTimeout(Integer timeout)

Set the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.

Parameters:

timeout - the timeout value to set

Returns:

the AccountListSupportedImagesOptions object itself.

Applies to