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

public class FileGetPropertiesFromTaskHeaders

Defines headers for GetPropertiesFromTask operation.

Constructor Summary

Constructor Description
FileGetPropertiesFromTaskHeaders()

Method Summary

Modifier and Type Method and Description
UUID clientRequestId()

Get the client-request-id provided by the client during the request.
Long contentLength()

Get the length of the file.
String contentType()

Get the content type of the file.
String eTag()

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

Get the time at which the resource was last modified.
Boolean ocpBatchFileIsdirectory()

Get whether the object represents a directory.
String ocpBatchFileMode()

Get the file mode attribute in octal format.
String ocpBatchFileUrl()

Get the URL of the file.
org.joda.time.DateTime ocpCreationTime()

Get the file creation time.
UUID requestId()

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

Set the client-request-id provided by the client during the request.
FileGetPropertiesFromTaskHeaders withContentLength(Long contentLength)

Set the length of the file.
FileGetPropertiesFromTaskHeaders withContentType(String contentType)

Set the content type of the file.
FileGetPropertiesFromTaskHeaders withETag(String eTag)

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

Set the time at which the resource was last modified.
FileGetPropertiesFromTaskHeaders withOcpBatchFileIsdirectory(Boolean ocpBatchFileIsdirectory)

Set whether the object represents a directory.
FileGetPropertiesFromTaskHeaders withOcpBatchFileMode(String ocpBatchFileMode)

Set the file mode attribute in octal format.
FileGetPropertiesFromTaskHeaders withOcpBatchFileUrl(String ocpBatchFileUrl)

Set the URL of the file.
FileGetPropertiesFromTaskHeaders withOcpCreationTime(DateTime ocpCreationTime)

Set the file creation time.
FileGetPropertiesFromTaskHeaders 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

FileGetPropertiesFromTaskHeaders

public FileGetPropertiesFromTaskHeaders()

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

contentLength

public Long contentLength()

Get the length of the file.

Returns:

the contentLength value

contentType

public String contentType()

Get the content type of the file.

Returns:

the contentType 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

ocpBatchFileIsdirectory

public Boolean ocpBatchFileIsdirectory()

Get whether the object represents a directory.

Returns:

the ocpBatchFileIsdirectory value

ocpBatchFileMode

public String ocpBatchFileMode()

Get the file mode attribute in octal format.

Returns:

the ocpBatchFileMode value

ocpBatchFileUrl

public String ocpBatchFileUrl()

Get the URL of the file.

Returns:

the ocpBatchFileUrl value

ocpCreationTime

public DateTime ocpCreationTime()

Get the file creation time.

Returns:

the ocpCreationTime 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 FileGetPropertiesFromTaskHeaders 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 FileGetPropertiesFromTaskHeaders object itself.

withContentLength

public FileGetPropertiesFromTaskHeaders withContentLength(Long contentLength)

Set the length of the file.

Parameters:

contentLength - the contentLength value to set

Returns:

the FileGetPropertiesFromTaskHeaders object itself.

withContentType

public FileGetPropertiesFromTaskHeaders withContentType(String contentType)

Set the content type of the file.

Parameters:

contentType - the contentType value to set

Returns:

the FileGetPropertiesFromTaskHeaders object itself.

withETag

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

withLastModified

public FileGetPropertiesFromTaskHeaders withLastModified(DateTime lastModified)

Set the time at which the resource was last modified.

Parameters:

lastModified - the lastModified value to set

Returns:

the FileGetPropertiesFromTaskHeaders object itself.

withOcpBatchFileIsdirectory

public FileGetPropertiesFromTaskHeaders withOcpBatchFileIsdirectory(Boolean ocpBatchFileIsdirectory)

Set whether the object represents a directory.

Parameters:

ocpBatchFileIsdirectory - the ocpBatchFileIsdirectory value to set

Returns:

the FileGetPropertiesFromTaskHeaders object itself.

withOcpBatchFileMode

public FileGetPropertiesFromTaskHeaders withOcpBatchFileMode(String ocpBatchFileMode)

Set the file mode attribute in octal format.

Parameters:

ocpBatchFileMode - the ocpBatchFileMode value to set

Returns:

the FileGetPropertiesFromTaskHeaders object itself.

withOcpBatchFileUrl

public FileGetPropertiesFromTaskHeaders withOcpBatchFileUrl(String ocpBatchFileUrl)

Set the URL of the file.

Parameters:

ocpBatchFileUrl - the ocpBatchFileUrl value to set

Returns:

the FileGetPropertiesFromTaskHeaders object itself.

withOcpCreationTime

public FileGetPropertiesFromTaskHeaders withOcpCreationTime(DateTime ocpCreationTime)

Set the file creation time.

Parameters:

ocpCreationTime - the ocpCreationTime value to set

Returns:

the FileGetPropertiesFromTaskHeaders object itself.

withRequestId

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

Applies to