Class DocumentSchema.Builder (2.17.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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
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
NameDescription
valuesIterable<? extends com.google.cloud.documentai.v1.DocumentSchema.EntityType>
Returns
TypeDescription
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
NameDescription
valueDocumentSchema.EntityType
Returns
TypeDescription
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
NameDescription
builderForValueDocumentSchema.EntityType.Builder
Returns
TypeDescription
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
NameDescription
indexint
valueDocumentSchema.EntityType
Returns
TypeDescription
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
NameDescription
indexint
builderForValueDocumentSchema.EntityType.Builder
Returns
TypeDescription
DocumentSchema.Builder

addEntityTypesBuilder()

public DocumentSchema.EntityType.Builder addEntityTypesBuilder()

Entity types of the schema.

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

Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
DocumentSchema.EntityType.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public DocumentSchema build()
Returns
TypeDescription
DocumentSchema

buildPartial()

public DocumentSchema buildPartial()
Returns
TypeDescription
DocumentSchema

clear()

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

clearDescription()

public DocumentSchema.Builder clearDescription()

Description of the schema.

string description = 2;

Returns
TypeDescription
DocumentSchema.Builder

This builder for chaining.

clearDisplayName()

public DocumentSchema.Builder clearDisplayName()

Display name to show to users.

string display_name = 1;

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

clearField(Descriptors.FieldDescriptor field)

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

clearMetadata()

public DocumentSchema.Builder clearMetadata()

Metadata of the schema.

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

Returns
TypeDescription
DocumentSchema.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

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

clone()

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

getDefaultInstanceForType()

public DocumentSchema getDefaultInstanceForType()
Returns
TypeDescription
DocumentSchema

getDescription()

public String getDescription()

Description of the schema.

string description = 2;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Description of the schema.

string description = 2;

Returns
TypeDescription
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getDisplayName()

public String getDisplayName()

Display name to show to users.

string display_name = 1;

Returns
TypeDescription
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Display name to show to users.

string display_name = 1;

Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
List<Builder>

getEntityTypesCount()

public int getEntityTypesCount()

Entity types of the schema.

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

Returns
TypeDescription
int

getEntityTypesList()

public List<DocumentSchema.EntityType> getEntityTypesList()

Entity types of the schema.

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

Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
DocumentSchema.Metadata

The metadata.

getMetadataBuilder()

public DocumentSchema.Metadata.Builder getMetadataBuilder()

Metadata of the schema.

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

Returns
TypeDescription
DocumentSchema.Metadata.Builder

getMetadataOrBuilder()

public DocumentSchema.MetadataOrBuilder getMetadataOrBuilder()

Metadata of the schema.

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

Returns
TypeDescription
DocumentSchema.MetadataOrBuilder

hasMetadata()

public boolean hasMetadata()

Metadata of the schema.

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

Returns
TypeDescription
boolean

Whether the metadata field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(DocumentSchema other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeMetadata(DocumentSchema.Metadata value)

public DocumentSchema.Builder mergeMetadata(DocumentSchema.Metadata value)

Metadata of the schema.

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

Parameter
NameDescription
valueDocumentSchema.Metadata
Returns
TypeDescription
DocumentSchema.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

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
NameDescription
indexint
Returns
TypeDescription
DocumentSchema.Builder

setDescription(String value)

public DocumentSchema.Builder setDescription(String value)

Description of the schema.

string description = 2;

Parameter
NameDescription
valueString

The description to set.

Returns
TypeDescription
DocumentSchema.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public DocumentSchema.Builder setDescriptionBytes(ByteString value)

Description of the schema.

string description = 2;

Parameter
NameDescription
valueByteString

The bytes for description to set.

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

The displayName to set.

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

The bytes for displayName to set.

Returns
TypeDescription
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
NameDescription
indexint
valueDocumentSchema.EntityType
Returns
TypeDescription
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
NameDescription
indexint
builderForValueDocumentSchema.EntityType.Builder
Returns
TypeDescription
DocumentSchema.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

setMetadata(DocumentSchema.Metadata value)

public DocumentSchema.Builder setMetadata(DocumentSchema.Metadata value)

Metadata of the schema.

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

Parameter
NameDescription
valueDocumentSchema.Metadata
Returns
TypeDescription
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
NameDescription
builderForValueDocumentSchema.Metadata.Builder
Returns
TypeDescription
DocumentSchema.Builder

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

public DocumentSchema.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
DocumentSchema.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

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