public interface OperationSnapshotA snapshot of a long-running operation.
The metadata and response will have a structure defined by the particular long-running operation that was initiated.
Methods
getErrorCode()
public abstract 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.
| Returns | |
|---|---|
| Type | Description |
StatusCode | |
getErrorMessage()
public abstract 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.
| Returns | |
|---|---|
| Type | Description |
String | |
getMetadata()
public abstract Object getMetadata()Get metadata for the operation, which can change over the course of the operation.
| Returns | |
|---|---|
| Type | Description |
Object | |
getName()
public abstract String getName()The name of the operation. This is used for identifying the operation on the server.
| Returns | |
|---|---|
| Type | Description |
String | |
getResponse()
public abstract 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.
| Returns | |
|---|---|
| Type | Description |
Object | |
isDone()
public abstract boolean isDone()Returns true if the operation is complete or failed, false otherwise.
| Returns | |
|---|---|
| Type | Description |
boolean | |