Class GenerateSuggestionsRequest.Builder (4.66.0)

public static final class GenerateSuggestionsRequest.Builder extends GeneratedMessageV3.Builder<GenerateSuggestionsRequest.Builder> implements GenerateSuggestionsRequestOrBuilder

The request message for Conversations.GenerateSuggestions.

Protobuf type google.cloud.dialogflow.v2beta1.GenerateSuggestionsRequest

Static Methods

getDescriptor()

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

Methods

addAllTriggerEvents(Iterable<? extends TriggerEvent> values)

public GenerateSuggestionsRequest.Builder addAllTriggerEvents(Iterable<? extends TriggerEvent> values)

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
values Iterable<? extends com.google.cloud.dialogflow.v2beta1.TriggerEvent>

The triggerEvents to add.

Returns
Type Description
GenerateSuggestionsRequest.Builder

This builder for chaining.

addAllTriggerEventsValue(Iterable<Integer> values)

public GenerateSuggestionsRequest.Builder addAllTriggerEventsValue(Iterable<Integer> values)

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
values Iterable<Integer>

The enum numeric values on the wire for triggerEvents to add.

Returns
Type Description
GenerateSuggestionsRequest.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public GenerateSuggestionsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
GenerateSuggestionsRequest.Builder
Overrides

addTriggerEvents(TriggerEvent value)

public GenerateSuggestionsRequest.Builder addTriggerEvents(TriggerEvent value)

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
value TriggerEvent

The triggerEvents to add.

Returns
Type Description
GenerateSuggestionsRequest.Builder

This builder for chaining.

addTriggerEventsValue(int value)

public GenerateSuggestionsRequest.Builder addTriggerEventsValue(int value)

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
value int

The enum numeric value on the wire for triggerEvents to add.

Returns
Type Description
GenerateSuggestionsRequest.Builder

This builder for chaining.

build()

public GenerateSuggestionsRequest build()
Returns
Type Description
GenerateSuggestionsRequest

buildPartial()

public GenerateSuggestionsRequest buildPartial()
Returns
Type Description
GenerateSuggestionsRequest

clear()

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

clearConversation()

public GenerateSuggestionsRequest.Builder clearConversation()

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

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public GenerateSuggestionsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
GenerateSuggestionsRequest.Builder
Overrides

clearLatestMessage()

public GenerateSuggestionsRequest.Builder clearLatestMessage()

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

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public GenerateSuggestionsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
GenerateSuggestionsRequest.Builder
Overrides

clearTriggerEvents()

public GenerateSuggestionsRequest.Builder clearTriggerEvents()

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

This builder for chaining.

clone()

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

getDescriptorForType()

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

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.

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(GenerateSuggestionsRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final GenerateSuggestionsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
GenerateSuggestionsRequest.Builder
Overrides

setConversation(String value)

public GenerateSuggestionsRequest.Builder setConversation(String value)

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) = { ... }

Parameter
Name Description
value String

The conversation to set.

Returns
Type Description
GenerateSuggestionsRequest.Builder

This builder for chaining.

setConversationBytes(ByteString value)

public GenerateSuggestionsRequest.Builder setConversationBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for conversation to set.

Returns
Type Description
GenerateSuggestionsRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public GenerateSuggestionsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
GenerateSuggestionsRequest.Builder
Overrides

setLatestMessage(String value)

public GenerateSuggestionsRequest.Builder setLatestMessage(String value)

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) = { ... }

Parameter
Name Description
value String

The latestMessage to set.

Returns
Type Description
GenerateSuggestionsRequest.Builder

This builder for chaining.

setLatestMessageBytes(ByteString value)

public GenerateSuggestionsRequest.Builder setLatestMessageBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for latestMessage to set.

Returns
Type Description
GenerateSuggestionsRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public GenerateSuggestionsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
GenerateSuggestionsRequest.Builder
Overrides

setTriggerEvents(int index, TriggerEvent value)

public GenerateSuggestionsRequest.Builder setTriggerEvents(int index, TriggerEvent value)

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];

Parameters
Name Description
index int

The index to set the value at.

value TriggerEvent

The triggerEvents to set.

Returns
Type Description
GenerateSuggestionsRequest.Builder

This builder for chaining.

setTriggerEventsValue(int index, int value)

public GenerateSuggestionsRequest.Builder setTriggerEventsValue(int index, int value)

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];

Parameters
Name Description
index int

The index to set the value at.

value int

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

Returns
Type Description
GenerateSuggestionsRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final GenerateSuggestionsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
GenerateSuggestionsRequest.Builder
Overrides