- 2.82.0 (latest)
 - 2.80.0
 - 2.79.0
 - 2.78.0
 - 2.77.0
 - 2.76.0
 - 2.74.0
 - 2.72.0
 - 2.71.0
 - 2.68.0
 - 2.67.0
 - 2.66.0
 - 2.64.0
 - 2.63.0
 - 2.62.0
 - 2.61.0
 - 2.60.0
 - 2.59.0
 - 2.58.0
 - 2.57.0
 - 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.Builder extends GeneratedMessageV3.Builder<DocumentSchema.Builder> implements DocumentSchemaOrBuilderThe schema defines the output of the processed document by a processor.
 Protobuf type google.cloud.documentai.v1beta3.DocumentSchema
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > DocumentSchema.BuilderImplements
DocumentSchemaOrBuilderStatic 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.v1beta3.DocumentSchema.EntityType entity_types = 3;
 
| Parameter | |
|---|---|
| Name | Description | 
values | 
        Iterable<? extends com.google.cloud.documentai.v1beta3.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.v1beta3.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.v1beta3.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.v1beta3.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.v1beta3.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.v1beta3.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.v1beta3.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 | 
        |
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 | 
        |
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.v1beta3.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 | 
        |
clearMetadata()
public DocumentSchema.Builder clearMetadata()Metadata of the schema.
 .google.cloud.documentai.v1beta3.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 | 
        |
clone()
public DocumentSchema.Builder clone()| Returns | |
|---|---|
| Type | Description | 
DocumentSchema.Builder | 
        |
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 | 
        |
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.v1beta3.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.v1beta3.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.v1beta3.DocumentSchema.EntityType entity_types = 3;
 
| Returns | |
|---|---|
| Type | Description | 
List<Builder> | 
        |
getEntityTypesCount()
public int getEntityTypesCount()Entity types of the schema.
 repeated .google.cloud.documentai.v1beta3.DocumentSchema.EntityType entity_types = 3;
 
| Returns | |
|---|---|
| Type | Description | 
int | 
        |
getEntityTypesList()
public List<DocumentSchema.EntityType> getEntityTypesList()Entity types of the schema.
 repeated .google.cloud.documentai.v1beta3.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.v1beta3.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.v1beta3.DocumentSchema.EntityType entity_types = 3;
 
| Returns | |
|---|---|
| Type | Description | 
List<? extends com.google.cloud.documentai.v1beta3.DocumentSchema.EntityTypeOrBuilder> | 
        |
getMetadata()
public DocumentSchema.Metadata getMetadata()Metadata of the schema.
 .google.cloud.documentai.v1beta3.DocumentSchema.Metadata metadata = 4;
| Returns | |
|---|---|
| Type | Description | 
DocumentSchema.Metadata | 
        The metadata.  | 
      
getMetadataBuilder()
public DocumentSchema.Metadata.Builder getMetadataBuilder()Metadata of the schema.
 .google.cloud.documentai.v1beta3.DocumentSchema.Metadata metadata = 4;
| Returns | |
|---|---|
| Type | Description | 
DocumentSchema.Metadata.Builder | 
        |
getMetadataOrBuilder()
public DocumentSchema.MetadataOrBuilder getMetadataOrBuilder()Metadata of the schema.
 .google.cloud.documentai.v1beta3.DocumentSchema.Metadata metadata = 4;
| Returns | |
|---|---|
| Type | Description | 
DocumentSchema.MetadataOrBuilder | 
        |
hasMetadata()
public boolean hasMetadata()Metadata of the schema.
 .google.cloud.documentai.v1beta3.DocumentSchema.Metadata metadata = 4;
| Returns | |
|---|---|
| Type | Description | 
boolean | 
        Whether the metadata field is set.  | 
      
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description | 
FieldAccessorTable | 
        |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description | 
boolean | 
        |
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 | 
        |
| Exceptions | |
|---|---|
| Type | Description | 
IOException | 
        |
mergeFrom(Message other)
public DocumentSchema.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description | 
other | 
        Message | 
      
| Returns | |
|---|---|
| Type | Description | 
DocumentSchema.Builder | 
        |
mergeMetadata(DocumentSchema.Metadata value)
public DocumentSchema.Builder mergeMetadata(DocumentSchema.Metadata value)Metadata of the schema.
 .google.cloud.documentai.v1beta3.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 | 
        |
removeEntityTypes(int index)
public DocumentSchema.Builder removeEntityTypes(int index)Entity types of the schema.
 repeated .google.cloud.documentai.v1beta3.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 | 
        StringThe 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 | 
        ByteStringThe 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 | 
        StringThe 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 | 
        ByteStringThe 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.v1beta3.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.v1beta3.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 | 
        |
setMetadata(DocumentSchema.Metadata value)
public DocumentSchema.Builder setMetadata(DocumentSchema.Metadata value)Metadata of the schema.
 .google.cloud.documentai.v1beta3.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.v1beta3.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 | 
        |
setUnknownFields(UnknownFieldSet unknownFields)
public final DocumentSchema.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description | 
unknownFields | 
        UnknownFieldSet | 
      
| Returns | |
|---|---|
| Type | Description | 
DocumentSchema.Builder | 
        |