public static final class Form.Parameter extends GeneratedMessageV3 implements Form.ParameterOrBuilder
Represents a form parameter.
Protobuf type google.cloud.dialogflow.cx.v3beta1.Form.Parameter
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
Static Fields
public static final int ADVANCED_SETTINGS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int DEFAULT_VALUE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int ENTITY_TYPE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int FILL_BEHAVIOR_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int IS_LIST_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int REDACT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int REQUIRED_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static Form.Parameter getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static Form.Parameter.Builder newBuilder()
public static Form.Parameter.Builder newBuilder(Form.Parameter prototype)
public static Form.Parameter parseDelimitedFrom(InputStream input)
public static Form.Parameter parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Form.Parameter parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static Form.Parameter parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Form.Parameter parseFrom(ByteString data)
public static Form.Parameter parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Form.Parameter parseFrom(CodedInputStream input)
public static Form.Parameter parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Form.Parameter parseFrom(InputStream input)
public static Form.Parameter parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Form.Parameter parseFrom(ByteBuffer data)
public static Form.Parameter parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<Form.Parameter> parser()
Methods
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
public AdvancedSettings getAdvancedSettings()
Hierarchical advanced settings for this parameter. The settings exposed
at the lower level overrides the settings exposed at the higher level.
.google.cloud.dialogflow.cx.v3beta1.AdvancedSettings advanced_settings = 12;
public AdvancedSettingsOrBuilder getAdvancedSettingsOrBuilder()
Hierarchical advanced settings for this parameter. The settings exposed
at the lower level overrides the settings exposed at the higher level.
.google.cloud.dialogflow.cx.v3beta1.AdvancedSettings advanced_settings = 12;
public Form.Parameter getDefaultInstanceForType()
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;
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.v3beta1.Form.Parameter.FillBehavior fill_behavior = 7 [(.google.api.field_behavior) = REQUIRED];
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];
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()
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 |
| Type |
Description |
int |
|
Overrides
public boolean hasAdvancedSettings()
Hierarchical advanced settings for this parameter. The settings exposed
at the lower level overrides the settings exposed at the higher level.
.google.cloud.dialogflow.cx.v3beta1.AdvancedSettings advanced_settings = 12;
| Returns |
| Type |
Description |
boolean |
Whether the advancedSettings field is set.
|
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.v3beta1.Form.Parameter.FillBehavior fill_behavior = 7 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
boolean |
Whether the fillBehavior field is set.
|
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public Form.Parameter.Builder newBuilderForType()
protected Form.Parameter.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
public Form.Parameter.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
