Class ParameterInfo (1.28.0)

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

Represents parameter information.

Attributes

NameDescription
display_name str
Always present for WebhookRequest. Required for WebhookResponse. The human-readable name of the parameter, unique within the form. This field cannot be modified by the webhook.
required bool
Optional for both WebhookRequest and WebhookResponse. 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.
state google.cloud.dialogflowcx_v3.types.PageInfo.FormInfo.ParameterInfo.ParameterState
Always present for WebhookRequest. Required for WebhookResponse. The state of the parameter. This field can be set to INVALID by the webhook to invalidate the parameter; other values set by the webhook will be ignored.
value google.protobuf.struct_pb2.Value
Optional for both WebhookRequest and WebhookResponse. The value of the parameter. This field can be set by the webhook to change the parameter value.
just_collected bool
Optional for WebhookRequest. Ignored for WebhookResponse. Indicates if the parameter value was just collected on the last conversation turn.

Classes

ParameterState

ParameterState(value)

Represents the state of a parameter.

Values: PARAMETER_STATE_UNSPECIFIED (0): Not specified. This value should be never used. EMPTY (1): Indicates that the parameter does not have a value. INVALID (2): Indicates that the parameter value is invalid. This field can be used by the webhook to invalidate the parameter and ask the server to collect it from the user again. FILLED (3): Indicates that the parameter has a value.