Package com.google.cloud.compute.v1

Class FirewallPolicy

  • All Implemented Interfaces:
    FirewallPolicyOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class FirewallPolicy
extends com.google.protobuf.GeneratedMessageV3
implements FirewallPolicyOrBuilder
     Represents a Firewall Policy resource.
    Protobuf type google.cloud.compute.v1.FirewallPolicy
    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

      • getAssociationsCount

        public int getAssociationsCount()
         A list of associations that belong to this firewall policy.
        repeated .google.cloud.compute.v1.FirewallPolicyAssociation associations = 508736530;
        Specified by:
        getAssociationsCount in interface FirewallPolicyOrBuilder

      • hasCreationTimestamp

        public boolean hasCreationTimestamp()
         [Output Only] Creation timestamp in RFC3339 text format.
        optional string creation_timestamp = 30525366;
        Specified by:
        hasCreationTimestamp in interface FirewallPolicyOrBuilder
        Returns:
        Whether the creationTimestamp field is set.

      • getCreationTimestamp

        public String getCreationTimestamp()
         [Output Only] Creation timestamp in RFC3339 text format.
        optional string creation_timestamp = 30525366;
        Specified by:
        getCreationTimestamp in interface FirewallPolicyOrBuilder
        Returns:
        The creationTimestamp.

      • getCreationTimestampBytes

        public com.google.protobuf.ByteString getCreationTimestampBytes()
         [Output Only] Creation timestamp in RFC3339 text format.
        optional string creation_timestamp = 30525366;
        Specified by:
        getCreationTimestampBytes in interface FirewallPolicyOrBuilder
        Returns:
        The bytes for creationTimestamp.

      • hasDescription

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

      • getDescription

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

      • getDescriptionBytes

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

      • hasDisplayName

        public boolean hasDisplayName()
         Deprecated, please use short name instead. User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        optional string display_name = 4473832;
        Specified by:
        hasDisplayName in interface FirewallPolicyOrBuilder
        Returns:
        Whether the displayName field is set.

      • getDisplayName

        public String getDisplayName()
         Deprecated, please use short name instead. User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        optional string display_name = 4473832;
        Specified by:
        getDisplayName in interface FirewallPolicyOrBuilder
        Returns:
        The displayName.

      • getDisplayNameBytes

        public com.google.protobuf.ByteString getDisplayNameBytes()
         Deprecated, please use short name instead. User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        optional string display_name = 4473832;
        Specified by:
        getDisplayNameBytes in interface FirewallPolicyOrBuilder
        Returns:
        The bytes for displayName.

      • hasFingerprint

        public boolean hasFingerprint()
         Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the firewall policy.
        optional string fingerprint = 234678500;
        Specified by:
        hasFingerprint in interface FirewallPolicyOrBuilder
        Returns:
        Whether the fingerprint field is set.

      • getFingerprint

        public String getFingerprint()
         Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the firewall policy.
        optional string fingerprint = 234678500;
        Specified by:
        getFingerprint in interface FirewallPolicyOrBuilder
        Returns:
        The fingerprint.

      • getFingerprintBytes

        public com.google.protobuf.ByteString getFingerprintBytes()
         Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the firewall policy.
        optional string fingerprint = 234678500;
        Specified by:
        getFingerprintBytes in interface FirewallPolicyOrBuilder
        Returns:
        The bytes for fingerprint.

      • hasId

        public boolean hasId()
         [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        optional uint64 id = 3355;
        Specified by:
        hasId in interface FirewallPolicyOrBuilder
        Returns:
        Whether the id field is set.

      • getId

        public long getId()
         [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        optional uint64 id = 3355;
        Specified by:
        getId in interface FirewallPolicyOrBuilder
        Returns:
        The id.

      • hasKind

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

      • getKind

        public String getKind()
         [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies
        optional string kind = 3292052;
        Specified by:
        getKind in interface FirewallPolicyOrBuilder
        Returns:
        The kind.

      • getKindBytes

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

      • hasName

        public boolean hasName()
         Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy.
        optional string name = 3373707;
        Specified by:
        hasName in interface FirewallPolicyOrBuilder
        Returns:
        Whether the name field is set.

      • getName

        public String getName()
         Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy.
        optional string name = 3373707;
        Specified by:
        getName in interface FirewallPolicyOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy.
        optional string name = 3373707;
        Specified by:
        getNameBytes in interface FirewallPolicyOrBuilder
        Returns:
        The bytes for name.

      • hasParent

        public boolean hasParent()
         [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies.
        optional string parent = 78317738;
        Specified by:
        hasParent in interface FirewallPolicyOrBuilder
        Returns:
        Whether the parent field is set.

      • getParent

        public String getParent()
         [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies.
        optional string parent = 78317738;
        Specified by:
        getParent in interface FirewallPolicyOrBuilder
        Returns:
        The parent.

      • getParentBytes

        public com.google.protobuf.ByteString getParentBytes()
         [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies.
        optional string parent = 78317738;
        Specified by:
        getParentBytes in interface FirewallPolicyOrBuilder
        Returns:
        The bytes for parent.

      • hasRegion

        public boolean hasRegion()
         [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
        optional string region = 138946292;
        Specified by:
        hasRegion in interface FirewallPolicyOrBuilder
        Returns:
        Whether the region field is set.

      • getRegion

        public String getRegion()
         [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
        optional string region = 138946292;
        Specified by:
        getRegion in interface FirewallPolicyOrBuilder
        Returns:
        The region.

      • getRegionBytes

        public com.google.protobuf.ByteString getRegionBytes()
         [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
        optional string region = 138946292;
        Specified by:
        getRegionBytes in interface FirewallPolicyOrBuilder
        Returns:
        The bytes for region.

      • hasRuleTupleCount

        public boolean hasRuleTupleCount()
         [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples.
        optional int32 rule_tuple_count = 388342037;
        Specified by:
        hasRuleTupleCount in interface FirewallPolicyOrBuilder
        Returns:
        Whether the ruleTupleCount field is set.

      • getRuleTupleCount

        public int getRuleTupleCount()
         [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples.
        optional int32 rule_tuple_count = 388342037;
        Specified by:
        getRuleTupleCount in interface FirewallPolicyOrBuilder
        Returns:
        The ruleTupleCount.

      • getRulesList

        public List<FirewallPolicyRule> getRulesList()
         A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match "*"). If no rules are provided when creating a firewall policy, a default rule with action "allow" will be added.
        repeated .google.cloud.compute.v1.FirewallPolicyRule rules = 108873975;
        Specified by:
        getRulesList in interface FirewallPolicyOrBuilder

      • getRulesOrBuilderList

        public List<? extends FirewallPolicyRuleOrBuilder> getRulesOrBuilderList()
         A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match "*"). If no rules are provided when creating a firewall policy, a default rule with action "allow" will be added.
        repeated .google.cloud.compute.v1.FirewallPolicyRule rules = 108873975;
        Specified by:
        getRulesOrBuilderList in interface FirewallPolicyOrBuilder

      • getRulesCount

        public int getRulesCount()
         A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match "*"). If no rules are provided when creating a firewall policy, a default rule with action "allow" will be added.
        repeated .google.cloud.compute.v1.FirewallPolicyRule rules = 108873975;
        Specified by:
        getRulesCount in interface FirewallPolicyOrBuilder

      • getRules

        public FirewallPolicyRule getRules​(int index)
         A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match "*"). If no rules are provided when creating a firewall policy, a default rule with action "allow" will be added.
        repeated .google.cloud.compute.v1.FirewallPolicyRule rules = 108873975;
        Specified by:
        getRules in interface FirewallPolicyOrBuilder

      • getRulesOrBuilder

        public FirewallPolicyRuleOrBuilder getRulesOrBuilder​(int index)
         A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match "*"). If no rules are provided when creating a firewall policy, a default rule with action "allow" will be added.
        repeated .google.cloud.compute.v1.FirewallPolicyRule rules = 108873975;
        Specified by:
        getRulesOrBuilder in interface FirewallPolicyOrBuilder

      • hasSelfLink

        public boolean hasSelfLink()
         [Output Only] Server-defined URL for the resource.
        optional string self_link = 456214797;
        Specified by:
        hasSelfLink in interface FirewallPolicyOrBuilder
        Returns:
        Whether the selfLink field is set.

      • getSelfLink

        public String getSelfLink()
         [Output Only] Server-defined URL for the resource.
        optional string self_link = 456214797;
        Specified by:
        getSelfLink in interface FirewallPolicyOrBuilder
        Returns:
        The selfLink.

      • getSelfLinkBytes

        public com.google.protobuf.ByteString getSelfLinkBytes()
         [Output Only] Server-defined URL for the resource.
        optional string self_link = 456214797;
        Specified by:
        getSelfLinkBytes in interface FirewallPolicyOrBuilder
        Returns:
        The bytes for selfLink.

      • hasSelfLinkWithId

        public boolean hasSelfLinkWithId()
         [Output Only] Server-defined URL for this resource with the resource id.
        optional string self_link_with_id = 44520962;
        Specified by:
        hasSelfLinkWithId in interface FirewallPolicyOrBuilder
        Returns:
        Whether the selfLinkWithId field is set.

      • getSelfLinkWithId

        public String getSelfLinkWithId()
         [Output Only] Server-defined URL for this resource with the resource id.
        optional string self_link_with_id = 44520962;
        Specified by:
        getSelfLinkWithId in interface FirewallPolicyOrBuilder
        Returns:
        The selfLinkWithId.

      • getSelfLinkWithIdBytes

        public com.google.protobuf.ByteString getSelfLinkWithIdBytes()
         [Output Only] Server-defined URL for this resource with the resource id.
        optional string self_link_with_id = 44520962;
        Specified by:
        getSelfLinkWithIdBytes in interface FirewallPolicyOrBuilder
        Returns:
        The bytes for selfLinkWithId.

      • hasShortName

        public boolean hasShortName()
         User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        optional string short_name = 492051566;
        Specified by:
        hasShortName in interface FirewallPolicyOrBuilder
        Returns:
        Whether the shortName field is set.

      • getShortName

        public String getShortName()
         User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        optional string short_name = 492051566;
        Specified by:
        getShortName in interface FirewallPolicyOrBuilder
        Returns:
        The shortName.

      • getShortNameBytes

        public com.google.protobuf.ByteString getShortNameBytes()
         User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        optional string short_name = 492051566;
        Specified by:
        getShortNameBytes in interface FirewallPolicyOrBuilder
        Returns:
        The bytes for shortName.

      • 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 FirewallPolicy parseFrom​(ByteBuffer data)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static FirewallPolicy getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<FirewallPolicy> parser()

      • getParserForType

        public com.google.protobuf.Parser<FirewallPolicy> 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 FirewallPolicy getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder