228 строки
15 KiB
YAML
228 строки
15 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.batch.protocol.models.TaskListOptions"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.TaskListOptions"
|
|
name: "TaskListOptions"
|
|
nameWithType: "TaskListOptions"
|
|
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 **TaskListOptions**"
|
|
constructors:
|
|
- uid: "com.microsoft.azure.batch.protocol.models.TaskListOptions.TaskListOptions()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.TaskListOptions.TaskListOptions()"
|
|
name: "TaskListOptions()"
|
|
nameWithType: "TaskListOptions.TaskListOptions()"
|
|
syntax: "public TaskListOptions()"
|
|
methods:
|
|
- uid: "com.microsoft.azure.batch.protocol.models.TaskListOptions.clientRequestId()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.TaskListOptions.clientRequestId()"
|
|
name: "clientRequestId()"
|
|
nameWithType: "TaskListOptions.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.TaskListOptions.expand()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.TaskListOptions.expand()"
|
|
name: "expand()"
|
|
nameWithType: "TaskListOptions.expand()"
|
|
summary: "Get an OData $expand clause."
|
|
syntax: "public String expand()"
|
|
desc: "Get an OData $expand clause."
|
|
returns:
|
|
description: "the expand value"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.TaskListOptions.filter()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.TaskListOptions.filter()"
|
|
name: "filter()"
|
|
nameWithType: "TaskListOptions.filter()"
|
|
summary: "Get an OData $filter clause."
|
|
syntax: "public String filter()"
|
|
desc: "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-tasks."
|
|
returns:
|
|
description: "the filter value"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.TaskListOptions.maxResults()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.TaskListOptions.maxResults()"
|
|
name: "maxResults()"
|
|
nameWithType: "TaskListOptions.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 Tasks 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.TaskListOptions.ocpDate()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.TaskListOptions.ocpDate()"
|
|
name: "ocpDate()"
|
|
nameWithType: "TaskListOptions.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.TaskListOptions.returnClientRequestId()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.TaskListOptions.returnClientRequestId()"
|
|
name: "returnClientRequestId()"
|
|
nameWithType: "TaskListOptions.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.TaskListOptions.select()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.TaskListOptions.select()"
|
|
name: "select()"
|
|
nameWithType: "TaskListOptions.select()"
|
|
summary: "Get an OData $select clause."
|
|
syntax: "public String select()"
|
|
desc: "Get an OData $select clause."
|
|
returns:
|
|
description: "the select value"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.TaskListOptions.timeout()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.TaskListOptions.timeout()"
|
|
name: "timeout()"
|
|
nameWithType: "TaskListOptions.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.TaskListOptions.withClientRequestId(java.util.UUID)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.TaskListOptions.withClientRequestId(UUID clientRequestId)"
|
|
name: "withClientRequestId(UUID clientRequestId)"
|
|
nameWithType: "TaskListOptions.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 TaskListOptions 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 TaskListOptions object itself."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.TaskListOptions?alt=com.microsoft.azure.batch.protocol.models.TaskListOptions&text=TaskListOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.TaskListOptions.withExpand(java.lang.String)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.TaskListOptions.withExpand(String expand)"
|
|
name: "withExpand(String expand)"
|
|
nameWithType: "TaskListOptions.withExpand(String expand)"
|
|
summary: "Set an OData $expand clause."
|
|
parameters:
|
|
- description: "the expand value to set"
|
|
name: "expand"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public TaskListOptions withExpand(String expand)"
|
|
desc: "Set an OData $expand clause."
|
|
returns:
|
|
description: "the TaskListOptions object itself."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.TaskListOptions?alt=com.microsoft.azure.batch.protocol.models.TaskListOptions&text=TaskListOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.TaskListOptions.withFilter(java.lang.String)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.TaskListOptions.withFilter(String filter)"
|
|
name: "withFilter(String filter)"
|
|
nameWithType: "TaskListOptions.withFilter(String filter)"
|
|
summary: "Set an OData $filter clause."
|
|
parameters:
|
|
- description: "the filter value to set"
|
|
name: "filter"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public TaskListOptions withFilter(String filter)"
|
|
desc: "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-tasks."
|
|
returns:
|
|
description: "the TaskListOptions object itself."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.TaskListOptions?alt=com.microsoft.azure.batch.protocol.models.TaskListOptions&text=TaskListOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.TaskListOptions.withMaxResults(java.lang.Integer)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.TaskListOptions.withMaxResults(Integer maxResults)"
|
|
name: "withMaxResults(Integer maxResults)"
|
|
nameWithType: "TaskListOptions.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 TaskListOptions withMaxResults(Integer maxResults)"
|
|
desc: "Set the maximum number of items to return in the response. A maximum of 1000 Tasks can be returned."
|
|
returns:
|
|
description: "the TaskListOptions object itself."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.TaskListOptions?alt=com.microsoft.azure.batch.protocol.models.TaskListOptions&text=TaskListOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.TaskListOptions.withOcpDate(org.joda.time.DateTime)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.TaskListOptions.withOcpDate(DateTime ocpDate)"
|
|
name: "withOcpDate(DateTime ocpDate)"
|
|
nameWithType: "TaskListOptions.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 TaskListOptions 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 TaskListOptions object itself."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.TaskListOptions?alt=com.microsoft.azure.batch.protocol.models.TaskListOptions&text=TaskListOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.TaskListOptions.withReturnClientRequestId(java.lang.Boolean)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.TaskListOptions.withReturnClientRequestId(Boolean returnClientRequestId)"
|
|
name: "withReturnClientRequestId(Boolean returnClientRequestId)"
|
|
nameWithType: "TaskListOptions.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 TaskListOptions withReturnClientRequestId(Boolean returnClientRequestId)"
|
|
desc: "Set whether the server should return the client-request-id in the response."
|
|
returns:
|
|
description: "the TaskListOptions object itself."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.TaskListOptions?alt=com.microsoft.azure.batch.protocol.models.TaskListOptions&text=TaskListOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.TaskListOptions.withSelect(java.lang.String)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.TaskListOptions.withSelect(String select)"
|
|
name: "withSelect(String select)"
|
|
nameWithType: "TaskListOptions.withSelect(String select)"
|
|
summary: "Set an OData $select clause."
|
|
parameters:
|
|
- description: "the select value to set"
|
|
name: "select"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public TaskListOptions withSelect(String select)"
|
|
desc: "Set an OData $select clause."
|
|
returns:
|
|
description: "the TaskListOptions object itself."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.TaskListOptions?alt=com.microsoft.azure.batch.protocol.models.TaskListOptions&text=TaskListOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.TaskListOptions.withTimeout(java.lang.Integer)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.TaskListOptions.withTimeout(Integer timeout)"
|
|
name: "withTimeout(Integer timeout)"
|
|
nameWithType: "TaskListOptions.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 TaskListOptions 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 TaskListOptions object itself."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.TaskListOptions?alt=com.microsoft.azure.batch.protocol.models.TaskListOptions&text=TaskListOptions\" 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
|