com.google.cloud.contactcenterinsights.v1

Class Entity.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<Entity.Builder>

com.google.cloud.contactcenterinsights.v1.Entity.Builder

All Implemented Interfaces:

EntityOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

Entity

public static final class Entity.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Entity.Builder>
implements EntityOrBuilder

 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 google.cloud.contactcenterinsights.v1.Entity

Method Summary

Modifier and Type	Method and Description
Entity.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
Entity	build()
Entity	buildPartial()
Entity.Builder	clear()
Entity.Builder	clearDisplayName() The representative name for the entity.
Entity.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
Entity.Builder	clearMetadata()
Entity.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
Entity.Builder	clearSalience() The salience score associated with the entity in the [0, 1.0] range.
Entity.Builder	clearSentiment() The aggregate sentiment expressed for this entity in the conversation.
Entity.Builder	clearType() The entity type.
Entity.Builder	clone()
boolean	containsMetadata(String key) Metadata associated with the entity.
Entity	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
String	getDisplayName() The representative name for the entity.
com.google.protobuf.ByteString	getDisplayNameBytes() The representative name for the entity.
Map<String,String>	getMetadata() Deprecated.
int	getMetadataCount() Metadata associated with the entity.
Map<String,String>	getMetadataMap() Metadata associated with the entity.
String	getMetadataOrDefault(String key, String defaultValue) Metadata associated with the entity.
String	getMetadataOrThrow(String key) Metadata associated with the entity.
Map<String,String>	getMutableMetadata() Deprecated.
float	getSalience() The salience score associated with the entity in the [0, 1.0] range.
SentimentData	getSentiment() The aggregate sentiment expressed for this entity in the conversation.
SentimentData.Builder	getSentimentBuilder() The aggregate sentiment expressed for this entity in the conversation.
SentimentDataOrBuilder	getSentimentOrBuilder() The aggregate sentiment expressed for this entity in the conversation.
Entity.Type	getType() The entity type.
int	getTypeValue() The entity type.
boolean	hasSentiment() The aggregate sentiment expressed for this entity in the conversation.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapFieldReflectionAccessor	internalGetMapFieldReflection(int number)
protected com.google.protobuf.MapFieldReflectionAccessor	internalGetMutableMapFieldReflection(int number)
boolean	isInitialized()
Entity.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
Entity.Builder	mergeFrom(Entity other)
Entity.Builder	mergeFrom(com.google.protobuf.Message other)
Entity.Builder	mergeSentiment(SentimentData value) The aggregate sentiment expressed for this entity in the conversation.
Entity.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
Entity.Builder	putAllMetadata(Map<String,String> values) Metadata associated with the entity.
Entity.Builder	putMetadata(String key, String value) Metadata associated with the entity.
Entity.Builder	removeMetadata(String key) Metadata associated with the entity.
Entity.Builder	setDisplayName(String value) The representative name for the entity.
Entity.Builder	setDisplayNameBytes(com.google.protobuf.ByteString value) The representative name for the entity.
Entity.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
Entity.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
Entity.Builder	setSalience(float value) The salience score associated with the entity in the [0, 1.0] range.
Entity.Builder	setSentiment(SentimentData.Builder builderForValue) The aggregate sentiment expressed for this entity in the conversation.
Entity.Builder	setSentiment(SentimentData value) The aggregate sentiment expressed for this entity in the conversation.
Entity.Builder	setType(Entity.Type value) The entity type.
Entity.Builder	setTypeValue(int value) The entity type.
Entity.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapFieldReflection

protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)

Overrides:

internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3.Builder<Entity.Builder>

internalGetMutableMapFieldReflection

protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)

Overrides:

internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessageV3.Builder<Entity.Builder>

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Entity.Builder>

clear

public Entity.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<Entity.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Entity.Builder>

getDefaultInstanceForType

public Entity getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public Entity build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public Entity buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public Entity.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<Entity.Builder>

setField

public Entity.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                               Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<Entity.Builder>

clearField

public Entity.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Entity.Builder>

clearOneof

public Entity.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Entity.Builder>

setRepeatedField

public Entity.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                       int index,
                                       Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Entity.Builder>

addRepeatedField

public Entity.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                       Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Entity.Builder>

mergeFrom

public Entity.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Entity.Builder>

mergeFrom

public Entity.Builder mergeFrom(Entity other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Entity.Builder>

mergeFrom

public Entity.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Entity.Builder>

Throws:

IOException

getDisplayName

public String getDisplayName()

 The representative name for the entity.
 

string display_name = 1;

Specified by:

getDisplayName in interface EntityOrBuilder

Returns:

The displayName.

getDisplayNameBytes

public com.google.protobuf.ByteString getDisplayNameBytes()

 The representative name for the entity.
 

string display_name = 1;

Specified by:

getDisplayNameBytes in interface EntityOrBuilder

Returns:

The bytes for displayName.

setDisplayName

public Entity.Builder setDisplayName(String value)

 The representative name for the entity.
 

string display_name = 1;

Parameters:

value - The displayName to set.

Returns:

This builder for chaining.

clearDisplayName

public Entity.Builder clearDisplayName()

 The representative name for the entity.
 

string display_name = 1;

Returns:

This builder for chaining.

setDisplayNameBytes

public Entity.Builder setDisplayNameBytes(com.google.protobuf.ByteString value)

 The representative name for the entity.
 

string display_name = 1;

Parameters:

value - The bytes for displayName to set.

Returns:

This builder for chaining.

getTypeValue

public int getTypeValue()

 The entity type.
 

.google.cloud.contactcenterinsights.v1.Entity.Type type = 2;

Specified by:

getTypeValue in interface EntityOrBuilder

Returns:

The enum numeric value on the wire for type.

setTypeValue

public Entity.Builder setTypeValue(int value)

 The entity type.
 

.google.cloud.contactcenterinsights.v1.Entity.Type type = 2;

Parameters:

value - The enum numeric value on the wire for type to set.

Returns:

This builder for chaining.

getType

public Entity.Type getType()

 The entity type.
 

.google.cloud.contactcenterinsights.v1.Entity.Type type = 2;

Specified by:

getType in interface EntityOrBuilder

Returns:

The type.

setType

public Entity.Builder setType(Entity.Type value)

 The entity type.
 

.google.cloud.contactcenterinsights.v1.Entity.Type type = 2;

Parameters:

value - The type to set.

Returns:

This builder for chaining.

clearType

public Entity.Builder clearType()

 The entity type.
 

.google.cloud.contactcenterinsights.v1.Entity.Type type = 2;

Returns:

This builder for chaining.

getMetadataCount

public int getMetadataCount()

Description copied from interface: EntityOrBuilder

 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;

Specified by:

getMetadataCount in interface EntityOrBuilder

containsMetadata

public boolean containsMetadata(String key)

 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;

Specified by:

containsMetadata in interface EntityOrBuilder

getMetadata

@Deprecated
public Map<String,String> getMetadata()

Deprecated.

Use getMetadataMap() instead.

Specified by:

getMetadata in interface EntityOrBuilder

getMetadataMap

public Map<String,String> 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;

Specified by:

getMetadataMap in interface EntityOrBuilder

getMetadataOrDefault

public String getMetadataOrDefault(String key,
                                   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;

Specified by:

getMetadataOrDefault in interface EntityOrBuilder

getMetadataOrThrow

public String getMetadataOrThrow(String key)

 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;

Specified by:

getMetadataOrThrow in interface EntityOrBuilder

clearMetadata

public Entity.Builder clearMetadata()

removeMetadata

public Entity.Builder removeMetadata(String key)

 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;

getMutableMetadata

@Deprecated
public Map<String,String> getMutableMetadata()

Deprecated.

Use alternate mutation accessors instead.

putMetadata

public Entity.Builder putMetadata(String key,
                                  String value)

 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;

putAllMetadata

public Entity.Builder putAllMetadata(Map<String,String> values)

 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;

getSalience

public float getSalience()

 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;

Specified by:

getSalience in interface EntityOrBuilder

Returns:

The salience.

setSalience

public Entity.Builder setSalience(float value)

 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;

Parameters:

value - The salience to set.

Returns:

This builder for chaining.

clearSalience

public Entity.Builder clearSalience()

 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;

Returns:

This builder for chaining.

hasSentiment

public boolean hasSentiment()

 The aggregate sentiment expressed for this entity in the conversation.
 

.google.cloud.contactcenterinsights.v1.SentimentData sentiment = 5;

Specified by:

hasSentiment in interface EntityOrBuilder

Returns:

Whether the sentiment field is set.

getSentiment

public SentimentData getSentiment()

 The aggregate sentiment expressed for this entity in the conversation.
 

.google.cloud.contactcenterinsights.v1.SentimentData sentiment = 5;

Specified by:

getSentiment in interface EntityOrBuilder

Returns:

The sentiment.

setSentiment

public Entity.Builder setSentiment(SentimentData value)

 The aggregate sentiment expressed for this entity in the conversation.
 

.google.cloud.contactcenterinsights.v1.SentimentData sentiment = 5;

setSentiment

public Entity.Builder setSentiment(SentimentData.Builder builderForValue)

 The aggregate sentiment expressed for this entity in the conversation.
 

.google.cloud.contactcenterinsights.v1.SentimentData sentiment = 5;

mergeSentiment

public Entity.Builder mergeSentiment(SentimentData value)

 The aggregate sentiment expressed for this entity in the conversation.
 

.google.cloud.contactcenterinsights.v1.SentimentData sentiment = 5;

clearSentiment

public Entity.Builder clearSentiment()

 The aggregate sentiment expressed for this entity in the conversation.
 

.google.cloud.contactcenterinsights.v1.SentimentData sentiment = 5;

getSentimentBuilder

public SentimentData.Builder getSentimentBuilder()

 The aggregate sentiment expressed for this entity in the conversation.
 

.google.cloud.contactcenterinsights.v1.SentimentData sentiment = 5;

getSentimentOrBuilder

public SentimentDataOrBuilder getSentimentOrBuilder()

 The aggregate sentiment expressed for this entity in the conversation.
 

.google.cloud.contactcenterinsights.v1.SentimentData sentiment = 5;

Specified by:

getSentimentOrBuilder in interface EntityOrBuilder

setUnknownFields

public final Entity.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Entity.Builder>

mergeUnknownFields

public final Entity.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Entity.Builder>