Class Form (0.52.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

Implements

FormOrBuilder

Static Fields

PARAMETERS_FIELD_NUMBER

public static final int PARAMETERS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Form getDefaultInstance()
Returns
TypeDescription
Form

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Form.Builder newBuilder()
Returns
TypeDescription
Form.Builder

newBuilder(Form prototype)

public static Form.Builder newBuilder(Form prototype)
Parameter
NameDescription
prototypeForm
Returns
TypeDescription
Form.Builder

parseDelimitedFrom(InputStream input)

public static Form parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Form
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Form parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Form
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Form parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Form
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Form parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Form
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Form parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Form
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Form parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Form
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Form parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Form
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Form parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Form
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Form parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Form
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Form parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Form
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Form parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Form
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Form parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Form
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Form> parser()
Returns
TypeDescription
Parser<Form>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public Form getDefaultInstanceForType()
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
Form.Parameter

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>

getParserForType()

public Parser<Form> getParserForType()
Returns
TypeDescription
Parser<Form>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Form.Builder newBuilderForType()
Returns
TypeDescription
Form.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Form.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Form.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Form.Builder toBuilder()
Returns
TypeDescription
Form.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException