- 2.82.0 (latest)
- 2.80.0
- 2.79.0
- 2.78.0
- 2.77.0
- 2.76.0
- 2.74.0
- 2.72.0
- 2.71.0
- 2.68.0
- 2.67.0
- 2.66.0
- 2.64.0
- 2.63.0
- 2.62.0
- 2.61.0
- 2.60.0
- 2.59.0
- 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 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.v1beta2.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()| Type | Description |
| Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Document.Entity.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| Document.Entity.Builder |
build()
public Document.Entity build()| Type | Description |
| Document.Entity |
buildPartial()
public Document.Entity buildPartial()| Type | Description |
| Document.Entity |
clear()
public Document.Entity.Builder clear()| Type | Description |
| Document.Entity.Builder |
clearConfidence()
public Document.Entity.Builder clearConfidence()Optional. Confidence of detected Schema entity. Range [0, 1].
float confidence = 5 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| Document.Entity.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public Document.Entity.Builder clearField(Descriptors.FieldDescriptor field)| Name | Description |
| field | FieldDescriptor |
| Type | Description |
| Document.Entity.Builder |
clearId()
public Document.Entity.Builder clearId()Optional. Canonical id. This will be a unique value in the entity list for this document.
string id = 7 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| Document.Entity.Builder | This builder for chaining. |
clearMentionId()
public Document.Entity.Builder clearMentionId() Deprecated. Use id field instead.
string mention_id = 4;
| 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;
| Type | Description |
| Document.Entity.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Document.Entity.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Name | Description |
| oneof | OneofDescriptor |
| Type | Description |
| Document.Entity.Builder |
clearPageAnchor()
public Document.Entity.Builder clearPageAnchor()Optional. Represents the provenance of this entity wrt. the location on the page where it was found.
.google.cloud.documentai.v1beta2.Document.PageAnchor page_anchor = 6 [(.google.api.field_behavior) = OPTIONAL];
| 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.v1beta2.Document.TextAnchor text_anchor = 1;
| 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];
| Type | Description |
| Document.Entity.Builder | This builder for chaining. |
clone()
public Document.Entity.Builder clone()| Type | Description |
| Document.Entity.Builder |
getConfidence()
public float getConfidence()Optional. Confidence of detected Schema entity. Range [0, 1].
float confidence = 5 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| float | The confidence. |
getDefaultInstanceForType()
public Document.Entity getDefaultInstanceForType()| Type | Description |
| Document.Entity |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Type | Description |
| Descriptor |
getId()
public String getId()Optional. Canonical id. This will be a unique value in the entity list for this document.
string id = 7 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| String | The id. |
getIdBytes()
public ByteString getIdBytes()Optional. Canonical id. This will be a unique value in the entity list for this document.
string id = 7 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| ByteString | The bytes for id. |
getMentionId()
public String getMentionId() Deprecated. Use id field instead.
string mention_id = 4;
| Type | Description |
| String | The mentionId. |
getMentionIdBytes()
public ByteString getMentionIdBytes() Deprecated. Use id field instead.
string mention_id = 4;
| 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;
| Type | Description |
| String | The mentionText. |
getMentionTextBytes()
public ByteString getMentionTextBytes() Text value in the document e.g. 1600 Amphitheatre Pkwy.
string mention_text = 3;
| Type | Description |
| ByteString | The bytes for mentionText. |
getPageAnchor()
public Document.PageAnchor getPageAnchor()Optional. Represents the provenance of this entity wrt. the location on the page where it was found.
.google.cloud.documentai.v1beta2.Document.PageAnchor page_anchor = 6 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| Document.PageAnchor | The pageAnchor. |
getPageAnchorBuilder()
public Document.PageAnchor.Builder getPageAnchorBuilder()Optional. Represents the provenance of this entity wrt. the location on the page where it was found.
.google.cloud.documentai.v1beta2.Document.PageAnchor page_anchor = 6 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| Document.PageAnchor.Builder |
getPageAnchorOrBuilder()
public Document.PageAnchorOrBuilder getPageAnchorOrBuilder()Optional. Represents the provenance of this entity wrt. the location on the page where it was found.
.google.cloud.documentai.v1beta2.Document.PageAnchor page_anchor = 6 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| Document.PageAnchorOrBuilder |
getTextAnchor()
public Document.TextAnchor getTextAnchor()Provenance of the entity. Text anchor indexing into the Document.text.
.google.cloud.documentai.v1beta2.Document.TextAnchor text_anchor = 1;
| 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.v1beta2.Document.TextAnchor text_anchor = 1;
| Type | Description |
| Document.TextAnchor.Builder |
getTextAnchorOrBuilder()
public Document.TextAnchorOrBuilder getTextAnchorOrBuilder()Provenance of the entity. Text anchor indexing into the Document.text.
.google.cloud.documentai.v1beta2.Document.TextAnchor text_anchor = 1;
| 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];
| 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];
| Type | Description |
| ByteString | The bytes for type. |
hasPageAnchor()
public boolean hasPageAnchor()Optional. Represents the provenance of this entity wrt. the location on the page where it was found.
.google.cloud.documentai.v1beta2.Document.PageAnchor page_anchor = 6 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| boolean | Whether the pageAnchor field is set. |
hasTextAnchor()
public boolean hasTextAnchor()Provenance of the entity. Text anchor indexing into the Document.text.
.google.cloud.documentai.v1beta2.Document.TextAnchor text_anchor = 1;
| Type | Description |
| boolean | Whether the textAnchor field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
| FieldAccessorTable |
isInitialized()
public final boolean isInitialized()| Type | Description |
| boolean |
mergeFrom(Document.Entity other)
public Document.Entity.Builder mergeFrom(Document.Entity other)| Name | Description |
| other | Document.Entity |
| Type | Description |
| Document.Entity.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Document.Entity.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | CodedInputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| Document.Entity.Builder |
| Type | Description |
| IOException |
mergeFrom(Message other)
public Document.Entity.Builder mergeFrom(Message other)| Name | Description |
| other | Message |
| Type | Description |
| Document.Entity.Builder |
mergePageAnchor(Document.PageAnchor value)
public Document.Entity.Builder mergePageAnchor(Document.PageAnchor value)Optional. Represents the provenance of this entity wrt. the location on the page where it was found.
.google.cloud.documentai.v1beta2.Document.PageAnchor page_anchor = 6 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
| value | Document.PageAnchor |
| 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.v1beta2.Document.TextAnchor text_anchor = 1;
| Name | Description |
| value | Document.TextAnchor |
| Type | Description |
| Document.Entity.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Document.Entity.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| Document.Entity.Builder |
setConfidence(float value)
public Document.Entity.Builder setConfidence(float value)Optional. Confidence of detected Schema entity. Range [0, 1].
float confidence = 5 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
| value | floatThe confidence to set. |
| Type | Description |
| Document.Entity.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public Document.Entity.Builder setField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| Document.Entity.Builder |
setId(String value)
public Document.Entity.Builder setId(String value)Optional. Canonical id. This will be a unique value in the entity list for this document.
string id = 7 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
| value | StringThe id to set. |
| Type | Description |
| Document.Entity.Builder | This builder for chaining. |
setIdBytes(ByteString value)
public Document.Entity.Builder setIdBytes(ByteString value)Optional. Canonical id. This will be a unique value in the entity list for this document.
string id = 7 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
| value | ByteStringThe bytes for id to set. |
| Type | Description |
| Document.Entity.Builder | This builder for chaining. |
setMentionId(String value)
public Document.Entity.Builder setMentionId(String value) Deprecated. Use id field instead.
string mention_id = 4;
| Name | Description |
| value | StringThe mentionId to set. |
| Type | Description |
| Document.Entity.Builder | This builder for chaining. |
setMentionIdBytes(ByteString value)
public Document.Entity.Builder setMentionIdBytes(ByteString value) Deprecated. Use id field instead.
string mention_id = 4;
| Name | Description |
| value | ByteStringThe bytes for mentionId to set. |
| 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;
| Name | Description |
| value | StringThe mentionText to set. |
| 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;
| Name | Description |
| value | ByteStringThe bytes for mentionText to set. |
| Type | Description |
| Document.Entity.Builder | This builder for chaining. |
setPageAnchor(Document.PageAnchor value)
public Document.Entity.Builder setPageAnchor(Document.PageAnchor value)Optional. Represents the provenance of this entity wrt. the location on the page where it was found.
.google.cloud.documentai.v1beta2.Document.PageAnchor page_anchor = 6 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
| value | Document.PageAnchor |
| Type | Description |
| Document.Entity.Builder |
setPageAnchor(Document.PageAnchor.Builder builderForValue)
public Document.Entity.Builder setPageAnchor(Document.PageAnchor.Builder builderForValue)Optional. Represents the provenance of this entity wrt. the location on the page where it was found.
.google.cloud.documentai.v1beta2.Document.PageAnchor page_anchor = 6 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
| builderForValue | Document.PageAnchor.Builder |
| Type | Description |
| Document.Entity.Builder |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Document.Entity.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Name | Description |
| field | FieldDescriptor |
| index | int |
| value | Object |
| 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.v1beta2.Document.TextAnchor text_anchor = 1;
| Name | Description |
| value | Document.TextAnchor |
| 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.v1beta2.Document.TextAnchor text_anchor = 1;
| Name | Description |
| builderForValue | Document.TextAnchor.Builder |
| 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];
| Name | Description |
| value | StringThe type to set. |
| 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];
| Name | Description |
| value | ByteStringThe bytes for type to set. |
| Type | Description |
| Document.Entity.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final Document.Entity.Builder setUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| Document.Entity.Builder |