Class DocumentSchema.EntityType.Property.Builder (2.46.0)

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

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

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

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

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

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

getDefaultInstanceForType()

public DocumentSchema.EntityType.Property getDefaultInstanceForType()
Returns
Type Description
DocumentSchema.EntityType.Property

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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

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

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

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

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

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.