Package com.oracle.bmc.databasetoolsruntime.model

Class WorkRequest.Builder

  • Enclosing class:
    WorkRequest
    public static class WorkRequest.Builder
extends Object

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • displayName

        public WorkRequest.Builder displayName​(String displayName)
        A user-friendly name for the operation.

        If provided for an asynchronous operation, this value will be propagated to the displayName property of the resulting Work Request, allowing for easier identification and tracking of the operation’s progress and outcome. This name is purely for descriptive purposes and does not affect the functionality of the operation itself.

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

      • operationType

        public WorkRequest.Builder operationType​(OperationType operationType)
        The asynchronous operation tracked by this work request.
        Parameters:
        operationType - the value to set
        Returns:
        this builder

      • compartmentId

        public WorkRequest.Builder compartmentId​(String compartmentId)
        The OCID of the compartment that contains the work request.
        Parameters:
        compartmentId - the value to set
        Returns:
        this builder

      • createdByPrincipalId

        public WorkRequest.Builder createdByPrincipalId​(String createdByPrincipalId)
        Principal id of the user or resource that submitted the asynchrounous request.
        Parameters:
        createdByPrincipalId - the value to set
        Returns:
        this builder

      • createdByPrincipalDomainId

        public WorkRequest.Builder createdByPrincipalDomainId​(String createdByPrincipalDomainId)
        Identity domain OCID for the user that submitted the asynchronous request.
        Parameters:
        createdByPrincipalDomainId - the value to set
        Returns:
        this builder

      • percentComplete

        public WorkRequest.Builder percentComplete​(Float percentComplete)
        Percentage of the request completed.
        Parameters:
        percentComplete - the value to set
        Returns:
        this builder

      • timeAccepted

        public WorkRequest.Builder timeAccepted​(Date timeAccepted)
        The date and time the work request was created, in the format defined by RFC3339.
        Parameters:
        timeAccepted - the value to set
        Returns:
        this builder

      • timeStarted

        public WorkRequest.Builder timeStarted​(Date timeStarted)
        The date and time the work request transitioned from ACCEPTED to IN_PROGRESS, in the format defined by RFC3339.
        Parameters:
        timeStarted - the value to set
        Returns:
        this builder

      • timeFinished

        public WorkRequest.Builder timeFinished​(Date timeFinished)
        The date and time the work request reached a terminal state, either FAILED or SUCCEEDED.

        Format is defined by RFC3339.

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

      • timeUpdated

        public WorkRequest.Builder timeUpdated​(Date timeUpdated)
        The date and time the work request was last updated, in the format defined by RFC3339.
        Parameters:
        timeUpdated - the value to set
        Returns:
        this builder

      • timeScheduled

        public WorkRequest.Builder timeScheduled​(Date timeScheduled)
        The date and time the work request is eligible to be launched, in the format defined by RFC3339.
        Parameters:
        timeScheduled - the value to set
        Returns:
        this builder