com.google.cloud.documentai.v1beta3

Class DocumentSchema.EntityType.Property

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.documentai.v1beta3.DocumentSchema.EntityType.Property

All Implemented Interfaces:

DocumentSchema.EntityType.PropertyOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

DocumentSchema.EntityType

public static final class DocumentSchema.EntityType.Property
extends com.google.protobuf.GeneratedMessageV3
implements DocumentSchema.EntityType.PropertyOrBuilder

 Defines properties that can be part of the entity type.
 

Protobuf type google.cloud.documentai.v1beta3.DocumentSchema.EntityType.Property

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DocumentSchema.EntityType.Property.Builder Defines properties that can be part of the entity type.
static class	DocumentSchema.EntityType.Property.OccurrenceType Types of occurrences of the entity type in the document.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	DESCRIPTION_FIELD_NUMBER
static int	DISPLAY_NAME_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	OCCURRENCE_TYPE_FIELD_NUMBER
static int	PROPERTY_METADATA_FIELD_NUMBER
static int	VALUE_TYPE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static DocumentSchema.EntityType.Property	getDefaultInstance()
DocumentSchema.EntityType.Property	getDefaultInstanceForType()
String	getDescription() The description of the property.
com.google.protobuf.ByteString	getDescriptionBytes() The description of the property.
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getDisplayName() User defined name for the property.
com.google.protobuf.ByteString	getDisplayNameBytes() User defined name for the property.
String	getName() The name of the property.
com.google.protobuf.ByteString	getNameBytes() The name of the property.
DocumentSchema.EntityType.Property.OccurrenceType	getOccurrenceType() Occurrence type limits the number of instances an entity type appears in the document.
int	getOccurrenceTypeValue() Occurrence type limits the number of instances an entity type appears in the document.
com.google.protobuf.Parser<DocumentSchema.EntityType.Property>	getParserForType()
PropertyMetadata	getPropertyMetadata() Any additional metadata about the property can be added here.
PropertyMetadataOrBuilder	getPropertyMetadataOrBuilder() Any additional metadata about the property can be added here.
int	getSerializedSize()
String	getValueType() A reference to the value type of the property.
com.google.protobuf.ByteString	getValueTypeBytes() A reference to the value type of the property.
int	hashCode()
boolean	hasPropertyMetadata() Any additional metadata about the property can be added here.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static DocumentSchema.EntityType.Property.Builder	newBuilder()
static DocumentSchema.EntityType.Property.Builder	newBuilder(DocumentSchema.EntityType.Property prototype)
DocumentSchema.EntityType.Property.Builder	newBuilderForType()
protected DocumentSchema.EntityType.Property.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static DocumentSchema.EntityType.Property	parseDelimitedFrom(InputStream input)
static DocumentSchema.EntityType.Property	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DocumentSchema.EntityType.Property	parseFrom(byte[] data)
static DocumentSchema.EntityType.Property	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DocumentSchema.EntityType.Property	parseFrom(ByteBuffer data)
static DocumentSchema.EntityType.Property	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DocumentSchema.EntityType.Property	parseFrom(com.google.protobuf.ByteString data)
static DocumentSchema.EntityType.Property	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DocumentSchema.EntityType.Property	parseFrom(com.google.protobuf.CodedInputStream input)
static DocumentSchema.EntityType.Property	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DocumentSchema.EntityType.Property	parseFrom(InputStream input)
static DocumentSchema.EntityType.Property	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<DocumentSchema.EntityType.Property>	parser()
DocumentSchema.EntityType.Property.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER

See Also:

Constant Field Values

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER

See Also:

Constant Field Values

VALUE_TYPE_FIELD_NUMBER

public static final int VALUE_TYPE_FIELD_NUMBER

See Also:

Constant Field Values

OCCURRENCE_TYPE_FIELD_NUMBER

public static final int OCCURRENCE_TYPE_FIELD_NUMBER

See Also:

Constant Field Values

PROPERTY_METADATA_FIELD_NUMBER

public static final int PROPERTY_METADATA_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getName

public String getName()

 The name of the property.  Follows the same guidelines as the
 EntityType name.
 

string name = 1;

Specified by:

getName in interface DocumentSchema.EntityType.PropertyOrBuilder

Returns:

The name.

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 The name of the property.  Follows the same guidelines as the
 EntityType name.
 

string name = 1;

Specified by:

getNameBytes in interface DocumentSchema.EntityType.PropertyOrBuilder

Returns:

The bytes for name.

getDescription

public String getDescription()

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

string description = 7;

Specified by:

getDescription in interface DocumentSchema.EntityType.PropertyOrBuilder

Returns:

The description.

getDescriptionBytes

public com.google.protobuf.ByteString getDescriptionBytes()

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

string description = 7;

Specified by:

getDescriptionBytes in interface DocumentSchema.EntityType.PropertyOrBuilder

Returns:

The bytes for description.

getDisplayName

public String getDisplayName()

 User defined name for the property.
 

string display_name = 6;

Specified by:

getDisplayName in interface DocumentSchema.EntityType.PropertyOrBuilder

Returns:

The displayName.

getDisplayNameBytes

public com.google.protobuf.ByteString getDisplayNameBytes()

 User defined name for the property.
 

string display_name = 6;

Specified by:

getDisplayNameBytes in interface DocumentSchema.EntityType.PropertyOrBuilder

Returns:

The bytes for displayName.

getValueType

public String getValueType()

 A reference to the value type of the property.  This type is subject
 to the same conventions as the `Entity.base_types` field.
 

string value_type = 2;

Specified by:

getValueType in interface DocumentSchema.EntityType.PropertyOrBuilder

Returns:

The valueType.

getValueTypeBytes

public com.google.protobuf.ByteString getValueTypeBytes()

 A reference to the value type of the property.  This type is subject
 to the same conventions as the `Entity.base_types` field.
 

string value_type = 2;

Specified by:

getValueTypeBytes in interface DocumentSchema.EntityType.PropertyOrBuilder

Returns:

The bytes for valueType.

getOccurrenceTypeValue

public int getOccurrenceTypeValue()

 Occurrence type limits the number of instances an entity type appears
 in the document.
 

.google.cloud.documentai.v1beta3.DocumentSchema.EntityType.Property.OccurrenceType occurrence_type = 3;

Specified by:

getOccurrenceTypeValue in interface DocumentSchema.EntityType.PropertyOrBuilder

Returns:

The enum numeric value on the wire for occurrenceType.

getOccurrenceType

public DocumentSchema.EntityType.Property.OccurrenceType getOccurrenceType()

 Occurrence type limits the number of instances an entity type appears
 in the document.
 

.google.cloud.documentai.v1beta3.DocumentSchema.EntityType.Property.OccurrenceType occurrence_type = 3;

Specified by:

getOccurrenceType in interface DocumentSchema.EntityType.PropertyOrBuilder

Returns:

The occurrenceType.

hasPropertyMetadata

public boolean hasPropertyMetadata()

 Any additional metadata about the property can be added here.
 

.google.cloud.documentai.v1beta3.PropertyMetadata property_metadata = 5;

Specified by:

hasPropertyMetadata in interface DocumentSchema.EntityType.PropertyOrBuilder

Returns:

Whether the propertyMetadata field is set.

getPropertyMetadata

public PropertyMetadata getPropertyMetadata()

 Any additional metadata about the property can be added here.
 

.google.cloud.documentai.v1beta3.PropertyMetadata property_metadata = 5;

Specified by:

getPropertyMetadata in interface DocumentSchema.EntityType.PropertyOrBuilder

Returns:

The propertyMetadata.

getPropertyMetadataOrBuilder

public PropertyMetadataOrBuilder getPropertyMetadataOrBuilder()

 Any additional metadata about the property can be added here.
 

.google.cloud.documentai.v1beta3.PropertyMetadata property_metadata = 5;

Specified by:

getPropertyMetadataOrBuilder in interface DocumentSchema.EntityType.PropertyOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static DocumentSchema.EntityType.Property parseFrom(ByteBuffer data)
                                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DocumentSchema.EntityType.Property parseFrom(ByteBuffer data,
                                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DocumentSchema.EntityType.Property parseFrom(com.google.protobuf.ByteString data)
                                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DocumentSchema.EntityType.Property parseFrom(com.google.protobuf.ByteString data,
                                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DocumentSchema.EntityType.Property parseFrom(byte[] data)
                                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DocumentSchema.EntityType.Property parseFrom(byte[] data,
                                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DocumentSchema.EntityType.Property parseFrom(InputStream input)
                                                    throws IOException

Throws:

IOException

parseFrom

public static DocumentSchema.EntityType.Property parseFrom(InputStream input,
                                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                    throws IOException

Throws:

IOException

parseDelimitedFrom

public static DocumentSchema.EntityType.Property parseDelimitedFrom(InputStream input)
                                                             throws IOException

Throws:

IOException

parseDelimitedFrom

public static DocumentSchema.EntityType.Property parseDelimitedFrom(InputStream input,
                                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                             throws IOException

Throws:

IOException

parseFrom

public static DocumentSchema.EntityType.Property parseFrom(com.google.protobuf.CodedInputStream input)
                                                    throws IOException

Throws:

IOException

parseFrom

public static DocumentSchema.EntityType.Property parseFrom(com.google.protobuf.CodedInputStream input,
                                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                    throws IOException

Throws:

IOException

newBuilderForType

public DocumentSchema.EntityType.Property.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static DocumentSchema.EntityType.Property.Builder newBuilder()

newBuilder

public static DocumentSchema.EntityType.Property.Builder newBuilder(DocumentSchema.EntityType.Property prototype)

toBuilder

public DocumentSchema.EntityType.Property.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected DocumentSchema.EntityType.Property.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static DocumentSchema.EntityType.Property getDefaultInstance()

parser

public static com.google.protobuf.Parser<DocumentSchema.EntityType.Property> parser()

getParserForType

public com.google.protobuf.Parser<DocumentSchema.EntityType.Property> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public DocumentSchema.EntityType.Property getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder