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
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > OperationInfo.BuilderImplements
OperationInfoOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public OperationInfo.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
OperationInfo.Builder |
build()
public OperationInfo build()
Returns | |
---|---|
Type | Description |
OperationInfo |
buildPartial()
public OperationInfo buildPartial()
Returns | |
---|---|
Type | Description |
OperationInfo |
clear()
public OperationInfo.Builder clear()
Returns | |
---|---|
Type | Description |
OperationInfo.Builder |
clearField(Descriptors.FieldDescriptor field)
public OperationInfo.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
OperationInfo.Builder |
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 | |
---|---|
Type | Description |
OperationInfo.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public OperationInfo.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
OperationInfo.Builder |
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 | |
---|---|
Type | Description |
OperationInfo.Builder |
This builder for chaining. |
clone()
public OperationInfo.Builder clone()
Returns | |
---|---|
Type | Description |
OperationInfo.Builder |
getDefaultInstanceForType()
public OperationInfo getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
OperationInfo |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
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. |
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeFrom(OperationInfo other)
public OperationInfo.Builder mergeFrom(OperationInfo other)
Parameter | |
---|---|
Name | Description |
other |
OperationInfo |
Returns | |
---|---|
Type | Description |
OperationInfo.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public OperationInfo.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
OperationInfo.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public OperationInfo.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
OperationInfo.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final OperationInfo.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
OperationInfo.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public OperationInfo.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
OperationInfo.Builder |
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 | |
---|---|
Name | Description |
value |
String The metadataType to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value |
ByteString The bytes for metadataType to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
OperationInfo.Builder |
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 | |
---|---|
Name | Description |
value |
String The responseType to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value |
ByteString The bytes for responseType to set. |
Returns | |
---|---|
Type | Description |
OperationInfo.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final OperationInfo.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
OperationInfo.Builder |