Class Form.Builder (0.14.2)

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
TypeDescription
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
NameDescription
valuesIterable<? extends com.google.cloud.dialogflow.cx.v3beta1.Form.Parameter>
Returns
TypeDescription
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
NameDescription
valueForm.Parameter
Returns
TypeDescription
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
NameDescription
builderForValueForm.Parameter.Builder
Returns
TypeDescription
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
NameDescription
indexint
valueForm.Parameter
Returns
TypeDescription
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
NameDescription
indexint
builderForValueForm.Parameter.Builder
Returns
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
Form.Parameter.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Form.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Form.Builder
Overrides

build()

public Form build()
Returns
TypeDescription
Form

buildPartial()

public Form buildPartial()
Returns
TypeDescription
Form

clear()

public Form.Builder clear()
Returns
TypeDescription
Form.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public Form.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Form.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public Form.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
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
TypeDescription
Form.Builder

clone()

public Form.Builder clone()
Returns
TypeDescription
Form.Builder
Overrides

getDefaultInstanceForType()

public Form getDefaultInstanceForType()
Returns
TypeDescription
Form

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
List<Builder>

getParametersCount()

public int getParametersCount()

Parameters to collect from the user.

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

Returns
TypeDescription
int

getParametersList()

public List<Form.Parameter> getParametersList()

Parameters to collect from the user.

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

Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
List<? extends com.google.cloud.dialogflow.cx.v3beta1.Form.ParameterOrBuilder>

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(Form other)

public Form.Builder mergeFrom(Form other)
Parameter
NameDescription
otherForm
Returns
TypeDescription
Form.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Form.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Form.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Form.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Form.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Form.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
Form.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Form.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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
NameDescription
indexint
valueForm.Parameter
Returns
TypeDescription
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
NameDescription
indexint
builderForValueForm.Parameter.Builder
Returns
TypeDescription
Form.Builder

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

public Form.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Form.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final Form.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Form.Builder
Overrides