ComputeNodeExtensionListOptions 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.ComputeNodeExtensionListOptions

public class ComputeNodeExtensionListOptions

Additional parameters for list operation.

Constructor Summary

Constructor Description
ComputeNodeExtensionListOptions()

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.
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.
ComputeNodeExtensionListOptions withClientRequestId(UUID clientRequestId)

Set the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.
ComputeNodeExtensionListOptions withMaxResults(Integer maxResults)

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

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

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

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

ComputeNodeExtensionListOptions

public ComputeNodeExtensionListOptions()

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

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

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. If the value is larger than 30, the default will be used instead.

Returns:

the timeout value

withClientRequestId

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

withMaxResults

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

withOcpDate

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

withReturnClientRequestId

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

withSelect

public ComputeNodeExtensionListOptions withSelect(String select)

Set an OData $select clause.

Parameters:

select - the select value to set

Returns:

the ComputeNodeExtensionListOptions object itself.

withTimeout

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

Applies to