Intent (proto-google-cloud-dialogflow-cx-v3 0.71.0 API)

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

All Implemented Interfaces:: IntentOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class Intent
extends com.google.protobuf.GeneratedMessageV3
implements IntentOrBuilder

 An intent represents a user's intent to interact with a conversational agent.

 You can provide information for the Dialogflow API to use to match user input
 to an intent by adding training phrases (i.e., examples of user input) to
 your intent.

Protobuf type google.cloud.dialogflow.cx.v3.Intent

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Intent.Builder` An intent represents a user's intent to interact with a conversational agent.
`static class`	`Intent.Parameter` Represents an intent parameter.
`static interface`	`Intent.ParameterOrBuilder`
`static class`	`Intent.TrainingPhrase` Represents an example that the agent is trained on to identify the intent.
`static interface`	`Intent.TrainingPhraseOrBuilder`

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

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DESCRIPTION_FIELD_NUMBER`
`static int`	`DISPLAY_NAME_FIELD_NUMBER`
`static int`	`IS_FALLBACK_FIELD_NUMBER`
`static int`	`LABELS_FIELD_NUMBER`
`static int`	`NAME_FIELD_NUMBER`
`static int`	`PARAMETERS_FIELD_NUMBER`
`static int`	`PRIORITY_FIELD_NUMBER`
`static int`	`TRAINING_PHRASES_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 Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`containsLabels(String key)` The key/value metadata to label an intent.
`boolean`	`equals(Object obj)`
`static Intent`	`getDefaultInstance()`
`Intent`	`getDefaultInstanceForType()`
`String`	`getDescription()` Human readable description for better understanding an intent like its scope, content, result etc.
`com.google.protobuf.ByteString`	`getDescriptionBytes()` Human readable description for better understanding an intent like its scope, content, result etc.
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`String`	`getDisplayName()` Required.
`com.google.protobuf.ByteString`	`getDisplayNameBytes()` Required.
`boolean`	`getIsFallback()` Indicates whether this is a fallback intent.
`Map<String,String>`	`getLabels()` Deprecated.
`int`	`getLabelsCount()` The key/value metadata to label an intent.
`Map<String,String>`	`getLabelsMap()` The key/value metadata to label an intent.
`String`	`getLabelsOrDefault(String key, String defaultValue)` The key/value metadata to label an intent.
`String`	`getLabelsOrThrow(String key)` The key/value metadata to label an intent.
`String`	`getName()` The unique identifier of the intent.
`com.google.protobuf.ByteString`	`getNameBytes()` The unique identifier of the intent.
`Intent.Parameter`	`getParameters(int index)` The collection of parameters associated with the intent.
`int`	`getParametersCount()` The collection of parameters associated with the intent.
`List<Intent.Parameter>`	`getParametersList()` The collection of parameters associated with the intent.
`Intent.ParameterOrBuilder`	`getParametersOrBuilder(int index)` The collection of parameters associated with the intent.
`List<? extends Intent.ParameterOrBuilder>`	`getParametersOrBuilderList()` The collection of parameters associated with the intent.
`com.google.protobuf.Parser<Intent>`	`getParserForType()`
`int`	`getPriority()` The priority of this intent.
`int`	`getSerializedSize()`
`Intent.TrainingPhrase`	`getTrainingPhrases(int index)` The collection of training phrases the agent is trained on to identify the intent.
`int`	`getTrainingPhrasesCount()` The collection of training phrases the agent is trained on to identify the intent.
`List<Intent.TrainingPhrase>`	`getTrainingPhrasesList()` The collection of training phrases the agent is trained on to identify the intent.
`Intent.TrainingPhraseOrBuilder`	`getTrainingPhrasesOrBuilder(int index)` The collection of training phrases the agent is trained on to identify the intent.
`List<? extends Intent.TrainingPhraseOrBuilder>`	`getTrainingPhrasesOrBuilderList()` The collection of training phrases the agent is trained on to identify the intent.
`int`	`hashCode()`
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`protected com.google.protobuf.MapFieldReflectionAccessor`	`internalGetMapFieldReflection(int number)`
`boolean`	`isInitialized()`
`static Intent.Builder`	`newBuilder()`
`static Intent.Builder`	`newBuilder(Intent prototype)`
`Intent.Builder`	`newBuilderForType()`
`protected Intent.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`protected Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`static Intent`	`parseDelimitedFrom(InputStream input)`
`static Intent`	`parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Intent`	`parseFrom(byte[] data)`
`static Intent`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Intent`	`parseFrom(ByteBuffer data)`
`static Intent`	`parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Intent`	`parseFrom(com.google.protobuf.ByteString data)`
`static Intent`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Intent`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static Intent`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Intent`	`parseFrom(InputStream input)`
`static Intent`	`parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<Intent>`	`parser()`
`Intent.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

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, getUnknownFields, 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
- TRAINING_PHRASES_FIELD_NUMBER
```
public static final int TRAINING_PHRASES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PARAMETERS_FIELD_NUMBER
```
public static final int PARAMETERS_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
- LABELS_FIELD_NUMBER
```
public static final int LABELS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DESCRIPTION_FIELD_NUMBER
```
public static final int DESCRIPTION_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:: newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapFieldReflection
```
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
```
Overrides:

internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getName

public String getName()

 The unique identifier of the intent.
 Required for the
 [Intents.UpdateIntent][google.cloud.dialogflow.cx.v3.Intents.UpdateIntent]
 method.
 [Intents.CreateIntent][google.cloud.dialogflow.cx.v3.Intents.CreateIntent]
 populates the name automatically.
 Format:
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>`.

string name = 1;

Specified by:: getName in interface IntentOrBuilder
Returns:: The name.

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 The unique identifier of the intent.
 Required for the
 [Intents.UpdateIntent][google.cloud.dialogflow.cx.v3.Intents.UpdateIntent]
 method.
 [Intents.CreateIntent][google.cloud.dialogflow.cx.v3.Intents.CreateIntent]
 populates the name automatically.
 Format:
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>`.

string name = 1;

Specified by:: getNameBytes in interface IntentOrBuilder
Returns:: The bytes for name.

getDisplayName
```
public String getDisplayName()
```
```
 Required. The human-readable name of the intent, unique within the agent.
 
```
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
Specified by:

getDisplayName in interface IntentOrBuilder

Returns:

The displayName.

getDisplayNameBytes
```
public com.google.protobuf.ByteString getDisplayNameBytes()
```
```
 Required. The human-readable name of the intent, unique within the agent.
 
```
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
Specified by:

getDisplayNameBytes in interface IntentOrBuilder

Returns:

The bytes for displayName.

getTrainingPhrasesList
```
public List<Intent.TrainingPhrase> getTrainingPhrasesList()
```
```
 The collection of training phrases the agent is trained on to identify the
 intent.
 
```
repeated .google.cloud.dialogflow.cx.v3.Intent.TrainingPhrase training_phrases = 3;
Specified by:

getTrainingPhrasesList in interface IntentOrBuilder

getTrainingPhrasesOrBuilderList
```
public List<? extends Intent.TrainingPhraseOrBuilder> getTrainingPhrasesOrBuilderList()
```
```
 The collection of training phrases the agent is trained on to identify the
 intent.
 
```
repeated .google.cloud.dialogflow.cx.v3.Intent.TrainingPhrase training_phrases = 3;
Specified by:

getTrainingPhrasesOrBuilderList in interface IntentOrBuilder

getTrainingPhrasesCount
```
public int getTrainingPhrasesCount()
```
```
 The collection of training phrases the agent is trained on to identify the
 intent.
 
```
repeated .google.cloud.dialogflow.cx.v3.Intent.TrainingPhrase training_phrases = 3;
Specified by:

getTrainingPhrasesCount in interface IntentOrBuilder

getTrainingPhrases
```
public Intent.TrainingPhrase getTrainingPhrases(int index)
```
```
 The collection of training phrases the agent is trained on to identify the
 intent.
 
```
repeated .google.cloud.dialogflow.cx.v3.Intent.TrainingPhrase training_phrases = 3;
Specified by:

getTrainingPhrases in interface IntentOrBuilder

getTrainingPhrasesOrBuilder
```
public Intent.TrainingPhraseOrBuilder getTrainingPhrasesOrBuilder(int index)
```
```
 The collection of training phrases the agent is trained on to identify the
 intent.
 
```
repeated .google.cloud.dialogflow.cx.v3.Intent.TrainingPhrase training_phrases = 3;
Specified by:

getTrainingPhrasesOrBuilder in interface IntentOrBuilder

getParametersList
```
public List<Intent.Parameter> getParametersList()
```
```
 The collection of parameters associated with the intent.
 
```
repeated .google.cloud.dialogflow.cx.v3.Intent.Parameter parameters = 4;
Specified by:

getParametersList in interface IntentOrBuilder

getParametersOrBuilderList
```
public List<? extends Intent.ParameterOrBuilder> getParametersOrBuilderList()
```
```
 The collection of parameters associated with the intent.
 
```
repeated .google.cloud.dialogflow.cx.v3.Intent.Parameter parameters = 4;
Specified by:

getParametersOrBuilderList in interface IntentOrBuilder

getParametersCount
```
public int getParametersCount()
```
```
 The collection of parameters associated with the intent.
 
```
repeated .google.cloud.dialogflow.cx.v3.Intent.Parameter parameters = 4;
Specified by:

getParametersCount in interface IntentOrBuilder

getParameters
```
public Intent.Parameter getParameters(int index)
```
```
 The collection of parameters associated with the intent.
 
```
repeated .google.cloud.dialogflow.cx.v3.Intent.Parameter parameters = 4;
Specified by:

getParameters in interface IntentOrBuilder

getParametersOrBuilder
```
public Intent.ParameterOrBuilder getParametersOrBuilder(int index)
```
```
 The collection of parameters associated with the intent.
 
```
repeated .google.cloud.dialogflow.cx.v3.Intent.Parameter parameters = 4;
Specified by:

getParametersOrBuilder in interface IntentOrBuilder

getPriority

public int getPriority()

 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 = 5;

Specified by:: getPriority in interface IntentOrBuilder
Returns:: The priority.

getIsFallback

public boolean getIsFallback()

 Indicates whether this is a fallback intent. Currently only default
 fallback intent is allowed in the agent, which is added upon agent
 creation.
 Adding training phrases to fallback intent is useful in the case of
 requests that are mistakenly matched, since training phrases assigned to
 fallback intents act as negative examples that triggers no-match event.

bool is_fallback = 6;

Specified by:: getIsFallback in interface IntentOrBuilder
Returns:: The isFallback.