Interface OperationSnapshot

  • All Known Implementing Classes:
    HttpJsonOperationSnapshot

    public interface OperationSnapshot
    A snapshot of a long-running operation.

    The metadata and response will have a structure defined by the particular long-running operation that was initiated.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      StatusCode getErrorCode()
      If the operation is done and it failed, returns the failure status code; if the operation is not done or if it succeeded, returns null.
      java.lang.String getErrorMessage()
      If the operation is done and it failed, returns the error message; if the operation is not done or if it succeeded, returns null.
      java.lang.Object getMetadata()
      Get metadata for the operation, which can change over the course of the operation.
      java.lang.String getName()
      The name of the operation.
      java.lang.Object getResponse()
      If the operation is done and successful, returns the response; if the operation is not done or if it is failed, returns null.
      boolean isDone()
      Returns true if the operation is complete or failed, false otherwise.
    • Method Detail

      • getName

        java.lang.String getName()
        The name of the operation. This is used for identifying the operation on the server.
      • getMetadata

        java.lang.Object getMetadata()
        Get metadata for the operation, which can change over the course of the operation.
      • isDone

        boolean isDone()
        Returns true if the operation is complete or failed, false otherwise.
      • getResponse

        java.lang.Object getResponse()
        If the operation is done and successful, returns the response; if the operation is not done or if it is failed, returns null.
      • getErrorCode

        StatusCode getErrorCode()
        If the operation is done and it failed, returns the failure status code; if the operation is not done or if it succeeded, returns null.
      • getErrorMessage

        java.lang.String getErrorMessage()
        If the operation is done and it failed, returns the error message; if the operation is not done or if it succeeded, returns null.