JobScheduleUpdateOptions Class

  • Reference
Package:
com.microsoft.azure.batch.protocol.models
  • java.lang.Object
    • com.microsoft.azure.batch.protocol.models.JobScheduleUpdateOptions

public class JobScheduleUpdateOptions

Additional parameters for update operation.

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.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
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.
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.
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.
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.
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.
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. The default is 30 seconds.
JobScheduleUpdateOptions 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.
JobScheduleUpdateOptions 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.
JobScheduleUpdateOptions 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.
JobScheduleUpdateOptions 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.
JobScheduleUpdateOptions 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.
JobScheduleUpdateOptions 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.
JobScheduleUpdateOptions withReturnClientRequestId(Boolean returnClientRequestId)

Set whether the server should return the client-request-id in the response.
JobScheduleUpdateOptions withTimeout(Integer timeout)

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

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:

the clientRequestId value

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:

the ifMatch value

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:

the ifModifiedSince value

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:

the ifNoneMatch value

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:

the ifUnmodifiedSince value

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:

the ocpDate value

returnClientRequestId

public Boolean returnClientRequestId()

Get whether the server should return the client-request-id in the response.

Returns:

the returnClientRequestId value

timeout

public Integer timeout()

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

Returns:

the timeout value

withClientRequestId

public JobScheduleUpdateOptions 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:

clientRequestId - the clientRequestId value to set

Returns:

the JobScheduleUpdateOptions object itself.

withIfMatch

public JobScheduleUpdateOptions 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:

ifMatch - the ifMatch value to set

Returns:

the JobScheduleUpdateOptions object itself.

withIfModifiedSince

public JobScheduleUpdateOptions 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:

ifModifiedSince - the ifModifiedSince value to set

Returns:

the JobScheduleUpdateOptions object itself.

withIfNoneMatch

public JobScheduleUpdateOptions 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:

ifNoneMatch - the ifNoneMatch value to set

Returns:

the JobScheduleUpdateOptions object itself.

withIfUnmodifiedSince

public JobScheduleUpdateOptions 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:

ifUnmodifiedSince - the ifUnmodifiedSince value to set

Returns:

the JobScheduleUpdateOptions object itself.

withOcpDate

public JobScheduleUpdateOptions 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:

ocpDate - the ocpDate value to set

Returns:

the JobScheduleUpdateOptions object itself.

withReturnClientRequestId

public JobScheduleUpdateOptions withReturnClientRequestId(Boolean returnClientRequestId)

Set whether the server should return the client-request-id in the response.

Parameters:

returnClientRequestId - the returnClientRequestId value to set

Returns:

the JobScheduleUpdateOptions object itself.

withTimeout

public JobScheduleUpdateOptions withTimeout(Integer timeout)

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

Parameters:

timeout - the timeout value to set

Returns:

the JobScheduleUpdateOptions object itself.

Applies to