com.google.longrunning

Interface OperationOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Operation, Operation.Builder

public interface OperationOrBuilder
extends com.google.protobuf.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.
StatusOrBuilder	getErrorOrBuilder() The error result of the operation in case of failure.
com.google.protobuf.Any	getMetadata() Some service-specific metadata associated with the operation.
com.google.protobuf.AnyOrBuilder	getMetadataOrBuilder() Some service-specific metadata associated with the operation.
java.lang.String	getName() The name of the operation resource, which is only unique within the same service that originally returns it.
com.google.protobuf.ByteString	getNameBytes() The name of the operation resource, which is only unique within the same service that originally returns it.
com.google.protobuf.Any	getResponse() The normal response of the operation in case of success.
com.google.protobuf.AnyOrBuilder	getResponseOrBuilder() The normal response of the operation in case of success.
Operation.ResultCase	getResultCase()
boolean	hasMetadata() Some service-specific metadata associated with the operation.

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 name of the operation resource, which is only unique within the same
 service that originally returns it.
 

optional string name = 1;

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 The name of the operation resource, which is only unique within the same
 service that originally returns it.
 

optional string name = 1;

hasMetadata

boolean hasMetadata()

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

optional .google.protobuf.Any metadata = 2;

getMetadata

com.google.protobuf.Any getMetadata()

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

optional .google.protobuf.Any metadata = 2;

getMetadataOrBuilder

com.google.protobuf.AnyOrBuilder getMetadataOrBuilder()

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

optional .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 the `result` is available.
 

optional bool done = 3;

getError

Status getError()

 The error result of the operation in case of failure.
 

optional .google.rpc.Status error = 4;

getErrorOrBuilder

StatusOrBuilder getErrorOrBuilder()

 The error result of the operation in case of failure.
 

optional .google.rpc.Status error = 4;

getResponse

com.google.protobuf.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 will be
 `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 will be
 `TakeSnapshotResponse`.
 

optional .google.protobuf.Any response = 5;

getResponseOrBuilder

com.google.protobuf.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 will be
 `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 will be
 `TakeSnapshotResponse`.
 

optional .google.protobuf.Any response = 5;

getResultCase

Operation.ResultCase getResultCase()