Send feedback
Class SecurityPolicyRule (1.6.0-beta)
Stay organized with collections
Save and categorize content based on your preferences.
Version 1.6.0-betakeyboard_arrow_down
public final class SecurityPolicyRule extends GeneratedMessageV3 implements SecurityPolicyRuleOrBuilder
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).
Protobuf type google.cloud.compute.v1.SecurityPolicyRule
Fields
ACTION_FIELD_NUMBER
public static final int ACTION_FIELD_NUMBER
Field Value
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Field Value
KIND_FIELD_NUMBER
public static final int KIND_FIELD_NUMBER
Field Value
MATCH_FIELD_NUMBER
public static final int MATCH_FIELD_NUMBER
Field Value
PREVIEW_FIELD_NUMBER
public static final int PREVIEW_FIELD_NUMBER
Field Value
PRIORITY_FIELD_NUMBER
public static final int PRIORITY_FIELD_NUMBER
Field Value
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Returns
Overrides
getAction()
public String getAction ()
The Action to perform when the client connection triggers the rule. Can currently be either "allow" or "deny()" where valid values for status are 403, 404, and 502.
optional string action = 187661878;
Returns
Type Description
String The action.
getActionBytes()
public ByteString getActionBytes ()
The Action to perform when the client connection triggers the rule. Can currently be either "allow" or "deny()" where valid values for status are 403, 404, and 502.
optional string action = 187661878;
Returns
getDefaultInstance()
public static SecurityPolicyRule getDefaultInstance ()
Returns
getDefaultInstanceForType()
public SecurityPolicyRule getDefaultInstanceForType ()
Returns
getDescription()
public String getDescription ()
An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
Returns
Type Description
String The description.
getDescriptionBytes()
public ByteString getDescriptionBytes ()
An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
Returns
Type Description
ByteString The bytes for description.
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
Returns
getKind()
[Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules
optional string kind = 3292052;
Returns
Type Description
String The kind.
getKindBytes()
public ByteString getKindBytes ()
[Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules
optional string kind = 3292052;
Returns
getMatch()
public 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
getMatchOrBuilder()
public 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;
Returns
getParserForType()
public Parser<SecurityPolicyRule> getParserForType ()
Returns
Overrides
getPreview()
public boolean getPreview ()
If set to true, the specified action is not enforced.
optional bool preview = 218686408;
Returns
Type Description
boolean The preview.
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
Type Description
int The priority.
getSerializedSize()
public int getSerializedSize ()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields ()
Returns
Overrides
hasAction()
public boolean hasAction ()
The Action to perform when the client connection triggers the rule. Can currently be either "allow" or "deny()" where valid values for status are 403, 404, and 502.
optional string action = 187661878;
Returns
Type Description
boolean Whether the action field is set.
hasDescription()
public boolean hasDescription ()
An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
Returns
Type Description
boolean Whether the description field is set.
hasKind()
[Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules
optional string kind = 3292052;
Returns
Type Description
boolean Whether the kind field is set.
hasMatch()
public 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
Type Description
boolean Whether the match field is set.
hasPreview()
public boolean hasPreview ()
If set to true, the specified action is not enforced.
optional bool preview = 218686408;
Returns
Type Description
boolean Whether the preview field is set.
hasPriority()
public 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
Type Description
boolean Whether the priority field is set.
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Returns
Overrides
isInitialized()
public final boolean isInitialized ()
Returns
Overrides
newBuilder()
public static SecurityPolicyRule . Builder newBuilder ()
Returns
newBuilder(SecurityPolicyRule prototype)
public static SecurityPolicyRule . Builder newBuilder ( SecurityPolicyRule prototype )
Parameter
Returns
newBuilderForType()
public SecurityPolicyRule . Builder newBuilderForType ()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SecurityPolicyRule . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Parameter
Returns
Overrides
public static SecurityPolicyRule parseDelimitedFrom ( InputStream input )
Parameter
Returns
Exceptions
public static SecurityPolicyRule parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static SecurityPolicyRule parseFrom ( byte [] data )
Parameter
Name Description
data byte []
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SecurityPolicyRule parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static SecurityPolicyRule parseFrom ( ByteString data )
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SecurityPolicyRule parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static SecurityPolicyRule parseFrom ( CodedInputStream input )
Parameter
Returns
Exceptions
public static SecurityPolicyRule parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static SecurityPolicyRule parseFrom ( InputStream input )
Parameter
Returns
Exceptions
public static SecurityPolicyRule parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static SecurityPolicyRule parseFrom ( ByteBuffer data )
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SecurityPolicyRule parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parser()
public static Parser<SecurityPolicyRule> parser ()
Returns
toBuilder()
public SecurityPolicyRule . Builder toBuilder ()
Returns
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Parameter
Overrides
Exceptions
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-06-11 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-11 UTC."],[],[]]
