Class Document.Label.Builder (2.27.0)

Version 2.27.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 Document.Label.Builder extends GeneratedMessageV3.Builder<Document.Label.Builder> implements Document.LabelOrBuilder

Label attaches schema information and/or other metadata to segments within a Document. Multiple Labels on a single field can denote either different labels, different instances of the same label created at different times, or some combination of both.

Protobuf type google.cloud.documentai.v1beta2.Document.Label

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Document.Label.Builder

Implements

Document.LabelOrBuilder

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 Document.Label.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
Document.Label.Builder

Overrides

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

build()

public Document.Label build()

Returns
Type	Description
Document.Label

buildPartial()

public Document.Label buildPartial()

Returns
Type	Description
Document.Label

clear()

public Document.Label.Builder clear()

Returns
Type	Description
Document.Label.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearAutomlModel()

public Document.Label.Builder clearAutomlModel()

Label is generated AutoML model. This field stores the full resource name of the AutoML model.

Format: projects/{project-id}/locations/{location-id}/models/{model-id}

string automl_model = 2;

Returns
Type	Description
Document.Label.Builder	This builder for chaining.

clearConfidence()

public Document.Label.Builder clearConfidence()

Confidence score between 0 and 1 for label assignment.

float confidence = 3;

Returns
Type	Description
Document.Label.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Document.Label.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
Document.Label.Builder

Overrides

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

clearName()

public Document.Label.Builder clearName()

Name of the label.

When the label is generated from AutoML Text Classification model, this field represents the name of the category.

string name = 1;

Returns
Type	Description
Document.Label.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Document.Label.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
Document.Label.Builder

Overrides

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

clearSource()

public Document.Label.Builder clearSource()

Returns
Type	Description
Document.Label.Builder

clone()

public Document.Label.Builder clone()

Returns
Type	Description
Document.Label.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getAutomlModel()

public String getAutomlModel()

Label is generated AutoML model. This field stores the full resource name of the AutoML model.

Format: projects/{project-id}/locations/{location-id}/models/{model-id}

string automl_model = 2;

Returns
Type	Description
String	The automlModel.

getAutomlModelBytes()

public ByteString getAutomlModelBytes()

Label is generated AutoML model. This field stores the full resource name of the AutoML model.

Format: projects/{project-id}/locations/{location-id}/models/{model-id}

string automl_model = 2;

Returns
Type	Description
ByteString	The bytes for automlModel.

getConfidence()

public float getConfidence()

Confidence score between 0 and 1 for label assignment.

float confidence = 3;

Returns
Type	Description
float	The confidence.

getDefaultInstanceForType()

public Document.Label getDefaultInstanceForType()

Returns
Type	Description
Document.Label

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getName()

public String getName()

Name of the label.

When the label is generated from AutoML Text Classification model, this field represents the name of the category.

string name = 1;

Returns
Type	Description
String	The name.

getNameBytes()

public ByteString getNameBytes()

Name of the label.

When the label is generated from AutoML Text Classification model, this field represents the name of the category.

string name = 1;

Returns
Type	Description
ByteString	The bytes for name.

getSourceCase()

public Document.Label.SourceCase getSourceCase()

Returns
Type	Description
Document.Label.SourceCase

hasAutomlModel()

public boolean hasAutomlModel()

Label is generated AutoML model. This field stores the full resource name of the AutoML model.

Format: projects/{project-id}/locations/{location-id}/models/{model-id}

string automl_model = 2;

Returns
Type	Description
boolean	Whether the automlModel 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()

mergeFrom(Document.Label other)

public Document.Label.Builder mergeFrom(Document.Label other)

Parameter
Name	Description
other	Document.Label

Returns
Type	Description
Document.Label.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Document.Label.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Document.Label.Builder

Overrides

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

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public Document.Label.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
Document.Label.Builder

Overrides

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Document.Label.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
Document.Label.Builder

Overrides

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

setAutomlModel(String value)

public Document.Label.Builder setAutomlModel(String value)

Label is generated AutoML model. This field stores the full resource name of the AutoML model.

Format: projects/{project-id}/locations/{location-id}/models/{model-id}

string automl_model = 2;

Parameter
Name	Description
value	String The automlModel to set.

Returns
Type	Description
Document.Label.Builder	This builder for chaining.

setAutomlModelBytes(ByteString value)

public Document.Label.Builder setAutomlModelBytes(ByteString value)

Label is generated AutoML model. This field stores the full resource name of the AutoML model.

Format: projects/{project-id}/locations/{location-id}/models/{model-id}

string automl_model = 2;

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

Returns
Type	Description
Document.Label.Builder	This builder for chaining.

setConfidence(float value)

public Document.Label.Builder setConfidence(float value)

Confidence score between 0 and 1 for label assignment.

float confidence = 3;

Parameter
Name	Description
value	float The confidence to set.

Returns
Type	Description
Document.Label.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
Document.Label.Builder

Overrides

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

setName(String value)

public Document.Label.Builder setName(String value)

Name of the label.

When the label is generated from AutoML Text Classification model, this field represents the name of the category.

string name = 1;

Parameter
Name	Description
value	String The name to set.

Returns
Type	Description
Document.Label.Builder	This builder for chaining.

setNameBytes(ByteString value)

public Document.Label.Builder setNameBytes(ByteString value)

Name of the label.

When the label is generated from AutoML Text Classification model, this field represents the name of the category.

string name = 1;

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

Returns
Type	Description
Document.Label.Builder	This builder for chaining.

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

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

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
Document.Label.Builder

Overrides

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

setUnknownFields(UnknownFieldSet unknownFields)

public final Document.Label.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
Document.Label.Builder

Overrides

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