FileListFromTaskOptions Class

Definition

Additional parameters for ListFromTask operation.

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

Constructors

FileListFromTaskOptions()

Initializes a new instance of the FileListFromTaskOptions class.

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

Initializes a new instance of the FileListFromTaskOptions 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.

Filter

Gets or sets an OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-task-files.

MaxResults

Gets or sets the maximum number of items to return in the response. A maximum of 1000 files 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.

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