Share via


JobScheduleTerminateOptions Class

Definition

Additional parameters for Terminate operation.

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

Constructors

JobScheduleTerminateOptions()

Initializes a new instance of the JobScheduleTerminateOptions class.

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

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

Force

Gets or sets if true, the server will terminate the JobSchedule even if the corresponding nodes have not fully processed the termination. The default value is false.

IfMatch

Gets or sets an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.

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.

IfNoneMatch

Gets or sets an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.

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.

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