Class Form.Parameter (0.23.0) 

public static final class Form.Parameter extends GeneratedMessageV3 implements Form.ParameterOrBuilder

Represents a form parameter.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Form.Parameter

Inheritance

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

Static Fields

DEFAULT_VALUE_FIELD_NUMBER

public static final int DEFAULT_VALUE_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

ENTITY_TYPE_FIELD_NUMBER

public static final int ENTITY_TYPE_FIELD_NUMBER
Field Value
Type Description
int

FILL_BEHAVIOR_FIELD_NUMBER

public static final int FILL_BEHAVIOR_FIELD_NUMBER
Field Value
Type Description
int

IS_LIST_FIELD_NUMBER

public static final int IS_LIST_FIELD_NUMBER
Field Value
Type Description
int

REDACT_FIELD_NUMBER

public static final int REDACT_FIELD_NUMBER
Field Value
Type Description
int

REQUIRED_FIELD_NUMBER

public static final int REQUIRED_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Form.Parameter getDefaultInstance()
Returns
Type Description
Form.Parameter

getDescriptor()

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

newBuilder()

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

newBuilder(Form.Parameter prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public Form.Parameter getDefaultInstanceForType()
Returns
Type Description
Form.Parameter

getDefaultValue()

public Value getDefaultValue()

The default value of an optional parameter. If the parameter is required, the default value will be ignored.

.google.protobuf.Value default_value = 9;

Returns
Type Description
Value

The defaultValue.

getDefaultValueOrBuilder()

public ValueOrBuilder getDefaultValueOrBuilder()

The default value of an optional parameter. If the parameter is required, the default value will be ignored.

.google.protobuf.Value default_value = 9;

Returns
Type Description
ValueOrBuilder

getDisplayName()

public String getDisplayName()

Required. The human-readable name of the parameter, unique within the form.

string display_name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Required. The human-readable name of the parameter, unique within the form.

string display_name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for displayName.

getEntityType()

public String getEntityType()

Required. The entity type of the parameter. Format: projects/-/locations/-/agents/-/entityTypes/<System Entity Type ID> for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID> for developer entity types.

string entity_type = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The entityType.

getEntityTypeBytes()

public ByteString getEntityTypeBytes()

Required. The entity type of the parameter. Format: projects/-/locations/-/agents/-/entityTypes/<System Entity Type ID> for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID> for developer entity types.

string entity_type = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for entityType.

getFillBehavior()

public Form.Parameter.FillBehavior getFillBehavior()

Required. Defines fill behavior for the parameter.

.google.cloud.dialogflow.cx.v3beta1.Form.Parameter.FillBehavior fill_behavior = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Form.Parameter.FillBehavior

The fillBehavior.

getFillBehaviorOrBuilder()

public Form.Parameter.FillBehaviorOrBuilder getFillBehaviorOrBuilder()

Required. Defines fill behavior for the parameter.

.google.cloud.dialogflow.cx.v3beta1.Form.Parameter.FillBehavior fill_behavior = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Form.Parameter.FillBehaviorOrBuilder

getIsList()

public boolean getIsList()

Indicates whether the parameter represents a list of values.

bool is_list = 4;

Returns
Type Description
boolean

The isList.

getParserForType()

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

getRedact()

public boolean getRedact()

Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.

bool redact = 11;

Returns
Type Description
boolean

The redact.

getRequired()

public boolean getRequired()

Indicates whether the parameter is required. Optional parameters will not trigger prompts; however, they are filled if the user specifies them. Required parameters must be filled before form filling concludes.

bool required = 2;

Returns
Type Description
boolean

The required.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
Type Description
UnknownFieldSet
Overrides

hasDefaultValue()

public boolean hasDefaultValue()

The default value of an optional parameter. If the parameter is required, the default value will be ignored.

.google.protobuf.Value default_value = 9;

Returns
Type Description
boolean

Whether the defaultValue field is set.

hasFillBehavior()

public boolean hasFillBehavior()

Required. Defines fill behavior for the parameter.

.google.cloud.dialogflow.cx.v3beta1.Form.Parameter.FillBehavior fill_behavior = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the fillBehavior field is set.

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.Parameter.Builder newBuilderForType()
Returns
Type Description
Form.Parameter.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Form.Parameter.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Form.Parameter.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.Parameter.Builder toBuilder()
Returns
Type Description
Form.Parameter.Builder

writeTo(CodedOutputStream output)

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