Class DocumentSchema.Metadata.Builder (2.17.0)

Version 2.17.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 DocumentSchema.Metadata.Builder extends GeneratedMessageV3.Builder<DocumentSchema.Metadata.Builder> implements DocumentSchema.MetadataOrBuilder

Metadata for global schema behavior.

Protobuf type google.cloud.documentai.v1.DocumentSchema.Metadata

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > DocumentSchema.Metadata.Builder

Implements

DocumentSchema.MetadataOrBuilder

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

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
DocumentSchema.Metadata.Builder

Overrides

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

build()

public DocumentSchema.Metadata build()

Returns
Type	Description
DocumentSchema.Metadata

buildPartial()

public DocumentSchema.Metadata buildPartial()

Returns
Type	Description
DocumentSchema.Metadata

clear()

public DocumentSchema.Metadata.Builder clear()

Returns
Type	Description
DocumentSchema.Metadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearDocumentAllowMultipleLabels()

public DocumentSchema.Metadata.Builder clearDocumentAllowMultipleLabels()

If true, on a given page, there can be multiple document annotations covering it.

bool document_allow_multiple_labels = 2;

Returns
Type	Description
DocumentSchema.Metadata.Builder	This builder for chaining.

clearDocumentSplitter()

public DocumentSchema.Metadata.Builder clearDocumentSplitter()

If true, a document entity type can be applied to subdocument ( splitting). Otherwise, it can only be applied to the entire document (classification).

bool document_splitter = 1;

Returns
Type	Description
DocumentSchema.Metadata.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public DocumentSchema.Metadata.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
DocumentSchema.Metadata.Builder

Overrides

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

clearOneof(Descriptors.OneofDescriptor oneof)

public DocumentSchema.Metadata.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
DocumentSchema.Metadata.Builder

Overrides

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

clearPrefixedNamingOnProperties()

public DocumentSchema.Metadata.Builder clearPrefixedNamingOnProperties()

If set, all the nested entities must be prefixed with the parents.

bool prefixed_naming_on_properties = 6;

Returns
Type	Description
DocumentSchema.Metadata.Builder	This builder for chaining.

clearSkipNamingValidation()

public DocumentSchema.Metadata.Builder clearSkipNamingValidation()

If set, we will skip the naming format validation in the schema. So the string values in DocumentSchema.EntityType.name and DocumentSchema.EntityType.Property.name will not be checked.

bool skip_naming_validation = 7;

Returns
Type	Description
DocumentSchema.Metadata.Builder	This builder for chaining.

clone()

public DocumentSchema.Metadata.Builder clone()

Returns
Type	Description
DocumentSchema.Metadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public DocumentSchema.Metadata getDefaultInstanceForType()

Returns
Type	Description
DocumentSchema.Metadata

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getDocumentAllowMultipleLabels()

public boolean getDocumentAllowMultipleLabels()

If true, on a given page, there can be multiple document annotations covering it.

bool document_allow_multiple_labels = 2;

Returns
Type	Description
boolean	The documentAllowMultipleLabels.

getDocumentSplitter()

public boolean getDocumentSplitter()

If true, a document entity type can be applied to subdocument ( splitting). Otherwise, it can only be applied to the entire document (classification).

bool document_splitter = 1;

Returns
Type	Description
boolean	The documentSplitter.

getPrefixedNamingOnProperties()

public boolean getPrefixedNamingOnProperties()

If set, all the nested entities must be prefixed with the parents.

bool prefixed_naming_on_properties = 6;

Returns
Type	Description
boolean	The prefixedNamingOnProperties.

getSkipNamingValidation()

public boolean getSkipNamingValidation()

If set, we will skip the naming format validation in the schema. So the string values in DocumentSchema.EntityType.name and DocumentSchema.EntityType.Property.name will not be checked.

bool skip_naming_validation = 7;

Returns
Type	Description
boolean	The skipNamingValidation.

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(DocumentSchema.Metadata other)

public DocumentSchema.Metadata.Builder mergeFrom(DocumentSchema.Metadata other)

Parameter
Name	Description
other	DocumentSchema.Metadata

Returns
Type	Description
DocumentSchema.Metadata.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DocumentSchema.Metadata.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DocumentSchema.Metadata.Builder

Overrides

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

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public DocumentSchema.Metadata.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
DocumentSchema.Metadata.Builder

Overrides

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DocumentSchema.Metadata.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
DocumentSchema.Metadata.Builder

Overrides

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

setDocumentAllowMultipleLabels(boolean value)

public DocumentSchema.Metadata.Builder setDocumentAllowMultipleLabels(boolean value)

If true, on a given page, there can be multiple document annotations covering it.

bool document_allow_multiple_labels = 2;

Parameter
Name	Description
value	boolean The documentAllowMultipleLabels to set.

Returns
Type	Description
DocumentSchema.Metadata.Builder	This builder for chaining.

setDocumentSplitter(boolean value)

public DocumentSchema.Metadata.Builder setDocumentSplitter(boolean value)

If true, a document entity type can be applied to subdocument ( splitting). Otherwise, it can only be applied to the entire document (classification).

bool document_splitter = 1;

Parameter
Name	Description
value	boolean The documentSplitter to set.

Returns
Type	Description
DocumentSchema.Metadata.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public DocumentSchema.Metadata.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
DocumentSchema.Metadata.Builder

Overrides

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

setPrefixedNamingOnProperties(boolean value)

public DocumentSchema.Metadata.Builder setPrefixedNamingOnProperties(boolean value)

If set, all the nested entities must be prefixed with the parents.

bool prefixed_naming_on_properties = 6;

Parameter
Name	Description
value	boolean The prefixedNamingOnProperties to set.

Returns
Type	Description
DocumentSchema.Metadata.Builder	This builder for chaining.

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

public DocumentSchema.Metadata.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
DocumentSchema.Metadata.Builder

Overrides

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

setSkipNamingValidation(boolean value)

public DocumentSchema.Metadata.Builder setSkipNamingValidation(boolean value)

If set, we will skip the naming format validation in the schema. So the string values in DocumentSchema.EntityType.name and DocumentSchema.EntityType.Property.name will not be checked.

bool skip_naming_validation = 7;

Parameter
Name	Description
value	boolean The skipNamingValidation to set.

Returns
Type	Description
DocumentSchema.Metadata.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final DocumentSchema.Metadata.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
DocumentSchema.Metadata.Builder

Overrides

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