JobEnableOptions Class

  • Reference
Package:
com.microsoft.azure.batch.protocol.models
Maven Artifact:
com.microsoft.azure:azure-batch:11.2.0
  • java.lang.Object
    • com.microsoft.azure.batch.protocol.models.JobEnableOptions

public class JobEnableOptions

Additional parameters for enable operation.

Constructor Summary

Constructor Description
JobEnableOptions()

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.
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.
JobEnableOptions withClientRequestId(UUID clientRequestId)

Set the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.
JobEnableOptions withIfMatch(String ifMatch)

Set an ETag value associated with the version of the resource known to the client.
JobEnableOptions withIfModifiedSince(DateTime ifModifiedSince)

Set a timestamp indicating the last modified time of the resource known to the client.
JobEnableOptions withIfNoneMatch(String ifNoneMatch)

Set an ETag value associated with the version of the resource known to the client.
JobEnableOptions withIfUnmodifiedSince(DateTime ifUnmodifiedSince)

Set a timestamp indicating the last modified time of the resource known to the client.
JobEnableOptions withOcpDate(DateTime ocpDate)

Set the time the request was issued.
JobEnableOptions withReturnClientRequestId(Boolean returnClientRequestId)

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

Set the maximum time that the server can spend processing the request, in seconds.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

JobEnableOptions

public JobEnableOptions()

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. If the value is larger than 30, the default will be used instead.

Returns:

the timeout value

withClientRequestId

public JobEnableOptions 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 JobEnableOptions object itself.

withIfMatch

public JobEnableOptions 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 JobEnableOptions object itself.

withIfModifiedSince

public JobEnableOptions 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 JobEnableOptions object itself.

withIfNoneMatch

public JobEnableOptions 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 JobEnableOptions object itself.

withIfUnmodifiedSince

public JobEnableOptions 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 JobEnableOptions object itself.

withOcpDate

public JobEnableOptions 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 JobEnableOptions object itself.

withReturnClientRequestId

public JobEnableOptions 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 JobEnableOptions object itself.

withTimeout

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

timeout - the timeout value to set

Returns:

the JobEnableOptions object itself.

Applies to