# Dialogflow CX V3 API - Class Google::Cloud::Dialogflow::CX::V3::PageInfo::FormInfo::ParameterInfo (v1.12.1)

1.12.1 (latest) 1.12.0 1.11.0 1.10.1 1.9.0 1.8.0 1.7.0 1.6.1 1.5.0 1.4.0 1.3.0 1.2.0 1.1.1 1.0.0 0.26.0 0.25.0 0.24.2 0.23.0 0.22.0 0.21.0 0.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.1 0.14.0 0.13.0 0.12.0 0.11.0 0.10.2 0.9.0 0.8.1 0.7.1 0.6.0 0.5.0 0.4.0 Reference documentation and code samples for the Dialogflow CX V3 API class Google::Cloud::Dialogflow::CX::V3::PageInfo::FormInfo::ParameterInfo.

Represents parameter information.

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #display_name

    def display_name() -> ::String

**Returns**

- (::String) --- Always present for [WebhookRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-WebhookRequest "Google::Cloud::Dialogflow::CX::V3::WebhookRequest (class)"). Required for [WebhookResponse](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-WebhookResponse "Google::Cloud::Dialogflow::CX::V3::WebhookResponse (class)"). The human-readable name of the parameter, unique within the form. This field cannot be modified by the webhook.

### #display_name=

    def display_name=(value) -> ::String

**Parameter**

- **value** (::String) --- Always present for [WebhookRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-WebhookRequest "Google::Cloud::Dialogflow::CX::V3::WebhookRequest (class)"). Required for [WebhookResponse](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-WebhookResponse "Google::Cloud::Dialogflow::CX::V3::WebhookResponse (class)"). The human-readable name of the parameter, unique within the form. This field cannot be modified by the webhook.
**Returns**

- (::String) --- Always present for [WebhookRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-WebhookRequest "Google::Cloud::Dialogflow::CX::V3::WebhookRequest (class)"). Required for [WebhookResponse](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-WebhookResponse "Google::Cloud::Dialogflow::CX::V3::WebhookResponse (class)"). The human-readable name of the parameter, unique within the form. This field cannot be modified by the webhook.

### #just_collected

    def just_collected() -> ::Boolean

**Returns**

- (::Boolean) --- Optional for [WebhookRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-WebhookRequest "Google::Cloud::Dialogflow::CX::V3::WebhookRequest (class)"). Ignored for [WebhookResponse](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-WebhookResponse "Google::Cloud::Dialogflow::CX::V3::WebhookResponse (class)"). Indicates if the parameter value was just collected on the last conversation turn.

### #just_collected=

    def just_collected=(value) -> ::Boolean

**Parameter**

- **value** (::Boolean) --- Optional for [WebhookRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-WebhookRequest "Google::Cloud::Dialogflow::CX::V3::WebhookRequest (class)"). Ignored for [WebhookResponse](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-WebhookResponse "Google::Cloud::Dialogflow::CX::V3::WebhookResponse (class)"). Indicates if the parameter value was just collected on the last conversation turn.
**Returns**

- (::Boolean) --- Optional for [WebhookRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-WebhookRequest "Google::Cloud::Dialogflow::CX::V3::WebhookRequest (class)"). Ignored for [WebhookResponse](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-WebhookResponse "Google::Cloud::Dialogflow::CX::V3::WebhookResponse (class)"). Indicates if the parameter value was just collected on the last conversation turn.

### #required

    def required() -> ::Boolean

**Returns**

- (::Boolean) --- Optional for both [WebhookRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-WebhookRequest "Google::Cloud::Dialogflow::CX::V3::WebhookRequest (class)") and [WebhookResponse](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-WebhookResponse "Google::Cloud::Dialogflow::CX::V3::WebhookResponse (class)"). 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) --- Optional for both [WebhookRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-WebhookRequest "Google::Cloud::Dialogflow::CX::V3::WebhookRequest (class)") and [WebhookResponse](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-WebhookResponse "Google::Cloud::Dialogflow::CX::V3::WebhookResponse (class)"). 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) --- Optional for both [WebhookRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-WebhookRequest "Google::Cloud::Dialogflow::CX::V3::WebhookRequest (class)") and [WebhookResponse](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-WebhookResponse "Google::Cloud::Dialogflow::CX::V3::WebhookResponse (class)"). 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

    def state() -> ::Google::Cloud::Dialogflow::CX::V3::PageInfo::FormInfo::ParameterInfo::ParameterState

**Returns**

- ([::Google::Cloud::Dialogflow::CX::V3::PageInfo::FormInfo::ParameterInfo::ParameterState](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-PageInfo-FormInfo-ParameterInfo-ParameterState)) --- Always present for [WebhookRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-WebhookRequest "Google::Cloud::Dialogflow::CX::V3::WebhookRequest (class)"). Required for [WebhookResponse](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-WebhookResponse "Google::Cloud::Dialogflow::CX::V3::WebhookResponse (class)"). The state of the parameter. This field can be set to [INVALID](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-PageInfo-FormInfo-ParameterInfo-ParameterState#Google__Cloud__Dialogflow__CX__V3__PageInfo__FormInfo__ParameterInfo__ParameterState__INVALID "Google::Cloud::Dialogflow::CX::V3::PageInfo::FormInfo::ParameterInfo::ParameterState::INVALID (constant)") by the webhook to invalidate the parameter; other values set by the webhook will be ignored.

### #state=

    def state=(value) -> ::Google::Cloud::Dialogflow::CX::V3::PageInfo::FormInfo::ParameterInfo::ParameterState

**Parameter**

- **value** ([::Google::Cloud::Dialogflow::CX::V3::PageInfo::FormInfo::ParameterInfo::ParameterState](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-PageInfo-FormInfo-ParameterInfo-ParameterState)) --- Always present for [WebhookRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-WebhookRequest "Google::Cloud::Dialogflow::CX::V3::WebhookRequest (class)"). Required for [WebhookResponse](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-WebhookResponse "Google::Cloud::Dialogflow::CX::V3::WebhookResponse (class)"). The state of the parameter. This field can be set to [INVALID](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-PageInfo-FormInfo-ParameterInfo-ParameterState#Google__Cloud__Dialogflow__CX__V3__PageInfo__FormInfo__ParameterInfo__ParameterState__INVALID "Google::Cloud::Dialogflow::CX::V3::PageInfo::FormInfo::ParameterInfo::ParameterState::INVALID (constant)") by the webhook to invalidate the parameter; other values set by the webhook will be ignored.
**Returns**

- ([::Google::Cloud::Dialogflow::CX::V3::PageInfo::FormInfo::ParameterInfo::ParameterState](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-PageInfo-FormInfo-ParameterInfo-ParameterState)) --- Always present for [WebhookRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-WebhookRequest "Google::Cloud::Dialogflow::CX::V3::WebhookRequest (class)"). Required for [WebhookResponse](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-WebhookResponse "Google::Cloud::Dialogflow::CX::V3::WebhookResponse (class)"). The state of the parameter. This field can be set to [INVALID](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-PageInfo-FormInfo-ParameterInfo-ParameterState#Google__Cloud__Dialogflow__CX__V3__PageInfo__FormInfo__ParameterInfo__ParameterState__INVALID "Google::Cloud::Dialogflow::CX::V3::PageInfo::FormInfo::ParameterInfo::ParameterState::INVALID (constant)") by the webhook to invalidate the parameter; other values set by the webhook will be ignored.

### #value

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

**Returns**

- ([::Google::Protobuf::Value](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Protobuf-Value)) --- Optional for both [WebhookRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-WebhookRequest "Google::Cloud::Dialogflow::CX::V3::WebhookRequest (class)") and [WebhookResponse](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-WebhookResponse "Google::Cloud::Dialogflow::CX::V3::WebhookResponse (class)"). The value of the parameter. This field can be set by the webhook to change the parameter value.

### #value=

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

**Parameter**

- **value** ([::Google::Protobuf::Value](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Protobuf-Value)) --- Optional for both [WebhookRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-WebhookRequest "Google::Cloud::Dialogflow::CX::V3::WebhookRequest (class)") and [WebhookResponse](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-WebhookResponse "Google::Cloud::Dialogflow::CX::V3::WebhookResponse (class)"). The value of the parameter. This field can be set by the webhook to change the parameter value.
**Returns**

- ([::Google::Protobuf::Value](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Protobuf-Value)) --- Optional for both [WebhookRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-WebhookRequest "Google::Cloud::Dialogflow::CX::V3::WebhookRequest (class)") and [WebhookResponse](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-WebhookResponse "Google::Cloud::Dialogflow::CX::V3::WebhookResponse (class)"). The value of the parameter. This field can be set by the webhook to change the parameter value.