Class Form (0.16.0) 

public final class Form extends GeneratedMessageV3 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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Form

Implements

FormOrBuilder

Static Fields

PARAMETERS_FIELD_NUMBER

public static final int PARAMETERS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Form getDefaultInstance()
Returns
Type Description
Form

getDescriptor()

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

newBuilder()

public static Form.Builder newBuilder()
Returns
Type Description
Form.Builder

newBuilder(Form prototype)

public static Form.Builder newBuilder(Form prototype)
Parameter
Name Description
prototype Form
Returns
Type Description
Form.Builder

parseDelimitedFrom(InputStream input)

public static Form parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Form
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Form parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Form
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Form parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Form
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Form parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Form
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Form parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Form
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Form parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Form
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Form parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Form
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Form parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Form
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Form parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Form
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Form parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Form
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Form parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Form
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Form parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Form
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Form> parser()
Returns
Type Description
Parser<Form>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public Form getDefaultInstanceForType()
Returns
Type Description
Form

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

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>

getParserForType()

public Parser<Form> getParserForType()
Returns
Type Description
Parser<Form>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
Type Description
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Form.Builder newBuilderForType()
Returns
Type Description
Form.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Form.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Form.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Form.Builder toBuilder()
Returns
Type Description
Form.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides Exceptions
Type Description
IOException