Class Form.Builder (0.33.0)

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.v3beta1.Form

Implements

FormOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllParameters(Iterable<? extends Form.Parameter> values)

public Form.Builder addAllParameters(Iterable<? extends Form.Parameter> values)

Parameters to collect from the user.

repeated .google.cloud.dialogflow.cx.v3beta1.Form.Parameter parameters = 1;

Parameter
Name Description
values Iterable<? extends com.google.cloud.dialogflow.cx.v3beta1.Form.Parameter>
Returns
Type Description
Form.Builder

addParameters(Form.Parameter value)

public Form.Builder addParameters(Form.Parameter value)

Parameters to collect from the user.

repeated .google.cloud.dialogflow.cx.v3beta1.Form.Parameter parameters = 1;

Parameter
Name Description
value Form.Parameter
Returns
Type Description
Form.Builder

addParameters(Form.Parameter.Builder builderForValue)

public Form.Builder addParameters(Form.Parameter.Builder builderForValue)

Parameters to collect from the user.

repeated .google.cloud.dialogflow.cx.v3beta1.Form.Parameter parameters = 1;

Parameter
Name Description
builderForValue Form.Parameter.Builder
Returns
Type Description
Form.Builder

addParameters(int index, Form.Parameter value)

public Form.Builder addParameters(int index, Form.Parameter value)

Parameters to collect from the user.

repeated .google.cloud.dialogflow.cx.v3beta1.Form.Parameter parameters = 1;

Parameters
Name Description
index int
value Form.Parameter
Returns
Type Description
Form.Builder

addParameters(int index, Form.Parameter.Builder builderForValue)

public Form.Builder addParameters(int index, Form.Parameter.Builder builderForValue)

Parameters to collect from the user.

repeated .google.cloud.dialogflow.cx.v3beta1.Form.Parameter parameters = 1;

Parameters
Name Description
index int
builderForValue Form.Parameter.Builder
Returns
Type Description
Form.Builder

addParametersBuilder()

public Form.Parameter.Builder addParametersBuilder()

Parameters to collect from the user.

repeated .google.cloud.dialogflow.cx.v3beta1.Form.Parameter parameters = 1;

Returns
Type Description
Form.Parameter.Builder

addParametersBuilder(int index)

public Form.Parameter.Builder addParametersBuilder(int index)

Parameters to collect from the user.

repeated .google.cloud.dialogflow.cx.v3beta1.Form.Parameter parameters = 1;

Parameter
Name Description
index int
Returns
Type Description
Form.Parameter.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Form.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Form.Builder
Overrides

build()

public Form build()
Returns
Type Description
Form

buildPartial()

public Form buildPartial()
Returns
Type Description
Form

clear()

public Form.Builder clear()
Returns
Type Description
Form.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public Form.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Form.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public Form.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Form.Builder
Overrides

clearParameters()

public Form.Builder clearParameters()

Parameters to collect from the user.

repeated .google.cloud.dialogflow.cx.v3beta1.Form.Parameter parameters = 1;

Returns
Type Description
Form.Builder

clone()

public Form.Builder clone()
Returns
Type Description
Form.Builder
Overrides

getDefaultInstanceForType()

public Form getDefaultInstanceForType()
Returns
Type Description
Form

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getParameters(int index)

public Form.Parameter getParameters(int index)

Parameters to collect from the user.

repeated .google.cloud.dialogflow.cx.v3beta1.Form.Parameter parameters = 1;

Parameter
Name Description
index int
Returns
Type Description
Form.Parameter

getParametersBuilder(int index)

public Form.Parameter.Builder getParametersBuilder(int index)

Parameters to collect from the user.

repeated .google.cloud.dialogflow.cx.v3beta1.Form.Parameter parameters = 1;

Parameter
Name Description
index int
Returns
Type Description
Form.Parameter.Builder

getParametersBuilderList()

public List<Form.Parameter.Builder> getParametersBuilderList()

Parameters to collect from the user.

repeated .google.cloud.dialogflow.cx.v3beta1.Form.Parameter parameters = 1;

Returns
Type Description
List<Builder>

getParametersCount()

public int getParametersCount()

Parameters to collect from the user.

repeated .google.cloud.dialogflow.cx.v3beta1.Form.Parameter parameters = 1;

Returns
Type Description
int

getParametersList()

public List<Form.Parameter> getParametersList()

Parameters to collect from the user.

repeated .google.cloud.dialogflow.cx.v3beta1.Form.Parameter parameters = 1;

Returns
Type Description
List<Parameter>

getParametersOrBuilder(int index)

public Form.ParameterOrBuilder getParametersOrBuilder(int index)

Parameters to collect from the user.

repeated .google.cloud.dialogflow.cx.v3beta1.Form.Parameter parameters = 1;

Parameter
Name Description
index int
Returns
Type Description
Form.ParameterOrBuilder

getParametersOrBuilderList()

public List<? extends Form.ParameterOrBuilder> getParametersOrBuilderList()

Parameters to collect from the user.

repeated .google.cloud.dialogflow.cx.v3beta1.Form.Parameter parameters = 1;

Returns
Type Description
List<? extends com.google.cloud.dialogflow.cx.v3beta1.Form.ParameterOrBuilder>

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Form other)

public Form.Builder mergeFrom(Form other)
Parameter
Name Description
other Form
Returns
Type Description
Form.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Form.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Form.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Form.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Form.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Form.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Form.Builder
Overrides

removeParameters(int index)

public Form.Builder removeParameters(int index)

Parameters to collect from the user.

repeated .google.cloud.dialogflow.cx.v3beta1.Form.Parameter parameters = 1;

Parameter
Name Description
index int
Returns
Type Description
Form.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Form.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Form.Builder
Overrides

setParameters(int index, Form.Parameter value)

public Form.Builder setParameters(int index, Form.Parameter value)

Parameters to collect from the user.

repeated .google.cloud.dialogflow.cx.v3beta1.Form.Parameter parameters = 1;

Parameters
Name Description
index int
value Form.Parameter
Returns
Type Description
Form.Builder

setParameters(int index, Form.Parameter.Builder builderForValue)

public Form.Builder setParameters(int index, Form.Parameter.Builder builderForValue)

Parameters to collect from the user.

repeated .google.cloud.dialogflow.cx.v3beta1.Form.Parameter parameters = 1;

Parameters
Name Description
index int
builderForValue Form.Parameter.Builder
Returns
Type Description
Form.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Form.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Form.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final Form.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Form.Builder
Overrides