Class WorkRequestResource.Builder

    • Constructor Detail

      • Builder

        public Builder()
    • Method Detail

      • entityType

        public WorkRequestResource.Builder entityType​(String entityType)
        The resource type the work request affects.
        Parameters:
        entityType - the value to set
        Returns:
        this builder
      • actionType

        public WorkRequestResource.Builder actionType​(ActionTypes actionType)
        The way in which this resource is affected by the work tracked in the work request.

        A resource being created, updated, or deleted will remain in the IN_PROGRESS state until work is complete for that resource at which point it will transition to CREATED, UPDATED, or DELETED, respectively.

        Parameters:
        actionType - the value to set
        Returns:
        this builder
      • identifier

        public WorkRequestResource.Builder identifier​(String identifier)
        The identifier of the resource the work request affects.
        Parameters:
        identifier - the value to set
        Returns:
        this builder
      • sourceId

        public WorkRequestResource.Builder sourceId​(String sourceId)
        The identifier of the source the work request is requesting.
        Parameters:
        sourceId - the value to set
        Returns:
        this builder
      • sourceName

        public WorkRequestResource.Builder sourceName​(String sourceName)
        The name of the source the work request is requesting.
        Parameters:
        sourceName - the value to set
        Returns:
        this builder
      • sourceVersion

        public WorkRequestResource.Builder sourceVersion​(String sourceVersion)
        The version of the source the work request is requesting.
        Parameters:
        sourceVersion - the value to set
        Returns:
        this builder
      • entityUri

        public WorkRequestResource.Builder entityUri​(String entityUri)
        The URI path that the user can do a GET on to access the resource metadata
        Parameters:
        entityUri - the value to set
        Returns:
        this builder
      • timeAccepted

        public WorkRequestResource.Builder timeAccepted​(Date timeAccepted)
        The date and time the request was created, as described in RFC 3339, section 5.6.
        Parameters:
        timeAccepted - the value to set
        Returns:
        this builder
      • timeStarted

        public WorkRequestResource.Builder timeStarted​(Date timeStarted)
        The date and time the request was started, as described in RFC 3339, section 5.6.
        Parameters:
        timeStarted - the value to set
        Returns:
        this builder
      • timeFinished

        public WorkRequestResource.Builder timeFinished​(Date timeFinished)
        The date and time the request was finished, as described in RFC 3339, section 5.6.
        Parameters:
        timeFinished - the value to set
        Returns:
        this builder
      • metadata

        public WorkRequestResource.Builder metadata​(Object metadata)
        Additional metadata about the resource that has been operated upon by this work request.

        For WorkRequests operationType WORK_DELIVERY the metadata will contain: workDeliveryStatus indicating the status of the work delivery item as a WorkDeliveryStatus value, workSubmissionKey the WorkSubmission request id, and workSubmissionDetails containing any details of result

        Parameters:
        metadata - the value to set
        Returns:
        this builder