CertificateListOptions Class
- java.
lang. Object - com.
microsoft. azure. batch. protocol. models. CertificateListOptions
- com.
public class CertificateListOptions
Additional parameters for list operation.
Constructor Summary
Constructor | Description | |
---|---|---|
CertificateListOptions() |
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. |
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. |
Certificate |
withClientRequestId(UUID clientRequestId)
Set the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e. |
Certificate |
withFilter(String filter)
Set an OData $filter clause. |
Certificate |
withMaxResults(Integer maxResults)
Set the maximum number of items to return in the response. |
Certificate |
withOcpDate(DateTime ocpDate)
Set the time the request was issued. |
Certificate |
withReturnClientRequestId(Boolean returnClientRequestId)
Set whether the server should return the client-request-id in the response. |
Certificate |
withSelect(String select)
Set an OData $select clause. |
Certificate |
withTimeout(Integer timeout)
Set the maximum time that the server can spend processing the request, in seconds. |
Methods inherited from java.lang.Object
Constructor Details
CertificateListOptions
public CertificateListOptions()
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:
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-certificates.
Returns:
maxResults
public Integer maxResults()
Get the maximum number of items to return in the response. A maximum of 1000 Certificates can be returned.
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. If the value is larger than 30, the default will be used instead.
Returns:
withClientRequestId
public CertificateListOptions 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:
withFilter
public CertificateListOptions 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-certificates.
Parameters:
Returns:
withMaxResults
public CertificateListOptions withMaxResults(Integer maxResults)
Set the maximum number of items to return in the response. A maximum of 1000 Certificates can be returned.
Parameters:
Returns:
withOcpDate
public CertificateListOptions 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 CertificateListOptions withReturnClientRequestId(Boolean returnClientRequestId)
Set whether the server should return the client-request-id in the response.
Parameters:
Returns:
withSelect
public CertificateListOptions withSelect(String select)
Set an OData $select clause.
Parameters:
Returns:
withTimeout
public CertificateListOptions 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:
Returns:
Applies to
Azure SDK for Java