Class FileGetFromTaskOptions | Azure SDK for Net

Additional parameters for GetFromTask operation.

Inheritance

FileGetFromTaskOptions

Namespace: Microsoft.Azure.Batch.Protocol.Models

Assembly: Microsoft.Azure.Batch.dll

Syntax

public class FileGetFromTaskOptions : Microsoft.Azure.Batch.Protocol.Models.ITimeoutOptions

Constructors

FileGetFromTaskOptions()

Initializes a new instance of the FileGetFromTaskOptions class.

Declaration

public FileGetFromTaskOptions ();

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

Initializes a new instance of the FileGetFromTaskOptions class.

Declaration

public FileGetFromTaskOptions (Nullable<int> timeout = null, Nullable<Guid> clientRequestId = null, Nullable<bool> returnClientRequestId = null, Nullable<DateTime> ocpDate = null, string ocpRange = null, Nullable<DateTime> ifModifiedSince = null, Nullable<DateTime> ifUnmodifiedSince = null);

Parameters

Nullable<Int32> timeout The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.

Nullable<Guid> clientRequestId 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.

Nullable<Boolean> returnClientRequestId Whether the server should return the client-request-id in the response.

Nullable<DateTime> ocpDate 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.

String ocpRange The byte range to be retrieved. The default is to retrieve the entire file. The format is bytes=startRange-endRange.

Nullable<DateTime> ifModifiedSince A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.

Nullable<DateTime> ifUnmodifiedSince A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.

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.

Declaration

[Newtonsoft.Json.JsonIgnore]
public Nullable<Guid> ClientRequestId { get; set; }

Property Value

Implements

IfModifiedSince

Gets or sets a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.

Declaration

[Newtonsoft.Json.JsonConverter(typeof(Microsoft.Rest.Serialization.DateTimeRfc1123JsonConverter))]
[Newtonsoft.Json.JsonIgnore]
public Nullable<DateTime> IfModifiedSince { get; set; }

Property Value

IfUnmodifiedSince

Gets or sets a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.

Declaration

[Newtonsoft.Json.JsonConverter(typeof(Microsoft.Rest.Serialization.DateTimeRfc1123JsonConverter))]
[Newtonsoft.Json.JsonIgnore]
public Nullable<DateTime> IfUnmodifiedSince { get; set; }

Property Value

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.

Declaration

[Newtonsoft.Json.JsonConverter(typeof(Microsoft.Rest.Serialization.DateTimeRfc1123JsonConverter))]
[Newtonsoft.Json.JsonIgnore]
public Nullable<DateTime> OcpDate { get; set; }

Property Value

OcpRange

Gets or sets the byte range to be retrieved. The default is to retrieve the entire file. The format is bytes=startRange-endRange.

Declaration

[Newtonsoft.Json.JsonIgnore]
public string OcpRange { get; set; }

Property Value

ReturnClientRequestId

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

Declaration

[Newtonsoft.Json.JsonIgnore]
public Nullable<bool> ReturnClientRequestId { get; set; }

Property Value

Implements

Timeout

Gets or sets the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.

Declaration

[Newtonsoft.Json.JsonIgnore]
public Nullable<int> Timeout { get; set; }

Property Value

Implements