Interface Form.ParameterOrBuilder (0.59.0)

public static interface Form.ParameterOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAdvancedSettings()

public abstract 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;

Returns
Type	Description
`AdvancedSettings`	The advancedSettings.

getAdvancedSettingsOrBuilder()

public abstract 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;

Returns
Type	Description
`AdvancedSettingsOrBuilder`

getDefaultValue()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract ByteString getEntityTypeBytes()

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

Returns
Type	Description
`ByteString`	The bytes for entityType.

getFillBehavior()

public abstract 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 abstract 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 abstract boolean getIsList()

Indicates whether the parameter represents a list of values.

bool is_list = 4;

Returns
Type	Description
`boolean`	The isList.

getRedact()

public abstract 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 abstract 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.

hasAdvancedSettings()

public abstract 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.

hasDefaultValue()

public abstract 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 abstract 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.