Class BatchProcessMetadata.IndividualProcessStatus.Builder (2.21.0)

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

The status of a each individual document in the batch process.

Protobuf type google.cloud.documentai.v1beta3.BatchProcessMetadata.IndividualProcessStatus

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public BatchProcessMetadata.IndividualProcessStatus build()
Returns
TypeDescription
BatchProcessMetadata.IndividualProcessStatus

buildPartial()

public BatchProcessMetadata.IndividualProcessStatus buildPartial()
Returns
TypeDescription
BatchProcessMetadata.IndividualProcessStatus

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearHumanReviewOperation() (deprecated)

public BatchProcessMetadata.IndividualProcessStatus.Builder clearHumanReviewOperation()

Deprecated. google.cloud.documentai.v1beta3.BatchProcessMetadata.IndividualProcessStatus.human_review_operation is deprecated. See google/cloud/documentai/v1beta3/document_processor_service.proto;l=518

The name of the operation triggered by the processed document. If the human review process is not triggered, this field will be empty. It has the same response type and metadata as the long running operation returned by ReviewDocument method.

string human_review_operation = 4 [deprecated = true];

Returns
TypeDescription
BatchProcessMetadata.IndividualProcessStatus.Builder

This builder for chaining.

clearHumanReviewStatus()

public BatchProcessMetadata.IndividualProcessStatus.Builder clearHumanReviewStatus()

The status of human review on the processed document.

.google.cloud.documentai.v1beta3.HumanReviewStatus human_review_status = 5;

Returns
TypeDescription
BatchProcessMetadata.IndividualProcessStatus.Builder

clearInputGcsSource()

public BatchProcessMetadata.IndividualProcessStatus.Builder clearInputGcsSource()

The source of the document, same as the [input_gcs_source] field in the request when the batch process started. The batch process is started by take snapshot of that document, since a user can move or change that document during the process.

string input_gcs_source = 1;

Returns
TypeDescription
BatchProcessMetadata.IndividualProcessStatus.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearOutputGcsDestination()

public BatchProcessMetadata.IndividualProcessStatus.Builder clearOutputGcsDestination()

The output_gcs_destination (in the request as output_gcs_destination) of the processed document if it was successful, otherwise empty.

string output_gcs_destination = 3;

Returns
TypeDescription
BatchProcessMetadata.IndividualProcessStatus.Builder

This builder for chaining.

clearStatus()

public BatchProcessMetadata.IndividualProcessStatus.Builder clearStatus()

The status processing the document.

.google.rpc.Status status = 2;

Returns
TypeDescription
BatchProcessMetadata.IndividualProcessStatus.Builder

clone()

public BatchProcessMetadata.IndividualProcessStatus.Builder clone()
Returns
TypeDescription
BatchProcessMetadata.IndividualProcessStatus.Builder
Overrides

getDefaultInstanceForType()

public BatchProcessMetadata.IndividualProcessStatus getDefaultInstanceForType()
Returns
TypeDescription
BatchProcessMetadata.IndividualProcessStatus

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getHumanReviewOperation() (deprecated)

public String getHumanReviewOperation()

Deprecated. google.cloud.documentai.v1beta3.BatchProcessMetadata.IndividualProcessStatus.human_review_operation is deprecated. See google/cloud/documentai/v1beta3/document_processor_service.proto;l=518

The name of the operation triggered by the processed document. If the human review process is not triggered, this field will be empty. It has the same response type and metadata as the long running operation returned by ReviewDocument method.

string human_review_operation = 4 [deprecated = true];

Returns
TypeDescription
String

The humanReviewOperation.

getHumanReviewOperationBytes() (deprecated)

public ByteString getHumanReviewOperationBytes()

Deprecated. google.cloud.documentai.v1beta3.BatchProcessMetadata.IndividualProcessStatus.human_review_operation is deprecated. See google/cloud/documentai/v1beta3/document_processor_service.proto;l=518

The name of the operation triggered by the processed document. If the human review process is not triggered, this field will be empty. It has the same response type and metadata as the long running operation returned by ReviewDocument method.

string human_review_operation = 4 [deprecated = true];

Returns
TypeDescription
ByteString

The bytes for humanReviewOperation.

getHumanReviewStatus()

public HumanReviewStatus getHumanReviewStatus()

The status of human review on the processed document.

.google.cloud.documentai.v1beta3.HumanReviewStatus human_review_status = 5;

Returns
TypeDescription
HumanReviewStatus

The humanReviewStatus.

getHumanReviewStatusBuilder()

public HumanReviewStatus.Builder getHumanReviewStatusBuilder()

The status of human review on the processed document.

.google.cloud.documentai.v1beta3.HumanReviewStatus human_review_status = 5;

Returns
TypeDescription
HumanReviewStatus.Builder

getHumanReviewStatusOrBuilder()

public HumanReviewStatusOrBuilder getHumanReviewStatusOrBuilder()

The status of human review on the processed document.

.google.cloud.documentai.v1beta3.HumanReviewStatus human_review_status = 5;

Returns
TypeDescription
HumanReviewStatusOrBuilder

getInputGcsSource()

public String getInputGcsSource()

The source of the document, same as the [input_gcs_source] field in the request when the batch process started. The batch process is started by take snapshot of that document, since a user can move or change that document during the process.

string input_gcs_source = 1;

Returns
TypeDescription
String

The inputGcsSource.

getInputGcsSourceBytes()

public ByteString getInputGcsSourceBytes()

The source of the document, same as the [input_gcs_source] field in the request when the batch process started. The batch process is started by take snapshot of that document, since a user can move or change that document during the process.

string input_gcs_source = 1;

Returns
TypeDescription
ByteString

The bytes for inputGcsSource.

getOutputGcsDestination()

public String getOutputGcsDestination()

The output_gcs_destination (in the request as output_gcs_destination) of the processed document if it was successful, otherwise empty.

string output_gcs_destination = 3;

Returns
TypeDescription
String

The outputGcsDestination.

getOutputGcsDestinationBytes()

public ByteString getOutputGcsDestinationBytes()

The output_gcs_destination (in the request as output_gcs_destination) of the processed document if it was successful, otherwise empty.

string output_gcs_destination = 3;

Returns
TypeDescription
ByteString

The bytes for outputGcsDestination.

getStatus()

public Status getStatus()

The status processing the document.

.google.rpc.Status status = 2;

Returns
TypeDescription
com.google.rpc.Status

The status.

getStatusBuilder()

public Status.Builder getStatusBuilder()

The status processing the document.

.google.rpc.Status status = 2;

Returns
TypeDescription
com.google.rpc.Status.Builder

getStatusOrBuilder()

public StatusOrBuilder getStatusOrBuilder()

The status processing the document.

.google.rpc.Status status = 2;

Returns
TypeDescription
com.google.rpc.StatusOrBuilder

hasHumanReviewStatus()

public boolean hasHumanReviewStatus()

The status of human review on the processed document.

.google.cloud.documentai.v1beta3.HumanReviewStatus human_review_status = 5;

Returns
TypeDescription
boolean

Whether the humanReviewStatus field is set.

hasStatus()

public boolean hasStatus()

The status processing the document.

.google.rpc.Status status = 2;

Returns
TypeDescription
boolean

Whether the status field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(BatchProcessMetadata.IndividualProcessStatus other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeHumanReviewStatus(HumanReviewStatus value)

public BatchProcessMetadata.IndividualProcessStatus.Builder mergeHumanReviewStatus(HumanReviewStatus value)

The status of human review on the processed document.

.google.cloud.documentai.v1beta3.HumanReviewStatus human_review_status = 5;

Parameter
NameDescription
valueHumanReviewStatus
Returns
TypeDescription
BatchProcessMetadata.IndividualProcessStatus.Builder

mergeStatus(Status value)

public BatchProcessMetadata.IndividualProcessStatus.Builder mergeStatus(Status value)

The status processing the document.

.google.rpc.Status status = 2;

Parameter
NameDescription
valuecom.google.rpc.Status
Returns
TypeDescription
BatchProcessMetadata.IndividualProcessStatus.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setHumanReviewOperation(String value) (deprecated)

public BatchProcessMetadata.IndividualProcessStatus.Builder setHumanReviewOperation(String value)

Deprecated. google.cloud.documentai.v1beta3.BatchProcessMetadata.IndividualProcessStatus.human_review_operation is deprecated. See google/cloud/documentai/v1beta3/document_processor_service.proto;l=518

The name of the operation triggered by the processed document. If the human review process is not triggered, this field will be empty. It has the same response type and metadata as the long running operation returned by ReviewDocument method.

string human_review_operation = 4 [deprecated = true];

Parameter
NameDescription
valueString

The humanReviewOperation to set.

Returns
TypeDescription
BatchProcessMetadata.IndividualProcessStatus.Builder

This builder for chaining.

setHumanReviewOperationBytes(ByteString value) (deprecated)

public BatchProcessMetadata.IndividualProcessStatus.Builder setHumanReviewOperationBytes(ByteString value)

Deprecated. google.cloud.documentai.v1beta3.BatchProcessMetadata.IndividualProcessStatus.human_review_operation is deprecated. See google/cloud/documentai/v1beta3/document_processor_service.proto;l=518

The name of the operation triggered by the processed document. If the human review process is not triggered, this field will be empty. It has the same response type and metadata as the long running operation returned by ReviewDocument method.

string human_review_operation = 4 [deprecated = true];

Parameter
NameDescription
valueByteString

The bytes for humanReviewOperation to set.

Returns
TypeDescription
BatchProcessMetadata.IndividualProcessStatus.Builder

This builder for chaining.

setHumanReviewStatus(HumanReviewStatus value)

public BatchProcessMetadata.IndividualProcessStatus.Builder setHumanReviewStatus(HumanReviewStatus value)

The status of human review on the processed document.

.google.cloud.documentai.v1beta3.HumanReviewStatus human_review_status = 5;

Parameter
NameDescription
valueHumanReviewStatus
Returns
TypeDescription
BatchProcessMetadata.IndividualProcessStatus.Builder

setHumanReviewStatus(HumanReviewStatus.Builder builderForValue)

public BatchProcessMetadata.IndividualProcessStatus.Builder setHumanReviewStatus(HumanReviewStatus.Builder builderForValue)

The status of human review on the processed document.

.google.cloud.documentai.v1beta3.HumanReviewStatus human_review_status = 5;

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

setInputGcsSource(String value)

public BatchProcessMetadata.IndividualProcessStatus.Builder setInputGcsSource(String value)

The source of the document, same as the [input_gcs_source] field in the request when the batch process started. The batch process is started by take snapshot of that document, since a user can move or change that document during the process.

string input_gcs_source = 1;

Parameter
NameDescription
valueString

The inputGcsSource to set.

Returns
TypeDescription
BatchProcessMetadata.IndividualProcessStatus.Builder

This builder for chaining.

setInputGcsSourceBytes(ByteString value)

public BatchProcessMetadata.IndividualProcessStatus.Builder setInputGcsSourceBytes(ByteString value)

The source of the document, same as the [input_gcs_source] field in the request when the batch process started. The batch process is started by take snapshot of that document, since a user can move or change that document during the process.

string input_gcs_source = 1;

Parameter
NameDescription
valueByteString

The bytes for inputGcsSource to set.

Returns
TypeDescription
BatchProcessMetadata.IndividualProcessStatus.Builder

This builder for chaining.

setOutputGcsDestination(String value)

public BatchProcessMetadata.IndividualProcessStatus.Builder setOutputGcsDestination(String value)

The output_gcs_destination (in the request as output_gcs_destination) of the processed document if it was successful, otherwise empty.

string output_gcs_destination = 3;

Parameter
NameDescription
valueString

The outputGcsDestination to set.

Returns
TypeDescription
BatchProcessMetadata.IndividualProcessStatus.Builder

This builder for chaining.

setOutputGcsDestinationBytes(ByteString value)

public BatchProcessMetadata.IndividualProcessStatus.Builder setOutputGcsDestinationBytes(ByteString value)

The output_gcs_destination (in the request as output_gcs_destination) of the processed document if it was successful, otherwise empty.

string output_gcs_destination = 3;

Parameter
NameDescription
valueByteString

The bytes for outputGcsDestination to set.

Returns
TypeDescription
BatchProcessMetadata.IndividualProcessStatus.Builder

This builder for chaining.

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

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

setStatus(Status value)

public BatchProcessMetadata.IndividualProcessStatus.Builder setStatus(Status value)

The status processing the document.

.google.rpc.Status status = 2;

Parameter
NameDescription
valuecom.google.rpc.Status
Returns
TypeDescription
BatchProcessMetadata.IndividualProcessStatus.Builder

setStatus(Status.Builder builderForValue)

public BatchProcessMetadata.IndividualProcessStatus.Builder setStatus(Status.Builder builderForValue)

The status processing the document.

.google.rpc.Status status = 2;

Parameter
NameDescription
builderForValuecom.google.rpc.Status.Builder
Returns
TypeDescription
BatchProcessMetadata.IndividualProcessStatus.Builder

setUnknownFields(UnknownFieldSet unknownFields)

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