Package com.google.cloud.compute.v1

Class FirewallPolicyRule

  • All Implemented Interfaces:
    FirewallPolicyRuleOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class FirewallPolicyRule
extends com.google.protobuf.GeneratedMessageV3
implements FirewallPolicyRuleOrBuilder
     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.FirewallPolicyRule
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • hasAction

        public boolean hasAction()
         The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next".
        optional string action = 187661878;
        Specified by:
        hasAction in interface FirewallPolicyRuleOrBuilder
        Returns:
        Whether the action field is set.

      • getAction

        public String getAction()
         The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next".
        optional string action = 187661878;
        Specified by:
        getAction in interface FirewallPolicyRuleOrBuilder
        Returns:
        The action.

      • getActionBytes

        public com.google.protobuf.ByteString getActionBytes()
         The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next".
        optional string action = 187661878;
        Specified by:
        getActionBytes in interface FirewallPolicyRuleOrBuilder
        Returns:
        The bytes for action.

      • hasDescription

        public boolean hasDescription()
         An optional description for this resource.
        optional string description = 422937596;
        Specified by:
        hasDescription in interface FirewallPolicyRuleOrBuilder
        Returns:
        Whether the description field is set.

      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         An optional description for this resource.
        optional string description = 422937596;
        Specified by:
        getDescriptionBytes in interface FirewallPolicyRuleOrBuilder
        Returns:
        The bytes for description.

      • hasDirection

        public boolean hasDirection()
         The direction in which this rule applies.
 Check the Direction enum for the list of possible values.
        optional string direction = 111150975;
        Specified by:
        hasDirection in interface FirewallPolicyRuleOrBuilder
        Returns:
        Whether the direction field is set.

      • getDirection

        public String getDirection()
         The direction in which this rule applies.
 Check the Direction enum for the list of possible values.
        optional string direction = 111150975;
        Specified by:
        getDirection in interface FirewallPolicyRuleOrBuilder
        Returns:
        The direction.

      • getDirectionBytes

        public com.google.protobuf.ByteString getDirectionBytes()
         The direction in which this rule applies.
 Check the Direction enum for the list of possible values.
        optional string direction = 111150975;
        Specified by:
        getDirectionBytes in interface FirewallPolicyRuleOrBuilder
        Returns:
        The bytes for direction.

      • hasDisabled

        public boolean hasDisabled()
         Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.
        optional bool disabled = 270940796;
        Specified by:
        hasDisabled in interface FirewallPolicyRuleOrBuilder
        Returns:
        Whether the disabled field is set.

      • getDisabled

        public boolean getDisabled()
         Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.
        optional bool disabled = 270940796;
        Specified by:
        getDisabled in interface FirewallPolicyRuleOrBuilder
        Returns:
        The disabled.

      • hasEnableLogging

        public boolean hasEnableLogging()
         Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules.
        optional bool enable_logging = 295396515;
        Specified by:
        hasEnableLogging in interface FirewallPolicyRuleOrBuilder
        Returns:
        Whether the enableLogging field is set.

      • getEnableLogging

        public boolean getEnableLogging()
         Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules.
        optional bool enable_logging = 295396515;
        Specified by:
        getEnableLogging in interface FirewallPolicyRuleOrBuilder
        Returns:
        The enableLogging.

      • hasKind

        public boolean hasKind()
         [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules
        optional string kind = 3292052;
        Specified by:
        hasKind in interface FirewallPolicyRuleOrBuilder
        Returns:
        Whether the kind field is set.

      • getKind

        public String getKind()
         [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules
        optional string kind = 3292052;
        Specified by:
        getKind in interface FirewallPolicyRuleOrBuilder
        Returns:
        The kind.

      • getKindBytes

        public com.google.protobuf.ByteString getKindBytes()
         [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules
        optional string kind = 3292052;
        Specified by:
        getKindBytes in interface FirewallPolicyRuleOrBuilder
        Returns:
        The bytes for kind.

      • 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.FirewallPolicyRuleMatcher match = 103668165;
        Specified by:
        hasMatch in interface FirewallPolicyRuleOrBuilder
        Returns:
        Whether the match field is set.

      • getMatch

        public FirewallPolicyRuleMatcher 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.FirewallPolicyRuleMatcher match = 103668165;
        Specified by:
        getMatch in interface FirewallPolicyRuleOrBuilder
        Returns:
        The match.

      • 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 prority.
        optional int32 priority = 445151652;
        Specified by:
        hasPriority in interface FirewallPolicyRuleOrBuilder
        Returns:
        Whether the priority field is set.

      • getPriority

        public 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 prority.
        optional int32 priority = 445151652;
        Specified by:
        getPriority in interface FirewallPolicyRuleOrBuilder
        Returns:
        The priority.

      • hasRuleName

        public boolean hasRuleName()
         An optional name for the rule. This field is not a unique identifier and can be updated.
        optional string rule_name = 55286254;
        Specified by:
        hasRuleName in interface FirewallPolicyRuleOrBuilder
        Returns:
        Whether the ruleName field is set.

      • getRuleName

        public String getRuleName()
         An optional name for the rule. This field is not a unique identifier and can be updated.
        optional string rule_name = 55286254;
        Specified by:
        getRuleName in interface FirewallPolicyRuleOrBuilder
        Returns:
        The ruleName.

      • getRuleNameBytes

        public com.google.protobuf.ByteString getRuleNameBytes()
         An optional name for the rule. This field is not a unique identifier and can be updated.
        optional string rule_name = 55286254;
        Specified by:
        getRuleNameBytes in interface FirewallPolicyRuleOrBuilder
        Returns:
        The bytes for ruleName.

      • hasRuleTupleCount

        public boolean hasRuleTupleCount()
         [Output Only] Calculation of the complexity of a single firewall policy rule.
        optional int32 rule_tuple_count = 388342037;
        Specified by:
        hasRuleTupleCount in interface FirewallPolicyRuleOrBuilder
        Returns:
        Whether the ruleTupleCount field is set.

      • getRuleTupleCount

        public int getRuleTupleCount()
         [Output Only] Calculation of the complexity of a single firewall policy rule.
        optional int32 rule_tuple_count = 388342037;
        Specified by:
        getRuleTupleCount in interface FirewallPolicyRuleOrBuilder
        Returns:
        The ruleTupleCount.

      • getTargetResourcesList

        public com.google.protobuf.ProtocolStringList getTargetResourcesList()
         A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.
        repeated string target_resources = 528230647;
        Specified by:
        getTargetResourcesList in interface FirewallPolicyRuleOrBuilder
        Returns:
        A list containing the targetResources.

      • getTargetResourcesCount

        public int getTargetResourcesCount()
         A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.
        repeated string target_resources = 528230647;
        Specified by:
        getTargetResourcesCount in interface FirewallPolicyRuleOrBuilder
        Returns:
        The count of targetResources.

      • getTargetResources

        public String getTargetResources​(int index)
         A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.
        repeated string target_resources = 528230647;
        Specified by:
        getTargetResources in interface FirewallPolicyRuleOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The targetResources at the given index.

      • getTargetResourcesBytes

        public com.google.protobuf.ByteString getTargetResourcesBytes​(int index)
         A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.
        repeated string target_resources = 528230647;
        Specified by:
        getTargetResourcesBytes in interface FirewallPolicyRuleOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the targetResources at the given index.

      • getTargetSecureTagsList

        public List<FirewallPolicyRuleSecureTag> getTargetSecureTagsList()
         A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.
        repeated .google.cloud.compute.v1.FirewallPolicyRuleSecureTag target_secure_tags = 468132403;
        Specified by:
        getTargetSecureTagsList in interface FirewallPolicyRuleOrBuilder

      • getTargetSecureTagsOrBuilderList

        public List<? extends FirewallPolicyRuleSecureTagOrBuilder> getTargetSecureTagsOrBuilderList()
         A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.
        repeated .google.cloud.compute.v1.FirewallPolicyRuleSecureTag target_secure_tags = 468132403;
        Specified by:
        getTargetSecureTagsOrBuilderList in interface FirewallPolicyRuleOrBuilder

      • getTargetSecureTagsCount

        public int getTargetSecureTagsCount()
         A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.
        repeated .google.cloud.compute.v1.FirewallPolicyRuleSecureTag target_secure_tags = 468132403;
        Specified by:
        getTargetSecureTagsCount in interface FirewallPolicyRuleOrBuilder

      • getTargetSecureTags

        public FirewallPolicyRuleSecureTag getTargetSecureTags​(int index)
         A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.
        repeated .google.cloud.compute.v1.FirewallPolicyRuleSecureTag target_secure_tags = 468132403;
        Specified by:
        getTargetSecureTags in interface FirewallPolicyRuleOrBuilder

      • getTargetSecureTagsOrBuilder

        public FirewallPolicyRuleSecureTagOrBuilder getTargetSecureTagsOrBuilder​(int index)
         A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.
        repeated .google.cloud.compute.v1.FirewallPolicyRuleSecureTag target_secure_tags = 468132403;
        Specified by:
        getTargetSecureTagsOrBuilder in interface FirewallPolicyRuleOrBuilder

      • getTargetServiceAccountsList

        public com.google.protobuf.ProtocolStringList getTargetServiceAccountsList()
         A list of service accounts indicating the sets of instances that are applied with this rule.
        repeated string target_service_accounts = 457639710;
        Specified by:
        getTargetServiceAccountsList in interface FirewallPolicyRuleOrBuilder
        Returns:
        A list containing the targetServiceAccounts.

      • getTargetServiceAccountsCount

        public int getTargetServiceAccountsCount()
         A list of service accounts indicating the sets of instances that are applied with this rule.
        repeated string target_service_accounts = 457639710;
        Specified by:
        getTargetServiceAccountsCount in interface FirewallPolicyRuleOrBuilder
        Returns:
        The count of targetServiceAccounts.

      • getTargetServiceAccounts

        public String getTargetServiceAccounts​(int index)
         A list of service accounts indicating the sets of instances that are applied with this rule.
        repeated string target_service_accounts = 457639710;
        Specified by:
        getTargetServiceAccounts in interface FirewallPolicyRuleOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The targetServiceAccounts at the given index.

      • getTargetServiceAccountsBytes

        public com.google.protobuf.ByteString getTargetServiceAccountsBytes​(int index)
         A list of service accounts indicating the sets of instances that are applied with this rule.
        repeated string target_service_accounts = 457639710;
        Specified by:
        getTargetServiceAccountsBytes in interface FirewallPolicyRuleOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the targetServiceAccounts at the given index.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static FirewallPolicyRule parseFrom​(ByteBuffer data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static FirewallPolicyRule parseFrom​(ByteBuffer data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static FirewallPolicyRule parseFrom​(com.google.protobuf.ByteString data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static FirewallPolicyRule parseFrom​(com.google.protobuf.ByteString data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static FirewallPolicyRule parseFrom​(byte[] data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static FirewallPolicyRule parseFrom​(byte[] data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static FirewallPolicyRule parseFrom​(com.google.protobuf.CodedInputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException
        Throws:
        IOException

      • newBuilderForType

        public FirewallPolicyRule.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public FirewallPolicyRule.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected FirewallPolicyRule.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<FirewallPolicyRule> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public FirewallPolicyRule getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder