Class ExportTask.Builder

  • Enclosing class:
    ExportTask

    public static final class ExportTask.Builder
    extends java.lang.Object
    Builder class for ExportTask.
    • Constructor Summary

      Constructors 
      Constructor Description
      Builder()
      Constructor with parameters for the required properties of ExportTask.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      ExportTask build()  
      ExportTask.Builder setAsyncResponseAvailable​(java.lang.Boolean asyncResponseAvailable)
      True if response for asynchronous request is available This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
      ExportTask.Builder setCancelable​(java.lang.Boolean cancelable)
      True if this task can be canceled This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
      ExportTask.Builder setDescription​(java.lang.String description)
      Description of the task This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
      ExportTask.Builder setDraftPath​(java.lang.String draftPath)
      Policy path of a draft if this is an export task to export draft configuration.
      ExportTask.Builder setEndTime​(java.lang.Long endTime)
      The end time of the task in epoch milliseconds format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
      ExportTask.Builder setExportedFile​(java.lang.String exportedFile)
      Name of the exported file generated after completion of export task.
      ExportTask.Builder setFailureMsg​(java.lang.String failureMsg)
      This property holds the reason of the task failure, if any.
      ExportTask.Builder setId​(java.lang.String id)
      Identifier for this task This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
      ExportTask.Builder setLinks​(java.util.List<ResourceLink> links)
      The server will populate this field when returing the resource.
      ExportTask.Builder setMessage​(java.lang.String message)
      A message describing the disposition of the task This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
      ExportTask.Builder setProgress​(java.lang.Long progress)
      Task progress if known, from 0 to 100 format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
      ExportTask.Builder setRequestMethod​(java.lang.String requestMethod)
      HTTP request method This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
      ExportTask.Builder setRequestUri​(java.lang.String requestUri)
      URI of the method invocation that spawned this task This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
      ExportTask.Builder setSchema​(java.lang.String schema)
      Schema for this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
      ExportTask.Builder setSelf​(SelfResourceLink self)  
      ExportTask.Builder setStartTime​(java.lang.Long startTime)
      The start time of the task in epoch milliseconds format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
      ExportTask.Builder setStatus​(java.lang.String status)
      Possible values are: ExportTask.STATUS_RUNNING ExportTask.STATUS_ERROR ExportTask.STATUS_SUCCESS ExportTask.STATUS_CANCELING ExportTask.STATUS_CANCELED ExportTask.STATUS_KILLED Current status of the task This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
      ExportTask.Builder setUser​(java.lang.String user)
      Name of the user who created this task This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • Builder

        public Builder()
        Constructor with parameters for the required properties of ExportTask.
    • Method Detail

      • setLinks

        public ExportTask.Builder setLinks​(java.util.List<ResourceLink> links)
        The server will populate this field when returing the resource. Ignored on PUT and POST. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        links - New value for the property.
      • setSchema

        public ExportTask.Builder setSchema​(java.lang.String schema)
        Schema for this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        schema - New value for the property.
      • setAsyncResponseAvailable

        public ExportTask.Builder setAsyncResponseAvailable​(java.lang.Boolean asyncResponseAvailable)
        True if response for asynchronous request is available This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        asyncResponseAvailable - New value for the property.
      • setCancelable

        public ExportTask.Builder setCancelable​(java.lang.Boolean cancelable)
        True if this task can be canceled This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        cancelable - New value for the property.
      • setDescription

        public ExportTask.Builder setDescription​(java.lang.String description)
        Description of the task This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        description - New value for the property.
      • setEndTime

        public ExportTask.Builder setEndTime​(java.lang.Long endTime)
        The end time of the task in epoch milliseconds format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        endTime - New value for the property.
      • setId

        public ExportTask.Builder setId​(java.lang.String id)
        Identifier for this task This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        id - New value for the property.
      • setMessage

        public ExportTask.Builder setMessage​(java.lang.String message)
        A message describing the disposition of the task This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        message - New value for the property.
      • setProgress

        public ExportTask.Builder setProgress​(java.lang.Long progress)
        Task progress if known, from 0 to 100 format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        progress - New value for the property.
      • setRequestMethod

        public ExportTask.Builder setRequestMethod​(java.lang.String requestMethod)
        HTTP request method This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        requestMethod - New value for the property.
      • setRequestUri

        public ExportTask.Builder setRequestUri​(java.lang.String requestUri)
        URI of the method invocation that spawned this task This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        requestUri - New value for the property.
      • setStartTime

        public ExportTask.Builder setStartTime​(java.lang.Long startTime)
        The start time of the task in epoch milliseconds format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        startTime - New value for the property.
      • setUser

        public ExportTask.Builder setUser​(java.lang.String user)
        Name of the user who created this task This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        user - New value for the property.
      • setFailureMsg

        public ExportTask.Builder setFailureMsg​(java.lang.String failureMsg)
        This property holds the reason of the task failure, if any. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        failureMsg - New value for the property.
      • setDraftPath

        public ExportTask.Builder setDraftPath​(java.lang.String draftPath)
        Policy path of a draft if this is an export task to export draft configuration. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        draftPath - New value for the property.
      • setExportedFile

        public ExportTask.Builder setExportedFile​(java.lang.String exportedFile)
        Name of the exported file generated after completion of export task. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        exportedFile - New value for the property.