JobAddHeaders 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.JobAddHeaders

public class JobAddHeaders

Defines headers for Add operation.

Constructor Summary

Constructor Description
JobAddHeaders()

Method Summary

Modifier and Type Method and Description
UUID clientRequestId()

Get the client-request-id provided by the client during the request.
String dataServiceId()

Get the OData ID of the resource to which the request applied.
String eTag()

Get the ETag HTTP response header.
org.joda.time.DateTime lastModified()

Get the time at which the resource was last modified.
UUID requestId()

Get a unique identifier for the request that was made to the Batch service.
JobAddHeaders withClientRequestId(UUID clientRequestId)

Set the client-request-id provided by the client during the request.
JobAddHeaders withDataServiceId(String dataServiceId)

Set the OData ID of the resource to which the request applied.
JobAddHeaders withETag(String eTag)

Set the ETag HTTP response header.
JobAddHeaders withLastModified(DateTime lastModified)

Set the time at which the resource was last modified.
JobAddHeaders withRequestId(UUID requestId)

Set a unique identifier for the request that was made to the Batch service.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

JobAddHeaders

public JobAddHeaders()

Method Details

clientRequestId

public UUID clientRequestId()

Get the client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

Returns:

the clientRequestId value

dataServiceId

public String dataServiceId()

Get the OData ID of the resource to which the request applied.

Returns:

the dataServiceId value

eTag

public String eTag()

Get the ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

Returns:

the eTag value

lastModified

public DateTime lastModified()

Get the time at which the resource was last modified.

Returns:

the lastModified value

requestId

public UUID requestId()

Get a unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.

Returns:

the requestId value

withClientRequestId

public JobAddHeaders withClientRequestId(UUID clientRequestId)

Set the client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

Parameters:

clientRequestId - the clientRequestId value to set

Returns:

the JobAddHeaders object itself.

withDataServiceId

public JobAddHeaders withDataServiceId(String dataServiceId)

Set the OData ID of the resource to which the request applied.

Parameters:

dataServiceId - the dataServiceId value to set

Returns:

the JobAddHeaders object itself.

withETag

public JobAddHeaders withETag(String eTag)

Set the ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

Parameters:

eTag - the eTag value to set

Returns:

the JobAddHeaders object itself.

withLastModified

public JobAddHeaders withLastModified(DateTime lastModified)

Set the time at which the resource was last modified.

Parameters:

lastModified - the lastModified value to set

Returns:

the JobAddHeaders object itself.

withRequestId

public JobAddHeaders withRequestId(UUID requestId)

Set a unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.

Parameters:

requestId - the requestId value to set

Returns:

the JobAddHeaders object itself.

Applies to