Interface OperationOrBuilder (2.41.0)

Version 2.41.0

• 2.48.0 (latest)
• 2.46.0
• 2.45.1
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.1
• 2.38.0
• 2.37.1
• 2.36.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 2.24.0
• 2.23.1
• 2.22.1
• 2.21.1
• 2.15.0
• 2.14.3
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.6
• 2.8.4
• 2.7.4

public interface OperationOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDone()

public abstract boolean getDone()

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

bool done = 3;

Returns
Type	Description
boolean	The done.

getError()

public abstract Status getError()

The error result of the operation in case of failure or cancellation.

.google.rpc.Status error = 4;

Returns
Type	Description
Status	The error.

getErrorOrBuilder()

public abstract StatusOrBuilder getErrorOrBuilder()

The error result of the operation in case of failure or cancellation.

.google.rpc.Status error = 4;

Returns
Type	Description
StatusOrBuilder

getMetadata()

public abstract Any getMetadata()

Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

.google.protobuf.Any metadata = 2;

Returns
Type	Description
Any	The metadata.

getMetadataOrBuilder()

public abstract AnyOrBuilder getMetadataOrBuilder()

Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

.google.protobuf.Any metadata = 2;

Returns
Type	Description
AnyOrBuilder

getName()

public abstract String getName()

The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.

string name = 1;

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.

string name = 1;

Returns
Type	Description
ByteString	The bytes for name.

getResponse()

public abstract Any getResponse()

The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.

.google.protobuf.Any response = 5;

Returns
Type	Description
Any	The response.

getResponseOrBuilder()

public abstract AnyOrBuilder getResponseOrBuilder()

The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.

.google.protobuf.Any response = 5;

Returns
Type	Description
AnyOrBuilder

getResultCase()

public abstract Operation.ResultCase getResultCase()

Returns
Type	Description
Operation.ResultCase

hasError()

public abstract boolean hasError()

The error result of the operation in case of failure or cancellation.

.google.rpc.Status error = 4;

Returns
Type	Description
boolean	Whether the error field is set.

hasMetadata()

public abstract boolean hasMetadata()

Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

.google.protobuf.Any metadata = 2;

Returns
Type	Description
boolean	Whether the metadata field is set.

hasResponse()

public abstract boolean hasResponse()

The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.

.google.protobuf.Any response = 5;

Returns
Type	Description
boolean	Whether the response field is set.