com.google.longrunning

Interface OperationOrBuilder

All Superinterfaces:

MessageLiteOrBuilder, MessageOrBuilder

All Known Implementing Classes:

Operation, Operation.Builder

public interface OperationOrBuilder
extends MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	getDone() If the value is `false`, it means the operation is still in progress.
Status	getError() The error result of the operation in case of failure or cancellation.
StatusOrBuilder	getErrorOrBuilder() The error result of the operation in case of failure or cancellation.
Any	getMetadata() Service-specific metadata associated with the operation.
AnyOrBuilder	getMetadataOrBuilder() Service-specific metadata associated with the operation.
java.lang.String	getName() The server-assigned name, which is only unique within the same service that originally returns it.
ByteString	getNameBytes() The server-assigned name, which is only unique within the same service that originally returns it.
Any	getResponse() The normal response of the operation in case of success.
AnyOrBuilder	getResponseOrBuilder() The normal response of the operation in case of success.
Operation.ResultCase	getResultCase()
boolean	hasError() The error result of the operation in case of failure or cancellation.
boolean	hasMetadata() Service-specific metadata associated with the operation.
boolean	hasResponse() The normal response of the operation in case of success.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

java.lang.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 have the format of `operations/some/unique/name`.
 

string name = 1;

getNameBytes

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 have the format of `operations/some/unique/name`.
 

string name = 1;

hasMetadata

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;

getMetadata

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;

getMetadataOrBuilder

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;

getDone

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;

hasError

boolean hasError()

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

.google.rpc.Status error = 4;

getError

Status getError()

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

.google.rpc.Status error = 4;

getErrorOrBuilder

StatusOrBuilder getErrorOrBuilder()

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

.google.rpc.Status error = 4;

hasResponse

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;

getResponse

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;

getResponseOrBuilder

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;

getResultCase

Operation.ResultCase getResultCase()