Dialogflow CX V3 API - Class Google::Cloud::Dialogflow::CX::V3::Form::Parameter (v1.2.0)

Reference documentation and code samples for the Dialogflow CX V3 API class Google::Cloud::Dialogflow::CX::V3::Form::Parameter.

Represents a form parameter.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#advanced_settings

def advanced_settings() -> ::Google::Cloud::Dialogflow::CX::V3::AdvancedSettings

Returns

(::Google::Cloud::Dialogflow::CX::V3::AdvancedSettings) — Hierarchical advanced settings for this parameter. The settings exposed at the lower level overrides the settings exposed at the higher level.

#advanced_settings=

def advanced_settings=(value) -> ::Google::Cloud::Dialogflow::CX::V3::AdvancedSettings

Parameter

value (::Google::Cloud::Dialogflow::CX::V3::AdvancedSettings) — Hierarchical advanced settings for this parameter. The settings exposed at the lower level overrides the settings exposed at the higher level.

Returns

(::Google::Cloud::Dialogflow::CX::V3::AdvancedSettings) — Hierarchical advanced settings for this parameter. The settings exposed at the lower level overrides the settings exposed at the higher level.

#default_value

def default_value() -> ::Google::Protobuf::Value

Returns

(::Google::Protobuf::Value) — The default value of an optional parameter. If the parameter is required, the default value will be ignored.

#default_value=

def default_value=(value) -> ::Google::Protobuf::Value

Parameter

value (::Google::Protobuf::Value) — The default value of an optional parameter. If the parameter is required, the default value will be ignored.

Returns

(::Google::Protobuf::Value) — The default value of an optional parameter. If the parameter is required, the default value will be ignored.

#display_name

def display_name() -> ::String

Returns

(::String) — Required. The human-readable name of the parameter, unique within the form.

#display_name=

def display_name=(value) -> ::String

Parameter

value (::String) — Required. The human-readable name of the parameter, unique within the form.

Returns

(::String) — Required. The human-readable name of the parameter, unique within the form.

#entity_type

def entity_type() -> ::String

Returns

(::String) — Required. The entity type of the parameter. Format: projects/-/locations/-/agents/-/entityTypes/<SystemEntityTypeID> for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/entityTypes/<EntityTypeID> for developer entity types.

#entity_type=

def entity_type=(value) -> ::String

Parameter

value (::String) — Required. The entity type of the parameter. Format: projects/-/locations/-/agents/-/entityTypes/<SystemEntityTypeID> for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/entityTypes/<EntityTypeID> for developer entity types.

Returns

(::String) — Required. The entity type of the parameter. Format: projects/-/locations/-/agents/-/entityTypes/<SystemEntityTypeID> for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/entityTypes/<EntityTypeID> for developer entity types.

#fill_behavior

def fill_behavior() -> ::Google::Cloud::Dialogflow::CX::V3::Form::Parameter::FillBehavior

Returns

(::Google::Cloud::Dialogflow::CX::V3::Form::Parameter::FillBehavior) — Required. Defines fill behavior for the parameter.

#fill_behavior=

def fill_behavior=(value) -> ::Google::Cloud::Dialogflow::CX::V3::Form::Parameter::FillBehavior

Parameter

value (::Google::Cloud::Dialogflow::CX::V3::Form::Parameter::FillBehavior) — Required. Defines fill behavior for the parameter.

Returns

(::Google::Cloud::Dialogflow::CX::V3::Form::Parameter::FillBehavior) — Required. Defines fill behavior for the parameter.

#is_list

def is_list() -> ::Boolean

Returns

(::Boolean) — Indicates whether the parameter represents a list of values.

#is_list=

def is_list=(value) -> ::Boolean

Parameter

value (::Boolean) — Indicates whether the parameter represents a list of values.

Returns

(::Boolean) — Indicates whether the parameter represents a list of values.

#redact

def redact() -> ::Boolean

Returns

(::Boolean) — 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.

#redact=

def redact=(value) -> ::Boolean

Parameter

value (::Boolean) — 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.

Returns

(::Boolean) — 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.

#required

def required() -> ::Boolean

Returns

(::Boolean) — 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.

#required=

def required=(value) -> ::Boolean

Parameter

value (::Boolean) — 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.

Returns

(::Boolean) — 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.