156 строки
11 KiB
YAML
156 строки
11 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.batch.protocol.models.ApplicationListOptions"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.ApplicationListOptions"
|
|
name: "ApplicationListOptions"
|
|
nameWithType: "ApplicationListOptions"
|
|
summary: "Additional parameters for list operation."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public class **ApplicationListOptions**"
|
|
constructors:
|
|
- uid: "com.microsoft.azure.batch.protocol.models.ApplicationListOptions.ApplicationListOptions()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.ApplicationListOptions.ApplicationListOptions()"
|
|
name: "ApplicationListOptions()"
|
|
nameWithType: "ApplicationListOptions.ApplicationListOptions()"
|
|
syntax: "public ApplicationListOptions()"
|
|
methods:
|
|
- uid: "com.microsoft.azure.batch.protocol.models.ApplicationListOptions.clientRequestId()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.ApplicationListOptions.clientRequestId()"
|
|
name: "clientRequestId()"
|
|
nameWithType: "ApplicationListOptions.clientRequestId()"
|
|
summary: "Get the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.<wbr>g."
|
|
syntax: "public UUID clientRequestId()"
|
|
desc: "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:
|
|
description: "the clientRequestId value"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/UUID.html\">UUID</a>"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.ApplicationListOptions.maxResults()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.ApplicationListOptions.maxResults()"
|
|
name: "maxResults()"
|
|
nameWithType: "ApplicationListOptions.maxResults()"
|
|
summary: "Get the maximum number of items to return in the response."
|
|
syntax: "public Integer maxResults()"
|
|
desc: "Get the maximum number of items to return in the response. A maximum of 1000 applications can be returned."
|
|
returns:
|
|
description: "the maxResults value"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.ApplicationListOptions.ocpDate()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.ApplicationListOptions.ocpDate()"
|
|
name: "ocpDate()"
|
|
nameWithType: "ApplicationListOptions.ocpDate()"
|
|
summary: "Get the time the request was issued."
|
|
syntax: "public DateTime ocpDate()"
|
|
desc: "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:
|
|
description: "the ocpDate value"
|
|
type: "<xref href=\"org.joda.time.DateTime?alt=org.joda.time.DateTime&text=DateTime\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.ApplicationListOptions.returnClientRequestId()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.ApplicationListOptions.returnClientRequestId()"
|
|
name: "returnClientRequestId()"
|
|
nameWithType: "ApplicationListOptions.returnClientRequestId()"
|
|
summary: "Get whether the server should return the client-request-id in the response."
|
|
syntax: "public Boolean returnClientRequestId()"
|
|
desc: "Get whether the server should return the client-request-id in the response."
|
|
returns:
|
|
description: "the returnClientRequestId value"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.ApplicationListOptions.timeout()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.ApplicationListOptions.timeout()"
|
|
name: "timeout()"
|
|
nameWithType: "ApplicationListOptions.timeout()"
|
|
summary: "Get the maximum time that the server can spend processing the request, in seconds."
|
|
syntax: "public Integer timeout()"
|
|
desc: "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:
|
|
description: "the timeout value"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.ApplicationListOptions.withClientRequestId(java.util.UUID)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.ApplicationListOptions.withClientRequestId(UUID clientRequestId)"
|
|
name: "withClientRequestId(UUID clientRequestId)"
|
|
nameWithType: "ApplicationListOptions.withClientRequestId(UUID clientRequestId)"
|
|
summary: "Set the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.<wbr>g."
|
|
parameters:
|
|
- description: "the clientRequestId value to set"
|
|
name: "clientRequestId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/UUID.html\">UUID</a>"
|
|
syntax: "public ApplicationListOptions withClientRequestId(UUID clientRequestId)"
|
|
desc: "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."
|
|
returns:
|
|
description: "the ApplicationListOptions object itself."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.ApplicationListOptions?alt=com.microsoft.azure.batch.protocol.models.ApplicationListOptions&text=ApplicationListOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.ApplicationListOptions.withMaxResults(java.lang.Integer)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.ApplicationListOptions.withMaxResults(Integer maxResults)"
|
|
name: "withMaxResults(Integer maxResults)"
|
|
nameWithType: "ApplicationListOptions.withMaxResults(Integer maxResults)"
|
|
summary: "Set the maximum number of items to return in the response."
|
|
parameters:
|
|
- description: "the maxResults value to set"
|
|
name: "maxResults"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
syntax: "public ApplicationListOptions withMaxResults(Integer maxResults)"
|
|
desc: "Set the maximum number of items to return in the response. A maximum of 1000 applications can be returned."
|
|
returns:
|
|
description: "the ApplicationListOptions object itself."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.ApplicationListOptions?alt=com.microsoft.azure.batch.protocol.models.ApplicationListOptions&text=ApplicationListOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.ApplicationListOptions.withOcpDate(org.joda.time.DateTime)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.ApplicationListOptions.withOcpDate(DateTime ocpDate)"
|
|
name: "withOcpDate(DateTime ocpDate)"
|
|
nameWithType: "ApplicationListOptions.withOcpDate(DateTime ocpDate)"
|
|
summary: "Set the time the request was issued."
|
|
parameters:
|
|
- description: "the ocpDate value to set"
|
|
name: "ocpDate"
|
|
type: "<xref href=\"org.joda.time.DateTime?alt=org.joda.time.DateTime&text=DateTime\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ApplicationListOptions withOcpDate(DateTime ocpDate)"
|
|
desc: "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."
|
|
returns:
|
|
description: "the ApplicationListOptions object itself."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.ApplicationListOptions?alt=com.microsoft.azure.batch.protocol.models.ApplicationListOptions&text=ApplicationListOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.ApplicationListOptions.withReturnClientRequestId(java.lang.Boolean)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.ApplicationListOptions.withReturnClientRequestId(Boolean returnClientRequestId)"
|
|
name: "withReturnClientRequestId(Boolean returnClientRequestId)"
|
|
nameWithType: "ApplicationListOptions.withReturnClientRequestId(Boolean returnClientRequestId)"
|
|
summary: "Set whether the server should return the client-request-id in the response."
|
|
parameters:
|
|
- description: "the returnClientRequestId value to set"
|
|
name: "returnClientRequestId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
syntax: "public ApplicationListOptions withReturnClientRequestId(Boolean returnClientRequestId)"
|
|
desc: "Set whether the server should return the client-request-id in the response."
|
|
returns:
|
|
description: "the ApplicationListOptions object itself."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.ApplicationListOptions?alt=com.microsoft.azure.batch.protocol.models.ApplicationListOptions&text=ApplicationListOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.ApplicationListOptions.withTimeout(java.lang.Integer)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.ApplicationListOptions.withTimeout(Integer timeout)"
|
|
name: "withTimeout(Integer timeout)"
|
|
nameWithType: "ApplicationListOptions.withTimeout(Integer timeout)"
|
|
summary: "Set the maximum time that the server can spend processing the request, in seconds."
|
|
parameters:
|
|
- description: "the timeout value to set"
|
|
name: "timeout"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
syntax: "public ApplicationListOptions withTimeout(Integer timeout)"
|
|
desc: "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."
|
|
returns:
|
|
description: "the ApplicationListOptions object itself."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.ApplicationListOptions?alt=com.microsoft.azure.batch.protocol.models.ApplicationListOptions&text=ApplicationListOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Additional parameters for list operation."
|
|
metadata: {}
|
|
package: "com.microsoft.azure.batch.protocol.models"
|
|
artifact: com.microsoft.azure:azure-batch:11.2.0
|