Reference documentation and code samples for the reCAPTCHA Enterprise V1 API class Google::Cloud::RecaptchaEnterprise::V1::FirewallAction::SetHeaderAction.
A set header action sets a header and forwards the request to the
backend. This can be used to trigger custom protection implemented on the
backend.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#key
defkey()->::String
Returns
(::String) — Optional. The header key to set in the request to the backend server.
#key=
defkey=(value)->::String
Parameter
value (::String) — Optional. The header key to set in the request to the backend server.
Returns
(::String) — Optional. The header key to set in the request to the backend server.
#value
defvalue()->::String
Returns
(::String) — Optional. The header value to set in the request to the backend server.
#value=
defvalue=(value)->::String
Parameter
value (::String) — Optional. The header value to set in the request to the backend server.
Returns
(::String) — Optional. The header value to set in the request to the backend server.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[],[],null,["# reCAPTCHA Enterprise V1 API - Class Google::Cloud::RecaptchaEnterprise::V1::FirewallAction::SetHeaderAction (v1.8.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.8.0 (latest)](/ruby/docs/reference/google-cloud-recaptcha_enterprise-v1/latest/Google-Cloud-RecaptchaEnterprise-V1-FirewallAction-SetHeaderAction)\n- [1.7.1](/ruby/docs/reference/google-cloud-recaptcha_enterprise-v1/1.7.1/Google-Cloud-RecaptchaEnterprise-V1-FirewallAction-SetHeaderAction)\n- [1.6.0](/ruby/docs/reference/google-cloud-recaptcha_enterprise-v1/1.6.0/Google-Cloud-RecaptchaEnterprise-V1-FirewallAction-SetHeaderAction)\n- [1.5.1](/ruby/docs/reference/google-cloud-recaptcha_enterprise-v1/1.5.1/Google-Cloud-RecaptchaEnterprise-V1-FirewallAction-SetHeaderAction)\n- [1.4.1](/ruby/docs/reference/google-cloud-recaptcha_enterprise-v1/1.4.1/Google-Cloud-RecaptchaEnterprise-V1-FirewallAction-SetHeaderAction)\n- [1.3.0](/ruby/docs/reference/google-cloud-recaptcha_enterprise-v1/1.3.0/Google-Cloud-RecaptchaEnterprise-V1-FirewallAction-SetHeaderAction)\n- [1.2.0](/ruby/docs/reference/google-cloud-recaptcha_enterprise-v1/1.2.0/Google-Cloud-RecaptchaEnterprise-V1-FirewallAction-SetHeaderAction)\n- [1.1.0](/ruby/docs/reference/google-cloud-recaptcha_enterprise-v1/1.1.0/Google-Cloud-RecaptchaEnterprise-V1-FirewallAction-SetHeaderAction)\n- [1.0.0](/ruby/docs/reference/google-cloud-recaptcha_enterprise-v1/1.0.0/Google-Cloud-RecaptchaEnterprise-V1-FirewallAction-SetHeaderAction)\n- [0.22.0](/ruby/docs/reference/google-cloud-recaptcha_enterprise-v1/0.22.0/Google-Cloud-RecaptchaEnterprise-V1-FirewallAction-SetHeaderAction)\n- [0.21.0](/ruby/docs/reference/google-cloud-recaptcha_enterprise-v1/0.21.0/Google-Cloud-RecaptchaEnterprise-V1-FirewallAction-SetHeaderAction)\n- [0.20.1](/ruby/docs/reference/google-cloud-recaptcha_enterprise-v1/0.20.1/Google-Cloud-RecaptchaEnterprise-V1-FirewallAction-SetHeaderAction)\n- [0.19.0](/ruby/docs/reference/google-cloud-recaptcha_enterprise-v1/0.19.0/Google-Cloud-RecaptchaEnterprise-V1-FirewallAction-SetHeaderAction)\n- [0.18.0](/ruby/docs/reference/google-cloud-recaptcha_enterprise-v1/0.18.0/Google-Cloud-RecaptchaEnterprise-V1-FirewallAction-SetHeaderAction)\n- [0.17.3](/ruby/docs/reference/google-cloud-recaptcha_enterprise-v1/0.17.3/Google-Cloud-RecaptchaEnterprise-V1-FirewallAction-SetHeaderAction)\n- [0.16.0](/ruby/docs/reference/google-cloud-recaptcha_enterprise-v1/0.16.0/Google-Cloud-RecaptchaEnterprise-V1-FirewallAction-SetHeaderAction)\n- [0.15.0](/ruby/docs/reference/google-cloud-recaptcha_enterprise-v1/0.15.0/Google-Cloud-RecaptchaEnterprise-V1-FirewallAction-SetHeaderAction)\n- [0.14.1](/ruby/docs/reference/google-cloud-recaptcha_enterprise-v1/0.14.1/Google-Cloud-RecaptchaEnterprise-V1-FirewallAction-SetHeaderAction)\n- [0.13.0](/ruby/docs/reference/google-cloud-recaptcha_enterprise-v1/0.13.0/Google-Cloud-RecaptchaEnterprise-V1-FirewallAction-SetHeaderAction)\n- [0.12.0](/ruby/docs/reference/google-cloud-recaptcha_enterprise-v1/0.12.0/Google-Cloud-RecaptchaEnterprise-V1-FirewallAction-SetHeaderAction)\n- [0.11.0](/ruby/docs/reference/google-cloud-recaptcha_enterprise-v1/0.11.0/Google-Cloud-RecaptchaEnterprise-V1-FirewallAction-SetHeaderAction)\n- [0.10.0](/ruby/docs/reference/google-cloud-recaptcha_enterprise-v1/0.10.0/Google-Cloud-RecaptchaEnterprise-V1-FirewallAction-SetHeaderAction)\n- [0.9.1](/ruby/docs/reference/google-cloud-recaptcha_enterprise-v1/0.9.1/Google-Cloud-RecaptchaEnterprise-V1-FirewallAction-SetHeaderAction)\n- [0.8.0](/ruby/docs/reference/google-cloud-recaptcha_enterprise-v1/0.8.0/Google-Cloud-RecaptchaEnterprise-V1-FirewallAction-SetHeaderAction)\n- [0.7.1](/ruby/docs/reference/google-cloud-recaptcha_enterprise-v1/0.7.1/Google-Cloud-RecaptchaEnterprise-V1-FirewallAction-SetHeaderAction) \nReference documentation and code samples for the reCAPTCHA Enterprise V1 API class Google::Cloud::RecaptchaEnterprise::V1::FirewallAction::SetHeaderAction.\n\nA set header action sets a header and forwards the request to the\nbackend. This can be used to trigger custom protection implemented on the\nbackend. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #key\n\n def key() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Optional. The header key to set in the request to the backend server.\n\n### #key=\n\n def key=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Optional. The header key to set in the request to the backend server. \n**Returns**\n\n- (::String) --- Optional. The header key to set in the request to the backend server.\n\n### #value\n\n def value() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Optional. The header value to set in the request to the backend server.\n\n### #value=\n\n def value=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Optional. The header value to set in the request to the backend server. \n**Returns**\n\n- (::String) --- Optional. The header value to set in the request to the backend server."]]