Class DocumentSchema.Builder (2.32.0)

public static final class DocumentSchema.Builder extends GeneratedMessageV3.Builder<DocumentSchema.Builder> implements DocumentSchemaOrBuilder

The schema defines the output of the processed document by a processor.

Protobuf type google.cloud.documentai.v1.DocumentSchema

Inheritance

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

Implements

DocumentSchemaOrBuilder

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

addAllEntityTypes(Iterable<? extends DocumentSchema.EntityType> values)

public DocumentSchema.Builder addAllEntityTypes(Iterable<? extends DocumentSchema.EntityType> values)

Entity types of the schema.

repeated .google.cloud.documentai.v1.DocumentSchema.EntityType entity_types = 3;

Parameter
Name	Description
`values`	`Iterable<? extends com.google.cloud.documentai.v1.DocumentSchema.EntityType>`

Returns
Type	Description
`DocumentSchema.Builder`

addEntityTypes(DocumentSchema.EntityType value)

public DocumentSchema.Builder addEntityTypes(DocumentSchema.EntityType value)

Entity types of the schema.

repeated .google.cloud.documentai.v1.DocumentSchema.EntityType entity_types = 3;

Parameter
Name	Description
`value`	`DocumentSchema.EntityType`

Returns
Type	Description
`DocumentSchema.Builder`

addEntityTypes(DocumentSchema.EntityType.Builder builderForValue)

public DocumentSchema.Builder addEntityTypes(DocumentSchema.EntityType.Builder builderForValue)

Entity types of the schema.

repeated .google.cloud.documentai.v1.DocumentSchema.EntityType entity_types = 3;

Parameter
Name	Description
`builderForValue`	`DocumentSchema.EntityType.Builder`

Returns
Type	Description
`DocumentSchema.Builder`

addEntityTypes(int index, DocumentSchema.EntityType value)

public DocumentSchema.Builder addEntityTypes(int index, DocumentSchema.EntityType value)

Entity types of the schema.

repeated .google.cloud.documentai.v1.DocumentSchema.EntityType entity_types = 3;

Parameters
Name	Description
`index`	`int`
`value`	`DocumentSchema.EntityType`

Returns
Type	Description
`DocumentSchema.Builder`

addEntityTypes(int index, DocumentSchema.EntityType.Builder builderForValue)

public DocumentSchema.Builder addEntityTypes(int index, DocumentSchema.EntityType.Builder builderForValue)

Entity types of the schema.

repeated .google.cloud.documentai.v1.DocumentSchema.EntityType entity_types = 3;

Parameters
Name	Description
`index`	`int`
`builderForValue`	`DocumentSchema.EntityType.Builder`

Returns
Type	Description
`DocumentSchema.Builder`

addEntityTypesBuilder()

public DocumentSchema.EntityType.Builder addEntityTypesBuilder()

Entity types of the schema.

repeated .google.cloud.documentai.v1.DocumentSchema.EntityType entity_types = 3;

Returns
Type	Description
`DocumentSchema.EntityType.Builder`

addEntityTypesBuilder(int index)

public DocumentSchema.EntityType.Builder addEntityTypesBuilder(int index)

Entity types of the schema.

repeated .google.cloud.documentai.v1.DocumentSchema.EntityType entity_types = 3;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`DocumentSchema.EntityType.Builder`

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`DocumentSchema.Builder`

Overrides

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

build()

public DocumentSchema build()

Returns
Type	Description
`DocumentSchema`

buildPartial()

public DocumentSchema buildPartial()

Returns
Type	Description
`DocumentSchema`

clear()

public DocumentSchema.Builder clear()

Returns
Type	Description
`DocumentSchema.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearDescription()

public DocumentSchema.Builder clearDescription()

Description of the schema.

string description = 2;

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

clearDisplayName()

public DocumentSchema.Builder clearDisplayName()

Display name to show to users.

string display_name = 1;

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

clearEntityTypes()

public DocumentSchema.Builder clearEntityTypes()

Entity types of the schema.

repeated .google.cloud.documentai.v1.DocumentSchema.EntityType entity_types = 3;

Returns
Type	Description
`DocumentSchema.Builder`

clearField(Descriptors.FieldDescriptor field)

public DocumentSchema.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`DocumentSchema.Builder`

Overrides

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

clearMetadata()

public DocumentSchema.Builder clearMetadata()

Metadata of the schema.

.google.cloud.documentai.v1.DocumentSchema.Metadata metadata = 4;

Returns
Type	Description
`DocumentSchema.Builder`

clearOneof(Descriptors.OneofDescriptor oneof)

public DocumentSchema.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`DocumentSchema.Builder`

Overrides

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

clone()

public DocumentSchema.Builder clone()

Returns
Type	Description
`DocumentSchema.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public DocumentSchema getDefaultInstanceForType()

Returns
Type	Description
`DocumentSchema`

getDescription()

public String getDescription()

Description of the schema.

string description = 2;

Returns
Type	Description
`String`	The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Description of the schema.

string description = 2;

Returns
Type	Description
`ByteString`	The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getDisplayName()

public String getDisplayName()

Display name to show to users.

string display_name = 1;

Returns
Type	Description
`String`	The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Display name to show to users.

string display_name = 1;

Returns
Type	Description
`ByteString`	The bytes for displayName.

getEntityTypes(int index)

public DocumentSchema.EntityType getEntityTypes(int index)

Entity types of the schema.

repeated .google.cloud.documentai.v1.DocumentSchema.EntityType entity_types = 3;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`DocumentSchema.EntityType`

getEntityTypesBuilder(int index)

public DocumentSchema.EntityType.Builder getEntityTypesBuilder(int index)

Entity types of the schema.

repeated .google.cloud.documentai.v1.DocumentSchema.EntityType entity_types = 3;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`DocumentSchema.EntityType.Builder`

getEntityTypesBuilderList()

public List<DocumentSchema.EntityType.Builder> getEntityTypesBuilderList()

Entity types of the schema.

repeated .google.cloud.documentai.v1.DocumentSchema.EntityType entity_types = 3;

Returns
Type	Description
`List<Builder>`

getEntityTypesCount()

public int getEntityTypesCount()

Entity types of the schema.

repeated .google.cloud.documentai.v1.DocumentSchema.EntityType entity_types = 3;

Returns
Type	Description
`int`

getEntityTypesList()

public List<DocumentSchema.EntityType> getEntityTypesList()

Entity types of the schema.

repeated .google.cloud.documentai.v1.DocumentSchema.EntityType entity_types = 3;

Returns
Type	Description
`List<EntityType>`

getEntityTypesOrBuilder(int index)

public DocumentSchema.EntityTypeOrBuilder getEntityTypesOrBuilder(int index)

Entity types of the schema.

repeated .google.cloud.documentai.v1.DocumentSchema.EntityType entity_types = 3;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`DocumentSchema.EntityTypeOrBuilder`

getEntityTypesOrBuilderList()

public List<? extends DocumentSchema.EntityTypeOrBuilder> getEntityTypesOrBuilderList()

Entity types of the schema.

repeated .google.cloud.documentai.v1.DocumentSchema.EntityType entity_types = 3;

Returns
Type	Description
`List<? extends com.google.cloud.documentai.v1.DocumentSchema.EntityTypeOrBuilder>`

getMetadata()

public DocumentSchema.Metadata getMetadata()

Metadata of the schema.

.google.cloud.documentai.v1.DocumentSchema.Metadata metadata = 4;

Returns
Type	Description
`DocumentSchema.Metadata`	The metadata.

getMetadataBuilder()

public DocumentSchema.Metadata.Builder getMetadataBuilder()

Metadata of the schema.

.google.cloud.documentai.v1.DocumentSchema.Metadata metadata = 4;

Returns
Type	Description
`DocumentSchema.Metadata.Builder`

getMetadataOrBuilder()

public DocumentSchema.MetadataOrBuilder getMetadataOrBuilder()

Metadata of the schema.

.google.cloud.documentai.v1.DocumentSchema.Metadata metadata = 4;

Returns
Type	Description
`DocumentSchema.MetadataOrBuilder`

hasMetadata()

public boolean hasMetadata()

Metadata of the schema.

.google.cloud.documentai.v1.DocumentSchema.Metadata metadata = 4;

Returns
Type	Description
`boolean`	Whether the metadata 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(DocumentSchema other)

public DocumentSchema.Builder mergeFrom(DocumentSchema other)

Parameter
Name	Description
`other`	`DocumentSchema`

Returns
Type	Description
`DocumentSchema.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`DocumentSchema.Builder`

Overrides

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

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public DocumentSchema.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`DocumentSchema.Builder`

Overrides

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

mergeMetadata(DocumentSchema.Metadata value)

public DocumentSchema.Builder mergeMetadata(DocumentSchema.Metadata value)

Metadata of the schema.

.google.cloud.documentai.v1.DocumentSchema.Metadata metadata = 4;

Parameter
Name	Description
`value`	`DocumentSchema.Metadata`

Returns
Type	Description
`DocumentSchema.Builder`

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DocumentSchema.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`DocumentSchema.Builder`

Overrides

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

removeEntityTypes(int index)

public DocumentSchema.Builder removeEntityTypes(int index)

Entity types of the schema.

repeated .google.cloud.documentai.v1.DocumentSchema.EntityType entity_types = 3;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`DocumentSchema.Builder`

setDescription(String value)

public DocumentSchema.Builder setDescription(String value)

Description of the schema.

string description = 2;

Parameter
Name	Description
`value`	`String` The description to set.

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

setDescriptionBytes(ByteString value)

public DocumentSchema.Builder setDescriptionBytes(ByteString value)

Description of the schema.

string description = 2;

Parameter
Name	Description
`value`	`ByteString` The bytes for description to set.

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

setDisplayName(String value)

public DocumentSchema.Builder setDisplayName(String value)

Display name to show to users.

string display_name = 1;

Parameter
Name	Description
`value`	`String` The displayName to set.

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

setDisplayNameBytes(ByteString value)

public DocumentSchema.Builder setDisplayNameBytes(ByteString value)

Display name to show to users.

string display_name = 1;

Parameter
Name	Description
`value`	`ByteString` The bytes for displayName to set.

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

setEntityTypes(int index, DocumentSchema.EntityType value)

public DocumentSchema.Builder setEntityTypes(int index, DocumentSchema.EntityType value)

Entity types of the schema.

repeated .google.cloud.documentai.v1.DocumentSchema.EntityType entity_types = 3;

Parameters
Name	Description
`index`	`int`
`value`	`DocumentSchema.EntityType`

Returns
Type	Description
`DocumentSchema.Builder`

setEntityTypes(int index, DocumentSchema.EntityType.Builder builderForValue)

public DocumentSchema.Builder setEntityTypes(int index, DocumentSchema.EntityType.Builder builderForValue)

Entity types of the schema.

repeated .google.cloud.documentai.v1.DocumentSchema.EntityType entity_types = 3;

Parameters
Name	Description
`index`	`int`
`builderForValue`	`DocumentSchema.EntityType.Builder`

Returns
Type	Description
`DocumentSchema.Builder`

setField(Descriptors.FieldDescriptor field, Object value)

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

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`DocumentSchema.Builder`

Overrides

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

setMetadata(DocumentSchema.Metadata value)

public DocumentSchema.Builder setMetadata(DocumentSchema.Metadata value)

Metadata of the schema.

.google.cloud.documentai.v1.DocumentSchema.Metadata metadata = 4;

Parameter
Name	Description
`value`	`DocumentSchema.Metadata`

Returns
Type	Description
`DocumentSchema.Builder`

setMetadata(DocumentSchema.Metadata.Builder builderForValue)

public DocumentSchema.Builder setMetadata(DocumentSchema.Metadata.Builder builderForValue)

Metadata of the schema.

.google.cloud.documentai.v1.DocumentSchema.Metadata metadata = 4;

Parameter
Name	Description
`builderForValue`	`DocumentSchema.Metadata.Builder`

Returns
Type	Description
`DocumentSchema.Builder`

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

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

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`DocumentSchema.Builder`

Overrides

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

setUnknownFields(UnknownFieldSet unknownFields)

public final DocumentSchema.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`DocumentSchema.Builder`

Overrides

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