Class DocumentSchema.EntityType.Property.Builder (2.56.0)

Version 2.56.0

• 2.59.0 (latest)
• 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.EntityType.Property.Builder extends GeneratedMessageV3.Builder<DocumentSchema.EntityType.Property.Builder> implements DocumentSchema.EntityType.PropertyOrBuilder

Defines properties that can be part of the entity type.

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

Inheritance

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

Implements

DocumentSchema.EntityType.PropertyOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public DocumentSchema.EntityType.Property.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
DocumentSchema.EntityType.Property.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public DocumentSchema.EntityType.Property build()

Returns
Type	Description
DocumentSchema.EntityType.Property

buildPartial()

public DocumentSchema.EntityType.Property buildPartial()

Returns
Type	Description
DocumentSchema.EntityType.Property

clear()

public DocumentSchema.EntityType.Property.Builder clear()

Returns
Type	Description
DocumentSchema.EntityType.Property.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearDescription()

public DocumentSchema.EntityType.Property.Builder clearDescription()

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

string description = 7;

Returns
Type	Description
DocumentSchema.EntityType.Property.Builder	This builder for chaining.

clearDisplayName()

public DocumentSchema.EntityType.Property.Builder clearDisplayName()

User defined name for the property.

string display_name = 6;

Returns
Type	Description
DocumentSchema.EntityType.Property.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public DocumentSchema.EntityType.Property.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
DocumentSchema.EntityType.Property.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearName()

public DocumentSchema.EntityType.Property.Builder clearName()

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

string name = 1;

Returns
Type	Description
DocumentSchema.EntityType.Property.Builder	This builder for chaining.

clearOccurrenceType()

public DocumentSchema.EntityType.Property.Builder clearOccurrenceType()

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;

Returns
Type	Description
DocumentSchema.EntityType.Property.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public DocumentSchema.EntityType.Property.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
DocumentSchema.EntityType.Property.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearPropertyMetadata()

public DocumentSchema.EntityType.Property.Builder clearPropertyMetadata()

Any additional metadata about the property can be added here.

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

Returns
Type	Description
DocumentSchema.EntityType.Property.Builder

clearValueType()

public DocumentSchema.EntityType.Property.Builder clearValueType()

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
Type	Description
DocumentSchema.EntityType.Property.Builder	This builder for chaining.

clone()

public DocumentSchema.EntityType.Property.Builder clone()

Returns
Type	Description
DocumentSchema.EntityType.Property.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public DocumentSchema.EntityType.Property getDefaultInstanceForType()

Returns
Type	Description
DocumentSchema.EntityType.Property

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;

Returns
Type	Description
String	The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

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

string description = 7;

Returns
Type	Description
ByteString	The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getDisplayName()

public String getDisplayName()

User defined name for the property.

string display_name = 6;

Returns
Type	Description
String	The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

User defined name for the property.

string display_name = 6;

Returns
Type	Description
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
Type	Description
String	The name.

getNameBytes()

public ByteString getNameBytes()

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

string name = 1;

Returns
Type	Description
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.v1beta3.DocumentSchema.EntityType.Property.OccurrenceType occurrence_type = 3;

Returns
Type	Description
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.v1beta3.DocumentSchema.EntityType.Property.OccurrenceType occurrence_type = 3;

Returns
Type	Description
int	The enum numeric value on the wire for occurrenceType.

getPropertyMetadata()

public PropertyMetadata getPropertyMetadata()

Any additional metadata about the property can be added here.

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

Returns
Type	Description
PropertyMetadata	The propertyMetadata.

getPropertyMetadataBuilder()

public PropertyMetadata.Builder getPropertyMetadataBuilder()

Any additional metadata about the property can be added here.

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

Returns
Type	Description
PropertyMetadata.Builder

getPropertyMetadataOrBuilder()

public PropertyMetadataOrBuilder getPropertyMetadataOrBuilder()

Any additional metadata about the property can be added here.

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

Returns
Type	Description
PropertyMetadataOrBuilder

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
Type	Description
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
Type	Description
ByteString	The bytes for valueType.

hasPropertyMetadata()

public boolean hasPropertyMetadata()

Any additional metadata about the property can be added here.

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

Returns
Type	Description
boolean	Whether the propertyMetadata field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(DocumentSchema.EntityType.Property other)

public DocumentSchema.EntityType.Property.Builder mergeFrom(DocumentSchema.EntityType.Property other)

Parameter
Name	Description
other	DocumentSchema.EntityType.Property

Returns
Type	Description
DocumentSchema.EntityType.Property.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DocumentSchema.EntityType.Property.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DocumentSchema.EntityType.Property.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public DocumentSchema.EntityType.Property.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
DocumentSchema.EntityType.Property.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergePropertyMetadata(PropertyMetadata value)

public DocumentSchema.EntityType.Property.Builder mergePropertyMetadata(PropertyMetadata value)

Any additional metadata about the property can be added here.

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

Parameter
Name	Description
value	PropertyMetadata

Returns
Type	Description
DocumentSchema.EntityType.Property.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DocumentSchema.EntityType.Property.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
DocumentSchema.EntityType.Property.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setDescription(String value)

public DocumentSchema.EntityType.Property.Builder setDescription(String value)

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

string description = 7;

Parameter
Name	Description
value	String The description to set.

Returns
Type	Description
DocumentSchema.EntityType.Property.Builder	This builder for chaining.

setDescriptionBytes(ByteString value)

public DocumentSchema.EntityType.Property.Builder setDescriptionBytes(ByteString value)

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

string description = 7;

Parameter
Name	Description
value	ByteString The bytes for description to set.

Returns
Type	Description
DocumentSchema.EntityType.Property.Builder	This builder for chaining.

setDisplayName(String value)

public DocumentSchema.EntityType.Property.Builder setDisplayName(String value)

User defined name for the property.

string display_name = 6;

Parameter
Name	Description
value	String The displayName to set.

Returns
Type	Description
DocumentSchema.EntityType.Property.Builder	This builder for chaining.

setDisplayNameBytes(ByteString value)

public DocumentSchema.EntityType.Property.Builder setDisplayNameBytes(ByteString value)

User defined name for the property.

string display_name = 6;

Parameter
Name	Description
value	ByteString The bytes for displayName to set.

Returns
Type	Description
DocumentSchema.EntityType.Property.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public DocumentSchema.EntityType.Property.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
DocumentSchema.EntityType.Property.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setName(String value)

public DocumentSchema.EntityType.Property.Builder setName(String value)

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

string name = 1;

Parameter
Name	Description
value	String The name to set.

Returns
Type	Description
DocumentSchema.EntityType.Property.Builder	This builder for chaining.

setNameBytes(ByteString value)

public DocumentSchema.EntityType.Property.Builder setNameBytes(ByteString value)

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

string name = 1;

Parameter
Name	Description
value	ByteString The bytes for name to set.

Returns
Type	Description
DocumentSchema.EntityType.Property.Builder	This builder for chaining.

setOccurrenceType(DocumentSchema.EntityType.Property.OccurrenceType value)

public DocumentSchema.EntityType.Property.Builder setOccurrenceType(DocumentSchema.EntityType.Property.OccurrenceType value)

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;

Parameter
Name	Description
value	DocumentSchema.EntityType.Property.OccurrenceType The occurrenceType to set.

Returns
Type	Description
DocumentSchema.EntityType.Property.Builder	This builder for chaining.

setOccurrenceTypeValue(int value)

public DocumentSchema.EntityType.Property.Builder setOccurrenceTypeValue(int value)

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;

Parameter
Name	Description
value	int The enum numeric value on the wire for occurrenceType to set.

Returns
Type	Description
DocumentSchema.EntityType.Property.Builder	This builder for chaining.

setPropertyMetadata(PropertyMetadata value)

public DocumentSchema.EntityType.Property.Builder setPropertyMetadata(PropertyMetadata value)

Any additional metadata about the property can be added here.

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

Parameter
Name	Description
value	PropertyMetadata

Returns
Type	Description
DocumentSchema.EntityType.Property.Builder

setPropertyMetadata(PropertyMetadata.Builder builderForValue)

public DocumentSchema.EntityType.Property.Builder setPropertyMetadata(PropertyMetadata.Builder builderForValue)

Any additional metadata about the property can be added here.

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

Parameter
Name	Description
builderForValue	PropertyMetadata.Builder

Returns
Type	Description
DocumentSchema.EntityType.Property.Builder

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

public DocumentSchema.EntityType.Property.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
DocumentSchema.EntityType.Property.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final DocumentSchema.EntityType.Property.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
DocumentSchema.EntityType.Property.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setValueType(String value)

public DocumentSchema.EntityType.Property.Builder setValueType(String value)

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;

Parameter
Name	Description
value	String The valueType to set.

Returns
Type	Description
DocumentSchema.EntityType.Property.Builder	This builder for chaining.

setValueTypeBytes(ByteString value)

public DocumentSchema.EntityType.Property.Builder setValueTypeBytes(ByteString value)

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;

Parameter
Name	Description
value	ByteString The bytes for valueType to set.

Returns
Type	Description
DocumentSchema.EntityType.Property.Builder	This builder for chaining.