Class AssistantSuggestion (0.19.0)

public final class AssistantSuggestion extends GeneratedMessage implements AssistantSuggestionOrBuilder

A single personalized onboarding suggestion chip for Arc's zero state.

Protobuf type google.cloud.ces.v1beta.AssistantSuggestion

Static Fields

CANDIDATE_TYPE_FIELD_NUMBER

public static final int CANDIDATE_TYPE_FIELD_NUMBER
Field Value
Type Description
int

ICON_FIELD_NUMBER

public static final int ICON_FIELD_NUMBER
Field Value
Type Description
int

LABEL_FIELD_NUMBER

public static final int LABEL_FIELD_NUMBER
Field Value
Type Description
int

LOAD_SESSION_FIELD_NUMBER

public static final int LOAD_SESSION_FIELD_NUMBER
Field Value
Type Description
int

RATIONALE_FIELD_NUMBER

public static final int RATIONALE_FIELD_NUMBER
Field Value
Type Description
int

SEED_PROMPT_FIELD_NUMBER

public static final int SEED_PROMPT_FIELD_NUMBER
Field Value
Type Description
int

SEND_MESSAGE_FIELD_NUMBER

public static final int SEND_MESSAGE_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_FIELD_NUMBER

public static final int SOURCE_FIELD_NUMBER
Field Value
Type Description
int

SUGGESTION_ID_FIELD_NUMBER

public static final int SUGGESTION_ID_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AssistantSuggestion getDefaultInstance()
Returns
Type Description
AssistantSuggestion

getDescriptor()

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

newBuilder()

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

newBuilder(AssistantSuggestion prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getActionCase()

public AssistantSuggestion.ActionCase getActionCase()
Returns
Type Description
AssistantSuggestion.ActionCase

getCandidateType()

public String getCandidateType()

Rule-table candidate type in kebab-case (e.g. "resume-pending-review"), for metrics.

string candidate_type = 9;

Returns
Type Description
String

The candidateType.

getCandidateTypeBytes()

public ByteString getCandidateTypeBytes()

Rule-table candidate type in kebab-case (e.g. "resume-pending-review"), for metrics.

string candidate_type = 9;

Returns
Type Description
ByteString

The bytes for candidateType.

getDefaultInstanceForType()

public AssistantSuggestion getDefaultInstanceForType()
Returns
Type Description
AssistantSuggestion

getIcon()

public AssistantSuggestion.Icon getIcon()

Icon hint for the chip.

.google.cloud.ces.v1beta.AssistantSuggestion.Icon icon = 4;

Returns
Type Description
AssistantSuggestion.Icon

The icon.

getIconValue()

public int getIconValue()

Icon hint for the chip.

.google.cloud.ces.v1beta.AssistantSuggestion.Icon icon = 4;

Returns
Type Description
int

The enum numeric value on the wire for icon.

getLabel()

public String getLabel()

Chip label shown to the user (at most 60 characters).

string label = 2;

Returns
Type Description
String

The label.

getLabelBytes()

public ByteString getLabelBytes()

Chip label shown to the user (at most 60 characters).

string label = 2;

Returns
Type Description
ByteString

The bytes for label.

getLoadSession()

public AssistantSuggestion.LoadSession getLoadSession()

Open an existing assistant session.

.google.cloud.ces.v1beta.AssistantSuggestion.LoadSession load_session = 6;

Returns
Type Description
AssistantSuggestion.LoadSession

The loadSession.

getLoadSessionOrBuilder()

public AssistantSuggestion.LoadSessionOrBuilder getLoadSessionOrBuilder()

Open an existing assistant session.

.google.cloud.ces.v1beta.AssistantSuggestion.LoadSession load_session = 6;

Returns
Type Description
AssistantSuggestion.LoadSessionOrBuilder

getParserForType()

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

getRationale()

public String getRationale()

Optional short explanation of why this suggestion is shown (tooltip / rationale popover).

string rationale = 3;

Returns
Type Description
String

The rationale.

getRationaleBytes()

public ByteString getRationaleBytes()

Optional short explanation of why this suggestion is shown (tooltip / rationale popover).

string rationale = 3;

Returns
Type Description
ByteString

The bytes for rationale.

getSeedPrompt()

public String getSeedPrompt()

Prefill the composer with this text; the user reviews and sends.

string seed_prompt = 5;

Returns
Type Description
String

The seedPrompt.

getSeedPromptBytes()

public ByteString getSeedPromptBytes()

Prefill the composer with this text; the user reviews and sends.

string seed_prompt = 5;

Returns
Type Description
ByteString

The bytes for seedPrompt.

getSendMessage()

public String getSendMessage()

Prefill the composer with this text and submit immediately. Only used for quick-reply chips inside an active onboarding conversation.

string send_message = 7;

Returns
Type Description
String

The sendMessage.

getSendMessageBytes()

public ByteString getSendMessageBytes()

Prefill the composer with this text and submit immediately. Only used for quick-reply chips inside an active onboarding conversation.

string send_message = 7;

Returns
Type Description
ByteString

The bytes for sendMessage.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSource()

public AssistantSuggestion.Source getSource()

How this suggestion was produced.

.google.cloud.ces.v1beta.AssistantSuggestion.Source source = 8;

Returns
Type Description
AssistantSuggestion.Source

The source.

getSourceValue()

public int getSourceValue()

How this suggestion was produced.

.google.cloud.ces.v1beta.AssistantSuggestion.Source source = 8;

Returns
Type Description
int

The enum numeric value on the wire for source.

getSuggestionId()

public String getSuggestionId()

Stable identifier for this suggestion, round-tripped by clients in interaction logging.

string suggestion_id = 1;

Returns
Type Description
String

The suggestionId.

getSuggestionIdBytes()

public ByteString getSuggestionIdBytes()

Stable identifier for this suggestion, round-tripped by clients in interaction logging.

string suggestion_id = 1;

Returns
Type Description
ByteString

The bytes for suggestionId.

hasLoadSession()

public boolean hasLoadSession()

Open an existing assistant session.

.google.cloud.ces.v1beta.AssistantSuggestion.LoadSession load_session = 6;

Returns
Type Description
boolean

Whether the loadSession field is set.

hasSeedPrompt()

public boolean hasSeedPrompt()

Prefill the composer with this text; the user reviews and sends.

string seed_prompt = 5;

Returns
Type Description
boolean

Whether the seedPrompt field is set.

hasSendMessage()

public boolean hasSendMessage()

Prefill the composer with this text and submit immediately. Only used for quick-reply chips inside an active onboarding conversation.

string send_message = 7;

Returns
Type Description
boolean

Whether the sendMessage field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(AbstractMessage.BuilderParent parent)

protected AssistantSuggestion.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
AssistantSuggestion.Builder
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

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