Class OperationInfo (2.40.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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > OperationInfo

Static Fields

METADATA_TYPE_FIELD_NUMBER

public static final int METADATA_TYPE_FIELD_NUMBER
Field Value
Type Description
int

RESPONSE_TYPE_FIELD_NUMBER

public static final int RESPONSE_TYPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static OperationInfo getDefaultInstance()
Returns
Type Description
OperationInfo

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static OperationInfo.Builder newBuilder()
Returns
Type Description
OperationInfo.Builder

newBuilder(OperationInfo prototype)

public static OperationInfo.Builder newBuilder(OperationInfo prototype)
Parameter
Name Description
prototype OperationInfo
Returns
Type Description
OperationInfo.Builder

parseDelimitedFrom(InputStream input)

public static OperationInfo parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
OperationInfo
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static OperationInfo parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OperationInfo
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static OperationInfo parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
OperationInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static OperationInfo parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OperationInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static OperationInfo parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
OperationInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static OperationInfo parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OperationInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static OperationInfo parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
OperationInfo
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static OperationInfo parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OperationInfo
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static OperationInfo parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
OperationInfo
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static OperationInfo parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OperationInfo
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static OperationInfo parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
OperationInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static OperationInfo parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OperationInfo
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<OperationInfo> parser()
Returns
Type Description
Parser<OperationInfo>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public OperationInfo getDefaultInstanceForType()
Returns
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for metadataType.

getParserForType()

public Parser<OperationInfo> getParserForType()
Returns
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for responseType.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public OperationInfo.Builder newBuilderForType()
Returns
Type Description
OperationInfo.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected OperationInfo.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
OperationInfo.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public OperationInfo.Builder toBuilder()
Returns
Type Description
OperationInfo.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException