JobScheduleDeleteOptions Class
- java.
lang. Object - com.
microsoft. azure. batch. protocol. models. JobScheduleDeleteOptions
- com.
public class JobScheduleDeleteOptions
Additional parameters for delete operation.
Constructor Summary
Constructor | Description | |
---|---|---|
JobScheduleDeleteOptions() |
Method Summary
Modifier and Type | Method and Description |
---|---|
UUID |
clientRequestId()
Get the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e. |
Boolean |
force()
Get if true, the server will delete the Job |
String |
ifMatch()
Get an ETag value associated with the version of the resource known to the client. |
org.joda.time.DateTime |
ifModifiedSince()
Get a timestamp indicating the last modified time of the resource known to the client. |
String |
ifNoneMatch()
Get an ETag value associated with the version of the resource known to the client. |
org.joda.time.DateTime |
ifUnmodifiedSince()
Get a timestamp indicating the last modified time of the resource known to the client. |
org.joda.time.DateTime |
ocpDate()
Get the time the request was issued. |
Boolean |
returnClientRequestId()
Get whether the server should return the client-request-id in the response. |
Integer |
timeout()
Get the maximum time that the server can spend processing the request, in seconds. |
Job |
withClientRequestId(UUID clientRequestId)
Set the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e. |
Job |
withForce(Boolean force)
Set if true, the server will delete the Job |
Job |
withIfMatch(String ifMatch)
Set an ETag value associated with the version of the resource known to the client. |
Job |
withIfModifiedSince(DateTime ifModifiedSince)
Set a timestamp indicating the last modified time of the resource known to the client. |
Job |
withIfNoneMatch(String ifNoneMatch)
Set an ETag value associated with the version of the resource known to the client. |
Job |
withIfUnmodifiedSince(DateTime ifUnmodifiedSince)
Set a timestamp indicating the last modified time of the resource known to the client. |
Job |
withOcpDate(DateTime ocpDate)
Set the time the request was issued. |
Job |
withReturnClientRequestId(Boolean returnClientRequestId)
Set whether the server should return the client-request-id in the response. |
Job |
withTimeout(Integer timeout)
Set the maximum time that the server can spend processing the request, in seconds. |
Methods inherited from java.lang.Object
Constructor Details
JobScheduleDeleteOptions
public JobScheduleDeleteOptions()
Method Details
clientRequestId
public UUID clientRequestId()
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:
force
public Boolean force()
Get if true, the server will delete the JobSchedule even if the corresponding nodes have not fully processed the deletion. The default value is false.
Returns:
ifMatch
public String ifMatch()
Get 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.
Returns:
ifModifiedSince
public DateTime ifModifiedSince()
Get 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.
Returns:
ifNoneMatch
public String ifNoneMatch()
Get 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.
Returns:
ifUnmodifiedSince
public DateTime ifUnmodifiedSince()
Get 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.
Returns:
ocpDate
public DateTime ocpDate()
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:
returnClientRequestId
public Boolean returnClientRequestId()
Get whether the server should return the client-request-id in the response.
Returns:
timeout
public Integer timeout()
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:
withClientRequestId
public JobScheduleDeleteOptions withClientRequestId(UUID clientRequestId)
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.
Parameters:
Returns:
withForce
public JobScheduleDeleteOptions withForce(Boolean force)
Set if true, the server will delete the JobSchedule even if the corresponding nodes have not fully processed the deletion. The default value is false.
Parameters:
Returns:
withIfMatch
public JobScheduleDeleteOptions withIfMatch(String ifMatch)
Set 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.
Parameters:
Returns:
withIfModifiedSince
public JobScheduleDeleteOptions withIfModifiedSince(DateTime ifModifiedSince)
Set 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.
Parameters:
Returns:
withIfNoneMatch
public JobScheduleDeleteOptions withIfNoneMatch(String ifNoneMatch)
Set 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.
Parameters:
Returns:
withIfUnmodifiedSince
public JobScheduleDeleteOptions withIfUnmodifiedSince(DateTime ifUnmodifiedSince)
Set 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.
Parameters:
Returns:
withOcpDate
public JobScheduleDeleteOptions withOcpDate(DateTime ocpDate)
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.
Parameters:
Returns:
withReturnClientRequestId
public JobScheduleDeleteOptions withReturnClientRequestId(Boolean returnClientRequestId)
Set whether the server should return the client-request-id in the response.
Parameters:
Returns:
withTimeout
public JobScheduleDeleteOptions withTimeout(Integer timeout)
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.
Parameters:
Returns:
Applies to
Azure SDK for Java