Interface OperationSnapshot (2.20.1)

Version 2.20.1

• 2.55.0 (latest)
• 2.54.1
• 2.53.0
• 2.52.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.1
• 2.47.0
• 2.46.1
• 2.45.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.1
• 2.33.0
• 2.32.1
• 2.31.1
• 2.30.1
• 2.24.0
• 2.23.3
• 2.22.0
• 2.21.0
• 2.20.1
• 2.19.6
• 2.18.7
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.2
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.1
• 2.7.1

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.

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