Package com.microsoft.azure.batch.protocol.models

Class FileGetFromTaskOptions

  • public class FileGetFromTaskOptions
extends Object
    Additional parameters for getFromTask operation.

    • Constructor Detail

      • FileGetFromTaskOptions

        public FileGetFromTaskOptions()

    • Method Detail

      • 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

      • withTimeout

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

      • 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

      • withClientRequestId

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

      • returnClientRequestId

        public Boolean returnClientRequestId()
        Get whether the server should return the client-request-id in the response.
        Returns:
        the returnClientRequestId value

      • withReturnClientRequestId

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

      • ocpDate

        public org.joda.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.
        Returns:
        the ocpDate value

      • withOcpDate

        public FileGetFromTaskOptions withOcpDate​(org.joda.time.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 FileGetFromTaskOptions object itself.

      • ocpRange

        public String ocpRange()
        Get the byte range to be retrieved. The default is to retrieve the entire file. The format is bytes=startRange-endRange.
        Returns:
        the ocpRange value

      • withOcpRange

        public FileGetFromTaskOptions withOcpRange​(String ocpRange)
        Set the byte range to be retrieved. The default is to retrieve the entire file. The format is bytes=startRange-endRange.
        Parameters:
        ocpRange - the ocpRange value to set
        Returns:
        the FileGetFromTaskOptions object itself.

      • ifModifiedSince

        public org.joda.time.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

      • withIfModifiedSince

        public FileGetFromTaskOptions withIfModifiedSince​(org.joda.time.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 FileGetFromTaskOptions object itself.

      • ifUnmodifiedSince

        public org.joda.time.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

      • withIfUnmodifiedSince

        public FileGetFromTaskOptions withIfUnmodifiedSince​(org.joda.time.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 FileGetFromTaskOptions object itself.