Share via


TaskListOptions Class

Definition

Additional parameters for List operation.

public class TaskListOptions : Microsoft.Azure.Batch.Protocol.Models.IODataExpand, Microsoft.Azure.Batch.Protocol.Models.IODataFilter, Microsoft.Azure.Batch.Protocol.Models.IODataSelect, Microsoft.Azure.Batch.Protocol.Models.ITimeoutOptions
type TaskListOptions = class
    interface ITimeoutOptions
    interface IOptions
    interface IODataSelect
    interface IODataFilter
    interface IODataExpand
Public Class TaskListOptions
Implements IODataExpand, IODataFilter, IODataSelect, ITimeoutOptions
Inheritance
TaskListOptions
Implements

Constructors

TaskListOptions()

Initializes a new instance of the TaskListOptions class.

TaskListOptions(String, String, String, Nullable<Int32>, Nullable<Int32>, Nullable<Guid>, Nullable<Boolean>, Nullable<DateTime>)

Initializes a new instance of the TaskListOptions class.

Properties

ClientRequestId

Gets or sets 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.

Expand

Gets or sets an OData $expand clause.

Filter

Gets or sets 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.

MaxResults

Gets or sets the maximum number of items to return in the response. A maximum of 1000 Tasks can be returned.

OcpDate

Gets or sets 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.

ReturnClientRequestId

Gets or sets whether the server should return the client-request-id in the response.

Select

Gets or sets an OData $select clause.

Timeout

Gets or sets 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.

Applies to