com.google.cloud.documentai.v1beta3

Interface DocumentSchema.EntityTypeOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

DocumentSchema.EntityType, DocumentSchema.EntityType.Builder

Enclosing class:

DocumentSchema

public static interface DocumentSchema.EntityTypeOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getBaseTypes(int index) The entity type that this type is derived from.
com.google.protobuf.ByteString	getBaseTypesBytes(int index) The entity type that this type is derived from.
int	getBaseTypesCount() The entity type that this type is derived from.
List<String>	getBaseTypesList() The entity type that this type is derived from.
String	getDescription() The description of the entity type.
com.google.protobuf.ByteString	getDescriptionBytes() The description of the entity type.
String	getDisplayName() User defined name for the type.
com.google.protobuf.ByteString	getDisplayNameBytes() User defined name for the type.
EntityTypeMetadata	getEntityTypeMetadata() Metadata for the entity type.
EntityTypeMetadataOrBuilder	getEntityTypeMetadataOrBuilder() Metadata for the entity type.
DocumentSchema.EntityType.EnumValues	getEnumValues() If specified, lists all the possible values for this entity.
DocumentSchema.EntityType.EnumValuesOrBuilder	getEnumValuesOrBuilder() If specified, lists all the possible values for this entity.
String	getName() Name of the type.
com.google.protobuf.ByteString	getNameBytes() Name of the type.
DocumentSchema.EntityType.Property	getProperties(int index) Description the nested structure, or composition of an entity.
int	getPropertiesCount() Description the nested structure, or composition of an entity.
List<DocumentSchema.EntityType.Property>	getPropertiesList() Description the nested structure, or composition of an entity.
DocumentSchema.EntityType.PropertyOrBuilder	getPropertiesOrBuilder(int index) Description the nested structure, or composition of an entity.
List<? extends DocumentSchema.EntityType.PropertyOrBuilder>	getPropertiesOrBuilderList() Description the nested structure, or composition of an entity.
DocumentSchema.EntityType.ValueSourceCase	getValueSourceCase()
boolean	hasEntityTypeMetadata() Metadata for the entity type.
boolean	hasEnumValues() If specified, lists all the possible values for this entity.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasEnumValues

boolean hasEnumValues()

 If specified, lists all the possible values for this entity.  This
 should not be more than a handful of values.  If the number of values
 is >10 or could change frequently use the `EntityType.value_ontology`
 field and specify a list of all possible values in a value ontology
 file.
 

.google.cloud.documentai.v1beta3.DocumentSchema.EntityType.EnumValues enum_values = 14;

Returns:

Whether the enumValues field is set.

getEnumValues

DocumentSchema.EntityType.EnumValues getEnumValues()

 If specified, lists all the possible values for this entity.  This
 should not be more than a handful of values.  If the number of values
 is >10 or could change frequently use the `EntityType.value_ontology`
 field and specify a list of all possible values in a value ontology
 file.
 

.google.cloud.documentai.v1beta3.DocumentSchema.EntityType.EnumValues enum_values = 14;

Returns:

The enumValues.

getEnumValuesOrBuilder

DocumentSchema.EntityType.EnumValuesOrBuilder getEnumValuesOrBuilder()

 If specified, lists all the possible values for this entity.  This
 should not be more than a handful of values.  If the number of values
 is >10 or could change frequently use the `EntityType.value_ontology`
 field and specify a list of all possible values in a value ontology
 file.
 

.google.cloud.documentai.v1beta3.DocumentSchema.EntityType.EnumValues enum_values = 14;

getDisplayName

String getDisplayName()

 User defined name for the type.
 

string display_name = 13;

Returns:

The displayName.

getDisplayNameBytes

com.google.protobuf.ByteString getDisplayNameBytes()

 User defined name for the type.
 

string display_name = 13;

Returns:

The bytes for displayName.

getName

String getName()

 Name of the type. It must be unique within the schema file and
 cannot be a "Common Type".  The following naming conventions are used:

 - Use `snake_casing`.
 - Name matching is case-sensitive.
 - Maximum 64 characters.
 - Must start with a letter.
 - Allowed characters: ASCII letters `[a-z0-9_-]`.  (For backward
   compatibility internal infrastructure and tooling can handle any ascii
   character.)
 - The `/` is sometimes used to denote a property of a type.  For example
   `line_item/amount`.  This convention is deprecated, but will still be
   honored for backward compatibility.
 

string name = 1;

Returns:

The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 Name of the type. It must be unique within the schema file and
 cannot be a "Common Type".  The following naming conventions are used:

 - Use `snake_casing`.
 - Name matching is case-sensitive.
 - Maximum 64 characters.
 - Must start with a letter.
 - Allowed characters: ASCII letters `[a-z0-9_-]`.  (For backward
   compatibility internal infrastructure and tooling can handle any ascii
   character.)
 - The `/` is sometimes used to denote a property of a type.  For example
   `line_item/amount`.  This convention is deprecated, but will still be
   honored for backward compatibility.
 

string name = 1;

Returns:

The bytes for name.

getDescription

String getDescription()

 The description of the entity type. Could be used to provide more
 information about the entity type for model calls.
 

string description = 15;

Returns:

The description.

getDescriptionBytes

com.google.protobuf.ByteString getDescriptionBytes()

 The description of the entity type. Could be used to provide more
 information about the entity type for model calls.
 

string description = 15;

Returns:

The bytes for description.

getBaseTypesList

List<String> getBaseTypesList()

 The entity type that this type is derived from.  For now, one and only
 one should be set.
 

repeated string base_types = 2;

Returns:

A list containing the baseTypes.

getBaseTypesCount

int getBaseTypesCount()

 The entity type that this type is derived from.  For now, one and only
 one should be set.
 

repeated string base_types = 2;

Returns:

The count of baseTypes.

getBaseTypes

String getBaseTypes(int index)

 The entity type that this type is derived from.  For now, one and only
 one should be set.
 

repeated string base_types = 2;

Parameters:

index - The index of the element to return.

Returns:

The baseTypes at the given index.

getBaseTypesBytes

com.google.protobuf.ByteString getBaseTypesBytes(int index)

 The entity type that this type is derived from.  For now, one and only
 one should be set.
 

repeated string base_types = 2;

Parameters:

index - The index of the value to return.

Returns:

The bytes of the baseTypes at the given index.

getPropertiesList

List<DocumentSchema.EntityType.Property> getPropertiesList()

 Description the nested structure, or composition of an entity.
 

repeated .google.cloud.documentai.v1beta3.DocumentSchema.EntityType.Property properties = 6;

getProperties

DocumentSchema.EntityType.Property getProperties(int index)

 Description the nested structure, or composition of an entity.
 

repeated .google.cloud.documentai.v1beta3.DocumentSchema.EntityType.Property properties = 6;

getPropertiesCount

int getPropertiesCount()

 Description the nested structure, or composition of an entity.
 

repeated .google.cloud.documentai.v1beta3.DocumentSchema.EntityType.Property properties = 6;

getPropertiesOrBuilderList

List<? extends DocumentSchema.EntityType.PropertyOrBuilder> getPropertiesOrBuilderList()

 Description the nested structure, or composition of an entity.
 

repeated .google.cloud.documentai.v1beta3.DocumentSchema.EntityType.Property properties = 6;

getPropertiesOrBuilder

DocumentSchema.EntityType.PropertyOrBuilder getPropertiesOrBuilder(int index)

 Description the nested structure, or composition of an entity.
 

repeated .google.cloud.documentai.v1beta3.DocumentSchema.EntityType.Property properties = 6;

hasEntityTypeMetadata

boolean hasEntityTypeMetadata()

 Metadata for the entity type.
 

.google.cloud.documentai.v1beta3.EntityTypeMetadata entity_type_metadata = 11;

Returns:

Whether the entityTypeMetadata field is set.

getEntityTypeMetadata

EntityTypeMetadata getEntityTypeMetadata()

 Metadata for the entity type.
 

.google.cloud.documentai.v1beta3.EntityTypeMetadata entity_type_metadata = 11;

Returns:

The entityTypeMetadata.

getEntityTypeMetadataOrBuilder

EntityTypeMetadataOrBuilder getEntityTypeMetadataOrBuilder()

 Metadata for the entity type.
 

.google.cloud.documentai.v1beta3.EntityTypeMetadata entity_type_metadata = 11;

getValueSourceCase

DocumentSchema.EntityType.ValueSourceCase getValueSourceCase()