Class Message (4.61.0)

public final class Message extends GeneratedMessageV3 implements MessageOrBuilder

Represents a message posted into a conversation.

Protobuf type google.cloud.dialogflow.v2beta1.Message

Implements

MessageOrBuilder

Static Fields

CONTENT_FIELD_NUMBER

public static final int CONTENT_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

LANGUAGE_CODE_FIELD_NUMBER

public static final int LANGUAGE_CODE_FIELD_NUMBER
Field Value
Type Description
int

MESSAGE_ANNOTATION_FIELD_NUMBER

public static final int MESSAGE_ANNOTATION_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PARTICIPANT_FIELD_NUMBER

public static final int PARTICIPANT_FIELD_NUMBER
Field Value
Type Description
int

PARTICIPANT_ROLE_FIELD_NUMBER

public static final int PARTICIPANT_ROLE_FIELD_NUMBER
Field Value
Type Description
int

RESPONSE_MESSAGES_FIELD_NUMBER

public static final int RESPONSE_MESSAGES_FIELD_NUMBER
Field Value
Type Description
int

SEND_TIME_FIELD_NUMBER

public static final int SEND_TIME_FIELD_NUMBER
Field Value
Type Description
int

SENTIMENT_ANALYSIS_FIELD_NUMBER

public static final int SENTIMENT_ANALYSIS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Message getDefaultInstance()
Returns
Type Description
Message

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Message.Builder newBuilder()
Returns
Type Description
Message.Builder

newBuilder(Message prototype)

public static Message.Builder newBuilder(Message prototype)
Parameter
Name Description
prototype Message
Returns
Type Description
Message.Builder

parseDelimitedFrom(InputStream input)

public static Message parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Message
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Message parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Message
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Message parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Message
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Message parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Message
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Message parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Message
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Message parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Message
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Message parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Message
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Message parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Message
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Message parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Message
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Message parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Message
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Message parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Message
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Message parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Message
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Message> parser()
Returns
Type Description
Parser<Message>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getContent()

public String getContent()

Required. The message content.

string content = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The content.

getContentBytes()

public ByteString getContentBytes()

Required. The message content.

string content = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for content.

getCreateTime()

public Timestamp getCreateTime()

Output only. The time when the message was created in Contact Center AI.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time when the message was created in Contact Center AI.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Message getDefaultInstanceForType()
Returns
Type Description
Message

getLanguageCode()

public String getLanguageCode()

Optional. The message language. This should be a BCP-47 language tag. Example: "en-US".

string language_code = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The languageCode.

getLanguageCodeBytes()

public ByteString getLanguageCodeBytes()

Optional. The message language. This should be a BCP-47 language tag. Example: "en-US".

string language_code = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for languageCode.

getMessageAnnotation()

public MessageAnnotation getMessageAnnotation()

Output only. The annotation for the message.

.google.cloud.dialogflow.v2beta1.MessageAnnotation message_annotation = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
MessageAnnotation

The messageAnnotation.

getMessageAnnotationOrBuilder()

public MessageAnnotationOrBuilder getMessageAnnotationOrBuilder()

Output only. The annotation for the message.

.google.cloud.dialogflow.v2beta1.MessageAnnotation message_annotation = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
MessageAnnotationOrBuilder

getName()

public String getName()

Optional. The unique identifier of the message. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/messages/<Message ID>.

string name = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Optional. The unique identifier of the message. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/messages/<Message ID>.

string name = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<Message> getParserForType()
Returns
Type Description
Parser<Message>
Overrides

getParticipant()

public String getParticipant()

Output only. The participant that sends this message.

string participant = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The participant.

getParticipantBytes()

public ByteString getParticipantBytes()

Output only. The participant that sends this message.

string participant = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for participant.

getParticipantRole()

public Participant.Role getParticipantRole()

Output only. The role of the participant.

.google.cloud.dialogflow.v2beta1.Participant.Role participant_role = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Participant.Role

The participantRole.

getParticipantRoleValue()

public int getParticipantRoleValue()

Output only. The role of the participant.

.google.cloud.dialogflow.v2beta1.Participant.Role participant_role = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for participantRole.

getResponseMessages(int index)

public ResponseMessage getResponseMessages(int index)

Optional. Automated agent responses.

repeated .google.cloud.dialogflow.v2beta1.ResponseMessage response_messages = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
ResponseMessage

getResponseMessagesCount()

public int getResponseMessagesCount()

Optional. Automated agent responses.

repeated .google.cloud.dialogflow.v2beta1.ResponseMessage response_messages = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getResponseMessagesList()

public List<ResponseMessage> getResponseMessagesList()

Optional. Automated agent responses.

repeated .google.cloud.dialogflow.v2beta1.ResponseMessage response_messages = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<ResponseMessage>

getResponseMessagesOrBuilder(int index)

public ResponseMessageOrBuilder getResponseMessagesOrBuilder(int index)

Optional. Automated agent responses.

repeated .google.cloud.dialogflow.v2beta1.ResponseMessage response_messages = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
ResponseMessageOrBuilder

getResponseMessagesOrBuilderList()

public List<? extends ResponseMessageOrBuilder> getResponseMessagesOrBuilderList()

Optional. Automated agent responses.

repeated .google.cloud.dialogflow.v2beta1.ResponseMessage response_messages = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.dialogflow.v2beta1.ResponseMessageOrBuilder>

getSendTime()

public Timestamp getSendTime()

Optional. The time when the message was sent.

.google.protobuf.Timestamp send_time = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Timestamp

The sendTime.

getSendTimeOrBuilder()

public TimestampOrBuilder getSendTimeOrBuilder()

Optional. The time when the message was sent.

.google.protobuf.Timestamp send_time = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TimestampOrBuilder

getSentimentAnalysis()

public SentimentAnalysisResult getSentimentAnalysis()

Output only. The sentiment analysis result for the message.

.google.cloud.dialogflow.v2beta1.SentimentAnalysisResult sentiment_analysis = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SentimentAnalysisResult

The sentimentAnalysis.

getSentimentAnalysisOrBuilder()

public SentimentAnalysisResultOrBuilder getSentimentAnalysisOrBuilder()

Output only. The sentiment analysis result for the message.

.google.cloud.dialogflow.v2beta1.SentimentAnalysisResult sentiment_analysis = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SentimentAnalysisResultOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasCreateTime()

public boolean hasCreateTime()

Output only. The time when the message was created in Contact Center AI.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasMessageAnnotation()

public boolean hasMessageAnnotation()

Output only. The annotation for the message.

.google.cloud.dialogflow.v2beta1.MessageAnnotation message_annotation = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the messageAnnotation field is set.

hasSendTime()

public boolean hasSendTime()

Optional. The time when the message was sent.

.google.protobuf.Timestamp send_time = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the sendTime field is set.

hasSentimentAnalysis()

public boolean hasSentimentAnalysis()

Output only. The sentiment analysis result for the message.

.google.cloud.dialogflow.v2beta1.SentimentAnalysisResult sentiment_analysis = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the sentimentAnalysis field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Message.Builder newBuilderForType()
Returns
Type Description
Message.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Message.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Message.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Message.Builder toBuilder()
Returns
Type Description
Message.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException