Interface GenerateSuggestionsRequestOrBuilder (4.66.0)

public interface GenerateSuggestionsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getConversation()

public abstract String getConversation()

Required. The conversation for which the suggestions are generated. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>.

The conversation must be created with a conversation profile which has generators configured in it to be able to get suggestions.

string conversation = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The conversation.

getConversationBytes()

public abstract ByteString getConversationBytes()

Required. The conversation for which the suggestions are generated. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>.

The conversation must be created with a conversation profile which has generators configured in it to be able to get suggestions.

string conversation = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for conversation.

getLatestMessage()

public abstract String getLatestMessage()

Optional. The name of the latest conversation message for which the request is triggered. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/messages/<Message ID>.

string latest_message = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The latestMessage.

getLatestMessageBytes()

public abstract ByteString getLatestMessageBytes()

Optional. The name of the latest conversation message for which the request is triggered. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/messages/<Message ID>.

string latest_message = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for latestMessage.

getTriggerEvents(int index)

public abstract TriggerEvent getTriggerEvents(int index)

Optional. A list of trigger events. Only generators configured in the conversation_profile whose trigger_event is listed here will be triggered.

repeated .google.cloud.dialogflow.v2beta1.TriggerEvent trigger_events = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
TriggerEvent

The triggerEvents at the given index.

getTriggerEventsCount()

public abstract int getTriggerEventsCount()

Optional. A list of trigger events. Only generators configured in the conversation_profile whose trigger_event is listed here will be triggered.

repeated .google.cloud.dialogflow.v2beta1.TriggerEvent trigger_events = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of triggerEvents.

getTriggerEventsList()

public abstract List<TriggerEvent> getTriggerEventsList()

Optional. A list of trigger events. Only generators configured in the conversation_profile whose trigger_event is listed here will be triggered.

repeated .google.cloud.dialogflow.v2beta1.TriggerEvent trigger_events = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<TriggerEvent>

A list containing the triggerEvents.

getTriggerEventsValue(int index)

public abstract int getTriggerEventsValue(int index)

Optional. A list of trigger events. Only generators configured in the conversation_profile whose trigger_event is listed here will be triggered.

repeated .google.cloud.dialogflow.v2beta1.TriggerEvent trigger_events = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
int

The enum numeric value on the wire of triggerEvents at the given index.

getTriggerEventsValueList()

public abstract List<Integer> getTriggerEventsValueList()

Optional. A list of trigger events. Only generators configured in the conversation_profile whose trigger_event is listed here will be triggered.

repeated .google.cloud.dialogflow.v2beta1.TriggerEvent trigger_events = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for triggerEvents.