Dialogflow v3 API - Class Form.Types.Parameter (2.17.0)

public sealed class Form.Types.Parameter : IMessage<Form.Types.Parameter>, IEquatable<Form.Types.Parameter>, IDeepCloneable<Form.Types.Parameter>, IBufferMessage, IMessage

Reference documentation and code samples for the Dialogflow v3 API class Form.Types.Parameter.

Represents a form parameter.

Inheritance

object > Form.Types.Parameter

Implements

IMessage Form Types Parameter, IEquatable Form Types Parameter, IDeepCloneable Form Types Parameter, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Dialogflow.Cx.V3

Assembly

Google.Cloud.Dialogflow.Cx.V3.dll

Constructors

Parameter()

public Parameter()

Parameter(Parameter)

public Parameter(Form.Types.Parameter other)

Parameter
Name	Description
`other`	`FormTypesParameter`

Properties

AdvancedSettings

public AdvancedSettings AdvancedSettings { get; set; }

Hierarchical advanced settings for this parameter. The settings exposed at the lower level overrides the settings exposed at the higher level.

Property Value
Type	Description
`AdvancedSettings`

DefaultValue

public Value DefaultValue { get; set; }

The default value of an optional parameter. If the parameter is required, the default value will be ignored.

Property Value
Type	Description
`Value`

DisplayName

public string DisplayName { get; set; }

Required. The human-readable name of the parameter, unique within the form.

Property Value
Type	Description
`string`

EntityType

public string EntityType { get; set; }

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.

Property Value
Type	Description
`string`

FillBehavior

public Form.Types.Parameter.Types.FillBehavior FillBehavior { get; set; }

Required. Defines fill behavior for the parameter.

Property Value
Type	Description
`FormTypesParameterTypesFillBehavior`

IsList

public bool IsList { get; set; }

Indicates whether the parameter represents a list of values.

Property Value
Type	Description
`bool`

Redact

public bool Redact { get; set; }

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][google.cloud.dialogflow.cx.v3.EntityType.redact] is enabled.

Property Value
Type	Description
`bool`

Required

public bool Required { get; set; }

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.

Property Value
Type	Description
`bool`