- 4.59.0 (latest)
- 4.58.0
- 4.57.0
- 4.55.0
- 4.54.0
- 4.53.0
- 4.52.0
- 4.51.0
- 4.50.0
- 4.49.0
- 4.48.0
- 4.47.0
- 4.46.0
- 4.45.0
- 4.43.0
- 4.42.0
- 4.41.0
- 4.40.0
- 4.39.0
- 4.38.0
- 4.37.0
- 4.36.0
- 4.35.0
- 4.34.0
- 4.33.0
- 4.30.0
- 4.29.0
- 4.28.0
- 4.27.0
- 4.26.0
- 4.25.0
- 4.24.0
- 4.23.0
- 4.22.0
- 4.21.0
- 4.20.0
- 4.19.0
- 4.18.0
- 4.17.0
- 4.15.0
- 4.14.0
- 4.13.0
- 4.12.0
- 4.11.0
- 4.10.0
- 4.9.1
- 4.8.6
- 4.7.5
- 4.6.0
- 4.5.11
- 4.4.0
- 4.3.1
public static final class Intent.Parameter.Builder extends GeneratedMessageV3.Builder<Intent.Parameter.Builder> implements Intent.ParameterOrBuilderRepresents intent parameters.
Protobuf type google.cloud.dialogflow.v2.Intent.Parameter
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Intent.Parameter.BuilderImplements
Intent.ParameterOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllPrompts(Iterable<String> values)
public Intent.Parameter.Builder addAllPrompts(Iterable<String> values)Optional. The collection of prompts that the agent can present to the user in order to collect a value for the parameter.
repeated string prompts = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The prompts to add. |
| Returns | |
|---|---|
| Type | Description |
Intent.Parameter.Builder |
This builder for chaining. |
addPrompts(String value)
public Intent.Parameter.Builder addPrompts(String value)Optional. The collection of prompts that the agent can present to the user in order to collect a value for the parameter.
repeated string prompts = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe prompts to add. |
| Returns | |
|---|---|
| Type | Description |
Intent.Parameter.Builder |
This builder for chaining. |
addPromptsBytes(ByteString value)
public Intent.Parameter.Builder addPromptsBytes(ByteString value)Optional. The collection of prompts that the agent can present to the user in order to collect a value for the parameter.
repeated string prompts = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the prompts to add. |
| Returns | |
|---|---|
| Type | Description |
Intent.Parameter.Builder |
This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Intent.Parameter.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Intent.Parameter.Builder |
|
build()
public Intent.Parameter build()| Returns | |
|---|---|
| Type | Description |
Intent.Parameter |
|
buildPartial()
public Intent.Parameter buildPartial()| Returns | |
|---|---|
| Type | Description |
Intent.Parameter |
|
clear()
public Intent.Parameter.Builder clear()| Returns | |
|---|---|
| Type | Description |
Intent.Parameter.Builder |
|
clearDefaultValue()
public Intent.Parameter.Builder clearDefaultValue() Optional. The default value to use when the value yields an empty
result.
Default values can be extracted from contexts by using the following
syntax: #context_name.parameter_name.
string default_value = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Intent.Parameter.Builder |
This builder for chaining. |
clearDisplayName()
public Intent.Parameter.Builder clearDisplayName()Required. The name of the parameter.
string display_name = 2;
| Returns | |
|---|---|
| Type | Description |
Intent.Parameter.Builder |
This builder for chaining. |
clearEntityTypeDisplayName()
public Intent.Parameter.Builder clearEntityTypeDisplayName() Optional. The name of the entity type, prefixed with @, that
describes values of the parameter. If the parameter is
required, this must be provided.
string entity_type_display_name = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Intent.Parameter.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public Intent.Parameter.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Intent.Parameter.Builder |
|
clearIsList()
public Intent.Parameter.Builder clearIsList()Optional. Indicates whether the parameter represents a list of values.
bool is_list = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Intent.Parameter.Builder |
This builder for chaining. |
clearMandatory()
public Intent.Parameter.Builder clearMandatory()Optional. Indicates whether the parameter is required. That is, whether the intent cannot be completed without collecting the parameter value.
bool mandatory = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Intent.Parameter.Builder |
This builder for chaining. |
clearName()
public Intent.Parameter.Builder clearName()The unique identifier of this parameter.
string name = 1;
| Returns | |
|---|---|
| Type | Description |
Intent.Parameter.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Intent.Parameter.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
Intent.Parameter.Builder |
|
clearPrompts()
public Intent.Parameter.Builder clearPrompts()Optional. The collection of prompts that the agent can present to the user in order to collect a value for the parameter.
repeated string prompts = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Intent.Parameter.Builder |
This builder for chaining. |
clearValue()
public Intent.Parameter.Builder clearValue()Optional. The definition of the parameter value. It can be:
- a constant string,
- a parameter value defined as
$parameter_name, - an original parameter value defined as
$parameter_name.original, - a parameter value from some context defined as
#context_name.parameter_name.
string value = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Intent.Parameter.Builder |
This builder for chaining. |
clone()
public Intent.Parameter.Builder clone()| Returns | |
|---|---|
| Type | Description |
Intent.Parameter.Builder |
|
getDefaultInstanceForType()
public Intent.Parameter getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Intent.Parameter |
|
getDefaultValue()
public String getDefaultValue() Optional. The default value to use when the value yields an empty
result.
Default values can be extracted from contexts by using the following
syntax: #context_name.parameter_name.
string default_value = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The defaultValue. |
getDefaultValueBytes()
public ByteString getDefaultValueBytes() Optional. The default value to use when the value yields an empty
result.
Default values can be extracted from contexts by using the following
syntax: #context_name.parameter_name.
string default_value = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for defaultValue. |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getDisplayName()
public String getDisplayName()Required. The name of the parameter.
string display_name = 2;
| Returns | |
|---|---|
| Type | Description |
String |
The displayName. |
getDisplayNameBytes()
public ByteString getDisplayNameBytes()Required. The name of the parameter.
string display_name = 2;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for displayName. |
getEntityTypeDisplayName()
public String getEntityTypeDisplayName() Optional. The name of the entity type, prefixed with @, that
describes values of the parameter. If the parameter is
required, this must be provided.
string entity_type_display_name = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The entityTypeDisplayName. |
getEntityTypeDisplayNameBytes()
public ByteString getEntityTypeDisplayNameBytes() Optional. The name of the entity type, prefixed with @, that
describes values of the parameter. If the parameter is
required, this must be provided.
string entity_type_display_name = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for entityTypeDisplayName. |
getIsList()
public boolean getIsList()Optional. Indicates whether the parameter represents a list of values.
bool is_list = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
The isList. |
getMandatory()
public boolean getMandatory()Optional. Indicates whether the parameter is required. That is, whether the intent cannot be completed without collecting the parameter value.
bool mandatory = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
The mandatory. |
getName()
public String getName()The unique identifier of this parameter.
string name = 1;
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public ByteString getNameBytes()The unique identifier of this parameter.
string name = 1;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getPrompts(int index)
public String getPrompts(int index)Optional. The collection of prompts that the agent can present to the user in order to collect a value for the parameter.
repeated string prompts = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The prompts at the given index. |
getPromptsBytes(int index)
public ByteString getPromptsBytes(int index)Optional. The collection of prompts that the agent can present to the user in order to collect a value for the parameter.
repeated string prompts = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the prompts at the given index. |
getPromptsCount()
public int getPromptsCount()Optional. The collection of prompts that the agent can present to the user in order to collect a value for the parameter.
repeated string prompts = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The count of prompts. |
getPromptsList()
public ProtocolStringList getPromptsList()Optional. The collection of prompts that the agent can present to the user in order to collect a value for the parameter.
repeated string prompts = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the prompts. |
getValue()
public String getValue()Optional. The definition of the parameter value. It can be:
- a constant string,
- a parameter value defined as
$parameter_name, - an original parameter value defined as
$parameter_name.original, - a parameter value from some context defined as
#context_name.parameter_name.
string value = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The value. |
getValueBytes()
public ByteString getValueBytes()Optional. The definition of the parameter value. It can be:
- a constant string,
- a parameter value defined as
$parameter_name, - an original parameter value defined as
$parameter_name.original, - a parameter value from some context defined as
#context_name.parameter_name.
string value = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for value. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(Intent.Parameter other)
public Intent.Parameter.Builder mergeFrom(Intent.Parameter other)| Parameter | |
|---|---|
| Name | Description |
other |
Intent.Parameter |
| Returns | |
|---|---|
| Type | Description |
Intent.Parameter.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Intent.Parameter.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Intent.Parameter.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public Intent.Parameter.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
Intent.Parameter.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Intent.Parameter.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Intent.Parameter.Builder |
|
setDefaultValue(String value)
public Intent.Parameter.Builder setDefaultValue(String value) Optional. The default value to use when the value yields an empty
result.
Default values can be extracted from contexts by using the following
syntax: #context_name.parameter_name.
string default_value = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe defaultValue to set. |
| Returns | |
|---|---|
| Type | Description |
Intent.Parameter.Builder |
This builder for chaining. |
setDefaultValueBytes(ByteString value)
public Intent.Parameter.Builder setDefaultValueBytes(ByteString value) Optional. The default value to use when the value yields an empty
result.
Default values can be extracted from contexts by using the following
syntax: #context_name.parameter_name.
string default_value = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for defaultValue to set. |
| Returns | |
|---|---|
| Type | Description |
Intent.Parameter.Builder |
This builder for chaining. |
setDisplayName(String value)
public Intent.Parameter.Builder setDisplayName(String value)Required. The name of the parameter.
string display_name = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe displayName to set. |
| Returns | |
|---|---|
| Type | Description |
Intent.Parameter.Builder |
This builder for chaining. |
setDisplayNameBytes(ByteString value)
public Intent.Parameter.Builder setDisplayNameBytes(ByteString value)Required. The name of the parameter.
string display_name = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for displayName to set. |
| Returns | |
|---|---|
| Type | Description |
Intent.Parameter.Builder |
This builder for chaining. |
setEntityTypeDisplayName(String value)
public Intent.Parameter.Builder setEntityTypeDisplayName(String value) Optional. The name of the entity type, prefixed with @, that
describes values of the parameter. If the parameter is
required, this must be provided.
string entity_type_display_name = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe entityTypeDisplayName to set. |
| Returns | |
|---|---|
| Type | Description |
Intent.Parameter.Builder |
This builder for chaining. |
setEntityTypeDisplayNameBytes(ByteString value)
public Intent.Parameter.Builder setEntityTypeDisplayNameBytes(ByteString value) Optional. The name of the entity type, prefixed with @, that
describes values of the parameter. If the parameter is
required, this must be provided.
string entity_type_display_name = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for entityTypeDisplayName to set. |
| Returns | |
|---|---|
| Type | Description |
Intent.Parameter.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public Intent.Parameter.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Intent.Parameter.Builder |
|
setIsList(boolean value)
public Intent.Parameter.Builder setIsList(boolean value)Optional. Indicates whether the parameter represents a list of values.
bool is_list = 8 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe isList to set. |
| Returns | |
|---|---|
| Type | Description |
Intent.Parameter.Builder |
This builder for chaining. |
setMandatory(boolean value)
public Intent.Parameter.Builder setMandatory(boolean value)Optional. Indicates whether the parameter is required. That is, whether the intent cannot be completed without collecting the parameter value.
bool mandatory = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe mandatory to set. |
| Returns | |
|---|---|
| Type | Description |
Intent.Parameter.Builder |
This builder for chaining. |
setName(String value)
public Intent.Parameter.Builder setName(String value)The unique identifier of this parameter.
string name = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
Intent.Parameter.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public Intent.Parameter.Builder setNameBytes(ByteString value)The unique identifier of this parameter.
string name = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
Intent.Parameter.Builder |
This builder for chaining. |
setPrompts(int index, String value)
public Intent.Parameter.Builder setPrompts(int index, String value)Optional. The collection of prompts that the agent can present to the user in order to collect a value for the parameter.
repeated string prompts = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe prompts to set. |
| Returns | |
|---|---|
| Type | Description |
Intent.Parameter.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Intent.Parameter.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Intent.Parameter.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final Intent.Parameter.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Intent.Parameter.Builder |
|
setValue(String value)
public Intent.Parameter.Builder setValue(String value)Optional. The definition of the parameter value. It can be:
- a constant string,
- a parameter value defined as
$parameter_name, - an original parameter value defined as
$parameter_name.original, - a parameter value from some context defined as
#context_name.parameter_name.
string value = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe value to set. |
| Returns | |
|---|---|
| Type | Description |
Intent.Parameter.Builder |
This builder for chaining. |
setValueBytes(ByteString value)
public Intent.Parameter.Builder setValueBytes(ByteString value)Optional. The definition of the parameter value. It can be:
- a constant string,
- a parameter value defined as
$parameter_name, - an original parameter value defined as
$parameter_name.original, - a parameter value from some context defined as
#context_name.parameter_name.
string value = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for value to set. |
| Returns | |
|---|---|
| Type | Description |
Intent.Parameter.Builder |
This builder for chaining. |