Intent (java API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.google.cloud.dialogflow.v2.Intent

All Implemented Interfaces:: IntentOrBuilder, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, java.io.Serializable

public final class Intent
extends GeneratedMessageV3
implements IntentOrBuilder

 Represents an intent.
 Intents convert a number of user expressions or patterns into an action. An
 action is an extraction of a user command or sentence semantics.

Protobuf type google.cloud.dialogflow.v2.Intent

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Intent.Builder` Represents an intent.
`static class`	`Intent.FollowupIntentInfo` Represents a single followup intent in the chain.
`static interface`	`Intent.FollowupIntentInfoOrBuilder`
`static class`	`Intent.Message` Corresponds to the `Response` field in the Dialogflow console.
`static interface`	`Intent.MessageOrBuilder`
`static class`	`Intent.Parameter` Represents intent parameters.
`static interface`	`Intent.ParameterOrBuilder`
`static class`	`Intent.TrainingPhrase` Represents an example or template that the agent is trained on.
`static interface`	`Intent.TrainingPhraseOrBuilder`
`static class`	`Intent.WebhookState` Represents the different states that webhooks can be in.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ACTION_FIELD_NUMBER`
`static int`	`DEFAULT_RESPONSE_PLATFORMS_FIELD_NUMBER`
`static int`	`DISPLAY_NAME_FIELD_NUMBER`
`static int`	`EVENTS_FIELD_NUMBER`
`static int`	`FOLLOWUP_INTENT_INFO_FIELD_NUMBER`
`static int`	`INPUT_CONTEXT_NAMES_FIELD_NUMBER`
`static int`	`IS_FALLBACK_FIELD_NUMBER`
`static int`	`MESSAGES_FIELD_NUMBER`
`static int`	`ML_DISABLED_FIELD_NUMBER`
`static int`	`NAME_FIELD_NUMBER`
`static int`	`OUTPUT_CONTEXTS_FIELD_NUMBER`
`static int`	`PARAMETERS_FIELD_NUMBER`
`static int`	`PARENT_FOLLOWUP_INTENT_NAME_FIELD_NUMBER`
`static int`	`PRIORITY_FIELD_NUMBER`
`static int`	`RESET_CONTEXTS_FIELD_NUMBER`
`static int`	`ROOT_FOLLOWUP_INTENT_NAME_FIELD_NUMBER`
`static int`	`TRAINING_PHRASES_FIELD_NUMBER`
`static int`	`WEBHOOK_STATE_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getAction()` Optional.
`ByteString`	`getActionBytes()` Optional.
`static Intent`	`getDefaultInstance()`
`Intent`	`getDefaultInstanceForType()`
`Intent.Message.Platform`	`getDefaultResponsePlatforms(int index)` Optional.
`int`	`getDefaultResponsePlatformsCount()` Optional.
`java.util.List<Intent.Message.Platform>`	`getDefaultResponsePlatformsList()` Optional.
`int`	`getDefaultResponsePlatformsValue(int index)` Optional.
`java.util.List<java.lang.Integer>`	`getDefaultResponsePlatformsValueList()` Optional.
`static Descriptors.Descriptor`	`getDescriptor()`
`java.lang.String`	`getDisplayName()` Required.
`ByteString`	`getDisplayNameBytes()` Required.
`java.lang.String`	`getEvents(int index)` Optional.
`ByteString`	`getEventsBytes(int index)` Optional.
`int`	`getEventsCount()` Optional.
`ProtocolStringList`	`getEventsList()` Optional.
`Intent.FollowupIntentInfo`	`getFollowupIntentInfo(int index)` Optional.
`int`	`getFollowupIntentInfoCount()` Optional.
`java.util.List<Intent.FollowupIntentInfo>`	`getFollowupIntentInfoList()` Optional.
`Intent.FollowupIntentInfoOrBuilder`	`getFollowupIntentInfoOrBuilder(int index)` Optional.
`java.util.List<? extends Intent.FollowupIntentInfoOrBuilder>`	`getFollowupIntentInfoOrBuilderList()` Optional.
`java.lang.String`	`getInputContextNames(int index)` Optional.
`ByteString`	`getInputContextNamesBytes(int index)` Optional.
`int`	`getInputContextNamesCount()` Optional.
`ProtocolStringList`	`getInputContextNamesList()` Optional.
`boolean`	`getIsFallback()` Optional.
`Intent.Message`	`getMessages(int index)` Optional.
`int`	`getMessagesCount()` Optional.
`java.util.List<Intent.Message>`	`getMessagesList()` Optional.
`Intent.MessageOrBuilder`	`getMessagesOrBuilder(int index)` Optional.
`java.util.List<? extends Intent.MessageOrBuilder>`	`getMessagesOrBuilderList()` Optional.
`boolean`	`getMlDisabled()` Optional.
`java.lang.String`	`getName()` Required for all methods except `create` (`create` populates the name automatically.
`ByteString`	`getNameBytes()` Required for all methods except `create` (`create` populates the name automatically.
`Context`	`getOutputContexts(int index)` Optional.
`int`	`getOutputContextsCount()` Optional.
`java.util.List<Context>`	`getOutputContextsList()` Optional.
`ContextOrBuilder`	`getOutputContextsOrBuilder(int index)` Optional.
`java.util.List<? extends ContextOrBuilder>`	`getOutputContextsOrBuilderList()` Optional.
`Intent.Parameter`	`getParameters(int index)` Optional.
`int`	`getParametersCount()` Optional.
`java.util.List<Intent.Parameter>`	`getParametersList()` Optional.
`Intent.ParameterOrBuilder`	`getParametersOrBuilder(int index)` Optional.
`java.util.List<? extends Intent.ParameterOrBuilder>`	`getParametersOrBuilderList()` Optional.
`java.lang.String`	`getParentFollowupIntentName()` The unique identifier of the parent intent in the chain of followup intents.
`ByteString`	`getParentFollowupIntentNameBytes()` The unique identifier of the parent intent in the chain of followup intents.
`Parser<Intent>`	`getParserForType()`
`int`	`getPriority()` Optional.
`boolean`	`getResetContexts()` Optional.
`java.lang.String`	`getRootFollowupIntentName()` The unique identifier of the root intent in the chain of followup intents.
`ByteString`	`getRootFollowupIntentNameBytes()` The unique identifier of the root intent in the chain of followup intents.
`int`	`getSerializedSize()`
`Intent.TrainingPhrase`	`getTrainingPhrases(int index)` Optional.
`int`	`getTrainingPhrasesCount()` Optional.
`java.util.List<Intent.TrainingPhrase>`	`getTrainingPhrasesList()` Optional.
`Intent.TrainingPhraseOrBuilder`	`getTrainingPhrasesOrBuilder(int index)` Optional.
`java.util.List<? extends Intent.TrainingPhraseOrBuilder>`	`getTrainingPhrasesOrBuilderList()` Optional.
`UnknownFieldSet`	`getUnknownFields()`
`Intent.WebhookState`	`getWebhookState()` Required.
`int`	`getWebhookStateValue()` Required.
`int`	`hashCode()`
`protected GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`static Intent.Builder`	`newBuilder()`
`static Intent.Builder`	`newBuilder(Intent prototype)`
`Intent.Builder`	`newBuilderForType()`
`protected Intent.Builder`	`newBuilderForType(GeneratedMessageV3.BuilderParent parent)`
`static Intent`	`parseDelimitedFrom(java.io.InputStream input)`
`static Intent`	`parseDelimitedFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)`
`static Intent`	`parseFrom(byte[] data)`
`static Intent`	`parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)`
`static Intent`	`parseFrom(java.nio.ByteBuffer data)`
`static Intent`	`parseFrom(java.nio.ByteBuffer data, ExtensionRegistryLite extensionRegistry)`
`static Intent`	`parseFrom(ByteString data)`
`static Intent`	`parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)`
`static Intent`	`parseFrom(CodedInputStream input)`
`static Intent`	`parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)`
`static Intent`	`parseFrom(java.io.InputStream input)`
`static Intent`	`parseFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)`
`static Parser<Intent>`	`parser()`
`Intent.Builder`	`toBuilder()`
`void`	`writeTo(CodedOutputStream output)`

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail
- NAME_FIELD_NUMBER
```
public static final int NAME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DISPLAY_NAME_FIELD_NUMBER
```
public static final int DISPLAY_NAME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- WEBHOOK_STATE_FIELD_NUMBER
```
public static final int WEBHOOK_STATE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PRIORITY_FIELD_NUMBER
```
public static final int PRIORITY_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- IS_FALLBACK_FIELD_NUMBER
```
public static final int IS_FALLBACK_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ML_DISABLED_FIELD_NUMBER
```
public static final int ML_DISABLED_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- INPUT_CONTEXT_NAMES_FIELD_NUMBER
```
public static final int INPUT_CONTEXT_NAMES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- EVENTS_FIELD_NUMBER
```
public static final int EVENTS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- TRAINING_PHRASES_FIELD_NUMBER
```
public static final int TRAINING_PHRASES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ACTION_FIELD_NUMBER
```
public static final int ACTION_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- OUTPUT_CONTEXTS_FIELD_NUMBER
```
public static final int OUTPUT_CONTEXTS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- RESET_CONTEXTS_FIELD_NUMBER
```
public static final int RESET_CONTEXTS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PARAMETERS_FIELD_NUMBER
```
public static final int PARAMETERS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- MESSAGES_FIELD_NUMBER
```
public static final int MESSAGES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DEFAULT_RESPONSE_PLATFORMS_FIELD_NUMBER
```
public static final int DEFAULT_RESPONSE_PLATFORMS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ROOT_FOLLOWUP_INTENT_NAME_FIELD_NUMBER
```
public static final int ROOT_FOLLOWUP_INTENT_NAME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PARENT_FOLLOWUP_INTENT_NAME_FIELD_NUMBER
```
public static final int PARENT_FOLLOWUP_INTENT_NAME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- FOLLOWUP_INTENT_INFO_FIELD_NUMBER
```
public static final int FOLLOWUP_INTENT_INFO_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

getUnknownFields
```
public final UnknownFieldSet getUnknownFields()
```
Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable
```
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

getName

public java.lang.String getName()

 Required for all methods except `create` (`create` populates the name
 automatically.
 The unique identifier of this intent.
 Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

string name = 1;

Specified by:: getName in interface IntentOrBuilder

getNameBytes

public ByteString getNameBytes()

 Required for all methods except `create` (`create` populates the name
 automatically.
 The unique identifier of this intent.
 Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

string name = 1;

Specified by:: getNameBytes in interface IntentOrBuilder

getDisplayName
```
public java.lang.String getDisplayName()
```
```
 Required. The name of this intent.
 
```
string display_name = 2;
Specified by:

getDisplayName in interface IntentOrBuilder

getDisplayNameBytes
```
public ByteString getDisplayNameBytes()
```
```
 Required. The name of this intent.
 
```
string display_name = 2;
Specified by:

getDisplayNameBytes in interface IntentOrBuilder

getWebhookStateValue
```
public int getWebhookStateValue()
```
```
 Required. Indicates whether webhooks are enabled for the intent.
 
```
.google.cloud.dialogflow.v2.Intent.WebhookState webhook_state = 6;
Specified by:

getWebhookStateValue in interface IntentOrBuilder

getWebhookState
```
public Intent.WebhookState getWebhookState()
```
```
 Required. Indicates whether webhooks are enabled for the intent.
 
```
.google.cloud.dialogflow.v2.Intent.WebhookState webhook_state = 6;
Specified by:

getWebhookState in interface IntentOrBuilder

getPriority

public int getPriority()

 Optional. The priority of this intent. Higher numbers represent higher
 priorities. Zero or negative numbers mean that the intent is disabled.

int32 priority = 3;

Specified by:: getPriority in interface IntentOrBuilder

getIsFallback

public boolean getIsFallback()

 Optional. Indicates whether this is a fallback intent.

bool is_fallback = 4;

Specified by:: getIsFallback in interface IntentOrBuilder

getMlDisabled

public boolean getMlDisabled()

 Optional. Indicates whether Machine Learning is disabled for the intent.
 Note: If `ml_diabled` 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;

Specified by:: getMlDisabled in interface IntentOrBuilder

getInputContextNamesList

public ProtocolStringList getInputContextNamesList()

 Optional. The list of context names required for this intent to be
 triggered.
 Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

repeated string input_context_names = 7;

Specified by:: getInputContextNamesList in interface IntentOrBuilder

getInputContextNamesCount

public int getInputContextNamesCount()

 Optional. The list of context names required for this intent to be
 triggered.
 Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

repeated string input_context_names = 7;

Specified by:: getInputContextNamesCount in interface IntentOrBuilder

getInputContextNames

public java.lang.String getInputContextNames(int index)

 Optional. The list of context names required for this intent to be
 triggered.
 Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

repeated string input_context_names = 7;

Specified by:: getInputContextNames in interface IntentOrBuilder

getInputContextNamesBytes

public ByteString getInputContextNamesBytes(int index)

 Optional. The list of context names required for this intent to be
 triggered.
 Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.

repeated string input_context_names = 7;

Specified by:: getInputContextNamesBytes in interface IntentOrBuilder

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.

repeated string events = 8;

Specified by:: getEventsList in interface IntentOrBuilder

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.

repeated string events = 8;

Specified by:: getEventsCount in interface IntentOrBuilder

getEvents

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

repeated string events = 8;

Specified by:: getEvents in interface IntentOrBuilder

getEventsBytes

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.

repeated string events = 8;

Specified by:: getEventsBytes in interface IntentOrBuilder

getTrainingPhrasesList
```
public java.util.List<Intent.TrainingPhrase> getTrainingPhrasesList()
```
```
 Optional. The collection of examples/templates that the agent is
 trained on.
 
```
repeated .google.cloud.dialogflow.v2.Intent.TrainingPhrase training_phrases = 9;
Specified by:

getTrainingPhrasesList in interface IntentOrBuilder

getTrainingPhrasesOrBuilderList

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

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

repeated .google.cloud.dialogflow.v2.Intent.TrainingPhrase training_phrases = 9;

Specified by:: getTrainingPhrasesOrBuilderList in interface IntentOrBuilder

getTrainingPhrasesCount
```
public int getTrainingPhrasesCount()
```
```
 Optional. The collection of examples/templates that the agent is
 trained on.
 
```
repeated .google.cloud.dialogflow.v2.Intent.TrainingPhrase training_phrases = 9;
Specified by:

getTrainingPhrasesCount in interface IntentOrBuilder

getTrainingPhrases
```
public Intent.TrainingPhrase getTrainingPhrases(int index)
```
```
 Optional. The collection of examples/templates that the agent is
 trained on.
 
```
repeated .google.cloud.dialogflow.v2.Intent.TrainingPhrase training_phrases = 9;
Specified by:

getTrainingPhrases in interface IntentOrBuilder

getTrainingPhrasesOrBuilder
```
public Intent.TrainingPhraseOrBuilder getTrainingPhrasesOrBuilder(int index)
```
```
 Optional. The collection of examples/templates that the agent is
 trained on.
 
```
repeated .google.cloud.dialogflow.v2.Intent.TrainingPhrase training_phrases = 9;
Specified by:

getTrainingPhrasesOrBuilder in interface IntentOrBuilder

getAction

public java.lang.String getAction()

 Optional. The name of the action associated with the intent.

string action = 10;

Specified by:: getAction in interface IntentOrBuilder

getActionBytes

public ByteString getActionBytes()

 Optional. The name of the action associated with the intent.

string action = 10;

Specified by:: getActionBytes in interface IntentOrBuilder