All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.google.cloud.contactcenterinsights.v1.Entity Maven / Gradle / Ivy

There is a newer version: 2.49.0
Show newest version
/*
 * Copyright 2023 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/contactcenterinsights/v1/resources.proto

package com.google.cloud.contactcenterinsights.v1;

/**
 *
 *
 * 
 * The data for an entity annotation.
 * Represents a phrase in the conversation that is a known entity, such
 * as a person, an organization, or location.
 * 
* * Protobuf type {@code google.cloud.contactcenterinsights.v1.Entity} */ public final class Entity extends com.google.protobuf.GeneratedMessageV3 implements // @@protoc_insertion_point(message_implements:google.cloud.contactcenterinsights.v1.Entity) EntityOrBuilder { private static final long serialVersionUID = 0L; // Use Entity.newBuilder() to construct. private Entity(com.google.protobuf.GeneratedMessageV3.Builder builder) { super(builder); } private Entity() { displayName_ = ""; type_ = 0; } @java.lang.Override @SuppressWarnings({"unused"}) protected java.lang.Object newInstance(UnusedPrivateParameter unused) { return new Entity(); } public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() { return com.google.cloud.contactcenterinsights.v1.ResourcesProto .internal_static_google_cloud_contactcenterinsights_v1_Entity_descriptor; } @SuppressWarnings({"rawtypes"}) @java.lang.Override protected com.google.protobuf.MapField internalGetMapField(int number) { switch (number) { case 3: return internalGetMetadata(); default: throw new RuntimeException("Invalid map field number: " + number); } } @java.lang.Override protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable() { return com.google.cloud.contactcenterinsights.v1.ResourcesProto .internal_static_google_cloud_contactcenterinsights_v1_Entity_fieldAccessorTable .ensureFieldAccessorsInitialized( com.google.cloud.contactcenterinsights.v1.Entity.class, com.google.cloud.contactcenterinsights.v1.Entity.Builder.class); } /** * * *
   * The type of the entity. For most entity types, the associated metadata is a
   * Wikipedia URL (`wikipedia_url`) and Knowledge Graph MID (`mid`). The table
   * below lists the associated fields for entities that have different
   * metadata.
   * 
* * Protobuf enum {@code google.cloud.contactcenterinsights.v1.Entity.Type} */ public enum Type implements com.google.protobuf.ProtocolMessageEnum { /** * * *
     * Unspecified.
     * 
* * TYPE_UNSPECIFIED = 0; */ TYPE_UNSPECIFIED(0), /** * * *
     * Person.
     * 
* * PERSON = 1; */ PERSON(1), /** * * *
     * Location.
     * 
* * LOCATION = 2; */ LOCATION(2), /** * * *
     * Organization.
     * 
* * ORGANIZATION = 3; */ ORGANIZATION(3), /** * * *
     * Event.
     * 
* * EVENT = 4; */ EVENT(4), /** * * *
     * Artwork.
     * 
* * WORK_OF_ART = 5; */ WORK_OF_ART(5), /** * * *
     * Consumer product.
     * 
* * CONSUMER_GOOD = 6; */ CONSUMER_GOOD(6), /** * * *
     * Other types of entities.
     * 
* * OTHER = 7; */ OTHER(7), /** * * *
     * Phone number.
     *
     * The metadata lists the phone number (formatted according to local
     * convention), plus whichever additional elements appear in the text:
     *
     * * `number` - The actual number, broken down into sections according to
     * local convention.
     * * `national_prefix` - Country code, if detected.
     * * `area_code` - Region or area code, if detected.
     * * `extension` - Phone extension (to be dialed after connection), if
     * detected.
     * 
* * PHONE_NUMBER = 9; */ PHONE_NUMBER(9), /** * * *
     * Address.
     *
     * The metadata identifies the street number and locality plus whichever
     * additional elements appear in the text:
     *
     * * `street_number` - Street number.
     * * `locality` - City or town.
     * * `street_name` - Street/route name, if detected.
     * * `postal_code` - Postal code, if detected.
     * * `country` - Country, if detected.
     * * `broad_region` - Administrative area, such as the state, if detected.
     * * `narrow_region` - Smaller administrative area, such as county, if
     * detected.
     * * `sublocality` - Used in Asian addresses to demark a district within a
     * city, if detected.
     * 
* * ADDRESS = 10; */ ADDRESS(10), /** * * *
     * Date.
     *
     * The metadata identifies the components of the date:
     *
     * * `year` - Four digit year, if detected.
     * * `month` - Two digit month number, if detected.
     * * `day` - Two digit day number, if detected.
     * 
* * DATE = 11; */ DATE(11), /** * * *
     * Number.
     *
     * The metadata is the number itself.
     * 
* * NUMBER = 12; */ NUMBER(12), /** * * *
     * Price.
     *
     * The metadata identifies the `value` and `currency`.
     * 
* * PRICE = 13; */ PRICE(13), UNRECOGNIZED(-1), ; /** * * *
     * Unspecified.
     * 
* * TYPE_UNSPECIFIED = 0; */ public static final int TYPE_UNSPECIFIED_VALUE = 0; /** * * *
     * Person.
     * 
* * PERSON = 1; */ public static final int PERSON_VALUE = 1; /** * * *
     * Location.
     * 
* * LOCATION = 2; */ public static final int LOCATION_VALUE = 2; /** * * *
     * Organization.
     * 
* * ORGANIZATION = 3; */ public static final int ORGANIZATION_VALUE = 3; /** * * *
     * Event.
     * 
* * EVENT = 4; */ public static final int EVENT_VALUE = 4; /** * * *
     * Artwork.
     * 
* * WORK_OF_ART = 5; */ public static final int WORK_OF_ART_VALUE = 5; /** * * *
     * Consumer product.
     * 
* * CONSUMER_GOOD = 6; */ public static final int CONSUMER_GOOD_VALUE = 6; /** * * *
     * Other types of entities.
     * 
* * OTHER = 7; */ public static final int OTHER_VALUE = 7; /** * * *
     * Phone number.
     *
     * The metadata lists the phone number (formatted according to local
     * convention), plus whichever additional elements appear in the text:
     *
     * * `number` - The actual number, broken down into sections according to
     * local convention.
     * * `national_prefix` - Country code, if detected.
     * * `area_code` - Region or area code, if detected.
     * * `extension` - Phone extension (to be dialed after connection), if
     * detected.
     * 
* * PHONE_NUMBER = 9; */ public static final int PHONE_NUMBER_VALUE = 9; /** * * *
     * Address.
     *
     * The metadata identifies the street number and locality plus whichever
     * additional elements appear in the text:
     *
     * * `street_number` - Street number.
     * * `locality` - City or town.
     * * `street_name` - Street/route name, if detected.
     * * `postal_code` - Postal code, if detected.
     * * `country` - Country, if detected.
     * * `broad_region` - Administrative area, such as the state, if detected.
     * * `narrow_region` - Smaller administrative area, such as county, if
     * detected.
     * * `sublocality` - Used in Asian addresses to demark a district within a
     * city, if detected.
     * 
* * ADDRESS = 10; */ public static final int ADDRESS_VALUE = 10; /** * * *
     * Date.
     *
     * The metadata identifies the components of the date:
     *
     * * `year` - Four digit year, if detected.
     * * `month` - Two digit month number, if detected.
     * * `day` - Two digit day number, if detected.
     * 
* * DATE = 11; */ public static final int DATE_VALUE = 11; /** * * *
     * Number.
     *
     * The metadata is the number itself.
     * 
* * NUMBER = 12; */ public static final int NUMBER_VALUE = 12; /** * * *
     * Price.
     *
     * The metadata identifies the `value` and `currency`.
     * 
* * PRICE = 13; */ public static final int PRICE_VALUE = 13; public final int getNumber() { if (this == UNRECOGNIZED) { throw new java.lang.IllegalArgumentException( "Can't get the number of an unknown enum value."); } return value; } /** * @param value The numeric wire value of the corresponding enum entry. * @return The enum associated with the given numeric wire value. * @deprecated Use {@link #forNumber(int)} instead. */ @java.lang.Deprecated public static Type valueOf(int value) { return forNumber(value); } /** * @param value The numeric wire value of the corresponding enum entry. * @return The enum associated with the given numeric wire value. */ public static Type forNumber(int value) { switch (value) { case 0: return TYPE_UNSPECIFIED; case 1: return PERSON; case 2: return LOCATION; case 3: return ORGANIZATION; case 4: return EVENT; case 5: return WORK_OF_ART; case 6: return CONSUMER_GOOD; case 7: return OTHER; case 9: return PHONE_NUMBER; case 10: return ADDRESS; case 11: return DATE; case 12: return NUMBER; case 13: return PRICE; default: return null; } } public static com.google.protobuf.Internal.EnumLiteMap internalGetValueMap() { return internalValueMap; } private static final com.google.protobuf.Internal.EnumLiteMap internalValueMap = new com.google.protobuf.Internal.EnumLiteMap() { public Type findValueByNumber(int number) { return Type.forNumber(number); } }; public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor() { if (this == UNRECOGNIZED) { throw new java.lang.IllegalStateException( "Can't get the descriptor of an unrecognized enum value."); } return getDescriptor().getValues().get(ordinal()); } public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType() { return getDescriptor(); } public static final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor() { return com.google.cloud.contactcenterinsights.v1.Entity.getDescriptor().getEnumTypes().get(0); } private static final Type[] VALUES = values(); public static Type valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc) { if (desc.getType() != getDescriptor()) { throw new java.lang.IllegalArgumentException("EnumValueDescriptor is not for this type."); } if (desc.getIndex() == -1) { return UNRECOGNIZED; } return VALUES[desc.getIndex()]; } private final int value; private Type(int value) { this.value = value; } // @@protoc_insertion_point(enum_scope:google.cloud.contactcenterinsights.v1.Entity.Type) } public static final int DISPLAY_NAME_FIELD_NUMBER = 1; @SuppressWarnings("serial") private volatile java.lang.Object displayName_ = ""; /** * * *
   * The representative name for the entity.
   * 
* * string display_name = 1; * * @return The displayName. */ @java.lang.Override public java.lang.String getDisplayName() { java.lang.Object ref = displayName_; if (ref instanceof java.lang.String) { return (java.lang.String) ref; } else { com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref; java.lang.String s = bs.toStringUtf8(); displayName_ = s; return s; } } /** * * *
   * The representative name for the entity.
   * 
* * string display_name = 1; * * @return The bytes for displayName. */ @java.lang.Override public com.google.protobuf.ByteString getDisplayNameBytes() { java.lang.Object ref = displayName_; if (ref instanceof java.lang.String) { com.google.protobuf.ByteString b = com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref); displayName_ = b; return b; } else { return (com.google.protobuf.ByteString) ref; } } public static final int TYPE_FIELD_NUMBER = 2; private int type_ = 0; /** * * *
   * The entity type.
   * 
* * .google.cloud.contactcenterinsights.v1.Entity.Type type = 2; * * @return The enum numeric value on the wire for type. */ @java.lang.Override public int getTypeValue() { return type_; } /** * * *
   * The entity type.
   * 
* * .google.cloud.contactcenterinsights.v1.Entity.Type type = 2; * * @return The type. */ @java.lang.Override public com.google.cloud.contactcenterinsights.v1.Entity.Type getType() { com.google.cloud.contactcenterinsights.v1.Entity.Type result = com.google.cloud.contactcenterinsights.v1.Entity.Type.forNumber(type_); return result == null ? com.google.cloud.contactcenterinsights.v1.Entity.Type.UNRECOGNIZED : result; } public static final int METADATA_FIELD_NUMBER = 3; private static final class MetadataDefaultEntryHolder { static final com.google.protobuf.MapEntry defaultEntry = com.google.protobuf.MapEntry.newDefaultInstance( com.google.cloud.contactcenterinsights.v1.ResourcesProto .internal_static_google_cloud_contactcenterinsights_v1_Entity_MetadataEntry_descriptor, com.google.protobuf.WireFormat.FieldType.STRING, "", com.google.protobuf.WireFormat.FieldType.STRING, ""); } @SuppressWarnings("serial") private com.google.protobuf.MapField metadata_; private com.google.protobuf.MapField internalGetMetadata() { if (metadata_ == null) { return com.google.protobuf.MapField.emptyMapField(MetadataDefaultEntryHolder.defaultEntry); } return metadata_; } public int getMetadataCount() { return internalGetMetadata().getMap().size(); } /** * * *
   * 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.Override public boolean containsMetadata(java.lang.String key) { if (key == null) { throw new NullPointerException("map key"); } return internalGetMetadata().getMap().containsKey(key); } /** Use {@link #getMetadataMap()} instead. */ @java.lang.Override @java.lang.Deprecated public java.util.Map getMetadata() { return 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; */ @java.lang.Override public java.util.Map getMetadataMap() { return internalGetMetadata().getMap(); } /** * * *
   * 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.Override public /* nullable */ java.lang.String getMetadataOrDefault( java.lang.String key, /* nullable */ java.lang.String defaultValue) { if (key == null) { throw new NullPointerException("map key"); } java.util.Map map = internalGetMetadata().getMap(); return map.containsKey(key) ? map.get(key) : 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.Override public java.lang.String getMetadataOrThrow(java.lang.String key) { if (key == null) { throw new NullPointerException("map key"); } java.util.Map map = internalGetMetadata().getMap(); if (!map.containsKey(key)) { throw new java.lang.IllegalArgumentException(); } return map.get(key); } public static final int SALIENCE_FIELD_NUMBER = 4; private float salience_ = 0F; /** * * *
   * 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. */ @java.lang.Override public float getSalience() { return salience_; } public static final int SENTIMENT_FIELD_NUMBER = 5; private com.google.cloud.contactcenterinsights.v1.SentimentData sentiment_; /** * * *
   * The aggregate sentiment expressed for this entity in the conversation.
   * 
* * .google.cloud.contactcenterinsights.v1.SentimentData sentiment = 5; * * @return Whether the sentiment field is set. */ @java.lang.Override public boolean hasSentiment() { return sentiment_ != null; } /** * * *
   * The aggregate sentiment expressed for this entity in the conversation.
   * 
* * .google.cloud.contactcenterinsights.v1.SentimentData sentiment = 5; * * @return The sentiment. */ @java.lang.Override public com.google.cloud.contactcenterinsights.v1.SentimentData getSentiment() { return sentiment_ == null ? com.google.cloud.contactcenterinsights.v1.SentimentData.getDefaultInstance() : sentiment_; } /** * * *
   * The aggregate sentiment expressed for this entity in the conversation.
   * 
* * .google.cloud.contactcenterinsights.v1.SentimentData sentiment = 5; */ @java.lang.Override public com.google.cloud.contactcenterinsights.v1.SentimentDataOrBuilder getSentimentOrBuilder() { return sentiment_ == null ? com.google.cloud.contactcenterinsights.v1.SentimentData.getDefaultInstance() : sentiment_; } private byte memoizedIsInitialized = -1; @java.lang.Override public final boolean isInitialized() { byte isInitialized = memoizedIsInitialized; if (isInitialized == 1) return true; if (isInitialized == 0) return false; memoizedIsInitialized = 1; return true; } @java.lang.Override public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io.IOException { if (!com.google.protobuf.GeneratedMessageV3.isStringEmpty(displayName_)) { com.google.protobuf.GeneratedMessageV3.writeString(output, 1, displayName_); } if (type_ != com.google.cloud.contactcenterinsights.v1.Entity.Type.TYPE_UNSPECIFIED.getNumber()) { output.writeEnum(2, type_); } com.google.protobuf.GeneratedMessageV3.serializeStringMapTo( output, internalGetMetadata(), MetadataDefaultEntryHolder.defaultEntry, 3); if (java.lang.Float.floatToRawIntBits(salience_) != 0) { output.writeFloat(4, salience_); } if (sentiment_ != null) { output.writeMessage(5, getSentiment()); } getUnknownFields().writeTo(output); } @java.lang.Override public int getSerializedSize() { int size = memoizedSize; if (size != -1) return size; size = 0; if (!com.google.protobuf.GeneratedMessageV3.isStringEmpty(displayName_)) { size += com.google.protobuf.GeneratedMessageV3.computeStringSize(1, displayName_); } if (type_ != com.google.cloud.contactcenterinsights.v1.Entity.Type.TYPE_UNSPECIFIED.getNumber()) { size += com.google.protobuf.CodedOutputStream.computeEnumSize(2, type_); } for (java.util.Map.Entry entry : internalGetMetadata().getMap().entrySet()) { com.google.protobuf.MapEntry metadata__ = MetadataDefaultEntryHolder.defaultEntry .newBuilderForType() .setKey(entry.getKey()) .setValue(entry.getValue()) .build(); size += com.google.protobuf.CodedOutputStream.computeMessageSize(3, metadata__); } if (java.lang.Float.floatToRawIntBits(salience_) != 0) { size += com.google.protobuf.CodedOutputStream.computeFloatSize(4, salience_); } if (sentiment_ != null) { size += com.google.protobuf.CodedOutputStream.computeMessageSize(5, getSentiment()); } size += getUnknownFields().getSerializedSize(); memoizedSize = size; return size; } @java.lang.Override public boolean equals(final java.lang.Object obj) { if (obj == this) { return true; } if (!(obj instanceof com.google.cloud.contactcenterinsights.v1.Entity)) { return super.equals(obj); } com.google.cloud.contactcenterinsights.v1.Entity other = (com.google.cloud.contactcenterinsights.v1.Entity) obj; if (!getDisplayName().equals(other.getDisplayName())) return false; if (type_ != other.type_) return false; if (!internalGetMetadata().equals(other.internalGetMetadata())) return false; if (java.lang.Float.floatToIntBits(getSalience()) != java.lang.Float.floatToIntBits(other.getSalience())) return false; if (hasSentiment() != other.hasSentiment()) return false; if (hasSentiment()) { if (!getSentiment().equals(other.getSentiment())) return false; } if (!getUnknownFields().equals(other.getUnknownFields())) return false; return true; } @java.lang.Override public int hashCode() { if (memoizedHashCode != 0) { return memoizedHashCode; } int hash = 41; hash = (19 * hash) + getDescriptor().hashCode(); hash = (37 * hash) + DISPLAY_NAME_FIELD_NUMBER; hash = (53 * hash) + getDisplayName().hashCode(); hash = (37 * hash) + TYPE_FIELD_NUMBER; hash = (53 * hash) + type_; if (!internalGetMetadata().getMap().isEmpty()) { hash = (37 * hash) + METADATA_FIELD_NUMBER; hash = (53 * hash) + internalGetMetadata().hashCode(); } hash = (37 * hash) + SALIENCE_FIELD_NUMBER; hash = (53 * hash) + java.lang.Float.floatToIntBits(getSalience()); if (hasSentiment()) { hash = (37 * hash) + SENTIMENT_FIELD_NUMBER; hash = (53 * hash) + getSentiment().hashCode(); } hash = (29 * hash) + getUnknownFields().hashCode(); memoizedHashCode = hash; return hash; } public static com.google.cloud.contactcenterinsights.v1.Entity parseFrom(java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException { return PARSER.parseFrom(data); } public static com.google.cloud.contactcenterinsights.v1.Entity parseFrom( java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException { return PARSER.parseFrom(data, extensionRegistry); } public static com.google.cloud.contactcenterinsights.v1.Entity parseFrom( com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException { return PARSER.parseFrom(data); } public static com.google.cloud.contactcenterinsights.v1.Entity parseFrom( com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException { return PARSER.parseFrom(data, extensionRegistry); } public static com.google.cloud.contactcenterinsights.v1.Entity parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException { return PARSER.parseFrom(data); } public static com.google.cloud.contactcenterinsights.v1.Entity parseFrom( byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException { return PARSER.parseFrom(data, extensionRegistry); } public static com.google.cloud.contactcenterinsights.v1.Entity parseFrom( java.io.InputStream input) throws java.io.IOException { return com.google.protobuf.GeneratedMessageV3.parseWithIOException(PARSER, input); } public static com.google.cloud.contactcenterinsights.v1.Entity parseFrom( java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException { return com.google.protobuf.GeneratedMessageV3.parseWithIOException( PARSER, input, extensionRegistry); } public static com.google.cloud.contactcenterinsights.v1.Entity parseDelimitedFrom( java.io.InputStream input) throws java.io.IOException { return com.google.protobuf.GeneratedMessageV3.parseDelimitedWithIOException(PARSER, input); } public static com.google.cloud.contactcenterinsights.v1.Entity parseDelimitedFrom( java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException { return com.google.protobuf.GeneratedMessageV3.parseDelimitedWithIOException( PARSER, input, extensionRegistry); } public static com.google.cloud.contactcenterinsights.v1.Entity parseFrom( com.google.protobuf.CodedInputStream input) throws java.io.IOException { return com.google.protobuf.GeneratedMessageV3.parseWithIOException(PARSER, input); } public static com.google.cloud.contactcenterinsights.v1.Entity parseFrom( com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException { return com.google.protobuf.GeneratedMessageV3.parseWithIOException( PARSER, input, extensionRegistry); } @java.lang.Override public Builder newBuilderForType() { return newBuilder(); } public static Builder newBuilder() { return DEFAULT_INSTANCE.toBuilder(); } public static Builder newBuilder(com.google.cloud.contactcenterinsights.v1.Entity prototype) { return DEFAULT_INSTANCE.toBuilder().mergeFrom(prototype); } @java.lang.Override public Builder toBuilder() { return this == DEFAULT_INSTANCE ? new Builder() : new Builder().mergeFrom(this); } @java.lang.Override protected Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) { Builder builder = new Builder(parent); return builder; } /** * * *
   * The data for an entity annotation.
   * Represents a phrase in the conversation that is a known entity, such
   * as a person, an organization, or location.
   * 
* * Protobuf type {@code google.cloud.contactcenterinsights.v1.Entity} */ public static final class Builder extends com.google.protobuf.GeneratedMessageV3.Builder implements // @@protoc_insertion_point(builder_implements:google.cloud.contactcenterinsights.v1.Entity) com.google.cloud.contactcenterinsights.v1.EntityOrBuilder { public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() { return com.google.cloud.contactcenterinsights.v1.ResourcesProto .internal_static_google_cloud_contactcenterinsights_v1_Entity_descriptor; } @SuppressWarnings({"rawtypes"}) protected com.google.protobuf.MapField internalGetMapField(int number) { switch (number) { case 3: return internalGetMetadata(); default: throw new RuntimeException("Invalid map field number: " + number); } } @SuppressWarnings({"rawtypes"}) protected com.google.protobuf.MapField internalGetMutableMapField(int number) { switch (number) { case 3: return internalGetMutableMetadata(); default: throw new RuntimeException("Invalid map field number: " + number); } } @java.lang.Override protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable() { return com.google.cloud.contactcenterinsights.v1.ResourcesProto .internal_static_google_cloud_contactcenterinsights_v1_Entity_fieldAccessorTable .ensureFieldAccessorsInitialized( com.google.cloud.contactcenterinsights.v1.Entity.class, com.google.cloud.contactcenterinsights.v1.Entity.Builder.class); } // Construct using com.google.cloud.contactcenterinsights.v1.Entity.newBuilder() private Builder() {} private Builder(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) { super(parent); } @java.lang.Override public Builder clear() { super.clear(); bitField0_ = 0; displayName_ = ""; type_ = 0; internalGetMutableMetadata().clear(); salience_ = 0F; sentiment_ = null; if (sentimentBuilder_ != null) { sentimentBuilder_.dispose(); sentimentBuilder_ = null; } return this; } @java.lang.Override public com.google.protobuf.Descriptors.Descriptor getDescriptorForType() { return com.google.cloud.contactcenterinsights.v1.ResourcesProto .internal_static_google_cloud_contactcenterinsights_v1_Entity_descriptor; } @java.lang.Override public com.google.cloud.contactcenterinsights.v1.Entity getDefaultInstanceForType() { return com.google.cloud.contactcenterinsights.v1.Entity.getDefaultInstance(); } @java.lang.Override public com.google.cloud.contactcenterinsights.v1.Entity build() { com.google.cloud.contactcenterinsights.v1.Entity result = buildPartial(); if (!result.isInitialized()) { throw newUninitializedMessageException(result); } return result; } @java.lang.Override public com.google.cloud.contactcenterinsights.v1.Entity buildPartial() { com.google.cloud.contactcenterinsights.v1.Entity result = new com.google.cloud.contactcenterinsights.v1.Entity(this); if (bitField0_ != 0) { buildPartial0(result); } onBuilt(); return result; } private void buildPartial0(com.google.cloud.contactcenterinsights.v1.Entity result) { int from_bitField0_ = bitField0_; if (((from_bitField0_ & 0x00000001) != 0)) { result.displayName_ = displayName_; } if (((from_bitField0_ & 0x00000002) != 0)) { result.type_ = type_; } if (((from_bitField0_ & 0x00000004) != 0)) { result.metadata_ = internalGetMetadata(); result.metadata_.makeImmutable(); } if (((from_bitField0_ & 0x00000008) != 0)) { result.salience_ = salience_; } if (((from_bitField0_ & 0x00000010) != 0)) { result.sentiment_ = sentimentBuilder_ == null ? sentiment_ : sentimentBuilder_.build(); } } @java.lang.Override public Builder clone() { return super.clone(); } @java.lang.Override public Builder setField( com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value) { return super.setField(field, value); } @java.lang.Override public Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field) { return super.clearField(field); } @java.lang.Override public Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) { return super.clearOneof(oneof); } @java.lang.Override public Builder setRepeatedField( com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value) { return super.setRepeatedField(field, index, value); } @java.lang.Override public Builder addRepeatedField( com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value) { return super.addRepeatedField(field, value); } @java.lang.Override public Builder mergeFrom(com.google.protobuf.Message other) { if (other instanceof com.google.cloud.contactcenterinsights.v1.Entity) { return mergeFrom((com.google.cloud.contactcenterinsights.v1.Entity) other); } else { super.mergeFrom(other); return this; } } public Builder mergeFrom(com.google.cloud.contactcenterinsights.v1.Entity other) { if (other == com.google.cloud.contactcenterinsights.v1.Entity.getDefaultInstance()) return this; if (!other.getDisplayName().isEmpty()) { displayName_ = other.displayName_; bitField0_ |= 0x00000001; onChanged(); } if (other.type_ != 0) { setTypeValue(other.getTypeValue()); } internalGetMutableMetadata().mergeFrom(other.internalGetMetadata()); bitField0_ |= 0x00000004; if (other.getSalience() != 0F) { setSalience(other.getSalience()); } if (other.hasSentiment()) { mergeSentiment(other.getSentiment()); } this.mergeUnknownFields(other.getUnknownFields()); onChanged(); return this; } @java.lang.Override public final boolean isInitialized() { return true; } @java.lang.Override public Builder mergeFrom( com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException { if (extensionRegistry == null) { throw new java.lang.NullPointerException(); } try { boolean done = false; while (!done) { int tag = input.readTag(); switch (tag) { case 0: done = true; break; case 10: { displayName_ = input.readStringRequireUtf8(); bitField0_ |= 0x00000001; break; } // case 10 case 16: { type_ = input.readEnum(); bitField0_ |= 0x00000002; break; } // case 16 case 26: { com.google.protobuf.MapEntry metadata__ = input.readMessage( MetadataDefaultEntryHolder.defaultEntry.getParserForType(), extensionRegistry); internalGetMutableMetadata() .getMutableMap() .put(metadata__.getKey(), metadata__.getValue()); bitField0_ |= 0x00000004; break; } // case 26 case 37: { salience_ = input.readFloat(); bitField0_ |= 0x00000008; break; } // case 37 case 42: { input.readMessage(getSentimentFieldBuilder().getBuilder(), extensionRegistry); bitField0_ |= 0x00000010; break; } // case 42 default: { if (!super.parseUnknownField(input, extensionRegistry, tag)) { done = true; // was an endgroup tag } break; } // default: } // switch (tag) } // while (!done) } catch (com.google.protobuf.InvalidProtocolBufferException e) { throw e.unwrapIOException(); } finally { onChanged(); } // finally return this; } private int bitField0_; private java.lang.Object displayName_ = ""; /** * * *
     * The representative name for the entity.
     * 
* * string display_name = 1; * * @return The displayName. */ public java.lang.String getDisplayName() { java.lang.Object ref = displayName_; if (!(ref instanceof java.lang.String)) { com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref; java.lang.String s = bs.toStringUtf8(); displayName_ = s; return s; } else { return (java.lang.String) ref; } } /** * * *
     * The representative name for the entity.
     * 
* * string display_name = 1; * * @return The bytes for displayName. */ public com.google.protobuf.ByteString getDisplayNameBytes() { java.lang.Object ref = displayName_; if (ref instanceof String) { com.google.protobuf.ByteString b = com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref); displayName_ = b; return b; } else { return (com.google.protobuf.ByteString) ref; } } /** * * *
     * The representative name for the entity.
     * 
* * string display_name = 1; * * @param value The displayName to set. * @return This builder for chaining. */ public Builder setDisplayName(java.lang.String value) { if (value == null) { throw new NullPointerException(); } displayName_ = value; bitField0_ |= 0x00000001; onChanged(); return this; } /** * * *
     * The representative name for the entity.
     * 
* * string display_name = 1; * * @return This builder for chaining. */ public Builder clearDisplayName() { displayName_ = getDefaultInstance().getDisplayName(); bitField0_ = (bitField0_ & ~0x00000001); onChanged(); return this; } /** * * *
     * The representative name for the entity.
     * 
* * string display_name = 1; * * @param value The bytes for displayName to set. * @return This builder for chaining. */ public Builder setDisplayNameBytes(com.google.protobuf.ByteString value) { if (value == null) { throw new NullPointerException(); } checkByteStringIsUtf8(value); displayName_ = value; bitField0_ |= 0x00000001; onChanged(); return this; } private int type_ = 0; /** * * *
     * The entity type.
     * 
* * .google.cloud.contactcenterinsights.v1.Entity.Type type = 2; * * @return The enum numeric value on the wire for type. */ @java.lang.Override public int getTypeValue() { return type_; } /** * * *
     * The entity type.
     * 
* * .google.cloud.contactcenterinsights.v1.Entity.Type type = 2; * * @param value The enum numeric value on the wire for type to set. * @return This builder for chaining. */ public Builder setTypeValue(int value) { type_ = value; bitField0_ |= 0x00000002; onChanged(); return this; } /** * * *
     * The entity type.
     * 
* * .google.cloud.contactcenterinsights.v1.Entity.Type type = 2; * * @return The type. */ @java.lang.Override public com.google.cloud.contactcenterinsights.v1.Entity.Type getType() { com.google.cloud.contactcenterinsights.v1.Entity.Type result = com.google.cloud.contactcenterinsights.v1.Entity.Type.forNumber(type_); return result == null ? com.google.cloud.contactcenterinsights.v1.Entity.Type.UNRECOGNIZED : result; } /** * * *
     * The entity type.
     * 
* * .google.cloud.contactcenterinsights.v1.Entity.Type type = 2; * * @param value The type to set. * @return This builder for chaining. */ public Builder setType(com.google.cloud.contactcenterinsights.v1.Entity.Type value) { if (value == null) { throw new NullPointerException(); } bitField0_ |= 0x00000002; type_ = value.getNumber(); onChanged(); return this; } /** * * *
     * The entity type.
     * 
* * .google.cloud.contactcenterinsights.v1.Entity.Type type = 2; * * @return This builder for chaining. */ public Builder clearType() { bitField0_ = (bitField0_ & ~0x00000002); type_ = 0; onChanged(); return this; } private com.google.protobuf.MapField metadata_; private com.google.protobuf.MapField internalGetMetadata() { if (metadata_ == null) { return com.google.protobuf.MapField.emptyMapField(MetadataDefaultEntryHolder.defaultEntry); } return metadata_; } private com.google.protobuf.MapField internalGetMutableMetadata() { if (metadata_ == null) { metadata_ = com.google.protobuf.MapField.newMapField(MetadataDefaultEntryHolder.defaultEntry); } if (!metadata_.isMutable()) { metadata_ = metadata_.copy(); } bitField0_ |= 0x00000004; onChanged(); return metadata_; } public int getMetadataCount() { return internalGetMetadata().getMap().size(); } /** * * *
     * 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.Override public boolean containsMetadata(java.lang.String key) { if (key == null) { throw new NullPointerException("map key"); } return internalGetMetadata().getMap().containsKey(key); } /** Use {@link #getMetadataMap()} instead. */ @java.lang.Override @java.lang.Deprecated public java.util.Map getMetadata() { return 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; */ @java.lang.Override public java.util.Map getMetadataMap() { return internalGetMetadata().getMap(); } /** * * *
     * 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.Override public /* nullable */ java.lang.String getMetadataOrDefault( java.lang.String key, /* nullable */ java.lang.String defaultValue) { if (key == null) { throw new NullPointerException("map key"); } java.util.Map map = internalGetMetadata().getMap(); return map.containsKey(key) ? map.get(key) : 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.Override public java.lang.String getMetadataOrThrow(java.lang.String key) { if (key == null) { throw new NullPointerException("map key"); } java.util.Map map = internalGetMetadata().getMap(); if (!map.containsKey(key)) { throw new java.lang.IllegalArgumentException(); } return map.get(key); } public Builder clearMetadata() { bitField0_ = (bitField0_ & ~0x00000004); internalGetMutableMetadata().getMutableMap().clear(); return this; } /** * * *
     * 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; */ public Builder removeMetadata(java.lang.String key) { if (key == null) { throw new NullPointerException("map key"); } internalGetMutableMetadata().getMutableMap().remove(key); return this; } /** Use alternate mutation accessors instead. */ @java.lang.Deprecated public java.util.Map getMutableMetadata() { bitField0_ |= 0x00000004; return internalGetMutableMetadata().getMutableMap(); } /** * * *
     * 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; */ public Builder putMetadata(java.lang.String key, java.lang.String value) { if (key == null) { throw new NullPointerException("map key"); } if (value == null) { throw new NullPointerException("map value"); } internalGetMutableMetadata().getMutableMap().put(key, value); bitField0_ |= 0x00000004; return this; } /** * * *
     * 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; */ public Builder putAllMetadata(java.util.Map values) { internalGetMutableMetadata().getMutableMap().putAll(values); bitField0_ |= 0x00000004; return this; } private float salience_; /** * * *
     * 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. */ @java.lang.Override public float getSalience() { return salience_; } /** * * *
     * 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; * * @param value The salience to set. * @return This builder for chaining. */ public Builder setSalience(float value) { salience_ = value; bitField0_ |= 0x00000008; onChanged(); return this; } /** * * *
     * 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 This builder for chaining. */ public Builder clearSalience() { bitField0_ = (bitField0_ & ~0x00000008); salience_ = 0F; onChanged(); return this; } private com.google.cloud.contactcenterinsights.v1.SentimentData sentiment_; private com.google.protobuf.SingleFieldBuilderV3< com.google.cloud.contactcenterinsights.v1.SentimentData, com.google.cloud.contactcenterinsights.v1.SentimentData.Builder, com.google.cloud.contactcenterinsights.v1.SentimentDataOrBuilder> sentimentBuilder_; /** * * *
     * The aggregate sentiment expressed for this entity in the conversation.
     * 
* * .google.cloud.contactcenterinsights.v1.SentimentData sentiment = 5; * * @return Whether the sentiment field is set. */ public boolean hasSentiment() { return ((bitField0_ & 0x00000010) != 0); } /** * * *
     * The aggregate sentiment expressed for this entity in the conversation.
     * 
* * .google.cloud.contactcenterinsights.v1.SentimentData sentiment = 5; * * @return The sentiment. */ public com.google.cloud.contactcenterinsights.v1.SentimentData getSentiment() { if (sentimentBuilder_ == null) { return sentiment_ == null ? com.google.cloud.contactcenterinsights.v1.SentimentData.getDefaultInstance() : sentiment_; } else { return sentimentBuilder_.getMessage(); } } /** * * *
     * The aggregate sentiment expressed for this entity in the conversation.
     * 
* * .google.cloud.contactcenterinsights.v1.SentimentData sentiment = 5; */ public Builder setSentiment(com.google.cloud.contactcenterinsights.v1.SentimentData value) { if (sentimentBuilder_ == null) { if (value == null) { throw new NullPointerException(); } sentiment_ = value; } else { sentimentBuilder_.setMessage(value); } bitField0_ |= 0x00000010; onChanged(); return this; } /** * * *
     * The aggregate sentiment expressed for this entity in the conversation.
     * 
* * .google.cloud.contactcenterinsights.v1.SentimentData sentiment = 5; */ public Builder setSentiment( com.google.cloud.contactcenterinsights.v1.SentimentData.Builder builderForValue) { if (sentimentBuilder_ == null) { sentiment_ = builderForValue.build(); } else { sentimentBuilder_.setMessage(builderForValue.build()); } bitField0_ |= 0x00000010; onChanged(); return this; } /** * * *
     * The aggregate sentiment expressed for this entity in the conversation.
     * 
* * .google.cloud.contactcenterinsights.v1.SentimentData sentiment = 5; */ public Builder mergeSentiment(com.google.cloud.contactcenterinsights.v1.SentimentData value) { if (sentimentBuilder_ == null) { if (((bitField0_ & 0x00000010) != 0) && sentiment_ != null && sentiment_ != com.google.cloud.contactcenterinsights.v1.SentimentData.getDefaultInstance()) { getSentimentBuilder().mergeFrom(value); } else { sentiment_ = value; } } else { sentimentBuilder_.mergeFrom(value); } bitField0_ |= 0x00000010; onChanged(); return this; } /** * * *
     * The aggregate sentiment expressed for this entity in the conversation.
     * 
* * .google.cloud.contactcenterinsights.v1.SentimentData sentiment = 5; */ public Builder clearSentiment() { bitField0_ = (bitField0_ & ~0x00000010); sentiment_ = null; if (sentimentBuilder_ != null) { sentimentBuilder_.dispose(); sentimentBuilder_ = null; } onChanged(); return this; } /** * * *
     * The aggregate sentiment expressed for this entity in the conversation.
     * 
* * .google.cloud.contactcenterinsights.v1.SentimentData sentiment = 5; */ public com.google.cloud.contactcenterinsights.v1.SentimentData.Builder getSentimentBuilder() { bitField0_ |= 0x00000010; onChanged(); return getSentimentFieldBuilder().getBuilder(); } /** * * *
     * The aggregate sentiment expressed for this entity in the conversation.
     * 
* * .google.cloud.contactcenterinsights.v1.SentimentData sentiment = 5; */ public com.google.cloud.contactcenterinsights.v1.SentimentDataOrBuilder getSentimentOrBuilder() { if (sentimentBuilder_ != null) { return sentimentBuilder_.getMessageOrBuilder(); } else { return sentiment_ == null ? com.google.cloud.contactcenterinsights.v1.SentimentData.getDefaultInstance() : sentiment_; } } /** * * *
     * The aggregate sentiment expressed for this entity in the conversation.
     * 
* * .google.cloud.contactcenterinsights.v1.SentimentData sentiment = 5; */ private com.google.protobuf.SingleFieldBuilderV3< com.google.cloud.contactcenterinsights.v1.SentimentData, com.google.cloud.contactcenterinsights.v1.SentimentData.Builder, com.google.cloud.contactcenterinsights.v1.SentimentDataOrBuilder> getSentimentFieldBuilder() { if (sentimentBuilder_ == null) { sentimentBuilder_ = new com.google.protobuf.SingleFieldBuilderV3< com.google.cloud.contactcenterinsights.v1.SentimentData, com.google.cloud.contactcenterinsights.v1.SentimentData.Builder, com.google.cloud.contactcenterinsights.v1.SentimentDataOrBuilder>( getSentiment(), getParentForChildren(), isClean()); sentiment_ = null; } return sentimentBuilder_; } @java.lang.Override public final Builder setUnknownFields(final com.google.protobuf.UnknownFieldSet unknownFields) { return super.setUnknownFields(unknownFields); } @java.lang.Override public final Builder mergeUnknownFields( final com.google.protobuf.UnknownFieldSet unknownFields) { return super.mergeUnknownFields(unknownFields); } // @@protoc_insertion_point(builder_scope:google.cloud.contactcenterinsights.v1.Entity) } // @@protoc_insertion_point(class_scope:google.cloud.contactcenterinsights.v1.Entity) private static final com.google.cloud.contactcenterinsights.v1.Entity DEFAULT_INSTANCE; static { DEFAULT_INSTANCE = new com.google.cloud.contactcenterinsights.v1.Entity(); } public static com.google.cloud.contactcenterinsights.v1.Entity getDefaultInstance() { return DEFAULT_INSTANCE; } private static final com.google.protobuf.Parser PARSER = new com.google.protobuf.AbstractParser() { @java.lang.Override public Entity parsePartialFrom( com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException { Builder builder = newBuilder(); try { builder.mergeFrom(input, extensionRegistry); } catch (com.google.protobuf.InvalidProtocolBufferException e) { throw e.setUnfinishedMessage(builder.buildPartial()); } catch (com.google.protobuf.UninitializedMessageException e) { throw e.asInvalidProtocolBufferException().setUnfinishedMessage(builder.buildPartial()); } catch (java.io.IOException e) { throw new com.google.protobuf.InvalidProtocolBufferException(e) .setUnfinishedMessage(builder.buildPartial()); } return builder.buildPartial(); } }; public static com.google.protobuf.Parser parser() { return PARSER; } @java.lang.Override public com.google.protobuf.Parser getParserForType() { return PARSER; } @java.lang.Override public com.google.cloud.contactcenterinsights.v1.Entity getDefaultInstanceForType() { return DEFAULT_INSTANCE; } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy