public static final class Form.Builder extends GeneratedMessageV3.Builder<Form.Builder> implements FormOrBuilder
A form is a data model that groups related parameters that can be collected
from the user. The process in which the agent prompts the user and collects
parameter values from the user is called form filling. A form can be added to
a page. When form filling is done, the filled parameters will be
written to the session.
Protobuf type google.cloud.dialogflow.cx.v3.Form
Static Methods
public static final Descriptors.Descriptor getDescriptor()
Returns
Methods
public Form.Builder addAllParameters(Iterable<? extends Form.Parameter> values)
Parameters to collect from the user.
repeated .google.cloud.dialogflow.cx.v3.Form.Parameter parameters = 1;
Parameter
Name |
Description |
values |
Iterable<? extends com.google.cloud.dialogflow.cx.v3.Form.Parameter>
|
Returns
public Form.Builder addParameters(Form.Parameter value)
Parameters to collect from the user.
repeated .google.cloud.dialogflow.cx.v3.Form.Parameter parameters = 1;
Parameter
Returns
public Form.Builder addParameters(Form.Parameter.Builder builderForValue)
Parameters to collect from the user.
repeated .google.cloud.dialogflow.cx.v3.Form.Parameter parameters = 1;
Parameter
Returns
public Form.Builder addParameters(int index, Form.Parameter value)
Parameters to collect from the user.
repeated .google.cloud.dialogflow.cx.v3.Form.Parameter parameters = 1;
Parameters
Returns
public Form.Builder addParameters(int index, Form.Parameter.Builder builderForValue)
Parameters to collect from the user.
repeated .google.cloud.dialogflow.cx.v3.Form.Parameter parameters = 1;
Parameters
Returns
public Form.Parameter.Builder addParametersBuilder()
Parameters to collect from the user.
repeated .google.cloud.dialogflow.cx.v3.Form.Parameter parameters = 1;
Returns
public Form.Parameter.Builder addParametersBuilder(int index)
Parameters to collect from the user.
repeated .google.cloud.dialogflow.cx.v3.Form.Parameter parameters = 1;
Parameter
Name |
Description |
index |
int
|
Returns
public Form.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
Returns
public Form buildPartial()
Returns
public Form.Builder clear()
Returns
Overrides
public Form.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Returns
Overrides
public Form.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Returns
Overrides
public Form.Builder clearParameters()
Parameters to collect from the user.
repeated .google.cloud.dialogflow.cx.v3.Form.Parameter parameters = 1;
Returns
public Form.Builder clone()
Returns
Overrides
public Form getDefaultInstanceForType()
Returns
public Descriptors.Descriptor getDescriptorForType()
Returns
Overrides
public Form.Parameter getParameters(int index)
Parameters to collect from the user.
repeated .google.cloud.dialogflow.cx.v3.Form.Parameter parameters = 1;
Parameter
Name |
Description |
index |
int
|
Returns
public Form.Parameter.Builder getParametersBuilder(int index)
Parameters to collect from the user.
repeated .google.cloud.dialogflow.cx.v3.Form.Parameter parameters = 1;
Parameter
Name |
Description |
index |
int
|
Returns
public List<Form.Parameter.Builder> getParametersBuilderList()
Parameters to collect from the user.
repeated .google.cloud.dialogflow.cx.v3.Form.Parameter parameters = 1;
Returns
public int getParametersCount()
Parameters to collect from the user.
repeated .google.cloud.dialogflow.cx.v3.Form.Parameter parameters = 1;
Returns
public List<Form.Parameter> getParametersList()
Parameters to collect from the user.
repeated .google.cloud.dialogflow.cx.v3.Form.Parameter parameters = 1;
Returns
public Form.ParameterOrBuilder getParametersOrBuilder(int index)
Parameters to collect from the user.
repeated .google.cloud.dialogflow.cx.v3.Form.Parameter parameters = 1;
Parameter
Name |
Description |
index |
int
|
Returns
public List<? extends Form.ParameterOrBuilder> getParametersOrBuilderList()
Parameters to collect from the user.
repeated .google.cloud.dialogflow.cx.v3.Form.Parameter parameters = 1;
Returns
Type |
Description |
List<? extends com.google.cloud.dialogflow.cx.v3.Form.ParameterOrBuilder> |
|
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
public final boolean isInitialized()
Returns
Overrides
public Form.Builder mergeFrom(Form other)
Parameter
Name |
Description |
other |
Form
|
Returns
public Form.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
public Form.Builder mergeFrom(Message other)
Parameter
Returns
Overrides
public final Form.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
public Form.Builder removeParameters(int index)
Parameters to collect from the user.
repeated .google.cloud.dialogflow.cx.v3.Form.Parameter parameters = 1;
Parameter
Name |
Description |
index |
int
|
Returns
public Form.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
public Form.Builder setParameters(int index, Form.Parameter value)
Parameters to collect from the user.
repeated .google.cloud.dialogflow.cx.v3.Form.Parameter parameters = 1;
Parameters
Returns
public Form.Builder setParameters(int index, Form.Parameter.Builder builderForValue)
Parameters to collect from the user.
repeated .google.cloud.dialogflow.cx.v3.Form.Parameter parameters = 1;
Parameters
Returns
public Form.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
Overrides
public final Form.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides