Class CommonOperationMetadata.Builder

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

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public CommonOperationMetadata build()
Returns
TypeDescription
CommonOperationMetadata

buildPartial()

public CommonOperationMetadata buildPartial()
Returns
TypeDescription
CommonOperationMetadata

clear()

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

clearCreateTime()

public CommonOperationMetadata.Builder clearCreateTime()

The creation time of the operation.

.google.protobuf.Timestamp create_time = 3;

Returns
TypeDescription
CommonOperationMetadata.Builder

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearState()

public CommonOperationMetadata.Builder clearState()

The state of the operation.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
CommonOperationMetadata.Builder

clone()

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

getCreateTime()

public Timestamp getCreateTime()

The creation time of the operation.

.google.protobuf.Timestamp create_time = 3;

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

The creation time of the operation.

.google.protobuf.Timestamp create_time = 3;

Returns
TypeDescription
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

The creation time of the operation.

.google.protobuf.Timestamp create_time = 3;

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public CommonOperationMetadata getDefaultInstanceForType()
Returns
TypeDescription
CommonOperationMetadata

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getState()

public CommonOperationMetadata.State getState()

The state of the operation.

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

Returns
TypeDescription
CommonOperationMetadata.State

The state.

getStateMessage()

public String getStateMessage()

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

string state_message = 2;

Returns
TypeDescription
String

The stateMessage.

getStateMessageBytes()

public ByteString getStateMessageBytes()

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

string state_message = 2;

Returns
TypeDescription
ByteString

The bytes for stateMessage.

getStateValue()

public int getStateValue()

The state of the operation.

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

Returns
TypeDescription
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
TypeDescription
Timestamp

The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

The last update time of the operation.

.google.protobuf.Timestamp update_time = 4;

Returns
TypeDescription
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

The last update time of the operation.

.google.protobuf.Timestamp update_time = 4;

Returns
TypeDescription
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

The creation time of the operation.

.google.protobuf.Timestamp create_time = 3;

Returns
TypeDescription
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
TypeDescription
boolean

Whether the updateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeCreateTime(Timestamp value)

public CommonOperationMetadata.Builder mergeCreateTime(Timestamp value)

The creation time of the operation.

.google.protobuf.Timestamp create_time = 3;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
CommonOperationMetadata.Builder

mergeFrom(CommonOperationMetadata other)

public CommonOperationMetadata.Builder mergeFrom(CommonOperationMetadata other)
Parameter
NameDescription
otherCommonOperationMetadata
Returns
TypeDescription
CommonOperationMetadata.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

mergeUpdateTime(Timestamp value)

public CommonOperationMetadata.Builder mergeUpdateTime(Timestamp value)

The last update time of the operation.

.google.protobuf.Timestamp update_time = 4;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
CommonOperationMetadata.Builder

setCreateTime(Timestamp value)

public CommonOperationMetadata.Builder setCreateTime(Timestamp value)

The creation time of the operation.

.google.protobuf.Timestamp create_time = 3;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
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
NameDescription
builderForValueBuilder
Returns
TypeDescription
CommonOperationMetadata.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

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

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

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
NameDescription
valueCommonOperationMetadata.State

The state to set.

Returns
TypeDescription
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
NameDescription
valueString

The stateMessage to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for stateMessage to set.

Returns
TypeDescription
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
NameDescription
valueint

The enum numeric value on the wire for state to set.

Returns
TypeDescription
CommonOperationMetadata.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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

setUpdateTime(Timestamp value)

public CommonOperationMetadata.Builder setUpdateTime(Timestamp value)

The last update time of the operation.

.google.protobuf.Timestamp update_time = 4;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
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
NameDescription
builderForValueBuilder
Returns
TypeDescription
CommonOperationMetadata.Builder