Class ParameterInfo

Represents parameter information.

Attributes
NameDescription
strdisplay_name
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.
boolrequired
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.
google.cloud.dialogflowcx_v3.types.PageInfo.FormInfo.ParameterInfo.ParameterStatestate
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.
google.protobuf.struct_pb2.Valuevalue
Optional for both WebhookRequest and WebhookResponse. The value of the parameter. This field can be set by the webhook to change the parameter value.
booljust_collected
Optional for WebhookRequest. Ignored for WebhookResponse. Indicates if the parameter value was just collected on the last conversation turn.

Inheritance

builtins.object > proto.message.Message > ParameterInfo

Classes

ParameterState

ParameterState(value)

Represents the state of a parameter.