Class OperationInfo.Builder (2.25.0)

public static final class OperationInfo.Builder extends GeneratedMessageV3.Builder<OperationInfo.Builder> 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 Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public OperationInfo.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
OperationInfo.Builder
Overrides

build()

public OperationInfo build()
Returns
TypeDescription
OperationInfo

buildPartial()

public OperationInfo buildPartial()
Returns
TypeDescription
OperationInfo

clear()

public OperationInfo.Builder clear()
Returns
TypeDescription
OperationInfo.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public OperationInfo.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
OperationInfo.Builder
Overrides

clearMetadataType()

public OperationInfo.Builder clearMetadataType()

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
OperationInfo.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public OperationInfo.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
OperationInfo.Builder
Overrides

clearResponseType()

public OperationInfo.Builder clearResponseType()

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
OperationInfo.Builder

This builder for chaining.

clone()

public OperationInfo.Builder clone()
Returns
TypeDescription
OperationInfo.Builder
Overrides

getDefaultInstanceForType()

public OperationInfo getDefaultInstanceForType()
Returns
TypeDescription
OperationInfo

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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.

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(OperationInfo other)

public OperationInfo.Builder mergeFrom(OperationInfo other)
Parameter
NameDescription
otherOperationInfo
Returns
TypeDescription
OperationInfo.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public OperationInfo.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
OperationInfo.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public OperationInfo.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
OperationInfo.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final OperationInfo.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
OperationInfo.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public OperationInfo.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
OperationInfo.Builder
Overrides

setMetadataType(String value)

public OperationInfo.Builder setMetadataType(String value)

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;

Parameter
NameDescription
valueString

The metadataType to set.

Returns
TypeDescription
OperationInfo.Builder

This builder for chaining.

setMetadataTypeBytes(ByteString value)

public OperationInfo.Builder setMetadataTypeBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for metadataType to set.

Returns
TypeDescription
OperationInfo.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public OperationInfo.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
OperationInfo.Builder
Overrides

setResponseType(String value)

public OperationInfo.Builder setResponseType(String value)

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;

Parameter
NameDescription
valueString

The responseType to set.

Returns
TypeDescription
OperationInfo.Builder

This builder for chaining.

setResponseTypeBytes(ByteString value)

public OperationInfo.Builder setResponseTypeBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for responseType to set.

Returns
TypeDescription
OperationInfo.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final OperationInfo.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
OperationInfo.Builder
Overrides