Class FirewallPolicy (1.22.0)

public final class FirewallPolicy extends GeneratedMessageV3 implements FirewallPolicyOrBuilder

Represents a Firewall Policy resource.

Protobuf type google.cloud.compute.v1.FirewallPolicy

Static Fields

ASSOCIATIONS_FIELD_NUMBER

public static final int ASSOCIATIONS_FIELD_NUMBER
Field Value
TypeDescription
int

CREATION_TIMESTAMP_FIELD_NUMBER

public static final int CREATION_TIMESTAMP_FIELD_NUMBER
Field Value
TypeDescription
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
TypeDescription
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

FINGERPRINT_FIELD_NUMBER

public static final int FINGERPRINT_FIELD_NUMBER
Field Value
TypeDescription
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
TypeDescription
int

KIND_FIELD_NUMBER

public static final int KIND_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
TypeDescription
int

REGION_FIELD_NUMBER

public static final int REGION_FIELD_NUMBER
Field Value
TypeDescription
int

RULES_FIELD_NUMBER

public static final int RULES_FIELD_NUMBER
Field Value
TypeDescription
int

RULE_TUPLE_COUNT_FIELD_NUMBER

public static final int RULE_TUPLE_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int
public static final int SELF_LINK_FIELD_NUMBER
Field Value
TypeDescription
int
public static final int SELF_LINK_WITH_ID_FIELD_NUMBER
Field Value
TypeDescription
int

SHORT_NAME_FIELD_NUMBER

public static final int SHORT_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static FirewallPolicy getDefaultInstance()
Returns
TypeDescription
FirewallPolicy

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static FirewallPolicy.Builder newBuilder()
Returns
TypeDescription
FirewallPolicy.Builder

newBuilder(FirewallPolicy prototype)

public static FirewallPolicy.Builder newBuilder(FirewallPolicy prototype)
Parameter
NameDescription
prototypeFirewallPolicy
Returns
TypeDescription
FirewallPolicy.Builder

parseDelimitedFrom(InputStream input)

public static FirewallPolicy parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
FirewallPolicy
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FirewallPolicy parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FirewallPolicy
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static FirewallPolicy parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
FirewallPolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static FirewallPolicy parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FirewallPolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static FirewallPolicy parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
FirewallPolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static FirewallPolicy parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FirewallPolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static FirewallPolicy parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
FirewallPolicy
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static FirewallPolicy parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FirewallPolicy
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static FirewallPolicy parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
FirewallPolicy
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FirewallPolicy parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FirewallPolicy
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static FirewallPolicy parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
FirewallPolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static FirewallPolicy parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FirewallPolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<FirewallPolicy> parser()
Returns
TypeDescription
Parser<FirewallPolicy>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAssociations(int index)

public FirewallPolicyAssociation getAssociations(int index)

A list of associations that belong to this firewall policy.

repeated .google.cloud.compute.v1.FirewallPolicyAssociation associations = 508736530;

Parameter
NameDescription
indexint
Returns
TypeDescription
FirewallPolicyAssociation

getAssociationsCount()

public int getAssociationsCount()

A list of associations that belong to this firewall policy.

repeated .google.cloud.compute.v1.FirewallPolicyAssociation associations = 508736530;

Returns
TypeDescription
int

getAssociationsList()

public List<FirewallPolicyAssociation> getAssociationsList()

A list of associations that belong to this firewall policy.

repeated .google.cloud.compute.v1.FirewallPolicyAssociation associations = 508736530;

Returns
TypeDescription
List<FirewallPolicyAssociation>

getAssociationsOrBuilder(int index)

public FirewallPolicyAssociationOrBuilder getAssociationsOrBuilder(int index)

A list of associations that belong to this firewall policy.

repeated .google.cloud.compute.v1.FirewallPolicyAssociation associations = 508736530;

Parameter
NameDescription
indexint
Returns
TypeDescription
FirewallPolicyAssociationOrBuilder

getAssociationsOrBuilderList()

public List<? extends FirewallPolicyAssociationOrBuilder> getAssociationsOrBuilderList()

A list of associations that belong to this firewall policy.

repeated .google.cloud.compute.v1.FirewallPolicyAssociation associations = 508736530;

Returns
TypeDescription
List<? extends com.google.cloud.compute.v1.FirewallPolicyAssociationOrBuilder>

getCreationTimestamp()

public String getCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
TypeDescription
String

The creationTimestamp.

getCreationTimestampBytes()

public ByteString getCreationTimestampBytes()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
TypeDescription
ByteString

The bytes for creationTimestamp.

getDefaultInstanceForType()

public FirewallPolicy getDefaultInstanceForType()
Returns
TypeDescription
FirewallPolicy

getDescription()

public String getDescription()

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Returns
TypeDescription
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
TypeDescription
ByteString

The bytes for description.

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? 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;

Returns
TypeDescription
String

The displayName.

getDisplayNameBytes()

public 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? 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;

Returns
TypeDescription
ByteString

The bytes for displayName.

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;

Returns
TypeDescription
String

The fingerprint.

getFingerprintBytes()

public 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;

Returns
TypeDescription
ByteString

The bytes for fingerprint.

getId()

public long getId()

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

optional uint64 id = 3355;

Returns
TypeDescription
long

The id.

getKind()

public String getKind()

[Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies

optional string kind = 3292052;

Returns
TypeDescription
String

The kind.

getKindBytes()

public ByteString getKindBytes()

[Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies

optional string kind = 3292052;

Returns
TypeDescription
ByteString

The bytes for kind.

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;

Returns
TypeDescription
String

The name.

getNameBytes()

public 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;

Returns
TypeDescription
ByteString

The bytes for name.

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;

Returns
TypeDescription
String

The parent.

getParentBytes()

public ByteString getParentBytes()

[Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies.

optional string parent = 78317738;

Returns
TypeDescription
ByteString

The bytes for parent.

getParserForType()

public Parser<FirewallPolicy> getParserForType()
Returns
TypeDescription
Parser<FirewallPolicy>
Overrides

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;

Returns
TypeDescription
String

The region.

getRegionBytes()

public 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;

Returns
TypeDescription
ByteString

The bytes for region.

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;

Returns
TypeDescription
int

The ruleTupleCount.

getRules(int index)

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;

Parameter
NameDescription
indexint
Returns
TypeDescription
FirewallPolicyRule

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;

Returns
TypeDescription
int

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;

Returns
TypeDescription
List<FirewallPolicyRule>

getRulesOrBuilder(int index)

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;

Parameter
NameDescription
indexint
Returns
TypeDescription
FirewallPolicyRuleOrBuilder

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;

Returns
TypeDescription
List<? extends com.google.cloud.compute.v1.FirewallPolicyRuleOrBuilder>
public String getSelfLink()

[Output Only] Server-defined URL for the resource.

optional string self_link = 456214797;

Returns
TypeDescription
String

The selfLink.

getSelfLinkBytes()

public ByteString getSelfLinkBytes()

[Output Only] Server-defined URL for the resource.

optional string self_link = 456214797;

Returns
TypeDescription
ByteString

The bytes for selfLink.

getSelfLinkWithId()

public String getSelfLinkWithId()

[Output Only] Server-defined URL for this resource with the resource id.

optional string self_link_with_id = 44520962;

Returns
TypeDescription
String

The selfLinkWithId.

getSelfLinkWithIdBytes()

public ByteString getSelfLinkWithIdBytes()

[Output Only] Server-defined URL for this resource with the resource id.

optional string self_link_with_id = 44520962;

Returns
TypeDescription
ByteString

The bytes for selfLinkWithId.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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? 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;

Returns
TypeDescription
String

The shortName.

getShortNameBytes()

public 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? 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;

Returns
TypeDescription
ByteString

The bytes for shortName.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasCreationTimestamp()

public boolean hasCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
TypeDescription
boolean

Whether the creationTimestamp 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
TypeDescription
boolean

Whether the description field is set.

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? 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;

Returns
TypeDescription
boolean

Whether the displayName field is set.

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;

Returns
TypeDescription
boolean

Whether the fingerprint field is set.

hasId()

public boolean hasId()

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

optional uint64 id = 3355;

Returns
TypeDescription
boolean

Whether the id field is set.

hasKind()

public boolean hasKind()

[Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies

optional string kind = 3292052;

Returns
TypeDescription
boolean

Whether the kind field is set.

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;

Returns
TypeDescription
boolean

Whether the name field is set.

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;

Returns
TypeDescription
boolean

Whether the parent field is set.

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;

Returns
TypeDescription
boolean

Whether the region field is set.

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;

Returns
TypeDescription
boolean

Whether the ruleTupleCount field is set.

public boolean hasSelfLink()

[Output Only] Server-defined URL for the resource.

optional string self_link = 456214797;

Returns
TypeDescription
boolean

Whether the selfLink field is set.

hasSelfLinkWithId()

public boolean hasSelfLinkWithId()

[Output Only] Server-defined URL for this resource with the resource id.

optional string self_link_with_id = 44520962;

Returns
TypeDescription
boolean

Whether the selfLinkWithId field is set.

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? 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;

Returns
TypeDescription
boolean

Whether the shortName field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public FirewallPolicy.Builder newBuilderForType()
Returns
TypeDescription
FirewallPolicy.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected FirewallPolicy.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
FirewallPolicy.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public FirewallPolicy.Builder toBuilder()
Returns
TypeDescription
FirewallPolicy.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException