Class DocumentSchema.EntityType.Property (2.41.0)

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

Defines properties that can be part of the entity type.

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > DocumentSchema.EntityType.Property

Static Fields

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

OCCURRENCE_TYPE_FIELD_NUMBER

public static final int OCCURRENCE_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

VALUE_TYPE_FIELD_NUMBER

public static final int VALUE_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static DocumentSchema.EntityType.Property getDefaultInstance()
Returns
TypeDescription
DocumentSchema.EntityType.Property

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

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

newBuilder(DocumentSchema.EntityType.Property prototype)

public static DocumentSchema.EntityType.Property.Builder newBuilder(DocumentSchema.EntityType.Property prototype)
Parameter
NameDescription
prototypeDocumentSchema.EntityType.Property
Returns
TypeDescription
DocumentSchema.EntityType.Property.Builder

parseDelimitedFrom(InputStream input)

public static DocumentSchema.EntityType.Property parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
DocumentSchema.EntityType.Property
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DocumentSchema.EntityType.Property parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DocumentSchema.EntityType.Property
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static DocumentSchema.EntityType.Property parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
DocumentSchema.EntityType.Property
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DocumentSchema.EntityType.Property parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DocumentSchema.EntityType.Property
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DocumentSchema.EntityType.Property parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
DocumentSchema.EntityType.Property
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DocumentSchema.EntityType.Property parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DocumentSchema.EntityType.Property
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DocumentSchema.EntityType.Property parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
DocumentSchema.EntityType.Property
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DocumentSchema.EntityType.Property parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DocumentSchema.EntityType.Property
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static DocumentSchema.EntityType.Property parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
DocumentSchema.EntityType.Property
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DocumentSchema.EntityType.Property parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DocumentSchema.EntityType.Property
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static DocumentSchema.EntityType.Property parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
DocumentSchema.EntityType.Property
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DocumentSchema.EntityType.Property parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DocumentSchema.EntityType.Property
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<DocumentSchema.EntityType.Property> parser()
Returns
TypeDescription
Parser<Property>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public DocumentSchema.EntityType.Property getDefaultInstanceForType()
Returns
TypeDescription
DocumentSchema.EntityType.Property

getDisplayName()

public String getDisplayName()

User defined name for the property.

string display_name = 6;

Returns
TypeDescription
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

User defined name for the property.

string display_name = 6;

Returns
TypeDescription
ByteString

The bytes for displayName.

getName()

public String getName()

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

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

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

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getOccurrenceType()

public DocumentSchema.EntityType.Property.OccurrenceType getOccurrenceType()

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

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

Returns
TypeDescription
DocumentSchema.EntityType.Property.OccurrenceType

The occurrenceType.

getOccurrenceTypeValue()

public int getOccurrenceTypeValue()

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

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

Returns
TypeDescription
int

The enum numeric value on the wire for occurrenceType.

getParserForType()

public Parser<DocumentSchema.EntityType.Property> getParserForType()
Returns
TypeDescription
Parser<Property>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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;

Returns
TypeDescription
String

The valueType.

getValueTypeBytes()

public 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;

Returns
TypeDescription
ByteString

The bytes for valueType.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public DocumentSchema.EntityType.Property.Builder newBuilderForType()
Returns
TypeDescription
DocumentSchema.EntityType.Property.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DocumentSchema.EntityType.Property.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
DocumentSchema.EntityType.Property.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public DocumentSchema.EntityType.Property.Builder toBuilder()
Returns
TypeDescription
DocumentSchema.EntityType.Property.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException