Class DocumentSchema.Metadata.Builder (2.9.0)

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

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public DocumentSchema.Metadata build()
Returns
TypeDescription
DocumentSchema.Metadata

buildPartial()

public DocumentSchema.Metadata buildPartial()
Returns
TypeDescription
DocumentSchema.Metadata

clear()

public DocumentSchema.Metadata.Builder clear()
Returns
TypeDescription
DocumentSchema.Metadata.Builder
Overrides

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
TypeDescription
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
TypeDescription
DocumentSchema.Metadata.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

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
TypeDescription
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
TypeDescription
DocumentSchema.Metadata.Builder

This builder for chaining.

clone()

public DocumentSchema.Metadata.Builder clone()
Returns
TypeDescription
DocumentSchema.Metadata.Builder
Overrides

getDefaultInstanceForType()

public DocumentSchema.Metadata getDefaultInstanceForType()
Returns
TypeDescription
DocumentSchema.Metadata

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

The skipNamingValidation.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(DocumentSchema.Metadata other)

public DocumentSchema.Metadata.Builder mergeFrom(DocumentSchema.Metadata other)
Parameter
NameDescription
otherDocumentSchema.Metadata
Returns
TypeDescription
DocumentSchema.Metadata.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

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
NameDescription
valueboolean

The documentAllowMultipleLabels to set.

Returns
TypeDescription
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
NameDescription
valueboolean

The documentSplitter to set.

Returns
TypeDescription
DocumentSchema.Metadata.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

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
NameDescription
valueboolean

The prefixedNamingOnProperties to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
DocumentSchema.Metadata.Builder
Overrides

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
NameDescription
valueboolean

The skipNamingValidation to set.

Returns
TypeDescription
DocumentSchema.Metadata.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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