Class OperationInfo (2.28.0)

public final class OperationInfo extends GeneratedMessageV3 implements OperationInfoOrBuilder

A message representing the message types used by a long-running operation.

Example:

rpc LongRunningRecognize(LongRunningRecognizeRequest) returns (google.longrunning.Operation) { option (google.longrunning.operation_info) = { response_type: "LongRunningRecognizeResponse" metadata_type: "LongRunningRecognizeMetadata" }; }

Protobuf type google.longrunning.OperationInfo

Static Fields

METADATA_TYPE_FIELD_NUMBER

public static final int METADATA_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

RESPONSE_TYPE_FIELD_NUMBER

public static final int RESPONSE_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static OperationInfo getDefaultInstance()
Returns
TypeDescription
OperationInfo

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static OperationInfo.Builder newBuilder()
Returns
TypeDescription
OperationInfo.Builder

newBuilder(OperationInfo prototype)

public static OperationInfo.Builder newBuilder(OperationInfo prototype)
Parameter
NameDescription
prototypeOperationInfo
Returns
TypeDescription
OperationInfo.Builder

parseDelimitedFrom(InputStream input)

public static OperationInfo parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
OperationInfo
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static OperationInfo parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
OperationInfo
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static OperationInfo parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
OperationInfo
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static OperationInfo parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
OperationInfo
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static OperationInfo parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
OperationInfo
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static OperationInfo parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
OperationInfo
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static OperationInfo parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
OperationInfo
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static OperationInfo parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
OperationInfo
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static OperationInfo parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
OperationInfo
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static OperationInfo parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
OperationInfo
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static OperationInfo parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
OperationInfo
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static OperationInfo parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
OperationInfo
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<OperationInfo> parser()
Returns
TypeDescription
Parser<OperationInfo>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public OperationInfo getDefaultInstanceForType()
Returns
TypeDescription
OperationInfo

getMetadataType()

public String getMetadataType()

Required. The message name of the metadata type for this long-running operation.

If the response is in a different package from the rpc, a fully-qualified message name must be used (e.g. google.protobuf.Struct).

Note: Altering this value constitutes a breaking change.

string metadata_type = 2;

Returns
TypeDescription
String

The metadataType.

getMetadataTypeBytes()

public ByteString getMetadataTypeBytes()

Required. The message name of the metadata type for this long-running operation.

If the response is in a different package from the rpc, a fully-qualified message name must be used (e.g. google.protobuf.Struct).

Note: Altering this value constitutes a breaking change.

string metadata_type = 2;

Returns
TypeDescription
ByteString

The bytes for metadataType.

getParserForType()

public Parser<OperationInfo> getParserForType()
Returns
TypeDescription
Parser<OperationInfo>
Overrides

getResponseType()

public String getResponseType()

Required. The message name of the primary return type for this long-running operation. This type will be used to deserialize the LRO's response.

If the response is in a different package from the rpc, a fully-qualified message name must be used (e.g. google.protobuf.Struct).

Note: Altering this value constitutes a breaking change.

string response_type = 1;

Returns
TypeDescription
String

The responseType.

getResponseTypeBytes()

public ByteString getResponseTypeBytes()

Required. The message name of the primary return type for this long-running operation. This type will be used to deserialize the LRO's response.

If the response is in a different package from the rpc, a fully-qualified message name must be used (e.g. google.protobuf.Struct).

Note: Altering this value constitutes a breaking change.

string response_type = 1;

Returns
TypeDescription
ByteString

The bytes for responseType.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public OperationInfo.Builder newBuilderForType()
Returns
TypeDescription
OperationInfo.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected OperationInfo.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
OperationInfo.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public OperationInfo.Builder toBuilder()
Returns
TypeDescription
OperationInfo.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException