Class Intent.Builder (4.27.0) 

public static final class Intent.Builder extends GeneratedMessageV3.Builder<Intent.Builder> implements IntentOrBuilder

An intent categorizes an end-user's intention for one conversation turn. For each agent, you define many intents, where your combined intents can handle a complete conversation. When an end-user writes or says something, referred to as an end-user expression or end-user input, Dialogflow matches the end-user input to the best intent in your agent. Matching an intent is also known as intent classification.

For more information, see the intent guide.

Protobuf type google.cloud.dialogflow.v2beta1.Intent

Inheritance

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

Implements

IntentOrBuilder

Static Methods

getDescriptor()

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

Methods

addAllDefaultResponsePlatforms(Iterable<? extends Intent.Message.Platform> values)

public Intent.Builder addAllDefaultResponsePlatforms(Iterable<? extends Intent.Message.Platform> values)

Optional. The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).

repeated .google.cloud.dialogflow.v2beta1.Intent.Message.Platform default_response_platforms = 15 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<? extends com.google.cloud.dialogflow.v2beta1.Intent.Message.Platform>

The defaultResponsePlatforms to add.
Returns
Type Description
Intent.Builder

This builder for chaining.

addAllDefaultResponsePlatformsValue(Iterable<Integer> values)

public Intent.Builder addAllDefaultResponsePlatformsValue(Iterable<Integer> values)

Optional. The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).

repeated .google.cloud.dialogflow.v2beta1.Intent.Message.Platform default_response_platforms = 15 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<Integer>

The enum numeric values on the wire for defaultResponsePlatforms to add.
Returns
Type Description
Intent.Builder

This builder for chaining.

addAllEvents(Iterable<String> values)

public Intent.Builder addAllEvents(Iterable<String> values)

Optional. The collection of event names that trigger the intent. If the collection of input contexts is not empty, all of the contexts must be present in the active user session for an event to trigger this intent. Event names are limited to 150 characters.

repeated string events = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<String>

The events to add.
Returns
Type Description
Intent.Builder

This builder for chaining.

addAllFollowupIntentInfo(Iterable<? extends Intent.FollowupIntentInfo> values)

public Intent.Builder addAllFollowupIntentInfo(Iterable<? extends Intent.FollowupIntentInfo> values)

Output only. Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output.

repeated .google.cloud.dialogflow.v2beta1.Intent.FollowupIntentInfo followup_intent_info = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
values Iterable<? extends com.google.cloud.dialogflow.v2beta1.Intent.FollowupIntentInfo>
Returns
Type Description
Intent.Builder

addAllInputContextNames(Iterable<String> values)

public Intent.Builder addAllInputContextNames(Iterable<String> values)

Optional. The list of context names required for this intent to be triggered. Formats:

  • projects/<Project ID>/agent/sessions/-/contexts/<Context ID>
  • projects/<Project ID>/locations/<Location ID>/agent/sessions/-/contexts/<Context ID>

repeated string input_context_names = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<String>

The inputContextNames to add.
Returns
Type Description
Intent.Builder

This builder for chaining.

addAllMessages(Iterable<? extends Intent.Message> values)

public Intent.Builder addAllMessages(Iterable<? extends Intent.Message> values)

Optional. The collection of rich messages corresponding to the Response field in the Dialogflow console.

repeated .google.cloud.dialogflow.v2beta1.Intent.Message messages = 14;

Parameter
Name Description
values Iterable<? extends com.google.cloud.dialogflow.v2beta1.Intent.Message>
Returns
Type Description
Intent.Builder

addAllOutputContexts(Iterable<? extends Context> values)

public Intent.Builder addAllOutputContexts(Iterable<? extends Context> values)

Optional. The collection of contexts that are activated when the intent is matched. Context messages in this collection should not set the parameters field. Setting the lifespan_count to 0 will reset the context when the intent is matched. Format: projects/<Project ID>/agent/sessions/-/contexts/<Context ID>.

repeated .google.cloud.dialogflow.v2beta1.Context output_contexts = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<? extends com.google.cloud.dialogflow.v2beta1.Context>
Returns
Type Description
Intent.Builder

addAllParameters(Iterable<? extends Intent.Parameter> values)

public Intent.Builder addAllParameters(Iterable<? extends Intent.Parameter> values)

Optional. The collection of parameters associated with the intent.

repeated .google.cloud.dialogflow.v2beta1.Intent.Parameter parameters = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<? extends com.google.cloud.dialogflow.v2beta1.Intent.Parameter>
Returns
Type Description
Intent.Builder

addAllTrainingPhrases(Iterable<? extends Intent.TrainingPhrase> values)

public Intent.Builder addAllTrainingPhrases(Iterable<? extends Intent.TrainingPhrase> values)

Optional. The collection of examples that the agent is trained on.

repeated .google.cloud.dialogflow.v2beta1.Intent.TrainingPhrase training_phrases = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<? extends com.google.cloud.dialogflow.v2beta1.Intent.TrainingPhrase>
Returns
Type Description
Intent.Builder

addDefaultResponsePlatforms(Intent.Message.Platform value)

public Intent.Builder addDefaultResponsePlatforms(Intent.Message.Platform value)

Optional. The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).

repeated .google.cloud.dialogflow.v2beta1.Intent.Message.Platform default_response_platforms = 15 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Intent.Message.Platform

The defaultResponsePlatforms to add.
Returns
Type Description
Intent.Builder

This builder for chaining.

addDefaultResponsePlatformsValue(int value)

public Intent.Builder addDefaultResponsePlatformsValue(int value)

Optional. The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).

repeated .google.cloud.dialogflow.v2beta1.Intent.Message.Platform default_response_platforms = 15 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The enum numeric value on the wire for defaultResponsePlatforms to add.
Returns
Type Description
Intent.Builder

This builder for chaining.

addEvents(String value)

public Intent.Builder addEvents(String value)

Optional. The collection of event names that trigger the intent. If the collection of input contexts is not empty, all of the contexts must be present in the active user session for an event to trigger this intent. Event names are limited to 150 characters.

repeated string events = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The events to add.
Returns
Type Description
Intent.Builder

This builder for chaining.

addEventsBytes(ByteString value)

public Intent.Builder addEventsBytes(ByteString value)

Optional. The collection of event names that trigger the intent. If the collection of input contexts is not empty, all of the contexts must be present in the active user session for an event to trigger this intent. Event names are limited to 150 characters.

repeated string events = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes of the events to add.
Returns
Type Description
Intent.Builder

This builder for chaining.

addFollowupIntentInfo(Intent.FollowupIntentInfo value)

public Intent.Builder addFollowupIntentInfo(Intent.FollowupIntentInfo value)

Output only. Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output.

repeated .google.cloud.dialogflow.v2beta1.Intent.FollowupIntentInfo followup_intent_info = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Intent.FollowupIntentInfo
Returns
Type Description
Intent.Builder

addFollowupIntentInfo(Intent.FollowupIntentInfo.Builder builderForValue)

public Intent.Builder addFollowupIntentInfo(Intent.FollowupIntentInfo.Builder builderForValue)

Output only. Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output.

repeated .google.cloud.dialogflow.v2beta1.Intent.FollowupIntentInfo followup_intent_info = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Intent.FollowupIntentInfo.Builder
Returns
Type Description
Intent.Builder

addFollowupIntentInfo(int index, Intent.FollowupIntentInfo value)

public Intent.Builder addFollowupIntentInfo(int index, Intent.FollowupIntentInfo value)

Output only. Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output.

repeated .google.cloud.dialogflow.v2beta1.Intent.FollowupIntentInfo followup_intent_info = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
value Intent.FollowupIntentInfo
Returns
Type Description
Intent.Builder

addFollowupIntentInfo(int index, Intent.FollowupIntentInfo.Builder builderForValue)

public Intent.Builder addFollowupIntentInfo(int index, Intent.FollowupIntentInfo.Builder builderForValue)

Output only. Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output.

repeated .google.cloud.dialogflow.v2beta1.Intent.FollowupIntentInfo followup_intent_info = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
builderForValue Intent.FollowupIntentInfo.Builder
Returns
Type Description
Intent.Builder

addFollowupIntentInfoBuilder()

public Intent.FollowupIntentInfo.Builder addFollowupIntentInfoBuilder()

Output only. Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output.

repeated .google.cloud.dialogflow.v2beta1.Intent.FollowupIntentInfo followup_intent_info = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Intent.FollowupIntentInfo.Builder

addFollowupIntentInfoBuilder(int index)

public Intent.FollowupIntentInfo.Builder addFollowupIntentInfoBuilder(int index)

Output only. Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output.

repeated .google.cloud.dialogflow.v2beta1.Intent.FollowupIntentInfo followup_intent_info = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
Intent.FollowupIntentInfo.Builder

addInputContextNames(String value)

public Intent.Builder addInputContextNames(String value)

Optional. The list of context names required for this intent to be triggered. Formats:

  • projects/<Project ID>/agent/sessions/-/contexts/<Context ID>
  • projects/<Project ID>/locations/<Location ID>/agent/sessions/-/contexts/<Context ID>

repeated string input_context_names = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The inputContextNames to add.
Returns
Type Description
Intent.Builder

This builder for chaining.

addInputContextNamesBytes(ByteString value)

public Intent.Builder addInputContextNamesBytes(ByteString value)

Optional. The list of context names required for this intent to be triggered. Formats:

  • projects/<Project ID>/agent/sessions/-/contexts/<Context ID>
  • projects/<Project ID>/locations/<Location ID>/agent/sessions/-/contexts/<Context ID>

repeated string input_context_names = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes of the inputContextNames to add.
Returns
Type Description
Intent.Builder

This builder for chaining.

addMessages(Intent.Message value)

public Intent.Builder addMessages(Intent.Message value)

Optional. The collection of rich messages corresponding to the Response field in the Dialogflow console.

repeated .google.cloud.dialogflow.v2beta1.Intent.Message messages = 14;

Parameter
Name Description
value Intent.Message
Returns
Type Description
Intent.Builder

addMessages(Intent.Message.Builder builderForValue)

public Intent.Builder addMessages(Intent.Message.Builder builderForValue)

Optional. The collection of rich messages corresponding to the Response field in the Dialogflow console.

repeated .google.cloud.dialogflow.v2beta1.Intent.Message messages = 14;

Parameter
Name Description
builderForValue Intent.Message.Builder
Returns
Type Description
Intent.Builder

addMessages(int index, Intent.Message value)

public Intent.Builder addMessages(int index, Intent.Message value)

Optional. The collection of rich messages corresponding to the Response field in the Dialogflow console.

repeated .google.cloud.dialogflow.v2beta1.Intent.Message messages = 14;

Parameters
Name Description
index int
value Intent.Message
Returns
Type Description
Intent.Builder

addMessages(int index, Intent.Message.Builder builderForValue)

public Intent.Builder addMessages(int index, Intent.Message.Builder builderForValue)

Optional. The collection of rich messages corresponding to the Response field in the Dialogflow console.

repeated .google.cloud.dialogflow.v2beta1.Intent.Message messages = 14;

Parameters
Name Description
index int
builderForValue Intent.Message.Builder
Returns
Type Description
Intent.Builder

addMessagesBuilder()

public Intent.Message.Builder addMessagesBuilder()

Optional. The collection of rich messages corresponding to the Response field in the Dialogflow console.

repeated .google.cloud.dialogflow.v2beta1.Intent.Message messages = 14;

Returns
Type Description
Intent.Message.Builder

addMessagesBuilder(int index)

public Intent.Message.Builder addMessagesBuilder(int index)

Optional. The collection of rich messages corresponding to the Response field in the Dialogflow console.

repeated .google.cloud.dialogflow.v2beta1.Intent.Message messages = 14;

Parameter
Name Description
index int
Returns
Type Description
Intent.Message.Builder

addOutputContexts(Context value)

public Intent.Builder addOutputContexts(Context value)

Optional. The collection of contexts that are activated when the intent is matched. Context messages in this collection should not set the parameters field. Setting the lifespan_count to 0 will reset the context when the intent is matched. Format: projects/<Project ID>/agent/sessions/-/contexts/<Context ID>.

repeated .google.cloud.dialogflow.v2beta1.Context output_contexts = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Context
Returns
Type Description
Intent.Builder

addOutputContexts(Context.Builder builderForValue)

public Intent.Builder addOutputContexts(Context.Builder builderForValue)

Optional. The collection of contexts that are activated when the intent is matched. Context messages in this collection should not set the parameters field. Setting the lifespan_count to 0 will reset the context when the intent is matched. Format: projects/<Project ID>/agent/sessions/-/contexts/<Context ID>.

repeated .google.cloud.dialogflow.v2beta1.Context output_contexts = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Context.Builder
Returns
Type Description
Intent.Builder

addOutputContexts(int index, Context value)

public Intent.Builder addOutputContexts(int index, Context value)

Optional. The collection of contexts that are activated when the intent is matched. Context messages in this collection should not set the parameters field. Setting the lifespan_count to 0 will reset the context when the intent is matched. Format: projects/<Project ID>/agent/sessions/-/contexts/<Context ID>.

repeated .google.cloud.dialogflow.v2beta1.Context output_contexts = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value Context
Returns
Type Description
Intent.Builder

addOutputContexts(int index, Context.Builder builderForValue)

public Intent.Builder addOutputContexts(int index, Context.Builder builderForValue)

Optional. The collection of contexts that are activated when the intent is matched. Context messages in this collection should not set the parameters field. Setting the lifespan_count to 0 will reset the context when the intent is matched. Format: projects/<Project ID>/agent/sessions/-/contexts/<Context ID>.

repeated .google.cloud.dialogflow.v2beta1.Context output_contexts = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue Context.Builder
Returns
Type Description
Intent.Builder

addOutputContextsBuilder()

public Context.Builder addOutputContextsBuilder()

Optional. The collection of contexts that are activated when the intent is matched. Context messages in this collection should not set the parameters field. Setting the lifespan_count to 0 will reset the context when the intent is matched. Format: projects/<Project ID>/agent/sessions/-/contexts/<Context ID>.

repeated .google.cloud.dialogflow.v2beta1.Context output_contexts = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Context.Builder

addOutputContextsBuilder(int index)

public Context.Builder addOutputContextsBuilder(int index)

Optional. The collection of contexts that are activated when the intent is matched. Context messages in this collection should not set the parameters field. Setting the lifespan_count to 0 will reset the context when the intent is matched. Format: projects/<Project ID>/agent/sessions/-/contexts/<Context ID>.

repeated .google.cloud.dialogflow.v2beta1.Context output_contexts = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Context.Builder

addParameters(Intent.Parameter value)

public Intent.Builder addParameters(Intent.Parameter value)

Optional. The collection of parameters associated with the intent.

repeated .google.cloud.dialogflow.v2beta1.Intent.Parameter parameters = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Intent.Parameter
Returns
Type Description
Intent.Builder

addParameters(Intent.Parameter.Builder builderForValue)

public Intent.Builder addParameters(Intent.Parameter.Builder builderForValue)

Optional. The collection of parameters associated with the intent.

repeated .google.cloud.dialogflow.v2beta1.Intent.Parameter parameters = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Intent.Parameter.Builder
Returns
Type Description
Intent.Builder

addParameters(int index, Intent.Parameter value)

public Intent.Builder addParameters(int index, Intent.Parameter value)

Optional. The collection of parameters associated with the intent.

repeated .google.cloud.dialogflow.v2beta1.Intent.Parameter parameters = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value Intent.Parameter
Returns
Type Description
Intent.Builder

addParameters(int index, Intent.Parameter.Builder builderForValue)

public Intent.Builder addParameters(int index, Intent.Parameter.Builder builderForValue)

Optional. The collection of parameters associated with the intent.

repeated .google.cloud.dialogflow.v2beta1.Intent.Parameter parameters = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue Intent.Parameter.Builder
Returns
Type Description
Intent.Builder

addParametersBuilder()

public Intent.Parameter.Builder addParametersBuilder()

Optional. The collection of parameters associated with the intent.

repeated .google.cloud.dialogflow.v2beta1.Intent.Parameter parameters = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Intent.Parameter.Builder

addParametersBuilder(int index)

public Intent.Parameter.Builder addParametersBuilder(int index)

Optional. The collection of parameters associated with the intent.

repeated .google.cloud.dialogflow.v2beta1.Intent.Parameter parameters = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Intent.Parameter.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

addTrainingPhrases(Intent.TrainingPhrase value)

public Intent.Builder addTrainingPhrases(Intent.TrainingPhrase value)

Optional. The collection of examples that the agent is trained on.

repeated .google.cloud.dialogflow.v2beta1.Intent.TrainingPhrase training_phrases = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Intent.TrainingPhrase
Returns
Type Description
Intent.Builder

addTrainingPhrases(Intent.TrainingPhrase.Builder builderForValue)

public Intent.Builder addTrainingPhrases(Intent.TrainingPhrase.Builder builderForValue)

Optional. The collection of examples that the agent is trained on.

repeated .google.cloud.dialogflow.v2beta1.Intent.TrainingPhrase training_phrases = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Intent.TrainingPhrase.Builder
Returns
Type Description
Intent.Builder

addTrainingPhrases(int index, Intent.TrainingPhrase value)

public Intent.Builder addTrainingPhrases(int index, Intent.TrainingPhrase value)

Optional. The collection of examples that the agent is trained on.

repeated .google.cloud.dialogflow.v2beta1.Intent.TrainingPhrase training_phrases = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value Intent.TrainingPhrase
Returns
Type Description
Intent.Builder

addTrainingPhrases(int index, Intent.TrainingPhrase.Builder builderForValue)

public Intent.Builder addTrainingPhrases(int index, Intent.TrainingPhrase.Builder builderForValue)

Optional. The collection of examples that the agent is trained on.

repeated .google.cloud.dialogflow.v2beta1.Intent.TrainingPhrase training_phrases = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue Intent.TrainingPhrase.Builder
Returns
Type Description
Intent.Builder

addTrainingPhrasesBuilder()

public Intent.TrainingPhrase.Builder addTrainingPhrasesBuilder()

Optional. The collection of examples that the agent is trained on.

repeated .google.cloud.dialogflow.v2beta1.Intent.TrainingPhrase training_phrases = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Intent.TrainingPhrase.Builder

addTrainingPhrasesBuilder(int index)

public Intent.TrainingPhrase.Builder addTrainingPhrasesBuilder(int index)

Optional. The collection of examples that the agent is trained on.

repeated .google.cloud.dialogflow.v2beta1.Intent.TrainingPhrase training_phrases = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Intent.TrainingPhrase.Builder

build()

public Intent build()
Returns
Type Description
Intent

buildPartial()

public Intent buildPartial()
Returns
Type Description
Intent

clear()

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

clearAction()

public Intent.Builder clearAction()

Optional. The name of the action associated with the intent. Note: The action name must not contain whitespaces.

string action = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Intent.Builder

This builder for chaining.

clearDefaultResponsePlatforms()

public Intent.Builder clearDefaultResponsePlatforms()

Optional. The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).

repeated .google.cloud.dialogflow.v2beta1.Intent.Message.Platform default_response_platforms = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Intent.Builder

This builder for chaining.

clearDisplayName()

public Intent.Builder clearDisplayName()

Required. The name of this intent.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Intent.Builder

This builder for chaining.

clearEndInteraction()

public Intent.Builder clearEndInteraction()

Optional. Indicates that this intent ends an interaction. Some integrations (e.g., Actions on Google or Dialogflow phone gateway) use this information to close interaction with an end user. Default is false.

bool end_interaction = 21 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Intent.Builder

This builder for chaining.

clearEvents()

public Intent.Builder clearEvents()

Optional. The collection of event names that trigger the intent. If the collection of input contexts is not empty, all of the contexts must be present in the active user session for an event to trigger this intent. Event names are limited to 150 characters.

repeated string events = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Intent.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearFollowupIntentInfo()

public Intent.Builder clearFollowupIntentInfo()

Output only. Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output.

repeated .google.cloud.dialogflow.v2beta1.Intent.FollowupIntentInfo followup_intent_info = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Intent.Builder

clearInputContextNames()

public Intent.Builder clearInputContextNames()

Optional. The list of context names required for this intent to be triggered. Formats:

  • projects/<Project ID>/agent/sessions/-/contexts/<Context ID>
  • projects/<Project ID>/locations/<Location ID>/agent/sessions/-/contexts/<Context ID>

repeated string input_context_names = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Intent.Builder

This builder for chaining.

clearIsFallback()

public Intent.Builder clearIsFallback()

Optional. Indicates whether this is a fallback intent.

bool is_fallback = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Intent.Builder

This builder for chaining.

clearLiveAgentHandoff()

public Intent.Builder clearLiveAgentHandoff()

Optional. Indicates that a live agent should be brought in to handle the interaction with the user. In most cases, when you set this flag to true, you would also want to set end_interaction to true as well. Default is false.

bool live_agent_handoff = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Intent.Builder

This builder for chaining.

clearMessages()

public Intent.Builder clearMessages()

Optional. The collection of rich messages corresponding to the Response field in the Dialogflow console.

repeated .google.cloud.dialogflow.v2beta1.Intent.Message messages = 14;

Returns
Type Description
Intent.Builder

clearMlDisabled()

public Intent.Builder clearMlDisabled()

Optional. Indicates whether Machine Learning is disabled for the intent. Note: If ml_disabled setting is set to true, then this intent is not taken into account during inference in ML ONLY match mode. Also, auto-markup in the UI is turned off.

bool ml_disabled = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Intent.Builder

This builder for chaining.

clearMlEnabled() (deprecated)

public Intent.Builder clearMlEnabled()

Deprecated. google.cloud.dialogflow.v2beta1.Intent.ml_enabled is deprecated. See google/cloud/dialogflow/v2beta1/intent.proto;l=1154

Optional. Indicates whether Machine Learning is enabled for the intent. Note: If ml_enabled setting is set to false, then this intent is not taken into account during inference in ML ONLY match mode. Also, auto-markup in the UI is turned off. DEPRECATED! Please use ml_disabled field instead. NOTE: If both ml_enabled and ml_disabled are either not set or false, then the default value is determined as follows:

  • Before April 15th, 2018 the default is: ml_enabled = false / ml_disabled = true.
  • After April 15th, 2018 the default is: ml_enabled = true / ml_disabled = false.

bool ml_enabled = 5 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Intent.Builder

This builder for chaining.

clearName()

public Intent.Builder clearName()

Optional. The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Supported formats:

  • projects/<Project ID>/agent/intents/<Intent ID>
  • projects/<Project ID>/locations/<Location ID>/agent/intents/<Intent ID>

string name = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Intent.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearOutputContexts()

public Intent.Builder clearOutputContexts()

Optional. The collection of contexts that are activated when the intent is matched. Context messages in this collection should not set the parameters field. Setting the lifespan_count to 0 will reset the context when the intent is matched. Format: projects/<Project ID>/agent/sessions/-/contexts/<Context ID>.

repeated .google.cloud.dialogflow.v2beta1.Context output_contexts = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Intent.Builder

clearParameters()

public Intent.Builder clearParameters()

Optional. The collection of parameters associated with the intent.

repeated .google.cloud.dialogflow.v2beta1.Intent.Parameter parameters = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Intent.Builder

clearParentFollowupIntentName()

public Intent.Builder clearParentFollowupIntentName()

Optional. The unique identifier of the parent intent in the chain of followup intents. You can set this field when creating an intent, for example with CreateIntent or BatchUpdateIntents, in order to make this intent a followup intent.

It identifies the parent followup intent. Format: projects/<Project ID>/agent/intents/<Intent ID>.

string parent_followup_intent_name = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Intent.Builder

This builder for chaining.

clearPriority()

public Intent.Builder clearPriority()

Optional. The priority of this intent. Higher numbers represent higher priorities.

  • If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the Normal priority in the console.
  • If the supplied value is negative, the intent is ignored in runtime detect intent requests.

int32 priority = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Intent.Builder

This builder for chaining.

clearResetContexts()

public Intent.Builder clearResetContexts()

Optional. Indicates whether to delete all contexts in the current session when this intent is matched.

bool reset_contexts = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Intent.Builder

This builder for chaining.

clearRootFollowupIntentName()

public Intent.Builder clearRootFollowupIntentName()

Output only. The unique identifier of the root intent in the chain of followup intents. It identifies the correct followup intents chain for this intent.

Format: projects/<Project ID>/agent/intents/<Intent ID>.

string root_followup_intent_name = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Intent.Builder

This builder for chaining.

clearTrainingPhrases()

public Intent.Builder clearTrainingPhrases()

Optional. The collection of examples that the agent is trained on.

repeated .google.cloud.dialogflow.v2beta1.Intent.TrainingPhrase training_phrases = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Intent.Builder

clearWebhookState()

public Intent.Builder clearWebhookState()

Optional. Indicates whether webhooks are enabled for the intent.

.google.cloud.dialogflow.v2beta1.Intent.WebhookState webhook_state = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Intent.Builder

This builder for chaining.

clone()

public Intent.Builder clone()
Returns
Type Description
Intent.Builder
Overrides

getAction()

public String getAction()

Optional. The name of the action associated with the intent. Note: The action name must not contain whitespaces.

string action = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The action.

getActionBytes()

public ByteString getActionBytes()

Optional. The name of the action associated with the intent. Note: The action name must not contain whitespaces.

string action = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for action.

getDefaultInstanceForType()

public Intent getDefaultInstanceForType()
Returns
Type Description
Intent

getDefaultResponsePlatforms(int index)

public Intent.Message.Platform getDefaultResponsePlatforms(int index)

Optional. The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).

repeated .google.cloud.dialogflow.v2beta1.Intent.Message.Platform default_response_platforms = 15 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
Intent.Message.Platform

The defaultResponsePlatforms at the given index.

getDefaultResponsePlatformsCount()

public int getDefaultResponsePlatformsCount()

Optional. The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).

repeated .google.cloud.dialogflow.v2beta1.Intent.Message.Platform default_response_platforms = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of defaultResponsePlatforms.

getDefaultResponsePlatformsList()

public List<Intent.Message.Platform> getDefaultResponsePlatformsList()

Optional. The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).

repeated .google.cloud.dialogflow.v2beta1.Intent.Message.Platform default_response_platforms = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Platform>

A list containing the defaultResponsePlatforms.

getDefaultResponsePlatformsValue(int index)

public int getDefaultResponsePlatformsValue(int index)

Optional. The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).

repeated .google.cloud.dialogflow.v2beta1.Intent.Message.Platform default_response_platforms = 15 [(.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 defaultResponsePlatforms at the given index.

getDefaultResponsePlatformsValueList()

public List<Integer> getDefaultResponsePlatformsValueList()

Optional. The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).

repeated .google.cloud.dialogflow.v2beta1.Intent.Message.Platform default_response_platforms = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Integer>

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

getDescriptorForType()

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

getDisplayName()

public String getDisplayName()

Required. The name of this intent.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Required. The name of this intent.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for displayName.

getEndInteraction()

public boolean getEndInteraction()

Optional. Indicates that this intent ends an interaction. Some integrations (e.g., Actions on Google or Dialogflow phone gateway) use this information to close interaction with an end user. Default is false.

bool end_interaction = 21 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The endInteraction.

getEvents(int index)

public String getEvents(int index)

Optional. The collection of event names that trigger the intent. If the collection of input contexts is not empty, all of the contexts must be present in the active user session for an event to trigger this intent. Event names are limited to 150 characters.

repeated string events = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The events at the given index.

getEventsBytes(int index)

public ByteString getEventsBytes(int index)

Optional. The collection of event names that trigger the intent. If the collection of input contexts is not empty, all of the contexts must be present in the active user session for an event to trigger this intent. Event names are limited to 150 characters.

repeated string events = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the events at the given index.

getEventsCount()

public int getEventsCount()

Optional. The collection of event names that trigger the intent. If the collection of input contexts is not empty, all of the contexts must be present in the active user session for an event to trigger this intent. Event names are limited to 150 characters.

repeated string events = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of events.

getEventsList()

public ProtocolStringList getEventsList()

Optional. The collection of event names that trigger the intent. If the collection of input contexts is not empty, all of the contexts must be present in the active user session for an event to trigger this intent. Event names are limited to 150 characters.

repeated string events = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the events.

getFollowupIntentInfo(int index)

public Intent.FollowupIntentInfo getFollowupIntentInfo(int index)

Output only. Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output.

repeated .google.cloud.dialogflow.v2beta1.Intent.FollowupIntentInfo followup_intent_info = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
Intent.FollowupIntentInfo

getFollowupIntentInfoBuilder(int index)

public Intent.FollowupIntentInfo.Builder getFollowupIntentInfoBuilder(int index)

Output only. Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output.

repeated .google.cloud.dialogflow.v2beta1.Intent.FollowupIntentInfo followup_intent_info = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
Intent.FollowupIntentInfo.Builder

getFollowupIntentInfoBuilderList()

public List<Intent.FollowupIntentInfo.Builder> getFollowupIntentInfoBuilderList()

Output only. Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output.

repeated .google.cloud.dialogflow.v2beta1.Intent.FollowupIntentInfo followup_intent_info = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<Builder>

getFollowupIntentInfoCount()

public int getFollowupIntentInfoCount()

Output only. Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output.

repeated .google.cloud.dialogflow.v2beta1.Intent.FollowupIntentInfo followup_intent_info = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getFollowupIntentInfoList()

public List<Intent.FollowupIntentInfo> getFollowupIntentInfoList()

Output only. Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output.

repeated .google.cloud.dialogflow.v2beta1.Intent.FollowupIntentInfo followup_intent_info = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<FollowupIntentInfo>

getFollowupIntentInfoOrBuilder(int index)

public Intent.FollowupIntentInfoOrBuilder getFollowupIntentInfoOrBuilder(int index)

Output only. Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output.

repeated .google.cloud.dialogflow.v2beta1.Intent.FollowupIntentInfo followup_intent_info = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
Intent.FollowupIntentInfoOrBuilder

getFollowupIntentInfoOrBuilderList()

public List<? extends Intent.FollowupIntentInfoOrBuilder> getFollowupIntentInfoOrBuilderList()

Output only. Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output.

repeated .google.cloud.dialogflow.v2beta1.Intent.FollowupIntentInfo followup_intent_info = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.cloud.dialogflow.v2beta1.Intent.FollowupIntentInfoOrBuilder>

getInputContextNames(int index)

public String getInputContextNames(int index)

Optional. The list of context names required for this intent to be triggered. Formats:

  • projects/<Project ID>/agent/sessions/-/contexts/<Context ID>
  • projects/<Project ID>/locations/<Location ID>/agent/sessions/-/contexts/<Context ID>

repeated string input_context_names = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The inputContextNames at the given index.

getInputContextNamesBytes(int index)

public ByteString getInputContextNamesBytes(int index)

Optional. The list of context names required for this intent to be triggered. Formats:

  • projects/<Project ID>/agent/sessions/-/contexts/<Context ID>
  • projects/<Project ID>/locations/<Location ID>/agent/sessions/-/contexts/<Context ID>

repeated string input_context_names = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the inputContextNames at the given index.

getInputContextNamesCount()

public int getInputContextNamesCount()

Optional. The list of context names required for this intent to be triggered. Formats:

  • projects/<Project ID>/agent/sessions/-/contexts/<Context ID>
  • projects/<Project ID>/locations/<Location ID>/agent/sessions/-/contexts/<Context ID>

repeated string input_context_names = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of inputContextNames.

getInputContextNamesList()

public ProtocolStringList getInputContextNamesList()

Optional. The list of context names required for this intent to be triggered. Formats:

  • projects/<Project ID>/agent/sessions/-/contexts/<Context ID>
  • projects/<Project ID>/locations/<Location ID>/agent/sessions/-/contexts/<Context ID>

repeated string input_context_names = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the inputContextNames.

getIsFallback()

public boolean getIsFallback()

Optional. Indicates whether this is a fallback intent.

bool is_fallback = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The isFallback.

getLiveAgentHandoff()

public boolean getLiveAgentHandoff()

Optional. Indicates that a live agent should be brought in to handle the interaction with the user. In most cases, when you set this flag to true, you would also want to set end_interaction to true as well. Default is false.

bool live_agent_handoff = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The liveAgentHandoff.

getMessages(int index)

public Intent.Message getMessages(int index)

Optional. The collection of rich messages corresponding to the Response field in the Dialogflow console.

repeated .google.cloud.dialogflow.v2beta1.Intent.Message messages = 14;

Parameter
Name Description
index int
Returns
Type Description
Intent.Message

getMessagesBuilder(int index)

public Intent.Message.Builder getMessagesBuilder(int index)

Optional. The collection of rich messages corresponding to the Response field in the Dialogflow console.

repeated .google.cloud.dialogflow.v2beta1.Intent.Message messages = 14;

Parameter
Name Description
index int
Returns
Type Description
Intent.Message.Builder

getMessagesBuilderList()

public List<Intent.Message.Builder> getMessagesBuilderList()

Optional. The collection of rich messages corresponding to the Response field in the Dialogflow console.

repeated .google.cloud.dialogflow.v2beta1.Intent.Message messages = 14;

Returns
Type Description
List<Builder>

getMessagesCount()

public int getMessagesCount()

Optional. The collection of rich messages corresponding to the Response field in the Dialogflow console.

repeated .google.cloud.dialogflow.v2beta1.Intent.Message messages = 14;

Returns
Type Description
int

getMessagesList()

public List<Intent.Message> getMessagesList()

Optional. The collection of rich messages corresponding to the Response field in the Dialogflow console.

repeated .google.cloud.dialogflow.v2beta1.Intent.Message messages = 14;

Returns
Type Description
List<Message>

getMessagesOrBuilder(int index)

public Intent.MessageOrBuilder getMessagesOrBuilder(int index)

Optional. The collection of rich messages corresponding to the Response field in the Dialogflow console.

repeated .google.cloud.dialogflow.v2beta1.Intent.Message messages = 14;

Parameter
Name Description
index int
Returns
Type Description
Intent.MessageOrBuilder

getMessagesOrBuilderList()

public List<? extends Intent.MessageOrBuilder> getMessagesOrBuilderList()

Optional. The collection of rich messages corresponding to the Response field in the Dialogflow console.

repeated .google.cloud.dialogflow.v2beta1.Intent.Message messages = 14;

Returns
Type Description
List<? extends com.google.cloud.dialogflow.v2beta1.Intent.MessageOrBuilder>

getMlDisabled()

public boolean getMlDisabled()

Optional. Indicates whether Machine Learning is disabled for the intent. Note: If ml_disabled setting is set to true, then this intent is not taken into account during inference in ML ONLY match mode. Also, auto-markup in the UI is turned off.

bool ml_disabled = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The mlDisabled.

getMlEnabled() (deprecated)

public boolean getMlEnabled()

Deprecated. google.cloud.dialogflow.v2beta1.Intent.ml_enabled is deprecated. See google/cloud/dialogflow/v2beta1/intent.proto;l=1154

Optional. Indicates whether Machine Learning is enabled for the intent. Note: If ml_enabled setting is set to false, then this intent is not taken into account during inference in ML ONLY match mode. Also, auto-markup in the UI is turned off. DEPRECATED! Please use ml_disabled field instead. NOTE: If both ml_enabled and ml_disabled are either not set or false, then the default value is determined as follows:

  • Before April 15th, 2018 the default is: ml_enabled = false / ml_disabled = true.
  • After April 15th, 2018 the default is: ml_enabled = true / ml_disabled = false.

bool ml_enabled = 5 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The mlEnabled.

getName()

public String getName()

Optional. The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Supported formats:

  • projects/<Project ID>/agent/intents/<Intent ID>
  • projects/<Project ID>/locations/<Location ID>/agent/intents/<Intent ID>

string name = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Optional. The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Supported formats:

  • projects/<Project ID>/agent/intents/<Intent ID>
  • projects/<Project ID>/locations/<Location ID>/agent/intents/<Intent ID>

string name = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for name.

getOutputContexts(int index)

public Context getOutputContexts(int index)

Optional. The collection of contexts that are activated when the intent is matched. Context messages in this collection should not set the parameters field. Setting the lifespan_count to 0 will reset the context when the intent is matched. Format: projects/<Project ID>/agent/sessions/-/contexts/<Context ID>.

repeated .google.cloud.dialogflow.v2beta1.Context output_contexts = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Context

getOutputContextsBuilder(int index)

public Context.Builder getOutputContextsBuilder(int index)

Optional. The collection of contexts that are activated when the intent is matched. Context messages in this collection should not set the parameters field. Setting the lifespan_count to 0 will reset the context when the intent is matched. Format: projects/<Project ID>/agent/sessions/-/contexts/<Context ID>.

repeated .google.cloud.dialogflow.v2beta1.Context output_contexts = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Context.Builder

getOutputContextsBuilderList()

public List<Context.Builder> getOutputContextsBuilderList()

Optional. The collection of contexts that are activated when the intent is matched. Context messages in this collection should not set the parameters field. Setting the lifespan_count to 0 will reset the context when the intent is matched. Format: projects/<Project ID>/agent/sessions/-/contexts/<Context ID>.

repeated .google.cloud.dialogflow.v2beta1.Context output_contexts = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Builder>

getOutputContextsCount()

public int getOutputContextsCount()

Optional. The collection of contexts that are activated when the intent is matched. Context messages in this collection should not set the parameters field. Setting the lifespan_count to 0 will reset the context when the intent is matched. Format: projects/<Project ID>/agent/sessions/-/contexts/<Context ID>.

repeated .google.cloud.dialogflow.v2beta1.Context output_contexts = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getOutputContextsList()

public List<Context> getOutputContextsList()

Optional. The collection of contexts that are activated when the intent is matched. Context messages in this collection should not set the parameters field. Setting the lifespan_count to 0 will reset the context when the intent is matched. Format: projects/<Project ID>/agent/sessions/-/contexts/<Context ID>.

repeated .google.cloud.dialogflow.v2beta1.Context output_contexts = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Context>

getOutputContextsOrBuilder(int index)

public ContextOrBuilder getOutputContextsOrBuilder(int index)

Optional. The collection of contexts that are activated when the intent is matched. Context messages in this collection should not set the parameters field. Setting the lifespan_count to 0 will reset the context when the intent is matched. Format: projects/<Project ID>/agent/sessions/-/contexts/<Context ID>.

repeated .google.cloud.dialogflow.v2beta1.Context output_contexts = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
ContextOrBuilder

getOutputContextsOrBuilderList()

public List<? extends ContextOrBuilder> getOutputContextsOrBuilderList()

Optional. The collection of contexts that are activated when the intent is matched. Context messages in this collection should not set the parameters field. Setting the lifespan_count to 0 will reset the context when the intent is matched. Format: projects/<Project ID>/agent/sessions/-/contexts/<Context ID>.

repeated .google.cloud.dialogflow.v2beta1.Context output_contexts = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.dialogflow.v2beta1.ContextOrBuilder>

getParameters(int index)

public Intent.Parameter getParameters(int index)

Optional. The collection of parameters associated with the intent.

repeated .google.cloud.dialogflow.v2beta1.Intent.Parameter parameters = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Intent.Parameter

getParametersBuilder(int index)

public Intent.Parameter.Builder getParametersBuilder(int index)

Optional. The collection of parameters associated with the intent.

repeated .google.cloud.dialogflow.v2beta1.Intent.Parameter parameters = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Intent.Parameter.Builder

getParametersBuilderList()

public List<Intent.Parameter.Builder> getParametersBuilderList()

Optional. The collection of parameters associated with the intent.

repeated .google.cloud.dialogflow.v2beta1.Intent.Parameter parameters = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Builder>

getParametersCount()

public int getParametersCount()

Optional. The collection of parameters associated with the intent.

repeated .google.cloud.dialogflow.v2beta1.Intent.Parameter parameters = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getParametersList()

public List<Intent.Parameter> getParametersList()

Optional. The collection of parameters associated with the intent.

repeated .google.cloud.dialogflow.v2beta1.Intent.Parameter parameters = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Parameter>

getParametersOrBuilder(int index)

public Intent.ParameterOrBuilder getParametersOrBuilder(int index)

Optional. The collection of parameters associated with the intent.

repeated .google.cloud.dialogflow.v2beta1.Intent.Parameter parameters = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Intent.ParameterOrBuilder

getParametersOrBuilderList()

public List<? extends Intent.ParameterOrBuilder> getParametersOrBuilderList()

Optional. The collection of parameters associated with the intent.

repeated .google.cloud.dialogflow.v2beta1.Intent.Parameter parameters = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.dialogflow.v2beta1.Intent.ParameterOrBuilder>

getParentFollowupIntentName()

public String getParentFollowupIntentName()

Optional. The unique identifier of the parent intent in the chain of followup intents. You can set this field when creating an intent, for example with CreateIntent or BatchUpdateIntents, in order to make this intent a followup intent.

It identifies the parent followup intent. Format: projects/<Project ID>/agent/intents/<Intent ID>.

string parent_followup_intent_name = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The parentFollowupIntentName.

getParentFollowupIntentNameBytes()

public ByteString getParentFollowupIntentNameBytes()

Optional. The unique identifier of the parent intent in the chain of followup intents. You can set this field when creating an intent, for example with CreateIntent or BatchUpdateIntents, in order to make this intent a followup intent.

It identifies the parent followup intent. Format: projects/<Project ID>/agent/intents/<Intent ID>.

string parent_followup_intent_name = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for parentFollowupIntentName.

getPriority()

public int getPriority()

Optional. The priority of this intent. Higher numbers represent higher priorities.

  • If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the Normal priority in the console.
  • If the supplied value is negative, the intent is ignored in runtime detect intent requests.

int32 priority = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The priority.

getResetContexts()

public boolean getResetContexts()

Optional. Indicates whether to delete all contexts in the current session when this intent is matched.

bool reset_contexts = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The resetContexts.

getRootFollowupIntentName()

public String getRootFollowupIntentName()

Output only. The unique identifier of the root intent in the chain of followup intents. It identifies the correct followup intents chain for this intent.

Format: projects/<Project ID>/agent/intents/<Intent ID>.

string root_followup_intent_name = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The rootFollowupIntentName.

getRootFollowupIntentNameBytes()

public ByteString getRootFollowupIntentNameBytes()

Output only. The unique identifier of the root intent in the chain of followup intents. It identifies the correct followup intents chain for this intent.

Format: projects/<Project ID>/agent/intents/<Intent ID>.

string root_followup_intent_name = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for rootFollowupIntentName.

getTrainingPhrases(int index)

public Intent.TrainingPhrase getTrainingPhrases(int index)

Optional. The collection of examples that the agent is trained on.

repeated .google.cloud.dialogflow.v2beta1.Intent.TrainingPhrase training_phrases = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Intent.TrainingPhrase

getTrainingPhrasesBuilder(int index)

public Intent.TrainingPhrase.Builder getTrainingPhrasesBuilder(int index)

Optional. The collection of examples that the agent is trained on.

repeated .google.cloud.dialogflow.v2beta1.Intent.TrainingPhrase training_phrases = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Intent.TrainingPhrase.Builder

getTrainingPhrasesBuilderList()

public List<Intent.TrainingPhrase.Builder> getTrainingPhrasesBuilderList()

Optional. The collection of examples that the agent is trained on.

repeated .google.cloud.dialogflow.v2beta1.Intent.TrainingPhrase training_phrases = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Builder>

getTrainingPhrasesCount()

public int getTrainingPhrasesCount()

Optional. The collection of examples that the agent is trained on.

repeated .google.cloud.dialogflow.v2beta1.Intent.TrainingPhrase training_phrases = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getTrainingPhrasesList()

public List<Intent.TrainingPhrase> getTrainingPhrasesList()

Optional. The collection of examples that the agent is trained on.

repeated .google.cloud.dialogflow.v2beta1.Intent.TrainingPhrase training_phrases = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<TrainingPhrase>

getTrainingPhrasesOrBuilder(int index)

public Intent.TrainingPhraseOrBuilder getTrainingPhrasesOrBuilder(int index)

Optional. The collection of examples that the agent is trained on.

repeated .google.cloud.dialogflow.v2beta1.Intent.TrainingPhrase training_phrases = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Intent.TrainingPhraseOrBuilder

getTrainingPhrasesOrBuilderList()

public List<? extends Intent.TrainingPhraseOrBuilder> getTrainingPhrasesOrBuilderList()

Optional. The collection of examples that the agent is trained on.

repeated .google.cloud.dialogflow.v2beta1.Intent.TrainingPhrase training_phrases = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.dialogflow.v2beta1.Intent.TrainingPhraseOrBuilder>

getWebhookState()

public Intent.WebhookState getWebhookState()

Optional. Indicates whether webhooks are enabled for the intent.

.google.cloud.dialogflow.v2beta1.Intent.WebhookState webhook_state = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Intent.WebhookState

The webhookState.

getWebhookStateValue()

public int getWebhookStateValue()

Optional. Indicates whether webhooks are enabled for the intent.

.google.cloud.dialogflow.v2beta1.Intent.WebhookState webhook_state = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for webhookState.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Intent other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

removeFollowupIntentInfo(int index)

public Intent.Builder removeFollowupIntentInfo(int index)

Output only. Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output.

repeated .google.cloud.dialogflow.v2beta1.Intent.FollowupIntentInfo followup_intent_info = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
Intent.Builder

removeMessages(int index)

public Intent.Builder removeMessages(int index)

Optional. The collection of rich messages corresponding to the Response field in the Dialogflow console.

repeated .google.cloud.dialogflow.v2beta1.Intent.Message messages = 14;

Parameter
Name Description
index int
Returns
Type Description
Intent.Builder

removeOutputContexts(int index)

public Intent.Builder removeOutputContexts(int index)

Optional. The collection of contexts that are activated when the intent is matched. Context messages in this collection should not set the parameters field. Setting the lifespan_count to 0 will reset the context when the intent is matched. Format: projects/<Project ID>/agent/sessions/-/contexts/<Context ID>.

repeated .google.cloud.dialogflow.v2beta1.Context output_contexts = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Intent.Builder

removeParameters(int index)

public Intent.Builder removeParameters(int index)

Optional. The collection of parameters associated with the intent.

repeated .google.cloud.dialogflow.v2beta1.Intent.Parameter parameters = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Intent.Builder

removeTrainingPhrases(int index)

public Intent.Builder removeTrainingPhrases(int index)

Optional. The collection of examples that the agent is trained on.

repeated .google.cloud.dialogflow.v2beta1.Intent.TrainingPhrase training_phrases = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Intent.Builder

setAction(String value)

public Intent.Builder setAction(String value)

Optional. The name of the action associated with the intent. Note: The action name must not contain whitespaces.

string action = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The action to set.
Returns
Type Description
Intent.Builder

This builder for chaining.

setActionBytes(ByteString value)

public Intent.Builder setActionBytes(ByteString value)

Optional. The name of the action associated with the intent. Note: The action name must not contain whitespaces.

string action = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for action to set.
Returns
Type Description
Intent.Builder

This builder for chaining.

setDefaultResponsePlatforms(int index, Intent.Message.Platform value)

public Intent.Builder setDefaultResponsePlatforms(int index, Intent.Message.Platform value)

Optional. The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).

repeated .google.cloud.dialogflow.v2beta1.Intent.Message.Platform default_response_platforms = 15 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int

The index to set the value at.
value Intent.Message.Platform

The defaultResponsePlatforms to set.
Returns
Type Description
Intent.Builder

This builder for chaining.

setDefaultResponsePlatformsValue(int index, int value)

public Intent.Builder setDefaultResponsePlatformsValue(int index, int value)

Optional. The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).

repeated .google.cloud.dialogflow.v2beta1.Intent.Message.Platform default_response_platforms = 15 [(.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 defaultResponsePlatforms to set.
Returns
Type Description
Intent.Builder

This builder for chaining.

setDisplayName(String value)

public Intent.Builder setDisplayName(String value)

Required. The name of this intent.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The displayName to set.
Returns
Type Description
Intent.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public Intent.Builder setDisplayNameBytes(ByteString value)

Required. The name of this intent.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for displayName to set.
Returns
Type Description
Intent.Builder

This builder for chaining.

setEndInteraction(boolean value)

public Intent.Builder setEndInteraction(boolean value)

Optional. Indicates that this intent ends an interaction. Some integrations (e.g., Actions on Google or Dialogflow phone gateway) use this information to close interaction with an end user. Default is false.

bool end_interaction = 21 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The endInteraction to set.
Returns
Type Description
Intent.Builder

This builder for chaining.

setEvents(int index, String value)

public Intent.Builder setEvents(int index, String value)

Optional. The collection of event names that trigger the intent. If the collection of input contexts is not empty, all of the contexts must be present in the active user session for an event to trigger this intent. Event names are limited to 150 characters.

repeated string events = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int

The index to set the value at.
value String

The events to set.
Returns
Type Description
Intent.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setFollowupIntentInfo(int index, Intent.FollowupIntentInfo value)

public Intent.Builder setFollowupIntentInfo(int index, Intent.FollowupIntentInfo value)

Output only. Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output.

repeated .google.cloud.dialogflow.v2beta1.Intent.FollowupIntentInfo followup_intent_info = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
value Intent.FollowupIntentInfo
Returns
Type Description
Intent.Builder

setFollowupIntentInfo(int index, Intent.FollowupIntentInfo.Builder builderForValue)

public Intent.Builder setFollowupIntentInfo(int index, Intent.FollowupIntentInfo.Builder builderForValue)

Output only. Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output.

repeated .google.cloud.dialogflow.v2beta1.Intent.FollowupIntentInfo followup_intent_info = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
builderForValue Intent.FollowupIntentInfo.Builder
Returns
Type Description
Intent.Builder

setInputContextNames(int index, String value)

public Intent.Builder setInputContextNames(int index, String value)

Optional. The list of context names required for this intent to be triggered. Formats:

  • projects/<Project ID>/agent/sessions/-/contexts/<Context ID>
  • projects/<Project ID>/locations/<Location ID>/agent/sessions/-/contexts/<Context ID>

repeated string input_context_names = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int

The index to set the value at.
value String

The inputContextNames to set.
Returns
Type Description
Intent.Builder

This builder for chaining.

setIsFallback(boolean value)

public Intent.Builder setIsFallback(boolean value)

Optional. Indicates whether this is a fallback intent.

bool is_fallback = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The isFallback to set.
Returns
Type Description
Intent.Builder

This builder for chaining.

setLiveAgentHandoff(boolean value)

public Intent.Builder setLiveAgentHandoff(boolean value)

Optional. Indicates that a live agent should be brought in to handle the interaction with the user. In most cases, when you set this flag to true, you would also want to set end_interaction to true as well. Default is false.

bool live_agent_handoff = 20 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The liveAgentHandoff to set.
Returns
Type Description
Intent.Builder

This builder for chaining.

setMessages(int index, Intent.Message value)

public Intent.Builder setMessages(int index, Intent.Message value)

Optional. The collection of rich messages corresponding to the Response field in the Dialogflow console.

repeated .google.cloud.dialogflow.v2beta1.Intent.Message messages = 14;

Parameters
Name Description
index int
value Intent.Message
Returns
Type Description
Intent.Builder

setMessages(int index, Intent.Message.Builder builderForValue)

public Intent.Builder setMessages(int index, Intent.Message.Builder builderForValue)

Optional. The collection of rich messages corresponding to the Response field in the Dialogflow console.

repeated .google.cloud.dialogflow.v2beta1.Intent.Message messages = 14;

Parameters
Name Description
index int
builderForValue Intent.Message.Builder
Returns
Type Description
Intent.Builder

setMlDisabled(boolean value)

public Intent.Builder setMlDisabled(boolean value)

Optional. Indicates whether Machine Learning is disabled for the intent. Note: If ml_disabled setting is set to true, then this intent is not taken into account during inference in ML ONLY match mode. Also, auto-markup in the UI is turned off.

bool ml_disabled = 19 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The mlDisabled to set.
Returns
Type Description
Intent.Builder

This builder for chaining.

setMlEnabled(boolean value) (deprecated)

public Intent.Builder setMlEnabled(boolean value)

Deprecated. google.cloud.dialogflow.v2beta1.Intent.ml_enabled is deprecated. See google/cloud/dialogflow/v2beta1/intent.proto;l=1154

Optional. Indicates whether Machine Learning is enabled for the intent. Note: If ml_enabled setting is set to false, then this intent is not taken into account during inference in ML ONLY match mode. Also, auto-markup in the UI is turned off. DEPRECATED! Please use ml_disabled field instead. NOTE: If both ml_enabled and ml_disabled are either not set or false, then the default value is determined as follows:

  • Before April 15th, 2018 the default is: ml_enabled = false / ml_disabled = true.
  • After April 15th, 2018 the default is: ml_enabled = true / ml_disabled = false.

bool ml_enabled = 5 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The mlEnabled to set.
Returns
Type Description
Intent.Builder

This builder for chaining.

setName(String value)

public Intent.Builder setName(String value)

Optional. The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Supported formats:

  • projects/<Project ID>/agent/intents/<Intent ID>
  • projects/<Project ID>/locations/<Location ID>/agent/intents/<Intent ID>

string name = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The name to set.
Returns
Type Description
Intent.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Intent.Builder setNameBytes(ByteString value)

Optional. The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Supported formats:

  • projects/<Project ID>/agent/intents/<Intent ID>
  • projects/<Project ID>/locations/<Location ID>/agent/intents/<Intent ID>

string name = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
Intent.Builder

This builder for chaining.

setOutputContexts(int index, Context value)

public Intent.Builder setOutputContexts(int index, Context value)

Optional. The collection of contexts that are activated when the intent is matched. Context messages in this collection should not set the parameters field. Setting the lifespan_count to 0 will reset the context when the intent is matched. Format: projects/<Project ID>/agent/sessions/-/contexts/<Context ID>.

repeated .google.cloud.dialogflow.v2beta1.Context output_contexts = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value Context
Returns
Type Description
Intent.Builder

setOutputContexts(int index, Context.Builder builderForValue)

public Intent.Builder setOutputContexts(int index, Context.Builder builderForValue)

Optional. The collection of contexts that are activated when the intent is matched. Context messages in this collection should not set the parameters field. Setting the lifespan_count to 0 will reset the context when the intent is matched. Format: projects/<Project ID>/agent/sessions/-/contexts/<Context ID>.

repeated .google.cloud.dialogflow.v2beta1.Context output_contexts = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue Context.Builder
Returns
Type Description
Intent.Builder

setParameters(int index, Intent.Parameter value)

public Intent.Builder setParameters(int index, Intent.Parameter value)

Optional. The collection of parameters associated with the intent.

repeated .google.cloud.dialogflow.v2beta1.Intent.Parameter parameters = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value Intent.Parameter
Returns
Type Description
Intent.Builder

setParameters(int index, Intent.Parameter.Builder builderForValue)

public Intent.Builder setParameters(int index, Intent.Parameter.Builder builderForValue)

Optional. The collection of parameters associated with the intent.

repeated .google.cloud.dialogflow.v2beta1.Intent.Parameter parameters = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue Intent.Parameter.Builder
Returns
Type Description
Intent.Builder

setParentFollowupIntentName(String value)

public Intent.Builder setParentFollowupIntentName(String value)

Optional. The unique identifier of the parent intent in the chain of followup intents. You can set this field when creating an intent, for example with CreateIntent or BatchUpdateIntents, in order to make this intent a followup intent.

It identifies the parent followup intent. Format: projects/<Project ID>/agent/intents/<Intent ID>.

string parent_followup_intent_name = 17 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The parentFollowupIntentName to set.
Returns
Type Description
Intent.Builder

This builder for chaining.

setParentFollowupIntentNameBytes(ByteString value)

public Intent.Builder setParentFollowupIntentNameBytes(ByteString value)

Optional. The unique identifier of the parent intent in the chain of followup intents. You can set this field when creating an intent, for example with CreateIntent or BatchUpdateIntents, in order to make this intent a followup intent.

It identifies the parent followup intent. Format: projects/<Project ID>/agent/intents/<Intent ID>.

string parent_followup_intent_name = 17 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for parentFollowupIntentName to set.
Returns
Type Description
Intent.Builder

This builder for chaining.

setPriority(int value)

public Intent.Builder setPriority(int value)

Optional. The priority of this intent. Higher numbers represent higher priorities.

  • If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the Normal priority in the console.
  • If the supplied value is negative, the intent is ignored in runtime detect intent requests.

int32 priority = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The priority to set.
Returns
Type Description
Intent.Builder

This builder for chaining.

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

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

setResetContexts(boolean value)

public Intent.Builder setResetContexts(boolean value)

Optional. Indicates whether to delete all contexts in the current session when this intent is matched.

bool reset_contexts = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The resetContexts to set.
Returns
Type Description
Intent.Builder

This builder for chaining.

setRootFollowupIntentName(String value)

public Intent.Builder setRootFollowupIntentName(String value)

Output only. The unique identifier of the root intent in the chain of followup intents. It identifies the correct followup intents chain for this intent.

Format: projects/<Project ID>/agent/intents/<Intent ID>.

string root_followup_intent_name = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The rootFollowupIntentName to set.
Returns
Type Description
Intent.Builder

This builder for chaining.

setRootFollowupIntentNameBytes(ByteString value)

public Intent.Builder setRootFollowupIntentNameBytes(ByteString value)

Output only. The unique identifier of the root intent in the chain of followup intents. It identifies the correct followup intents chain for this intent.

Format: projects/<Project ID>/agent/intents/<Intent ID>.

string root_followup_intent_name = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for rootFollowupIntentName to set.
Returns
Type Description
Intent.Builder

This builder for chaining.

setTrainingPhrases(int index, Intent.TrainingPhrase value)

public Intent.Builder setTrainingPhrases(int index, Intent.TrainingPhrase value)

Optional. The collection of examples that the agent is trained on.

repeated .google.cloud.dialogflow.v2beta1.Intent.TrainingPhrase training_phrases = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value Intent.TrainingPhrase
Returns
Type Description
Intent.Builder

setTrainingPhrases(int index, Intent.TrainingPhrase.Builder builderForValue)

public Intent.Builder setTrainingPhrases(int index, Intent.TrainingPhrase.Builder builderForValue)

Optional. The collection of examples that the agent is trained on.

repeated .google.cloud.dialogflow.v2beta1.Intent.TrainingPhrase training_phrases = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue Intent.TrainingPhrase.Builder
Returns
Type Description
Intent.Builder

setUnknownFields(UnknownFieldSet unknownFields)

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

setWebhookState(Intent.WebhookState value)

public Intent.Builder setWebhookState(Intent.WebhookState value)

Optional. Indicates whether webhooks are enabled for the intent.

.google.cloud.dialogflow.v2beta1.Intent.WebhookState webhook_state = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Intent.WebhookState

The webhookState to set.
Returns
Type Description
Intent.Builder

This builder for chaining.

setWebhookStateValue(int value)

public Intent.Builder setWebhookStateValue(int value)

Optional. Indicates whether webhooks are enabled for the intent.

.google.cloud.dialogflow.v2beta1.Intent.WebhookState webhook_state = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The enum numeric value on the wire for webhookState to set.
Returns
Type Description
Intent.Builder

This builder for chaining.