Class Parameter (1.33.0)

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

Represents a form parameter.


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/, or projects/ for developer entity types.
is_list bool
Indicates whether the parameter represents a list of values.
Required. Defines fill behavior for the parameter.
default_value google.protobuf.struct_pb2.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 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.
Hierarchical advanced settings for this parameter. The settings exposed at the lower level overrides the settings exposed at the higher level.



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

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