/* * Copyright 2020 Google LLC * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * https://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ // Generated by the protocol buffer compiler. DO NOT EDIT! // source: google/cloud/language/v1/language_service.proto package com.google.cloud.language.v1; public interface EntityOrBuilder extends // @@protoc_insertion_point(interface_extends:google.cloud.language.v1.Entity) com.google.protobuf.MessageOrBuilder { /** * * * 
   * The representative name for the entity.
   *
* * string name = 1; * * @return The name. */ java.lang.String getName(); /** * * * 
   * The representative name for the entity.
   *
* * string name = 1; * * @return The bytes for name. */ com.google.protobuf.ByteString getNameBytes(); /** * * * 
   * The entity type.
   *
* * .google.cloud.language.v1.Entity.Type type = 2; * * @return The enum numeric value on the wire for type. */ int getTypeValue(); /** * * * 
   * The entity type.
   *
* * .google.cloud.language.v1.Entity.Type type = 2; * * @return The type. */ com.google.cloud.language.v1.Entity.Type getType(); /** * * * 
   * Metadata associated with the entity.
   * For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`)
   * and Knowledge Graph MID (`mid`), if they are available. For the metadata
   * associated with other entity types, see the Type table below.
   *
* * map<string, string> metadata = 3; */ int getMetadataCount(); /** * * * 
   * Metadata associated with the entity.
   * For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`)
   * and Knowledge Graph MID (`mid`), if they are available. For the metadata
   * associated with other entity types, see the Type table below.
   *
* * map<string, string> metadata = 3; */ boolean containsMetadata(java.lang.String key); /** Use {@link #getMetadataMap()} instead. */ @java.lang.Deprecated java.util.Map getMetadata(); /** * * * 
   * Metadata associated with the entity.
   * For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`)
   * and Knowledge Graph MID (`mid`), if they are available. For the metadata
   * associated with other entity types, see the Type table below.
   *
* * map<string, string> metadata = 3; */ java.util.Map getMetadataMap(); /** * * * 
   * Metadata associated with the entity.
   * For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`)
   * and Knowledge Graph MID (`mid`), if they are available. For the metadata
   * associated with other entity types, see the Type table below.
   *
* * map<string, string> metadata = 3; */ /* nullable */ java.lang.String getMetadataOrDefault( java.lang.String key, /* nullable */ java.lang.String defaultValue); /** * * * 
   * Metadata associated with the entity.
   * For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`)
   * and Knowledge Graph MID (`mid`), if they are available. For the metadata
   * associated with other entity types, see the Type table below.
   *
* * map<string, string> metadata = 3; */ java.lang.String getMetadataOrThrow(java.lang.String key); /** * * * 
   * The salience score associated with the entity in the [0, 1.0] range.
   * The salience score for an entity provides information about the
   * importance or centrality of that entity to the entire document text.
   * Scores closer to 0 are less salient, while scores closer to 1.0 are highly
   * salient.
   *
* * float salience = 4; * * @return The salience. */ float getSalience(); /** * * * 
   * The mentions of this entity in the input document. The API currently
   * supports proper noun mentions.
   *
* * repeated .google.cloud.language.v1.EntityMention mentions = 5; */ java.util.List getMentionsList(); /** * * * 
   * The mentions of this entity in the input document. The API currently
   * supports proper noun mentions.
   *
* * repeated .google.cloud.language.v1.EntityMention mentions = 5; */ com.google.cloud.language.v1.EntityMention getMentions(int index); /** * * * 
   * The mentions of this entity in the input document. The API currently
   * supports proper noun mentions.
   *
* * repeated .google.cloud.language.v1.EntityMention mentions = 5; */ int getMentionsCount(); /** * * * 
   * The mentions of this entity in the input document. The API currently
   * supports proper noun mentions.
   *
* * repeated .google.cloud.language.v1.EntityMention mentions = 5; */ java.util.List getMentionsOrBuilderList(); /** * * * 
   * The mentions of this entity in the input document. The API currently
   * supports proper noun mentions.
   *
* * repeated .google.cloud.language.v1.EntityMention mentions = 5; */ com.google.cloud.language.v1.EntityMentionOrBuilder getMentionsOrBuilder(int index); /** * * * 
   * For calls to [AnalyzeEntitySentiment][] or if
   * [AnnotateTextRequest.Features.extract_entity_sentiment][google.cloud.language.v1.AnnotateTextRequest.Features.extract_entity_sentiment]
   * is set to true, this field will contain the aggregate sentiment expressed
   * for this entity in the provided document.
   *
* * .google.cloud.language.v1.Sentiment sentiment = 6; * * @return Whether the sentiment field is set. */ boolean hasSentiment(); /** * * * 
   * For calls to [AnalyzeEntitySentiment][] or if
   * [AnnotateTextRequest.Features.extract_entity_sentiment][google.cloud.language.v1.AnnotateTextRequest.Features.extract_entity_sentiment]
   * is set to true, this field will contain the aggregate sentiment expressed
   * for this entity in the provided document.
   *
* * .google.cloud.language.v1.Sentiment sentiment = 6; * * @return The sentiment. */ com.google.cloud.language.v1.Sentiment getSentiment(); /** * * * 
   * For calls to [AnalyzeEntitySentiment][] or if
   * [AnnotateTextRequest.Features.extract_entity_sentiment][google.cloud.language.v1.AnnotateTextRequest.Features.extract_entity_sentiment]
   * is set to true, this field will contain the aggregate sentiment expressed
   * for this entity in the provided document.
   *
* * .google.cloud.language.v1.Sentiment sentiment = 6; */ com.google.cloud.language.v1.SentimentOrBuilder getSentimentOrBuilder(); }