Reference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::SecurityPolicyRule.
Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#action
def action() -> ::String
Returns
- (::String) — The Action to perform when the rule is matched. The following are the valid actions: - allow: allow access to target. - deny(): deny access to target, returns the HTTP response code specified (valid values are 403, 404, and 502). - rate_based_ban: limit client traffic to the configured threshold and ban the client if the traffic exceeds the threshold. Configure parameters for this action in RateLimitOptions. Requires rate_limit_options to be set. - redirect: redirect to a different target. This can either be an internal reCAPTCHA redirect, or an external URL-based redirect via a 302 response. Parameters for this action can be configured via redirectOptions. - throttle: limit client traffic to the configured threshold. Configure parameters for this action in rateLimitOptions. Requires rate_limit_options to be set for this.
#action=
def action=(value) -> ::String
Parameter
- value (::String) — The Action to perform when the rule is matched. The following are the valid actions: - allow: allow access to target. - deny(): deny access to target, returns the HTTP response code specified (valid values are 403, 404, and 502). - rate_based_ban: limit client traffic to the configured threshold and ban the client if the traffic exceeds the threshold. Configure parameters for this action in RateLimitOptions. Requires rate_limit_options to be set. - redirect: redirect to a different target. This can either be an internal reCAPTCHA redirect, or an external URL-based redirect via a 302 response. Parameters for this action can be configured via redirectOptions. - throttle: limit client traffic to the configured threshold. Configure parameters for this action in rateLimitOptions. Requires rate_limit_options to be set for this.
Returns
- (::String) — The Action to perform when the rule is matched. The following are the valid actions: - allow: allow access to target. - deny(): deny access to target, returns the HTTP response code specified (valid values are 403, 404, and 502). - rate_based_ban: limit client traffic to the configured threshold and ban the client if the traffic exceeds the threshold. Configure parameters for this action in RateLimitOptions. Requires rate_limit_options to be set. - redirect: redirect to a different target. This can either be an internal reCAPTCHA redirect, or an external URL-based redirect via a 302 response. Parameters for this action can be configured via redirectOptions. - throttle: limit client traffic to the configured threshold. Configure parameters for this action in rateLimitOptions. Requires rate_limit_options to be set for this.
#description
def description() -> ::String
Returns
- (::String) — An optional description of this resource. Provide this property when you create the resource.
#description=
def description=(value) -> ::String
Parameter
- value (::String) — An optional description of this resource. Provide this property when you create the resource.
Returns
- (::String) — An optional description of this resource. Provide this property when you create the resource.
#header_action
def header_action() -> ::Google::Cloud::Compute::V1::SecurityPolicyRuleHttpHeaderAction
Returns
- (::Google::Cloud::Compute::V1::SecurityPolicyRuleHttpHeaderAction) — Optional, additional actions that are performed on headers.
#header_action=
def header_action=(value) -> ::Google::Cloud::Compute::V1::SecurityPolicyRuleHttpHeaderAction
Parameter
- value (::Google::Cloud::Compute::V1::SecurityPolicyRuleHttpHeaderAction) — Optional, additional actions that are performed on headers.
Returns
- (::Google::Cloud::Compute::V1::SecurityPolicyRuleHttpHeaderAction) — Optional, additional actions that are performed on headers.
#kind
def kind() -> ::String
Returns
- (::String) — [Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules
#kind=
def kind=(value) -> ::String
Parameter
- value (::String) — [Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules
Returns
- (::String) — [Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules
#match
def match() -> ::Google::Cloud::Compute::V1::SecurityPolicyRuleMatcher
Returns
- (::Google::Cloud::Compute::V1::SecurityPolicyRuleMatcher) — A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.
#match=
def match=(value) -> ::Google::Cloud::Compute::V1::SecurityPolicyRuleMatcher
Parameter
- value (::Google::Cloud::Compute::V1::SecurityPolicyRuleMatcher) — A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.
Returns
- (::Google::Cloud::Compute::V1::SecurityPolicyRuleMatcher) — A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.
#preview
def preview() -> ::Boolean
Returns
- (::Boolean) — If set to true, the specified action is not enforced.
#preview=
def preview=(value) -> ::Boolean
Parameter
- value (::Boolean) — If set to true, the specified action is not enforced.
Returns
- (::Boolean) — If set to true, the specified action is not enforced.
#priority
def priority() -> ::Integer
Returns
- (::Integer) — An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority.
#priority=
def priority=(value) -> ::Integer
Parameter
- value (::Integer) — An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority.
Returns
- (::Integer) — An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority.
#rate_limit_options
def rate_limit_options() -> ::Google::Cloud::Compute::V1::SecurityPolicyRuleRateLimitOptions
Returns
- (::Google::Cloud::Compute::V1::SecurityPolicyRuleRateLimitOptions) — Must be specified if the action is "rate_based_ban" or "throttle". Cannot be specified for any other actions.
#rate_limit_options=
def rate_limit_options=(value) -> ::Google::Cloud::Compute::V1::SecurityPolicyRuleRateLimitOptions
Parameter
- value (::Google::Cloud::Compute::V1::SecurityPolicyRuleRateLimitOptions) — Must be specified if the action is "rate_based_ban" or "throttle". Cannot be specified for any other actions.
Returns
- (::Google::Cloud::Compute::V1::SecurityPolicyRuleRateLimitOptions) — Must be specified if the action is "rate_based_ban" or "throttle". Cannot be specified for any other actions.
#redirect_options
def redirect_options() -> ::Google::Cloud::Compute::V1::SecurityPolicyRuleRedirectOptions
Returns
- (::Google::Cloud::Compute::V1::SecurityPolicyRuleRedirectOptions) — Parameters defining the redirect action. Cannot be specified for any other actions.
#redirect_options=
def redirect_options=(value) -> ::Google::Cloud::Compute::V1::SecurityPolicyRuleRedirectOptions
Parameter
- value (::Google::Cloud::Compute::V1::SecurityPolicyRuleRedirectOptions) — Parameters defining the redirect action. Cannot be specified for any other actions.
Returns
- (::Google::Cloud::Compute::V1::SecurityPolicyRuleRedirectOptions) — Parameters defining the redirect action. Cannot be specified for any other actions.