Class GenerateSuggestionsRequest (4.66.0)

public final class GenerateSuggestionsRequest extends GeneratedMessageV3 implements GenerateSuggestionsRequestOrBuilder

The request message for Conversations.GenerateSuggestions.

Protobuf type google.cloud.dialogflow.v2beta1.GenerateSuggestionsRequest

Static Fields

CONVERSATION_FIELD_NUMBER

public static final int CONVERSATION_FIELD_NUMBER
Field Value
Type Description
int

LATEST_MESSAGE_FIELD_NUMBER

public static final int LATEST_MESSAGE_FIELD_NUMBER
Field Value
Type Description
int

TRIGGER_EVENTS_FIELD_NUMBER

public static final int TRIGGER_EVENTS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static GenerateSuggestionsRequest getDefaultInstance()
Returns
Type Description
GenerateSuggestionsRequest

getDescriptor()

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

newBuilder()

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

newBuilder(GenerateSuggestionsRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getConversation()

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

getDefaultInstanceForType()

public GenerateSuggestionsRequest getDefaultInstanceForType()
Returns
Type Description
GenerateSuggestionsRequest

getLatestMessage()

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

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTriggerEvents(int index)

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

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 GenerateSuggestionsRequest.Builder newBuilderForType()
Returns
Type Description
GenerateSuggestionsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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