Class AssistantSuggestion.Builder (0.19.0)

public static final class AssistantSuggestion.Builder extends GeneratedMessage.Builder<AssistantSuggestion.Builder> implements AssistantSuggestionOrBuilder

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

Protobuf type google.cloud.ces.v1beta.AssistantSuggestion

Static Methods

getDescriptor()

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

Methods

build()

public AssistantSuggestion build()
Returns
Type Description
AssistantSuggestion

buildPartial()

public AssistantSuggestion buildPartial()
Returns
Type Description
AssistantSuggestion

clear()

public AssistantSuggestion.Builder clear()
Returns
Type Description
AssistantSuggestion.Builder
Overrides

clearAction()

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

clearCandidateType()

public AssistantSuggestion.Builder clearCandidateType()

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

string candidate_type = 9;

Returns
Type Description
AssistantSuggestion.Builder

This builder for chaining.

clearIcon()

public AssistantSuggestion.Builder clearIcon()

Icon hint for the chip.

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

Returns
Type Description
AssistantSuggestion.Builder

This builder for chaining.

clearLabel()

public AssistantSuggestion.Builder clearLabel()

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

string label = 2;

Returns
Type Description
AssistantSuggestion.Builder

This builder for chaining.

clearLoadSession()

public AssistantSuggestion.Builder clearLoadSession()

Open an existing assistant session.

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

Returns
Type Description
AssistantSuggestion.Builder

clearRationale()

public AssistantSuggestion.Builder clearRationale()

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

string rationale = 3;

Returns
Type Description
AssistantSuggestion.Builder

This builder for chaining.

clearSeedPrompt()

public AssistantSuggestion.Builder clearSeedPrompt()

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

string seed_prompt = 5;

Returns
Type Description
AssistantSuggestion.Builder

This builder for chaining.

clearSendMessage()

public AssistantSuggestion.Builder clearSendMessage()

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
AssistantSuggestion.Builder

This builder for chaining.

clearSource()

public AssistantSuggestion.Builder clearSource()

How this suggestion was produced.

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

Returns
Type Description
AssistantSuggestion.Builder

This builder for chaining.

clearSuggestionId()

public AssistantSuggestion.Builder clearSuggestionId()

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

string suggestion_id = 1;

Returns
Type Description
AssistantSuggestion.Builder

This builder for chaining.

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getLoadSessionBuilder()

public AssistantSuggestion.LoadSession.Builder getLoadSessionBuilder()

Open an existing assistant session.

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

Returns
Type Description
AssistantSuggestion.LoadSession.Builder

getLoadSessionOrBuilder()

public AssistantSuggestion.LoadSessionOrBuilder getLoadSessionOrBuilder()

Open an existing assistant session.

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

Returns
Type Description
AssistantSuggestion.LoadSessionOrBuilder

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.

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(AssistantSuggestion other)

public AssistantSuggestion.Builder mergeFrom(AssistantSuggestion other)
Parameter
Name Description
other AssistantSuggestion
Returns
Type Description
AssistantSuggestion.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AssistantSuggestion.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AssistantSuggestion.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public AssistantSuggestion.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
AssistantSuggestion.Builder
Overrides

mergeLoadSession(AssistantSuggestion.LoadSession value)

public AssistantSuggestion.Builder mergeLoadSession(AssistantSuggestion.LoadSession value)

Open an existing assistant session.

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

Parameter
Name Description
value AssistantSuggestion.LoadSession
Returns
Type Description
AssistantSuggestion.Builder

setCandidateType(String value)

public AssistantSuggestion.Builder setCandidateType(String value)

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

string candidate_type = 9;

Parameter
Name Description
value String

The candidateType to set.

Returns
Type Description
AssistantSuggestion.Builder

This builder for chaining.

setCandidateTypeBytes(ByteString value)

public AssistantSuggestion.Builder setCandidateTypeBytes(ByteString value)

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

string candidate_type = 9;

Parameter
Name Description
value ByteString

The bytes for candidateType to set.

Returns
Type Description
AssistantSuggestion.Builder

This builder for chaining.

setIcon(AssistantSuggestion.Icon value)

public AssistantSuggestion.Builder setIcon(AssistantSuggestion.Icon value)

Icon hint for the chip.

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

Parameter
Name Description
value AssistantSuggestion.Icon

The icon to set.

Returns
Type Description
AssistantSuggestion.Builder

This builder for chaining.

setIconValue(int value)

public AssistantSuggestion.Builder setIconValue(int value)

Icon hint for the chip.

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

Parameter
Name Description
value int

The enum numeric value on the wire for icon to set.

Returns
Type Description
AssistantSuggestion.Builder

This builder for chaining.

setLabel(String value)

public AssistantSuggestion.Builder setLabel(String value)

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

string label = 2;

Parameter
Name Description
value String

The label to set.

Returns
Type Description
AssistantSuggestion.Builder

This builder for chaining.

setLabelBytes(ByteString value)

public AssistantSuggestion.Builder setLabelBytes(ByteString value)

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

string label = 2;

Parameter
Name Description
value ByteString

The bytes for label to set.

Returns
Type Description
AssistantSuggestion.Builder

This builder for chaining.

setLoadSession(AssistantSuggestion.LoadSession value)

public AssistantSuggestion.Builder setLoadSession(AssistantSuggestion.LoadSession value)

Open an existing assistant session.

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

Parameter
Name Description
value AssistantSuggestion.LoadSession
Returns
Type Description
AssistantSuggestion.Builder

setLoadSession(AssistantSuggestion.LoadSession.Builder builderForValue)

public AssistantSuggestion.Builder setLoadSession(AssistantSuggestion.LoadSession.Builder builderForValue)

Open an existing assistant session.

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

Parameter
Name Description
builderForValue AssistantSuggestion.LoadSession.Builder
Returns
Type Description
AssistantSuggestion.Builder

setRationale(String value)

public AssistantSuggestion.Builder setRationale(String value)

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

string rationale = 3;

Parameter
Name Description
value String

The rationale to set.

Returns
Type Description
AssistantSuggestion.Builder

This builder for chaining.

setRationaleBytes(ByteString value)

public AssistantSuggestion.Builder setRationaleBytes(ByteString value)

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

string rationale = 3;

Parameter
Name Description
value ByteString

The bytes for rationale to set.

Returns
Type Description
AssistantSuggestion.Builder

This builder for chaining.

setSeedPrompt(String value)

public AssistantSuggestion.Builder setSeedPrompt(String value)

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

string seed_prompt = 5;

Parameter
Name Description
value String

The seedPrompt to set.

Returns
Type Description
AssistantSuggestion.Builder

This builder for chaining.

setSeedPromptBytes(ByteString value)

public AssistantSuggestion.Builder setSeedPromptBytes(ByteString value)

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

string seed_prompt = 5;

Parameter
Name Description
value ByteString

The bytes for seedPrompt to set.

Returns
Type Description
AssistantSuggestion.Builder

This builder for chaining.

setSendMessage(String value)

public AssistantSuggestion.Builder setSendMessage(String value)

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

string send_message = 7;

Parameter
Name Description
value String

The sendMessage to set.

Returns
Type Description
AssistantSuggestion.Builder

This builder for chaining.

setSendMessageBytes(ByteString value)

public AssistantSuggestion.Builder setSendMessageBytes(ByteString value)

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

string send_message = 7;

Parameter
Name Description
value ByteString

The bytes for sendMessage to set.

Returns
Type Description
AssistantSuggestion.Builder

This builder for chaining.

setSource(AssistantSuggestion.Source value)

public AssistantSuggestion.Builder setSource(AssistantSuggestion.Source value)

How this suggestion was produced.

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

Parameter
Name Description
value AssistantSuggestion.Source

The source to set.

Returns
Type Description
AssistantSuggestion.Builder

This builder for chaining.

setSourceValue(int value)

public AssistantSuggestion.Builder setSourceValue(int value)

How this suggestion was produced.

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

Parameter
Name Description
value int

The enum numeric value on the wire for source to set.

Returns
Type Description
AssistantSuggestion.Builder

This builder for chaining.

setSuggestionId(String value)

public AssistantSuggestion.Builder setSuggestionId(String value)

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

string suggestion_id = 1;

Parameter
Name Description
value String

The suggestionId to set.

Returns
Type Description
AssistantSuggestion.Builder

This builder for chaining.

setSuggestionIdBytes(ByteString value)

public AssistantSuggestion.Builder setSuggestionIdBytes(ByteString value)

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

string suggestion_id = 1;

Parameter
Name Description
value ByteString

The bytes for suggestionId to set.

Returns
Type Description
AssistantSuggestion.Builder

This builder for chaining.