Send feedback
Class Form.Parameter (0.13.1)
Stay organized with collections
Save and categorize content based on your preferences.
Version 0.13.1 keyboard_arrow_down
public static final class Form . Parameter extends GeneratedMessageV3 implements Form . ParameterOrBuilder
Represents a form parameter.
Protobuf type google.cloud.dialogflow.cx.v3.Form.Parameter
Static Fields
public static final int DEFAULT_VALUE_FIELD_NUMBER
Field Value
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
public static final int ENTITY_TYPE_FIELD_NUMBER
Field Value
public static final int FILL_BEHAVIOR_FIELD_NUMBER
Field Value
public static final int IS_LIST_FIELD_NUMBER
Field Value
public static final int REDACT_FIELD_NUMBER
Field Value
public static final int REQUIRED_FIELD_NUMBER
Field Value
Static Methods
public static Form . Parameter getDefaultInstance ()
Returns
public static final Descriptors . Descriptor getDescriptor ()
Returns
public static Form . Parameter . Builder newBuilder ()
Returns
public static Form . Parameter . Builder newBuilder ( Form . Parameter prototype )
Parameter
Returns
public static Form . Parameter parseDelimitedFrom ( InputStream input )
Parameter
Returns
Exceptions
public static Form . Parameter parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static Form . Parameter parseFrom ( byte [] data )
Parameter
Name Description
data byte []
Returns
Exceptions
public static Form . Parameter parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static Form . Parameter parseFrom ( ByteString data )
Parameter
Returns
Exceptions
public static Form . Parameter parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static Form . Parameter parseFrom ( CodedInputStream input )
Parameter
Returns
Exceptions
public static Form . Parameter parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static Form . Parameter parseFrom ( InputStream input )
Parameter
Returns
Exceptions
public static Form . Parameter parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static Form . Parameter parseFrom ( ByteBuffer data )
Parameter
Returns
Exceptions
public static Form . Parameter parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static Parser<Form . Parameter > parser ()
Returns
Methods
public boolean equals ( Object obj )
Parameter
Returns
Overrides
public Form . Parameter getDefaultInstanceForType ()
Returns
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.
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
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.
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.
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.
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.
public Form . Parameter . FillBehavior getFillBehavior ()
Required. Defines fill behavior for the parameter.
.google.cloud.dialogflow.cx.v3.Form.Parameter.FillBehavior fill_behavior = 7 [(.google.api.field_behavior) = REQUIRED];
Returns
public Form . Parameter . FillBehaviorOrBuilder getFillBehaviorOrBuilder ()
Required. Defines fill behavior for the parameter.
.google.cloud.dialogflow.cx.v3.Form.Parameter.FillBehavior fill_behavior = 7 [(.google.api.field_behavior) = REQUIRED];
Returns
public boolean getIsList ()
Indicates whether the parameter represents a list of values.
bool is_list = 4;
Returns
Type Description
boolean The isList.
public Parser<Form . Parameter > getParserForType ()
Returns
Overrides
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.
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.
public int getSerializedSize ()
Returns
Overrides
public final UnknownFieldSet getUnknownFields ()
Returns
Overrides
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.
public boolean hasFillBehavior ()
Required. Defines fill behavior for the parameter.
.google.cloud.dialogflow.cx.v3.Form.Parameter.FillBehavior fill_behavior = 7 [(.google.api.field_behavior) = REQUIRED];
Returns
Type Description
boolean Whether the fillBehavior field is set.
Returns
Overrides
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Returns
Overrides
public final boolean isInitialized ()
Returns
Overrides
public Form . Parameter . Builder newBuilderForType ()
Returns
protected Form . Parameter . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Parameter
Returns
Overrides
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Parameter
Returns
Overrides
public Form . Parameter . Builder toBuilder ()
Returns
public void writeTo ( CodedOutputStream output )
Parameter
Overrides
Exceptions
Send feedback
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-01-28 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-01-28 UTC."],[],[]]
