com.google.cloud.contactcenterinsights.v1

Class FaqAnswerData.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

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

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

com.google.cloud.contactcenterinsights.v1.FaqAnswerData.Builder

All Implemented Interfaces:

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

Enclosing class:

FaqAnswerData

public static final class FaqAnswerData.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<FaqAnswerData.Builder>
implements FaqAnswerDataOrBuilder

 Agent Assist frequently-asked-question answer data.
 

Protobuf type google.cloud.contactcenterinsights.v1.FaqAnswerData

Method Summary

Modifier and Type	Method and Description
FaqAnswerData.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
FaqAnswerData	build()
FaqAnswerData	buildPartial()
FaqAnswerData.Builder	clear()
FaqAnswerData.Builder	clearAnswer() The piece of text from the `source` knowledge base document.
FaqAnswerData.Builder	clearConfidenceScore() The system's confidence score that this answer is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain).
FaqAnswerData.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
FaqAnswerData.Builder	clearMetadata()
FaqAnswerData.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
FaqAnswerData.Builder	clearQueryRecord() The name of the answer record.
FaqAnswerData.Builder	clearQuestion() The corresponding FAQ question.
FaqAnswerData.Builder	clearSource() The knowledge document that this answer was extracted from.
FaqAnswerData.Builder	clone()
boolean	containsMetadata(String key) Map that contains metadata about the FAQ answer and the document that it originates from.
String	getAnswer() The piece of text from the `source` knowledge base document.
com.google.protobuf.ByteString	getAnswerBytes() The piece of text from the `source` knowledge base document.
float	getConfidenceScore() The system's confidence score that this answer is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain).
FaqAnswerData	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
Map<String,String>	getMetadata() Deprecated.
int	getMetadataCount() Map that contains metadata about the FAQ answer and the document that it originates from.
Map<String,String>	getMetadataMap() Map that contains metadata about the FAQ answer and the document that it originates from.
String	getMetadataOrDefault(String key, String defaultValue) Map that contains metadata about the FAQ answer and the document that it originates from.
String	getMetadataOrThrow(String key) Map that contains metadata about the FAQ answer and the document that it originates from.
Map<String,String>	getMutableMetadata() Deprecated.
String	getQueryRecord() The name of the answer record.
com.google.protobuf.ByteString	getQueryRecordBytes() The name of the answer record.
String	getQuestion() The corresponding FAQ question.
com.google.protobuf.ByteString	getQuestionBytes() The corresponding FAQ question.
String	getSource() The knowledge document that this answer was extracted from.
com.google.protobuf.ByteString	getSourceBytes() The knowledge document that this answer was extracted from.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapField	internalGetMapField(int number)
protected com.google.protobuf.MapField	internalGetMutableMapField(int number)
boolean	isInitialized()
FaqAnswerData.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
FaqAnswerData.Builder	mergeFrom(FaqAnswerData other)
FaqAnswerData.Builder	mergeFrom(com.google.protobuf.Message other)
FaqAnswerData.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
FaqAnswerData.Builder	putAllMetadata(Map<String,String> values) Map that contains metadata about the FAQ answer and the document that it originates from.
FaqAnswerData.Builder	putMetadata(String key, String value) Map that contains metadata about the FAQ answer and the document that it originates from.
FaqAnswerData.Builder	removeMetadata(String key) Map that contains metadata about the FAQ answer and the document that it originates from.
FaqAnswerData.Builder	setAnswer(String value) The piece of text from the `source` knowledge base document.
FaqAnswerData.Builder	setAnswerBytes(com.google.protobuf.ByteString value) The piece of text from the `source` knowledge base document.
FaqAnswerData.Builder	setConfidenceScore(float value) The system's confidence score that this answer is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain).
FaqAnswerData.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
FaqAnswerData.Builder	setQueryRecord(String value) The name of the answer record.
FaqAnswerData.Builder	setQueryRecordBytes(com.google.protobuf.ByteString value) The name of the answer record.
FaqAnswerData.Builder	setQuestion(String value) The corresponding FAQ question.
FaqAnswerData.Builder	setQuestionBytes(com.google.protobuf.ByteString value) The corresponding FAQ question.
FaqAnswerData.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
FaqAnswerData.Builder	setSource(String value) The knowledge document that this answer was extracted from.
FaqAnswerData.Builder	setSourceBytes(com.google.protobuf.ByteString value) The knowledge document that this answer was extracted from.
FaqAnswerData.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, internalGetMapFieldReflection, internalGetMutableMapFieldReflection, 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()

internalGetMapField

protected com.google.protobuf.MapField internalGetMapField(int number)

Overrides:

internalGetMapField in class com.google.protobuf.GeneratedMessageV3.Builder<FaqAnswerData.Builder>

internalGetMutableMapField

protected com.google.protobuf.MapField internalGetMutableMapField(int number)

Overrides:

internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<FaqAnswerData.Builder>

internalGetFieldAccessorTable

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

Specified by:

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

clear

public FaqAnswerData.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<FaqAnswerData.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<FaqAnswerData.Builder>

getDefaultInstanceForType

public FaqAnswerData getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public FaqAnswerData build()

Specified by:

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

Specified by:

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

buildPartial

public FaqAnswerData buildPartial()

Specified by:

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

Specified by:

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

clone

public FaqAnswerData.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<FaqAnswerData.Builder>

setField

public FaqAnswerData.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<FaqAnswerData.Builder>

clearField

public FaqAnswerData.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<FaqAnswerData.Builder>

clearOneof

public FaqAnswerData.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<FaqAnswerData.Builder>

setRepeatedField

public FaqAnswerData.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<FaqAnswerData.Builder>

addRepeatedField

public FaqAnswerData.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<FaqAnswerData.Builder>

mergeFrom

public FaqAnswerData.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<FaqAnswerData.Builder>

mergeFrom

public FaqAnswerData.Builder mergeFrom(FaqAnswerData other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

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

mergeFrom

public FaqAnswerData.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<FaqAnswerData.Builder>

Throws:

IOException

getAnswer

public String getAnswer()

 The piece of text from the `source` knowledge base document.
 

string answer = 1;

Specified by:

getAnswer in interface FaqAnswerDataOrBuilder

Returns:

The answer.

getAnswerBytes

public com.google.protobuf.ByteString getAnswerBytes()

 The piece of text from the `source` knowledge base document.
 

string answer = 1;

Specified by:

getAnswerBytes in interface FaqAnswerDataOrBuilder

Returns:

The bytes for answer.

setAnswer

public FaqAnswerData.Builder setAnswer(String value)

 The piece of text from the `source` knowledge base document.
 

string answer = 1;

Parameters:

value - The answer to set.

Returns:

This builder for chaining.

clearAnswer

public FaqAnswerData.Builder clearAnswer()

 The piece of text from the `source` knowledge base document.
 

string answer = 1;

Returns:

This builder for chaining.

setAnswerBytes

public FaqAnswerData.Builder setAnswerBytes(com.google.protobuf.ByteString value)

 The piece of text from the `source` knowledge base document.
 

string answer = 1;

Parameters:

value - The bytes for answer to set.

Returns:

This builder for chaining.

getConfidenceScore

public float getConfidenceScore()

 The system's confidence score that this answer is a good match for this
 conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely
 certain).
 

float confidence_score = 2;

Specified by:

getConfidenceScore in interface FaqAnswerDataOrBuilder

Returns:

The confidenceScore.

setConfidenceScore

public FaqAnswerData.Builder setConfidenceScore(float value)

 The system's confidence score that this answer is a good match for this
 conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely
 certain).
 

float confidence_score = 2;

Parameters:

value - The confidenceScore to set.

Returns:

This builder for chaining.

clearConfidenceScore

public FaqAnswerData.Builder clearConfidenceScore()

 The system's confidence score that this answer is a good match for this
 conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely
 certain).
 

float confidence_score = 2;

Returns:

This builder for chaining.

getQuestion

public String getQuestion()

 The corresponding FAQ question.
 

string question = 3;

Specified by:

getQuestion in interface FaqAnswerDataOrBuilder

Returns:

The question.

getQuestionBytes

public com.google.protobuf.ByteString getQuestionBytes()

 The corresponding FAQ question.
 

string question = 3;

Specified by:

getQuestionBytes in interface FaqAnswerDataOrBuilder

Returns:

The bytes for question.

setQuestion

public FaqAnswerData.Builder setQuestion(String value)

 The corresponding FAQ question.
 

string question = 3;

Parameters:

value - The question to set.

Returns:

This builder for chaining.

clearQuestion

public FaqAnswerData.Builder clearQuestion()

 The corresponding FAQ question.
 

string question = 3;

Returns:

This builder for chaining.

setQuestionBytes

public FaqAnswerData.Builder setQuestionBytes(com.google.protobuf.ByteString value)

 The corresponding FAQ question.
 

string question = 3;

Parameters:

value - The bytes for question to set.

Returns:

This builder for chaining.

getMetadataCount

public int getMetadataCount()

Description copied from interface: FaqAnswerDataOrBuilder

 Map that contains metadata about the FAQ answer and the document that
 it originates from.
 

map<string, string> metadata = 4;

Specified by:

getMetadataCount in interface FaqAnswerDataOrBuilder

containsMetadata

public boolean containsMetadata(String key)

 Map that contains metadata about the FAQ answer and the document that
 it originates from.
 

map<string, string> metadata = 4;

Specified by:

containsMetadata in interface FaqAnswerDataOrBuilder

getMetadata

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

Deprecated.

Use getMetadataMap() instead.

Specified by:

getMetadata in interface FaqAnswerDataOrBuilder

getMetadataMap

public Map<String,String> getMetadataMap()

 Map that contains metadata about the FAQ answer and the document that
 it originates from.
 

map<string, string> metadata = 4;

Specified by:

getMetadataMap in interface FaqAnswerDataOrBuilder

getMetadataOrDefault

public String getMetadataOrDefault(String key,
                                   String defaultValue)

 Map that contains metadata about the FAQ answer and the document that
 it originates from.
 

map<string, string> metadata = 4;

Specified by:

getMetadataOrDefault in interface FaqAnswerDataOrBuilder

getMetadataOrThrow

public String getMetadataOrThrow(String key)

 Map that contains metadata about the FAQ answer and the document that
 it originates from.
 

map<string, string> metadata = 4;

Specified by:

getMetadataOrThrow in interface FaqAnswerDataOrBuilder

clearMetadata

public FaqAnswerData.Builder clearMetadata()

removeMetadata

public FaqAnswerData.Builder removeMetadata(String key)

 Map that contains metadata about the FAQ answer and the document that
 it originates from.
 

map<string, string> metadata = 4;

getMutableMetadata

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

Deprecated.

Use alternate mutation accessors instead.

putMetadata

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

 Map that contains metadata about the FAQ answer and the document that
 it originates from.
 

map<string, string> metadata = 4;

putAllMetadata

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

 Map that contains metadata about the FAQ answer and the document that
 it originates from.
 

map<string, string> metadata = 4;

getQueryRecord

public String getQueryRecord()

 The name of the answer record.
 Format:
 projects/{project}/locations/{location}/answerRecords/{answer_record}
 

string query_record = 5;

Specified by:

getQueryRecord in interface FaqAnswerDataOrBuilder

Returns:

The queryRecord.

getQueryRecordBytes

public com.google.protobuf.ByteString getQueryRecordBytes()

 The name of the answer record.
 Format:
 projects/{project}/locations/{location}/answerRecords/{answer_record}
 

string query_record = 5;

Specified by:

getQueryRecordBytes in interface FaqAnswerDataOrBuilder

Returns:

The bytes for queryRecord.

setQueryRecord

public FaqAnswerData.Builder setQueryRecord(String value)

 The name of the answer record.
 Format:
 projects/{project}/locations/{location}/answerRecords/{answer_record}
 

string query_record = 5;

Parameters:

value - The queryRecord to set.

Returns:

This builder for chaining.

clearQueryRecord

public FaqAnswerData.Builder clearQueryRecord()

 The name of the answer record.
 Format:
 projects/{project}/locations/{location}/answerRecords/{answer_record}
 

string query_record = 5;

Returns:

This builder for chaining.

setQueryRecordBytes

public FaqAnswerData.Builder setQueryRecordBytes(com.google.protobuf.ByteString value)

 The name of the answer record.
 Format:
 projects/{project}/locations/{location}/answerRecords/{answer_record}
 

string query_record = 5;

Parameters:

value - The bytes for queryRecord to set.

Returns:

This builder for chaining.

getSource

public String getSource()

 The knowledge document that this answer was extracted from.
 Format:
 projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}.
 

string source = 6;

Specified by:

getSource in interface FaqAnswerDataOrBuilder

Returns:

The source.

getSourceBytes

public com.google.protobuf.ByteString getSourceBytes()

 The knowledge document that this answer was extracted from.
 Format:
 projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}.
 

string source = 6;

Specified by:

getSourceBytes in interface FaqAnswerDataOrBuilder

Returns:

The bytes for source.

setSource

public FaqAnswerData.Builder setSource(String value)

 The knowledge document that this answer was extracted from.
 Format:
 projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}.
 

string source = 6;

Parameters:

value - The source to set.

Returns:

This builder for chaining.

clearSource

public FaqAnswerData.Builder clearSource()

 The knowledge document that this answer was extracted from.
 Format:
 projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}.
 

string source = 6;

Returns:

This builder for chaining.

setSourceBytes

public FaqAnswerData.Builder setSourceBytes(com.google.protobuf.ByteString value)

 The knowledge document that this answer was extracted from.
 Format:
 projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}.
 

string source = 6;

Parameters:

value - The bytes for source to set.

Returns:

This builder for chaining.

setUnknownFields

public final FaqAnswerData.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<FaqAnswerData.Builder>

mergeUnknownFields

public final FaqAnswerData.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<FaqAnswerData.Builder>