- 2.57.0 (latest)
- 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 Document.Entity.Builder extends GeneratedMessageV3.Builder<Document.Entity.Builder> implements Document.EntityOrBuilderA phrase in the text that is a known entity type, such as a person, an organization, or location.
Protobuf type google.cloud.documentai.v1beta1.Document.Entity
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Document.Entity.BuilderImplements
Document.EntityOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Document.Entity.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Document.Entity.Builder |
|
build()
public Document.Entity build()| Returns | |
|---|---|
| Type | Description |
Document.Entity |
|
buildPartial()
public Document.Entity buildPartial()| Returns | |
|---|---|
| Type | Description |
Document.Entity |
|
clear()
public Document.Entity.Builder clear()| Returns | |
|---|---|
| Type | Description |
Document.Entity.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public Document.Entity.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Document.Entity.Builder |
|
clearMentionId()
public Document.Entity.Builder clearMentionId()Canonical mention name. This will be a unique value in the entity list for this document.
string mention_id = 4;
| Returns | |
|---|---|
| Type | Description |
Document.Entity.Builder |
This builder for chaining. |
clearMentionText()
public Document.Entity.Builder clearMentionText() Text value in the document e.g. 1600 Amphitheatre Pkwy.
string mention_text = 3;
| Returns | |
|---|---|
| Type | Description |
Document.Entity.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Document.Entity.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
Document.Entity.Builder |
|
clearTextAnchor()
public Document.Entity.Builder clearTextAnchor()Provenance of the entity. Text anchor indexing into the Document.text.
.google.cloud.documentai.v1beta1.Document.TextAnchor text_anchor = 1;
| Returns | |
|---|---|
| Type | Description |
Document.Entity.Builder |
|
clearType()
public Document.Entity.Builder clearType() Required. Entity type from a schema e.g. Address.
string type = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Document.Entity.Builder |
This builder for chaining. |
clone()
public Document.Entity.Builder clone()| Returns | |
|---|---|
| Type | Description |
Document.Entity.Builder |
|
getDefaultInstanceForType()
public Document.Entity getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Document.Entity |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getMentionId()
public String getMentionId()Canonical mention name. This will be a unique value in the entity list for this document.
string mention_id = 4;
| Returns | |
|---|---|
| Type | Description |
String |
The mentionId. |
getMentionIdBytes()
public ByteString getMentionIdBytes()Canonical mention name. This will be a unique value in the entity list for this document.
string mention_id = 4;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for mentionId. |
getMentionText()
public String getMentionText() Text value in the document e.g. 1600 Amphitheatre Pkwy.
string mention_text = 3;
| Returns | |
|---|---|
| Type | Description |
String |
The mentionText. |
getMentionTextBytes()
public ByteString getMentionTextBytes() Text value in the document e.g. 1600 Amphitheatre Pkwy.
string mention_text = 3;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for mentionText. |
getTextAnchor()
public Document.TextAnchor getTextAnchor()Provenance of the entity. Text anchor indexing into the Document.text.
.google.cloud.documentai.v1beta1.Document.TextAnchor text_anchor = 1;
| Returns | |
|---|---|
| Type | Description |
Document.TextAnchor |
The textAnchor. |
getTextAnchorBuilder()
public Document.TextAnchor.Builder getTextAnchorBuilder()Provenance of the entity. Text anchor indexing into the Document.text.
.google.cloud.documentai.v1beta1.Document.TextAnchor text_anchor = 1;
| Returns | |
|---|---|
| Type | Description |
Document.TextAnchor.Builder |
|
getTextAnchorOrBuilder()
public Document.TextAnchorOrBuilder getTextAnchorOrBuilder()Provenance of the entity. Text anchor indexing into the Document.text.
.google.cloud.documentai.v1beta1.Document.TextAnchor text_anchor = 1;
| Returns | |
|---|---|
| Type | Description |
Document.TextAnchorOrBuilder |
|
getType()
public String getType() Required. Entity type from a schema e.g. Address.
string type = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String |
The type. |
getTypeBytes()
public ByteString getTypeBytes() Required. Entity type from a schema e.g. Address.
string type = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for type. |
hasTextAnchor()
public boolean hasTextAnchor()Provenance of the entity. Text anchor indexing into the Document.text.
.google.cloud.documentai.v1beta1.Document.TextAnchor text_anchor = 1;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the textAnchor field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(Document.Entity other)
public Document.Entity.Builder mergeFrom(Document.Entity other)| Parameter | |
|---|---|
| Name | Description |
other |
Document.Entity |
| Returns | |
|---|---|
| Type | Description |
Document.Entity.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Document.Entity.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Document.Entity.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public Document.Entity.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
Document.Entity.Builder |
|
mergeTextAnchor(Document.TextAnchor value)
public Document.Entity.Builder mergeTextAnchor(Document.TextAnchor value)Provenance of the entity. Text anchor indexing into the Document.text.
.google.cloud.documentai.v1beta1.Document.TextAnchor text_anchor = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
Document.TextAnchor |
| Returns | |
|---|---|
| Type | Description |
Document.Entity.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Document.Entity.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Document.Entity.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public Document.Entity.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Document.Entity.Builder |
|
setMentionId(String value)
public Document.Entity.Builder setMentionId(String value)Canonical mention name. This will be a unique value in the entity list for this document.
string mention_id = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe mentionId to set. |
| Returns | |
|---|---|
| Type | Description |
Document.Entity.Builder |
This builder for chaining. |
setMentionIdBytes(ByteString value)
public Document.Entity.Builder setMentionIdBytes(ByteString value)Canonical mention name. This will be a unique value in the entity list for this document.
string mention_id = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for mentionId to set. |
| Returns | |
|---|---|
| Type | Description |
Document.Entity.Builder |
This builder for chaining. |
setMentionText(String value)
public Document.Entity.Builder setMentionText(String value) Text value in the document e.g. 1600 Amphitheatre Pkwy.
string mention_text = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe mentionText to set. |
| Returns | |
|---|---|
| Type | Description |
Document.Entity.Builder |
This builder for chaining. |
setMentionTextBytes(ByteString value)
public Document.Entity.Builder setMentionTextBytes(ByteString value) Text value in the document e.g. 1600 Amphitheatre Pkwy.
string mention_text = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for mentionText to set. |
| Returns | |
|---|---|
| Type | Description |
Document.Entity.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Document.Entity.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Document.Entity.Builder |
|
setTextAnchor(Document.TextAnchor value)
public Document.Entity.Builder setTextAnchor(Document.TextAnchor value)Provenance of the entity. Text anchor indexing into the Document.text.
.google.cloud.documentai.v1beta1.Document.TextAnchor text_anchor = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
Document.TextAnchor |
| Returns | |
|---|---|
| Type | Description |
Document.Entity.Builder |
|
setTextAnchor(Document.TextAnchor.Builder builderForValue)
public Document.Entity.Builder setTextAnchor(Document.TextAnchor.Builder builderForValue)Provenance of the entity. Text anchor indexing into the Document.text.
.google.cloud.documentai.v1beta1.Document.TextAnchor text_anchor = 1;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Document.TextAnchor.Builder |
| Returns | |
|---|---|
| Type | Description |
Document.Entity.Builder |
|
setType(String value)
public Document.Entity.Builder setType(String value) Required. Entity type from a schema e.g. Address.
string type = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe type to set. |
| Returns | |
|---|---|
| Type | Description |
Document.Entity.Builder |
This builder for chaining. |
setTypeBytes(ByteString value)
public Document.Entity.Builder setTypeBytes(ByteString value) Required. Entity type from a schema e.g. Address.
string type = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for type to set. |
| Returns | |
|---|---|
| Type | Description |
Document.Entity.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final Document.Entity.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Document.Entity.Builder |
|