Class Form.Builder (0.34.0)
Version 0.34.0keyboard_arrow_down
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
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
public static final Descriptors . Descriptor getDescriptor ()
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
valuesIterable <? extends com.google.cloud.dialogflow.cx.v3.Form.Parameter >
public Form . Builder addParameters ( Form . Parameter value )
Parameters to collect from the user.
repeated .google.cloud.dialogflow.cx.v3.Form.Parameter parameters = 1;
public Form . Builder addParameters ( Form . Parameter . Builder builderForValue )
Parameters to collect from the user.
repeated .google.cloud.dialogflow.cx.v3.Form.Parameter parameters = 1;
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;
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;
public Form . Parameter . Builder addParametersBuilder ()
Parameters to collect from the user.
repeated .google.cloud.dialogflow.cx.v3.Form.Parameter parameters = 1;
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
indexint
public Form . Builder addRepeatedField ( Descriptors . FieldDescriptor field , Object value )
Overrides
Returns
Type Description
Form
public Form buildPartial ()
Returns
Type Description
Form
public Form . Builder clear ()
Overrides
public Form . Builder clearField ( Descriptors . FieldDescriptor field )
Overrides
public Form . Builder clearOneof ( Descriptors . OneofDescriptor oneof )
Overrides
public Form . Builder clearParameters ()
Parameters to collect from the user.
repeated .google.cloud.dialogflow.cx.v3.Form.Parameter parameters = 1;
public Form . Builder clone ()
Overrides
public Form getDefaultInstanceForType ()
Returns
Type Description
Form
public Descriptors . Descriptor getDescriptorForType ()
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
indexint
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
indexint
public List<Form . Parameter . Builder > getParametersBuilderList ()
Parameters to collect from the user.
repeated .google.cloud.dialogflow.cx.v3.Form.Parameter parameters = 1;
public int getParametersCount ()
Parameters to collect from the user.
repeated .google.cloud.dialogflow.cx.v3.Form.Parameter parameters = 1;
Returns
Type Description
int
public List<Form . Parameter > getParametersList ()
Parameters to collect from the user.
repeated .google.cloud.dialogflow.cx.v3.Form.Parameter parameters = 1;
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
indexint
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 ()
Overrides
public final boolean isInitialized ()
Overrides
public Form . Builder mergeFrom ( Form other )
Parameter
Name Description
otherForm
public Form . Builder mergeFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Overrides
public Form . Builder mergeFrom ( Message other )
Parameter
Name Description
otherMessage
Overrides
public final Form . Builder mergeUnknownFields ( UnknownFieldSet unknownFields )
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
indexint
public Form . Builder setField ( Descriptors . FieldDescriptor field , Object value )
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;
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;
public Form . Builder setRepeatedField ( Descriptors . FieldDescriptor field , int index , Object value )
Overrides
public final Form . Builder setUnknownFields ( UnknownFieldSet unknownFields )
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-29 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-29 UTC."],[],[]]
