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

Class JobGetOptions

  • public class JobGetOptions
extends Object
    Additional parameters for get operation.

    • Constructor Detail

      • JobGetOptions

        public JobGetOptions()

    • Method Detail

      • select

        public String select()
        Get an OData $select clause.
        Returns:
        the select value

      • withSelect

        public JobGetOptions withSelect​(String select)
        Set an OData $select clause.
        Parameters:
        select - the select value to set
        Returns:
        the JobGetOptions object itself.

      • expand

        public String expand()
        Get an OData $expand clause.
        Returns:
        the expand value

      • withExpand

        public JobGetOptions withExpand​(String expand)
        Set an OData $expand clause.
        Parameters:
        expand - the expand value to set
        Returns:
        the JobGetOptions object itself.

      • 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 JobGetOptions 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 JobGetOptions 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 JobGetOptions 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 JobGetOptions 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 JobGetOptions 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 JobGetOptions 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 JobGetOptions 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 JobGetOptions object itself.

      • 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

      • withIfMatch

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

      • 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

      • withIfNoneMatch

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