Class Parameter (0.3.0)

Parameter(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Represents a form parameter.

Attributes

NameDescription
display_name str
Required. The human-readable name of the parameter, unique within the form.
required bool
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.
entity_type str
Required. The entity type of the parameter. Format: projects/-/locations/-/agents/-/entityTypes/ for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects/ for developer entity types.
is_list bool
Indicates whether the parameter represents a list of values.
fill_behavior .gcdc_page.Form.Parameter.FillBehavior
Required. Defines fill behavior for the parameter.
default_value .struct.Value
The default value of an optional parameter. If the parameter is required, the default value will be ignored.
redact bool
Indicates whether the parameter content is logged in text and audio. If it is set to true, the parameter content will be replaced to parameter name in both request and response. The default value is false.

Classes

FillBehavior

FillBehavior(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Configuration for how the filling of a parameter should be handled.