public sealed class Parameter : IMessage<Form.Types.Parameter>, IEquatable<Form.Types.Parameter>, IDeepCloneable<Form.Types.Parameter>, IBufferMessage, IMessage
Represents a form parameter.
Inheritance
System.Object > Form.Types.ParameterImplements
Google.Protobuf.IMessage<Form.Types.Parameter>, System.IEquatable<Form.Types.Parameter>, Google.Protobuf.IDeepCloneable<Form.Types.Parameter>, Google.Protobuf.IBufferMessage, Google.Protobuf.IMessageNamespace
Google.Cloud.Dialogflow.Cx.V3Assembly
Google.Cloud.Dialogflow.Cx.V3.dll
Constructors
Parameter()
public Parameter()
Parameter(Form.Types.Parameter)
public Parameter(Form.Types.Parameter other)
Parameter | |
---|---|
Name | Description |
other | Form.Types.Parameter |
Properties
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 |
Google.Protobuf.WellKnownTypes.Value |
DisplayName
public string DisplayName { get; set; }
Required. The human-readable name of the parameter, unique within the form.
Property Value | |
---|---|
Type | Description |
System.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 |
System.String |
FillBehavior
public Form.Types.Parameter.Types.FillBehavior FillBehavior { get; set; }
Required. Defines fill behavior for the parameter.
Property Value | |
---|---|
Type | Description |
Form.Types.Parameter.Types.FillBehavior |
IsList
public bool IsList { get; set; }
Indicates whether the parameter represents a list of values.
Property Value | |
---|---|
Type | Description |
System.Boolean |
Redact
public bool Redact { get; set; }
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.
Property Value | |
---|---|
Type | Description |
System.Boolean |
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 |
System.Boolean |