Class BatchProcessMetadata.Builder (2.17.0)

public static final class BatchProcessMetadata.Builder extends GeneratedMessageV3.Builder<BatchProcessMetadata.Builder> implements BatchProcessMetadataOrBuilder

The long running operation metadata for batch process method.

Protobuf type google.cloud.documentai.v1.BatchProcessMetadata

Static Methods

getDescriptor()

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

Methods

addAllIndividualProcessStatuses(Iterable<? extends BatchProcessMetadata.IndividualProcessStatus> values)

public BatchProcessMetadata.Builder addAllIndividualProcessStatuses(Iterable<? extends BatchProcessMetadata.IndividualProcessStatus> values)

The list of response details of each document.

repeated .google.cloud.documentai.v1.BatchProcessMetadata.IndividualProcessStatus individual_process_statuses = 5;

Parameter
NameDescription
valuesIterable<? extends com.google.cloud.documentai.v1.BatchProcessMetadata.IndividualProcessStatus>
Returns
TypeDescription
BatchProcessMetadata.Builder

addIndividualProcessStatuses(BatchProcessMetadata.IndividualProcessStatus value)

public BatchProcessMetadata.Builder addIndividualProcessStatuses(BatchProcessMetadata.IndividualProcessStatus value)

The list of response details of each document.

repeated .google.cloud.documentai.v1.BatchProcessMetadata.IndividualProcessStatus individual_process_statuses = 5;

Parameter
NameDescription
valueBatchProcessMetadata.IndividualProcessStatus
Returns
TypeDescription
BatchProcessMetadata.Builder

addIndividualProcessStatuses(BatchProcessMetadata.IndividualProcessStatus.Builder builderForValue)

public BatchProcessMetadata.Builder addIndividualProcessStatuses(BatchProcessMetadata.IndividualProcessStatus.Builder builderForValue)

The list of response details of each document.

repeated .google.cloud.documentai.v1.BatchProcessMetadata.IndividualProcessStatus individual_process_statuses = 5;

Parameter
NameDescription
builderForValueBatchProcessMetadata.IndividualProcessStatus.Builder
Returns
TypeDescription
BatchProcessMetadata.Builder

addIndividualProcessStatuses(int index, BatchProcessMetadata.IndividualProcessStatus value)

public BatchProcessMetadata.Builder addIndividualProcessStatuses(int index, BatchProcessMetadata.IndividualProcessStatus value)

The list of response details of each document.

repeated .google.cloud.documentai.v1.BatchProcessMetadata.IndividualProcessStatus individual_process_statuses = 5;

Parameters
NameDescription
indexint
valueBatchProcessMetadata.IndividualProcessStatus
Returns
TypeDescription
BatchProcessMetadata.Builder

addIndividualProcessStatuses(int index, BatchProcessMetadata.IndividualProcessStatus.Builder builderForValue)

public BatchProcessMetadata.Builder addIndividualProcessStatuses(int index, BatchProcessMetadata.IndividualProcessStatus.Builder builderForValue)

The list of response details of each document.

repeated .google.cloud.documentai.v1.BatchProcessMetadata.IndividualProcessStatus individual_process_statuses = 5;

Parameters
NameDescription
indexint
builderForValueBatchProcessMetadata.IndividualProcessStatus.Builder
Returns
TypeDescription
BatchProcessMetadata.Builder

addIndividualProcessStatusesBuilder()

public BatchProcessMetadata.IndividualProcessStatus.Builder addIndividualProcessStatusesBuilder()

The list of response details of each document.

repeated .google.cloud.documentai.v1.BatchProcessMetadata.IndividualProcessStatus individual_process_statuses = 5;

Returns
TypeDescription
BatchProcessMetadata.IndividualProcessStatus.Builder

addIndividualProcessStatusesBuilder(int index)

public BatchProcessMetadata.IndividualProcessStatus.Builder addIndividualProcessStatusesBuilder(int index)

The list of response details of each document.

repeated .google.cloud.documentai.v1.BatchProcessMetadata.IndividualProcessStatus individual_process_statuses = 5;

Parameter
NameDescription
indexint
Returns
TypeDescription
BatchProcessMetadata.IndividualProcessStatus.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public BatchProcessMetadata build()
Returns
TypeDescription
BatchProcessMetadata

buildPartial()

public BatchProcessMetadata buildPartial()
Returns
TypeDescription
BatchProcessMetadata

clear()

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

clearCreateTime()

public BatchProcessMetadata.Builder clearCreateTime()

The creation time of the operation.

.google.protobuf.Timestamp create_time = 3;

Returns
TypeDescription
BatchProcessMetadata.Builder

clearField(Descriptors.FieldDescriptor field)

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

clearIndividualProcessStatuses()

public BatchProcessMetadata.Builder clearIndividualProcessStatuses()

The list of response details of each document.

repeated .google.cloud.documentai.v1.BatchProcessMetadata.IndividualProcessStatus individual_process_statuses = 5;

Returns
TypeDescription
BatchProcessMetadata.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearState()

public BatchProcessMetadata.Builder clearState()

The state of the current batch processing.

.google.cloud.documentai.v1.BatchProcessMetadata.State state = 1;

Returns
TypeDescription
BatchProcessMetadata.Builder

This builder for chaining.

clearStateMessage()

public BatchProcessMetadata.Builder clearStateMessage()

A message providing more details about the current state of processing. For example, the error message if the operation is failed.

string state_message = 2;

Returns
TypeDescription
BatchProcessMetadata.Builder

This builder for chaining.

clearUpdateTime()

public BatchProcessMetadata.Builder clearUpdateTime()

The last update time of the operation.

.google.protobuf.Timestamp update_time = 4;

Returns
TypeDescription
BatchProcessMetadata.Builder

clone()

public BatchProcessMetadata.Builder clone()
Returns
TypeDescription
BatchProcessMetadata.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 BatchProcessMetadata getDefaultInstanceForType()
Returns
TypeDescription
BatchProcessMetadata

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getIndividualProcessStatuses(int index)

public BatchProcessMetadata.IndividualProcessStatus getIndividualProcessStatuses(int index)

The list of response details of each document.

repeated .google.cloud.documentai.v1.BatchProcessMetadata.IndividualProcessStatus individual_process_statuses = 5;

Parameter
NameDescription
indexint
Returns
TypeDescription
BatchProcessMetadata.IndividualProcessStatus

getIndividualProcessStatusesBuilder(int index)

public BatchProcessMetadata.IndividualProcessStatus.Builder getIndividualProcessStatusesBuilder(int index)

The list of response details of each document.

repeated .google.cloud.documentai.v1.BatchProcessMetadata.IndividualProcessStatus individual_process_statuses = 5;

Parameter
NameDescription
indexint
Returns
TypeDescription
BatchProcessMetadata.IndividualProcessStatus.Builder

getIndividualProcessStatusesBuilderList()

public List<BatchProcessMetadata.IndividualProcessStatus.Builder> getIndividualProcessStatusesBuilderList()

The list of response details of each document.

repeated .google.cloud.documentai.v1.BatchProcessMetadata.IndividualProcessStatus individual_process_statuses = 5;

Returns
TypeDescription
List<Builder>

getIndividualProcessStatusesCount()

public int getIndividualProcessStatusesCount()

The list of response details of each document.

repeated .google.cloud.documentai.v1.BatchProcessMetadata.IndividualProcessStatus individual_process_statuses = 5;

Returns
TypeDescription
int

getIndividualProcessStatusesList()

public List<BatchProcessMetadata.IndividualProcessStatus> getIndividualProcessStatusesList()

The list of response details of each document.

repeated .google.cloud.documentai.v1.BatchProcessMetadata.IndividualProcessStatus individual_process_statuses = 5;

Returns
TypeDescription
List<IndividualProcessStatus>

getIndividualProcessStatusesOrBuilder(int index)

public BatchProcessMetadata.IndividualProcessStatusOrBuilder getIndividualProcessStatusesOrBuilder(int index)

The list of response details of each document.

repeated .google.cloud.documentai.v1.BatchProcessMetadata.IndividualProcessStatus individual_process_statuses = 5;

Parameter
NameDescription
indexint
Returns
TypeDescription
BatchProcessMetadata.IndividualProcessStatusOrBuilder

getIndividualProcessStatusesOrBuilderList()

public List<? extends BatchProcessMetadata.IndividualProcessStatusOrBuilder> getIndividualProcessStatusesOrBuilderList()

The list of response details of each document.

repeated .google.cloud.documentai.v1.BatchProcessMetadata.IndividualProcessStatus individual_process_statuses = 5;

Returns
TypeDescription
List<? extends com.google.cloud.documentai.v1.BatchProcessMetadata.IndividualProcessStatusOrBuilder>

getState()

public BatchProcessMetadata.State getState()

The state of the current batch processing.

.google.cloud.documentai.v1.BatchProcessMetadata.State state = 1;

Returns
TypeDescription
BatchProcessMetadata.State

The state.

getStateMessage()

public String getStateMessage()

A message providing more details about the current state of processing. For example, the error message if the operation is failed.

string state_message = 2;

Returns
TypeDescription
String

The stateMessage.

getStateMessageBytes()

public ByteString getStateMessageBytes()

A message providing more details about the current state of processing. For example, the error message if the operation is failed.

string state_message = 2;

Returns
TypeDescription
ByteString

The bytes for stateMessage.

getStateValue()

public int getStateValue()

The state of the current batch processing.

.google.cloud.documentai.v1.BatchProcessMetadata.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 BatchProcessMetadata.Builder mergeCreateTime(Timestamp value)

The creation time of the operation.

.google.protobuf.Timestamp create_time = 3;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
BatchProcessMetadata.Builder

mergeFrom(BatchProcessMetadata other)

public BatchProcessMetadata.Builder mergeFrom(BatchProcessMetadata other)
Parameter
NameDescription
otherBatchProcessMetadata
Returns
TypeDescription
BatchProcessMetadata.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

mergeUpdateTime(Timestamp value)

public BatchProcessMetadata.Builder mergeUpdateTime(Timestamp value)

The last update time of the operation.

.google.protobuf.Timestamp update_time = 4;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
BatchProcessMetadata.Builder

removeIndividualProcessStatuses(int index)

public BatchProcessMetadata.Builder removeIndividualProcessStatuses(int index)

The list of response details of each document.

repeated .google.cloud.documentai.v1.BatchProcessMetadata.IndividualProcessStatus individual_process_statuses = 5;

Parameter
NameDescription
indexint
Returns
TypeDescription
BatchProcessMetadata.Builder

setCreateTime(Timestamp value)

public BatchProcessMetadata.Builder setCreateTime(Timestamp value)

The creation time of the operation.

.google.protobuf.Timestamp create_time = 3;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
BatchProcessMetadata.Builder

setCreateTime(Timestamp.Builder builderForValue)

public BatchProcessMetadata.Builder setCreateTime(Timestamp.Builder builderForValue)

The creation time of the operation.

.google.protobuf.Timestamp create_time = 3;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
BatchProcessMetadata.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

setIndividualProcessStatuses(int index, BatchProcessMetadata.IndividualProcessStatus value)

public BatchProcessMetadata.Builder setIndividualProcessStatuses(int index, BatchProcessMetadata.IndividualProcessStatus value)

The list of response details of each document.

repeated .google.cloud.documentai.v1.BatchProcessMetadata.IndividualProcessStatus individual_process_statuses = 5;

Parameters
NameDescription
indexint
valueBatchProcessMetadata.IndividualProcessStatus
Returns
TypeDescription
BatchProcessMetadata.Builder

setIndividualProcessStatuses(int index, BatchProcessMetadata.IndividualProcessStatus.Builder builderForValue)

public BatchProcessMetadata.Builder setIndividualProcessStatuses(int index, BatchProcessMetadata.IndividualProcessStatus.Builder builderForValue)

The list of response details of each document.

repeated .google.cloud.documentai.v1.BatchProcessMetadata.IndividualProcessStatus individual_process_statuses = 5;

Parameters
NameDescription
indexint
builderForValueBatchProcessMetadata.IndividualProcessStatus.Builder
Returns
TypeDescription
BatchProcessMetadata.Builder

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

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

setState(BatchProcessMetadata.State value)

public BatchProcessMetadata.Builder setState(BatchProcessMetadata.State value)

The state of the current batch processing.

.google.cloud.documentai.v1.BatchProcessMetadata.State state = 1;

Parameter
NameDescription
valueBatchProcessMetadata.State

The state to set.

Returns
TypeDescription
BatchProcessMetadata.Builder

This builder for chaining.

setStateMessage(String value)

public BatchProcessMetadata.Builder setStateMessage(String value)

A message providing more details about the current state of processing. For example, the error message if the operation is failed.

string state_message = 2;

Parameter
NameDescription
valueString

The stateMessage to set.

Returns
TypeDescription
BatchProcessMetadata.Builder

This builder for chaining.

setStateMessageBytes(ByteString value)

public BatchProcessMetadata.Builder setStateMessageBytes(ByteString value)

A message providing more details about the current state of processing. For example, the error message if the operation is failed.

string state_message = 2;

Parameter
NameDescription
valueByteString

The bytes for stateMessage to set.

Returns
TypeDescription
BatchProcessMetadata.Builder

This builder for chaining.

setStateValue(int value)

public BatchProcessMetadata.Builder setStateValue(int value)

The state of the current batch processing.

.google.cloud.documentai.v1.BatchProcessMetadata.State state = 1;

Parameter
NameDescription
valueint

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

Returns
TypeDescription
BatchProcessMetadata.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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

setUpdateTime(Timestamp value)

public BatchProcessMetadata.Builder setUpdateTime(Timestamp value)

The last update time of the operation.

.google.protobuf.Timestamp update_time = 4;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
BatchProcessMetadata.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public BatchProcessMetadata.Builder setUpdateTime(Timestamp.Builder builderForValue)

The last update time of the operation.

.google.protobuf.Timestamp update_time = 4;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
BatchProcessMetadata.Builder