Class HumanReviewStatus.Builder (2.87.0)

public static final class HumanReviewStatus.Builder extends GeneratedMessage.Builder<HumanReviewStatus.Builder> implements HumanReviewStatusOrBuilder

The status of human review on a processed document.

Protobuf type google.cloud.documentai.v1beta3.HumanReviewStatus

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

build()

public HumanReviewStatus build()
Returns
Type Description
HumanReviewStatus

buildPartial()

public HumanReviewStatus buildPartial()
Returns
Type Description
HumanReviewStatus

clear()

public HumanReviewStatus.Builder clear()
Returns
Type Description
HumanReviewStatus.Builder
Overrides

clearHumanReviewOperation()

public HumanReviewStatus.Builder clearHumanReviewOperation()

The name of the operation triggered by the processed document. This field is populated only when the state is HUMAN_REVIEW_IN_PROGRESS. It has the same response type and metadata as the long-running operation returned by ReviewDocument.

string human_review_operation = 3;

Returns
Type Description
HumanReviewStatus.Builder

This builder for chaining.

clearState()

public HumanReviewStatus.Builder clearState()

The state of human review on the processing request.

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

Returns
Type Description
HumanReviewStatus.Builder

This builder for chaining.

clearStateMessage()

public HumanReviewStatus.Builder clearStateMessage()

A message providing more details about the human review state.

string state_message = 2;

Returns
Type Description
HumanReviewStatus.Builder

This builder for chaining.

getDefaultInstanceForType()

public HumanReviewStatus getDefaultInstanceForType()
Returns
Type Description
HumanReviewStatus

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getHumanReviewOperation()

public String getHumanReviewOperation()

The name of the operation triggered by the processed document. This field is populated only when the state is HUMAN_REVIEW_IN_PROGRESS. It has the same response type and metadata as the long-running operation returned by ReviewDocument.

string human_review_operation = 3;

Returns
Type Description
String

The humanReviewOperation.

getHumanReviewOperationBytes()

public ByteString getHumanReviewOperationBytes()

The name of the operation triggered by the processed document. This field is populated only when the state is HUMAN_REVIEW_IN_PROGRESS. It has the same response type and metadata as the long-running operation returned by ReviewDocument.

string human_review_operation = 3;

Returns
Type Description
ByteString

The bytes for humanReviewOperation.

getState()

public HumanReviewStatus.State getState()

The state of human review on the processing request.

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

Returns
Type Description
HumanReviewStatus.State

The state.

getStateMessage()

public String getStateMessage()

A message providing more details about the human review state.

string state_message = 2;

Returns
Type Description
String

The stateMessage.

getStateMessageBytes()

public ByteString getStateMessageBytes()

A message providing more details about the human review state.

string state_message = 2;

Returns
Type Description
ByteString

The bytes for stateMessage.

getStateValue()

public int getStateValue()

The state of human review on the processing request.

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

Returns
Type Description
int

The enum numeric value on the wire for state.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(HumanReviewStatus other)

public HumanReviewStatus.Builder mergeFrom(HumanReviewStatus other)
Parameter
Name Description
other HumanReviewStatus
Returns
Type Description
HumanReviewStatus.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public HumanReviewStatus.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HumanReviewStatus.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public HumanReviewStatus.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
HumanReviewStatus.Builder
Overrides

setHumanReviewOperation(String value)

public HumanReviewStatus.Builder setHumanReviewOperation(String value)

The name of the operation triggered by the processed document. This field is populated only when the state is HUMAN_REVIEW_IN_PROGRESS. It has the same response type and metadata as the long-running operation returned by ReviewDocument.

string human_review_operation = 3;

Parameter
Name Description
value String

The humanReviewOperation to set.

Returns
Type Description
HumanReviewStatus.Builder

This builder for chaining.

setHumanReviewOperationBytes(ByteString value)

public HumanReviewStatus.Builder setHumanReviewOperationBytes(ByteString value)

The name of the operation triggered by the processed document. This field is populated only when the state is HUMAN_REVIEW_IN_PROGRESS. It has the same response type and metadata as the long-running operation returned by ReviewDocument.

string human_review_operation = 3;

Parameter
Name Description
value ByteString

The bytes for humanReviewOperation to set.

Returns
Type Description
HumanReviewStatus.Builder

This builder for chaining.

setState(HumanReviewStatus.State value)

public HumanReviewStatus.Builder setState(HumanReviewStatus.State value)

The state of human review on the processing request.

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

Parameter
Name Description
value HumanReviewStatus.State

The state to set.

Returns
Type Description
HumanReviewStatus.Builder

This builder for chaining.

setStateMessage(String value)

public HumanReviewStatus.Builder setStateMessage(String value)

A message providing more details about the human review state.

string state_message = 2;

Parameter
Name Description
value String

The stateMessage to set.

Returns
Type Description
HumanReviewStatus.Builder

This builder for chaining.

setStateMessageBytes(ByteString value)

public HumanReviewStatus.Builder setStateMessageBytes(ByteString value)

A message providing more details about the human review state.

string state_message = 2;

Parameter
Name Description
value ByteString

The bytes for stateMessage to set.

Returns
Type Description
HumanReviewStatus.Builder

This builder for chaining.

setStateValue(int value)

public HumanReviewStatus.Builder setStateValue(int value)

The state of human review on the processing request.

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

Parameter
Name Description
value int

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

Returns
Type Description
HumanReviewStatus.Builder

This builder for chaining.