Class CommonOperationMetadata.Builder (2.21.0)

Version 2.21.0

• 2.57.0 (latest)
• 2.56.0
• 2.55.0
• 2.53.0
• 2.52.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.5
• 2.6.2
• 2.5.1
• 2.4.3
• 2.3.1
• 2.2.1
• 2.1.9

public static final class CommonOperationMetadata.Builder extends GeneratedMessageV3.Builder<CommonOperationMetadata.Builder> implements CommonOperationMetadataOrBuilder

The common metadata for long running operations.

Protobuf type google.cloud.documentai.v1beta3.CommonOperationMetadata

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > CommonOperationMetadata.Builder

Implements

CommonOperationMetadataOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CommonOperationMetadata.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
CommonOperationMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public CommonOperationMetadata build()

Returns
Type	Description
CommonOperationMetadata

buildPartial()

public CommonOperationMetadata buildPartial()

Returns
Type	Description
CommonOperationMetadata

clear()

public CommonOperationMetadata.Builder clear()

Returns
Type	Description
CommonOperationMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearCreateTime()

public CommonOperationMetadata.Builder clearCreateTime()

The creation time of the operation.

.google.protobuf.Timestamp create_time = 3;

Returns
Type	Description
CommonOperationMetadata.Builder

clearField(Descriptors.FieldDescriptor field)

public CommonOperationMetadata.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
CommonOperationMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public CommonOperationMetadata.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
CommonOperationMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearResource()

public CommonOperationMetadata.Builder clearResource()

A related resource to this operation.

string resource = 5;

Returns
Type	Description
CommonOperationMetadata.Builder	This builder for chaining.

clearState()

public CommonOperationMetadata.Builder clearState()

The state of the operation.

.google.cloud.documentai.v1beta3.CommonOperationMetadata.State state = 1;

Returns
Type	Description
CommonOperationMetadata.Builder	This builder for chaining.

clearStateMessage()

public CommonOperationMetadata.Builder clearStateMessage()

A message providing more details about the current state of processing.

string state_message = 2;

Returns
Type	Description
CommonOperationMetadata.Builder	This builder for chaining.

clearUpdateTime()

public CommonOperationMetadata.Builder clearUpdateTime()

The last update time of the operation.

.google.protobuf.Timestamp update_time = 4;

Returns
Type	Description
CommonOperationMetadata.Builder

clone()

public CommonOperationMetadata.Builder clone()

Returns
Type	Description
CommonOperationMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getCreateTime()

public Timestamp getCreateTime()

The creation time of the operation.

.google.protobuf.Timestamp create_time = 3;

Returns
Type	Description
Timestamp	The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

The creation time of the operation.

.google.protobuf.Timestamp create_time = 3;

Returns
Type	Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

The creation time of the operation.

.google.protobuf.Timestamp create_time = 3;

Returns
Type	Description
TimestampOrBuilder

getDefaultInstanceForType()

public CommonOperationMetadata getDefaultInstanceForType()

Returns
Type	Description
CommonOperationMetadata

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getResource()

public String getResource()

A related resource to this operation.

string resource = 5;

Returns
Type	Description
String	The resource.

getResourceBytes()

public ByteString getResourceBytes()

A related resource to this operation.

string resource = 5;

Returns
Type	Description
ByteString	The bytes for resource.

getState()

public CommonOperationMetadata.State getState()

The state of the operation.

.google.cloud.documentai.v1beta3.CommonOperationMetadata.State state = 1;

Returns
Type	Description
CommonOperationMetadata.State	The state.

getStateMessage()

public String getStateMessage()

A message providing more details about the current state of processing.

string state_message = 2;

Returns
Type	Description
String	The stateMessage.

getStateMessageBytes()

public ByteString getStateMessageBytes()

A message providing more details about the current state of processing.

string state_message = 2;

Returns
Type	Description
ByteString	The bytes for stateMessage.

getStateValue()

public int getStateValue()

The state of the operation.

.google.cloud.documentai.v1beta3.CommonOperationMetadata.State state = 1;

Returns
Type	Description
int	The enum numeric value on the wire for state.

getUpdateTime()

public Timestamp getUpdateTime()

The last update time of the operation.

.google.protobuf.Timestamp update_time = 4;

Returns
Type	Description
Timestamp	The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

The last update time of the operation.

.google.protobuf.Timestamp update_time = 4;

Returns
Type	Description
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

The last update time of the operation.

.google.protobuf.Timestamp update_time = 4;

Returns
Type	Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

The creation time of the operation.

.google.protobuf.Timestamp create_time = 3;

Returns
Type	Description
boolean	Whether the createTime field is set.

hasUpdateTime()

public boolean hasUpdateTime()

The last update time of the operation.

.google.protobuf.Timestamp update_time = 4;

Returns
Type	Description
boolean	Whether the updateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeCreateTime(Timestamp value)

public CommonOperationMetadata.Builder mergeCreateTime(Timestamp value)

The creation time of the operation.

.google.protobuf.Timestamp create_time = 3;

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
CommonOperationMetadata.Builder

mergeFrom(CommonOperationMetadata other)

public CommonOperationMetadata.Builder mergeFrom(CommonOperationMetadata other)

Parameter
Name	Description
other	CommonOperationMetadata

Returns
Type	Description
CommonOperationMetadata.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CommonOperationMetadata.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
CommonOperationMetadata.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public CommonOperationMetadata.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
CommonOperationMetadata.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CommonOperationMetadata.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
CommonOperationMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

mergeUpdateTime(Timestamp value)

public CommonOperationMetadata.Builder mergeUpdateTime(Timestamp value)

The last update time of the operation.

.google.protobuf.Timestamp update_time = 4;

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
CommonOperationMetadata.Builder

setCreateTime(Timestamp value)

public CommonOperationMetadata.Builder setCreateTime(Timestamp value)

The creation time of the operation.

.google.protobuf.Timestamp create_time = 3;

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
CommonOperationMetadata.Builder

setCreateTime(Timestamp.Builder builderForValue)

public CommonOperationMetadata.Builder setCreateTime(Timestamp.Builder builderForValue)

The creation time of the operation.

.google.protobuf.Timestamp create_time = 3;

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
CommonOperationMetadata.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public CommonOperationMetadata.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
CommonOperationMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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

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

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
CommonOperationMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setResource(String value)

public CommonOperationMetadata.Builder setResource(String value)

A related resource to this operation.

string resource = 5;

Parameter
Name	Description
value	String The resource to set.

Returns
Type	Description
CommonOperationMetadata.Builder	This builder for chaining.

setResourceBytes(ByteString value)

public CommonOperationMetadata.Builder setResourceBytes(ByteString value)

A related resource to this operation.

string resource = 5;

Parameter
Name	Description
value	ByteString The bytes for resource to set.

Returns
Type	Description
CommonOperationMetadata.Builder	This builder for chaining.

setState(CommonOperationMetadata.State value)

public CommonOperationMetadata.Builder setState(CommonOperationMetadata.State value)

The state of the operation.

.google.cloud.documentai.v1beta3.CommonOperationMetadata.State state = 1;

Parameter
Name	Description
value	CommonOperationMetadata.State The state to set.

Returns
Type	Description
CommonOperationMetadata.Builder	This builder for chaining.

setStateMessage(String value)

public CommonOperationMetadata.Builder setStateMessage(String value)

A message providing more details about the current state of processing.

string state_message = 2;

Parameter
Name	Description
value	String The stateMessage to set.

Returns
Type	Description
CommonOperationMetadata.Builder	This builder for chaining.

setStateMessageBytes(ByteString value)

public CommonOperationMetadata.Builder setStateMessageBytes(ByteString value)

A message providing more details about the current state of processing.

string state_message = 2;

Parameter
Name	Description
value	ByteString The bytes for stateMessage to set.

Returns
Type	Description
CommonOperationMetadata.Builder	This builder for chaining.

setStateValue(int value)

public CommonOperationMetadata.Builder setStateValue(int value)

The state of the operation.

.google.cloud.documentai.v1beta3.CommonOperationMetadata.State state = 1;

Parameter
Name	Description
value	int The enum numeric value on the wire for state to set.

Returns
Type	Description
CommonOperationMetadata.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final CommonOperationMetadata.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
CommonOperationMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setUpdateTime(Timestamp value)

public CommonOperationMetadata.Builder setUpdateTime(Timestamp value)

The last update time of the operation.

.google.protobuf.Timestamp update_time = 4;

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
CommonOperationMetadata.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public CommonOperationMetadata.Builder setUpdateTime(Timestamp.Builder builderForValue)

The last update time of the operation.

.google.protobuf.Timestamp update_time = 4;

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
CommonOperationMetadata.Builder