Class Intent.Parameter.Builder (4.3.1)

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

Represents intent parameters.

Protobuf type google.cloud.dialogflow.v2.Intent.Parameter

Inheritance

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

Implements

Intent.ParameterOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[])

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

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

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

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

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

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

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

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

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

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

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

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

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

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

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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	`String` The 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	`ByteString` The 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

Overrides

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

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

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

Overrides

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

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

Overrides

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

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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.

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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	`int` The 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	`int` The 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

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

Overrides

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

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

Overrides

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Intent.Parameter.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	`UnknownFieldSet`

Returns

Type	Description
Intent.Parameter.Builder

Overrides

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

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	`String` The 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	`ByteString` The 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	`String` The 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	`ByteString` The 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	`String` The 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	`ByteString` The 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

Overrides

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

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	`boolean` The 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	`boolean` The 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	`String` The 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	`ByteString` The 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	`int` The index to set the value at.
value	`String` The 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

Overrides

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

setUnknownFields(UnknownFieldSet unknownFields)

public final Intent.Parameter.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	`UnknownFieldSet`

Returns

Type	Description
Intent.Parameter.Builder

Overrides

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

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	`String` The 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	`ByteString` The bytes for value to set.

Returns

Type	Description
Intent.Parameter.Builder	This builder for chaining.