Class GenerateSuggestionsRequest.Builder (4.84.0)

Version latest

• 4.84.0 (latest)
• 4.82.0
• 4.81.0
• 4.80.0
• 4.79.0
• 4.78.0
• 4.76.0
• 4.74.0
• 4.73.0
• 4.70.0
• 4.69.0
• 4.68.0
• 4.66.0
• 4.65.0
• 4.64.0
• 4.63.0
• 4.62.0
• 4.61.0
• 4.60.0
• 4.59.0
• 4.58.0
• 4.57.0
• 4.55.0
• 4.54.0
• 4.53.0
• 4.52.0
• 4.51.0
• 4.50.0
• 4.49.0
• 4.48.0
• 4.47.0
• 4.46.0
• 4.45.0
• 4.43.0
• 4.42.0
• 4.41.0
• 4.40.0
• 4.39.0
• 4.38.0
• 4.37.0
• 4.36.0
• 4.35.0
• 4.34.0
• 4.33.0
• 4.30.0
• 4.29.0
• 4.28.0
• 4.27.0
• 4.26.0
• 4.25.0
• 4.24.0
• 4.23.0
• 4.22.0
• 4.21.0
• 4.20.0
• 4.19.0
• 4.18.0
• 4.17.0
• 4.15.0
• 4.14.0
• 4.13.0
• 4.12.0
• 4.11.0
• 4.10.0
• 4.9.1
• 4.8.6
• 4.7.5
• 4.6.0
• 4.5.11
• 4.4.0
• 4.3.1

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

The request message for Conversations.GenerateSuggestions.

Protobuf type google.cloud.dialogflow.v2.GenerateSuggestionsRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > GenerateSuggestionsRequest.Builder

Implements

GenerateSuggestionsRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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.v2.TriggerEvent trigger_events = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
values	Iterable<? extends com.google.cloud.dialogflow.v2.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.v2.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

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.clear()

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

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

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

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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

GeneratedMessageV3.Builder<BuilderType>.clone()

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

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public GenerateSuggestionsRequest.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
GenerateSuggestionsRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final GenerateSuggestionsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
GenerateSuggestionsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)