Package com.google.cloud.compute.v1

Interface SecurityPolicyRuleOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
SecurityPolicyRule, SecurityPolicyRule.Builder
@Generated public interface SecurityPolicyRuleOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasAction

      boolean hasAction()
       The Action to perform when the rule is matched.
 The following are the valid actions:

 - allow: allow access to target.
 - deny(STATUS): deny access to target, returns the
 HTTP response code specified. Valid values for `STATUS`
 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. This action is only supported in Global Security
 Policies of type CLOUD_ARMOR.
 - throttle: limit
 client traffic to the configured threshold. Configure parameters for this
 action in rateLimitOptions. Requires rate_limit_options to be set for
 this.
 - fairshare (preview only): when traffic reaches the
 threshold limit, requests from the clients matching this rule begin to be
 rate-limited using the Fair Share algorithm. This action is only allowed
 in security policies of type `CLOUD_ARMOR_INTERNAL_SERVICE`.
      optional string action = 187661878;
      Returns:
      Whether the action field is set.

    • getAction

      String getAction()
       The Action to perform when the rule is matched.
 The following are the valid actions:

 - allow: allow access to target.
 - deny(STATUS): deny access to target, returns the
 HTTP response code specified. Valid values for `STATUS`
 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. This action is only supported in Global Security
 Policies of type CLOUD_ARMOR.
 - throttle: limit
 client traffic to the configured threshold. Configure parameters for this
 action in rateLimitOptions. Requires rate_limit_options to be set for
 this.
 - fairshare (preview only): when traffic reaches the
 threshold limit, requests from the clients matching this rule begin to be
 rate-limited using the Fair Share algorithm. This action is only allowed
 in security policies of type `CLOUD_ARMOR_INTERNAL_SERVICE`.
      optional string action = 187661878;
      Returns:
      The action.

    • getActionBytes

      com.google.protobuf.ByteString getActionBytes()
       The Action to perform when the rule is matched.
 The following are the valid actions:

 - allow: allow access to target.
 - deny(STATUS): deny access to target, returns the
 HTTP response code specified. Valid values for `STATUS`
 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. This action is only supported in Global Security
 Policies of type CLOUD_ARMOR.
 - throttle: limit
 client traffic to the configured threshold. Configure parameters for this
 action in rateLimitOptions. Requires rate_limit_options to be set for
 this.
 - fairshare (preview only): when traffic reaches the
 threshold limit, requests from the clients matching this rule begin to be
 rate-limited using the Fair Share algorithm. This action is only allowed
 in security policies of type `CLOUD_ARMOR_INTERNAL_SERVICE`.
      optional string action = 187661878;
      Returns:
      The bytes for action.

    • hasDescription

      boolean hasDescription()
       An optional description of this resource. Provide this property when you
 create the resource.
      optional string description = 422937596;
      Returns:
      Whether the description field is set.

    • getDescription

      String getDescription()
       An optional description of this resource. Provide this property when you
 create the resource.
      optional string description = 422937596;
      Returns:
      The description.

    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
       An optional description of this resource. Provide this property when you
 create the resource.
      optional string description = 422937596;
      Returns:
      The bytes for description.

    • hasHeaderAction

      boolean hasHeaderAction()
       Optional, additional actions that are performed on headers.
 This field is only supported in Global Security Policies of type
 CLOUD_ARMOR.
      optional .google.cloud.compute.v1.SecurityPolicyRuleHttpHeaderAction header_action = 328077352;
      Returns:
      Whether the headerAction field is set.

    • getHeaderAction

      SecurityPolicyRuleHttpHeaderAction getHeaderAction()
       Optional, additional actions that are performed on headers.
 This field is only supported in Global Security Policies of type
 CLOUD_ARMOR.
      optional .google.cloud.compute.v1.SecurityPolicyRuleHttpHeaderAction header_action = 328077352;
      Returns:
      The headerAction.

    • getHeaderActionOrBuilder

      SecurityPolicyRuleHttpHeaderActionOrBuilder getHeaderActionOrBuilder()
       Optional, additional actions that are performed on headers.
 This field is only supported in Global Security Policies of type
 CLOUD_ARMOR.
      optional .google.cloud.compute.v1.SecurityPolicyRuleHttpHeaderAction header_action = 328077352;

    • hasKind

      boolean hasKind()
       Output only. [Output only] Type of the resource. Alwayscompute#securityPolicyRule for security policy rules
      optional string kind = 3292052;
      Returns:
      Whether the kind field is set.

    • getKind

      String getKind()
       Output only. [Output only] Type of the resource. Alwayscompute#securityPolicyRule for security policy rules
      optional string kind = 3292052;
      Returns:
      The kind.

    • getKindBytes

      com.google.protobuf.ByteString getKindBytes()
       Output only. [Output only] Type of the resource. Alwayscompute#securityPolicyRule for security policy rules
      optional string kind = 3292052;
      Returns:
      The bytes for kind.

    • hasMatch

      boolean hasMatch()
       A match condition that incoming traffic is evaluated against.
 If it evaluates to true, the corresponding 'action' is enforced.
      optional .google.cloud.compute.v1.SecurityPolicyRuleMatcher match = 103668165;
      Returns:
      Whether the match field is set.

    • getMatch

      SecurityPolicyRuleMatcher getMatch()
       A match condition that incoming traffic is evaluated against.
 If it evaluates to true, the corresponding 'action' is enforced.
      optional .google.cloud.compute.v1.SecurityPolicyRuleMatcher match = 103668165;
      Returns:
      The match.

    • getMatchOrBuilder

      SecurityPolicyRuleMatcherOrBuilder getMatchOrBuilder()
       A match condition that incoming traffic is evaluated against.
 If it evaluates to true, the corresponding 'action' is enforced.
      optional .google.cloud.compute.v1.SecurityPolicyRuleMatcher match = 103668165;

    • hasNetworkMatch

      boolean hasNetworkMatch()
       A match condition that incoming packets are evaluated against for
 CLOUD_ARMOR_NETWORK security policies. If it matches, the corresponding
 'action' is enforced.

 The match criteria for a rule consists of built-in match fields (like
 'srcIpRanges') and potentially multiple user-defined match fields
 ('userDefinedFields').

 Field values may be extracted directly from the packet or derived from it
 (e.g. 'srcRegionCodes'). Some fields may not be present in every packet
 (e.g. 'srcPorts'). A user-defined field is only present if the base
 header is found in the packet and the entire field is in bounds.

 Each match field may specify which values can match it, listing one or
 more ranges, prefixes, or exact values that are considered a match for
 the field. A field value must be present in order to match a specified
 match field. If no match values are specified for a match field, then any
 field value is considered to match it, and it's not required to be
 present. For strings specifying '*' is also equivalent to match all.

 For a packet to match a rule, all specified match fields must match the
 corresponding field values derived from the packet.

 Example:

 networkMatch:
 srcIpRanges:
 - "192.0.2.0/24"
 - "198.51.100.0/24"
 userDefinedFields:
 - name: "ipv4_fragment_offset"
 values:
 - "1-0x1fff"

 The above match condition matches packets with a source IP in
 192.0.2.0/24 or 198.51.100.0/24 and a user-defined field named
 "ipv4_fragment_offset" with a value between 1 and 0x1fff inclusive.
      optional .google.cloud.compute.v1.SecurityPolicyRuleNetworkMatcher network_match = 463387764;
      Returns:
      Whether the networkMatch field is set.

    • getNetworkMatch

      SecurityPolicyRuleNetworkMatcher getNetworkMatch()
       A match condition that incoming packets are evaluated against for
 CLOUD_ARMOR_NETWORK security policies. If it matches, the corresponding
 'action' is enforced.

 The match criteria for a rule consists of built-in match fields (like
 'srcIpRanges') and potentially multiple user-defined match fields
 ('userDefinedFields').

 Field values may be extracted directly from the packet or derived from it
 (e.g. 'srcRegionCodes'). Some fields may not be present in every packet
 (e.g. 'srcPorts'). A user-defined field is only present if the base
 header is found in the packet and the entire field is in bounds.

 Each match field may specify which values can match it, listing one or
 more ranges, prefixes, or exact values that are considered a match for
 the field. A field value must be present in order to match a specified
 match field. If no match values are specified for a match field, then any
 field value is considered to match it, and it's not required to be
 present. For strings specifying '*' is also equivalent to match all.

 For a packet to match a rule, all specified match fields must match the
 corresponding field values derived from the packet.

 Example:

 networkMatch:
 srcIpRanges:
 - "192.0.2.0/24"
 - "198.51.100.0/24"
 userDefinedFields:
 - name: "ipv4_fragment_offset"
 values:
 - "1-0x1fff"

 The above match condition matches packets with a source IP in
 192.0.2.0/24 or 198.51.100.0/24 and a user-defined field named
 "ipv4_fragment_offset" with a value between 1 and 0x1fff inclusive.
      optional .google.cloud.compute.v1.SecurityPolicyRuleNetworkMatcher network_match = 463387764;
      Returns:
      The networkMatch.

    • getNetworkMatchOrBuilder

      SecurityPolicyRuleNetworkMatcherOrBuilder getNetworkMatchOrBuilder()
       A match condition that incoming packets are evaluated against for
 CLOUD_ARMOR_NETWORK security policies. If it matches, the corresponding
 'action' is enforced.

 The match criteria for a rule consists of built-in match fields (like
 'srcIpRanges') and potentially multiple user-defined match fields
 ('userDefinedFields').

 Field values may be extracted directly from the packet or derived from it
 (e.g. 'srcRegionCodes'). Some fields may not be present in every packet
 (e.g. 'srcPorts'). A user-defined field is only present if the base
 header is found in the packet and the entire field is in bounds.

 Each match field may specify which values can match it, listing one or
 more ranges, prefixes, or exact values that are considered a match for
 the field. A field value must be present in order to match a specified
 match field. If no match values are specified for a match field, then any
 field value is considered to match it, and it's not required to be
 present. For strings specifying '*' is also equivalent to match all.

 For a packet to match a rule, all specified match fields must match the
 corresponding field values derived from the packet.

 Example:

 networkMatch:
 srcIpRanges:
 - "192.0.2.0/24"
 - "198.51.100.0/24"
 userDefinedFields:
 - name: "ipv4_fragment_offset"
 values:
 - "1-0x1fff"

 The above match condition matches packets with a source IP in
 192.0.2.0/24 or 198.51.100.0/24 and a user-defined field named
 "ipv4_fragment_offset" with a value between 1 and 0x1fff inclusive.
      optional .google.cloud.compute.v1.SecurityPolicyRuleNetworkMatcher network_match = 463387764;

    • hasPreconfiguredWafConfig

      boolean hasPreconfiguredWafConfig()
       Preconfigured WAF configuration to be applied for the rule. If the rule
 does not evaluate preconfigured WAF rules, i.e., if
 evaluatePreconfiguredWaf() is not used, this field will have no effect.
      optional .google.cloud.compute.v1.SecurityPolicyRulePreconfiguredWafConfig preconfigured_waf_config = 117805027;
      Returns:
      Whether the preconfiguredWafConfig field is set.

    • getPreconfiguredWafConfig

      SecurityPolicyRulePreconfiguredWafConfig getPreconfiguredWafConfig()
       Preconfigured WAF configuration to be applied for the rule. If the rule
 does not evaluate preconfigured WAF rules, i.e., if
 evaluatePreconfiguredWaf() is not used, this field will have no effect.
      optional .google.cloud.compute.v1.SecurityPolicyRulePreconfiguredWafConfig preconfigured_waf_config = 117805027;
      Returns:
      The preconfiguredWafConfig.

    • getPreconfiguredWafConfigOrBuilder

      SecurityPolicyRulePreconfiguredWafConfigOrBuilder getPreconfiguredWafConfigOrBuilder()
       Preconfigured WAF configuration to be applied for the rule. If the rule
 does not evaluate preconfigured WAF rules, i.e., if
 evaluatePreconfiguredWaf() is not used, this field will have no effect.
      optional .google.cloud.compute.v1.SecurityPolicyRulePreconfiguredWafConfig preconfigured_waf_config = 117805027;

    • hasPreview

      boolean hasPreview()
       If set to true, the specified action is not enforced.
      optional bool preview = 218686408;
      Returns:
      Whether the preview field is set.

    • getPreview

      boolean getPreview()
       If set to true, the specified action is not enforced.
      optional bool preview = 218686408;
      Returns:
      The preview.

    • hasPriority

      boolean hasPriority()
       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.
      optional int32 priority = 445151652;
      Returns:
      Whether the priority field is set.

    • getPriority

      int getPriority()
       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.
      optional int32 priority = 445151652;
      Returns:
      The priority.

    • hasRateLimitOptions

      boolean hasRateLimitOptions()
       Must be specified if the action is "rate_based_ban" or "throttle" or
 "fairshare". Cannot be specified for any other actions.
      optional .google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptions rate_limit_options = 67544315;
      Returns:
      Whether the rateLimitOptions field is set.

    • getRateLimitOptions

      SecurityPolicyRuleRateLimitOptions getRateLimitOptions()
       Must be specified if the action is "rate_based_ban" or "throttle" or
 "fairshare". Cannot be specified for any other actions.
      optional .google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptions rate_limit_options = 67544315;
      Returns:
      The rateLimitOptions.

    • getRateLimitOptionsOrBuilder

      SecurityPolicyRuleRateLimitOptionsOrBuilder getRateLimitOptionsOrBuilder()
       Must be specified if the action is "rate_based_ban" or "throttle" or
 "fairshare". Cannot be specified for any other actions.
      optional .google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptions rate_limit_options = 67544315;

    • hasRedirectOptions

      boolean hasRedirectOptions()
       Parameters defining the redirect action. Cannot be specified for any
 other actions.
 This field is only supported in Global Security Policies of type
 CLOUD_ARMOR.
      optional .google.cloud.compute.v1.SecurityPolicyRuleRedirectOptions redirect_options = 163285307;
      Returns:
      Whether the redirectOptions field is set.

    • getRedirectOptions

      SecurityPolicyRuleRedirectOptions getRedirectOptions()
       Parameters defining the redirect action. Cannot be specified for any
 other actions.
 This field is only supported in Global Security Policies of type
 CLOUD_ARMOR.
      optional .google.cloud.compute.v1.SecurityPolicyRuleRedirectOptions redirect_options = 163285307;
      Returns:
      The redirectOptions.

    • getRedirectOptionsOrBuilder

      SecurityPolicyRuleRedirectOptionsOrBuilder getRedirectOptionsOrBuilder()
       Parameters defining the redirect action. Cannot be specified for any
 other actions.
 This field is only supported in Global Security Policies of type
 CLOUD_ARMOR.
      optional .google.cloud.compute.v1.SecurityPolicyRuleRedirectOptions redirect_options = 163285307;