com.google.api.gax.longrunning

Interface OperationSnapshot

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
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

Modifier and Type	Method and 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.
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.
Object	getMetadata() Get metadata for the operation, which can change over the course of the operation.
String	getName() The name of the operation.
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

String getName()

The name of the operation. This is used for identifying the operation on the server.

getMetadata

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

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

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.