public static final class Form.Builder extends com.google.protobuf.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][google.cloud.dialogflow.cx.v3.Page]. When form filling is done, the filled parameters will be written to the [session][google.cloud.dialogflow.cx.v3.SessionInfo.parameters].Protobuf type
google.cloud.dialogflow.cx.v3.Form| Modifier and Type | Method and Description |
|---|---|
Form.Builder |
addAllParameters(Iterable<? extends Form.Parameter> values)
Parameters to collect from the user.
|
Form.Builder |
addParameters(Form.Parameter.Builder builderForValue)
Parameters to collect from the user.
|
Form.Builder |
addParameters(Form.Parameter value)
Parameters to collect from the user.
|
Form.Builder |
addParameters(int index,
Form.Parameter.Builder builderForValue)
Parameters to collect from the user.
|
Form.Builder |
addParameters(int index,
Form.Parameter value)
Parameters to collect from the user.
|
Form.Parameter.Builder |
addParametersBuilder()
Parameters to collect from the user.
|
Form.Parameter.Builder |
addParametersBuilder(int index)
Parameters to collect from the user.
|
Form.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
Form |
build() |
Form |
buildPartial() |
Form.Builder |
clear() |
Form.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
Form.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
Form.Builder |
clearParameters()
Parameters to collect from the user.
|
Form.Builder |
clone() |
Form |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
Form.Parameter |
getParameters(int index)
Parameters to collect from the user.
|
Form.Parameter.Builder |
getParametersBuilder(int index)
Parameters to collect from the user.
|
List<Form.Parameter.Builder> |
getParametersBuilderList()
Parameters to collect from the user.
|
int |
getParametersCount()
Parameters to collect from the user.
|
List<Form.Parameter> |
getParametersList()
Parameters to collect from the user.
|
Form.ParameterOrBuilder |
getParametersOrBuilder(int index)
Parameters to collect from the user.
|
List<? extends Form.ParameterOrBuilder> |
getParametersOrBuilderList()
Parameters to collect from the user.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
Form.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
Form.Builder |
mergeFrom(Form other) |
Form.Builder |
mergeFrom(com.google.protobuf.Message other) |
Form.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
Form.Builder |
removeParameters(int index)
Parameters to collect from the user.
|
Form.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
Form.Builder |
setParameters(int index,
Form.Parameter.Builder builderForValue)
Parameters to collect from the user.
|
Form.Builder |
setParameters(int index,
Form.Parameter value)
Parameters to collect from the user.
|
Form.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
Form.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitfindInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Form.Builder>public Form.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<Form.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Form.Builder>public Form getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic Form build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic Form buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic Form.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<Form.Builder>public Form.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<Form.Builder>public Form.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<Form.Builder>public Form.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Form.Builder>public Form.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Form.Builder>public Form.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Form.Builder>public Form.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<Form.Builder>public Form.Builder mergeFrom(Form other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Form.Builder>public Form.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<Form.Builder>IOExceptionpublic List<Form.Parameter> getParametersList()
Parameters to collect from the user.
repeated .google.cloud.dialogflow.cx.v3.Form.Parameter parameters = 1;getParametersList in interface FormOrBuilderpublic int getParametersCount()
Parameters to collect from the user.
repeated .google.cloud.dialogflow.cx.v3.Form.Parameter parameters = 1;getParametersCount in interface FormOrBuilderpublic Form.Parameter getParameters(int index)
Parameters to collect from the user.
repeated .google.cloud.dialogflow.cx.v3.Form.Parameter parameters = 1;getParameters in interface FormOrBuilderpublic 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 addParameters(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 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.Builder builderForValue)
Parameters to collect from the user.
repeated .google.cloud.dialogflow.cx.v3.Form.Parameter parameters = 1;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;public Form.Builder clearParameters()
Parameters to collect from the user.
repeated .google.cloud.dialogflow.cx.v3.Form.Parameter parameters = 1;public Form.Builder removeParameters(int index)
Parameters to collect from the user.
repeated .google.cloud.dialogflow.cx.v3.Form.Parameter parameters = 1;public Form.Parameter.Builder getParametersBuilder(int index)
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;getParametersOrBuilder in interface FormOrBuilderpublic List<? extends Form.ParameterOrBuilder> getParametersOrBuilderList()
Parameters to collect from the user.
repeated .google.cloud.dialogflow.cx.v3.Form.Parameter parameters = 1;getParametersOrBuilderList in interface FormOrBuilderpublic 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;public List<Form.Parameter.Builder> getParametersBuilderList()
Parameters to collect from the user.
repeated .google.cloud.dialogflow.cx.v3.Form.Parameter parameters = 1;public final Form.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Form.Builder>public final Form.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Form.Builder>Copyright © 2022 Google LLC. All rights reserved.