Class FirewallPolicy.Builder (1.63.0) 

public static final class FirewallPolicy.Builder extends GeneratedMessageV3.Builder<FirewallPolicy.Builder> implements FirewallPolicyOrBuilder

Represents a Firewall Policy resource.

Protobuf type google.cloud.compute.v1.FirewallPolicy

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > FirewallPolicy.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllAssociations(Iterable<? extends FirewallPolicyAssociation> values)

public FirewallPolicy.Builder addAllAssociations(Iterable<? extends FirewallPolicyAssociation> values)

A list of associations that belong to this firewall policy.

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

Parameter
Name Description
values Iterable<? extends com.google.cloud.compute.v1.FirewallPolicyAssociation>
Returns
Type Description
FirewallPolicy.Builder

addAllRules(Iterable<? extends FirewallPolicyRule> values)

public FirewallPolicy.Builder addAllRules(Iterable<? extends FirewallPolicyRule> values)

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
Name Description
values Iterable<? extends com.google.cloud.compute.v1.FirewallPolicyRule>
Returns
Type Description
FirewallPolicy.Builder

addAssociations(FirewallPolicyAssociation value)

public FirewallPolicy.Builder addAssociations(FirewallPolicyAssociation value)

A list of associations that belong to this firewall policy.

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

Parameter
Name Description
value FirewallPolicyAssociation
Returns
Type Description
FirewallPolicy.Builder

addAssociations(FirewallPolicyAssociation.Builder builderForValue)

public FirewallPolicy.Builder addAssociations(FirewallPolicyAssociation.Builder builderForValue)

A list of associations that belong to this firewall policy.

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

Parameter
Name Description
builderForValue FirewallPolicyAssociation.Builder
Returns
Type Description
FirewallPolicy.Builder

addAssociations(int index, FirewallPolicyAssociation value)

public FirewallPolicy.Builder addAssociations(int index, FirewallPolicyAssociation value)

A list of associations that belong to this firewall policy.

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

Parameters
Name Description
index int
value FirewallPolicyAssociation
Returns
Type Description
FirewallPolicy.Builder

addAssociations(int index, FirewallPolicyAssociation.Builder builderForValue)

public FirewallPolicy.Builder addAssociations(int index, FirewallPolicyAssociation.Builder builderForValue)

A list of associations that belong to this firewall policy.

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

Parameters
Name Description
index int
builderForValue FirewallPolicyAssociation.Builder
Returns
Type Description
FirewallPolicy.Builder

addAssociationsBuilder()

public FirewallPolicyAssociation.Builder addAssociationsBuilder()

A list of associations that belong to this firewall policy.

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

Returns
Type Description
FirewallPolicyAssociation.Builder

addAssociationsBuilder(int index)

public FirewallPolicyAssociation.Builder addAssociationsBuilder(int index)

A list of associations that belong to this firewall policy.

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

Parameter
Name Description
index int
Returns
Type Description
FirewallPolicyAssociation.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public FirewallPolicy.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
FirewallPolicy.Builder
Overrides

addRules(FirewallPolicyRule value)

public FirewallPolicy.Builder addRules(FirewallPolicyRule value)

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
Name Description
value FirewallPolicyRule
Returns
Type Description
FirewallPolicy.Builder

addRules(FirewallPolicyRule.Builder builderForValue)

public FirewallPolicy.Builder addRules(FirewallPolicyRule.Builder builderForValue)

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
Name Description
builderForValue FirewallPolicyRule.Builder
Returns
Type Description
FirewallPolicy.Builder

addRules(int index, FirewallPolicyRule value)

public FirewallPolicy.Builder addRules(int index, FirewallPolicyRule value)

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;

Parameters
Name Description
index int
value FirewallPolicyRule
Returns
Type Description
FirewallPolicy.Builder

addRules(int index, FirewallPolicyRule.Builder builderForValue)

public FirewallPolicy.Builder addRules(int index, FirewallPolicyRule.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue FirewallPolicyRule.Builder
Returns
Type Description
FirewallPolicy.Builder

addRulesBuilder()

public FirewallPolicyRule.Builder addRulesBuilder()

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
Type Description
FirewallPolicyRule.Builder

addRulesBuilder(int index)

public FirewallPolicyRule.Builder addRulesBuilder(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
Name Description
index int
Returns
Type Description
FirewallPolicyRule.Builder

build()

public FirewallPolicy build()
Returns
Type Description
FirewallPolicy

buildPartial()

public FirewallPolicy buildPartial()
Returns
Type Description
FirewallPolicy

clear()

public FirewallPolicy.Builder clear()
Returns
Type Description
FirewallPolicy.Builder
Overrides

clearAssociations()

public FirewallPolicy.Builder clearAssociations()

A list of associations that belong to this firewall policy.

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

Returns
Type Description
FirewallPolicy.Builder

clearCreationTimestamp()

public FirewallPolicy.Builder clearCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
FirewallPolicy.Builder

This builder for chaining.

clearDescription()

public FirewallPolicy.Builder clearDescription()

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

optional string description = 422937596;

Returns
Type Description
FirewallPolicy.Builder

This builder for chaining.

clearDisplayName()

public FirewallPolicy.Builder clearDisplayName()

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
Type Description
FirewallPolicy.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public FirewallPolicy.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
FirewallPolicy.Builder
Overrides

clearFingerprint()

public FirewallPolicy.Builder clearFingerprint()

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
Type Description
FirewallPolicy.Builder

This builder for chaining.

clearId()

public FirewallPolicy.Builder clearId()

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

optional uint64 id = 3355;

Returns
Type Description
FirewallPolicy.Builder

This builder for chaining.

clearKind()

public FirewallPolicy.Builder clearKind()

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

optional string kind = 3292052;

Returns
Type Description
FirewallPolicy.Builder

This builder for chaining.

clearName()

public FirewallPolicy.Builder clearName()

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
Type Description
FirewallPolicy.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public FirewallPolicy.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
FirewallPolicy.Builder
Overrides

clearParent()

public FirewallPolicy.Builder clearParent()

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

optional string parent = 78317738;

Returns
Type Description
FirewallPolicy.Builder

This builder for chaining.

clearRegion()

public FirewallPolicy.Builder clearRegion()

[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
Type Description
FirewallPolicy.Builder

This builder for chaining.

clearRuleTupleCount()

public FirewallPolicy.Builder clearRuleTupleCount()

[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
Type Description
FirewallPolicy.Builder

This builder for chaining.

clearRules()

public FirewallPolicy.Builder clearRules()

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
Type Description
FirewallPolicy.Builder

clearSelfLink()

public FirewallPolicy.Builder clearSelfLink()

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

optional string self_link = 456214797;

Returns
Type Description
FirewallPolicy.Builder

This builder for chaining.

clearSelfLinkWithId()

public FirewallPolicy.Builder clearSelfLinkWithId()

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

optional string self_link_with_id = 44520962;

Returns
Type Description
FirewallPolicy.Builder

This builder for chaining.

clearShortName()

public FirewallPolicy.Builder clearShortName()

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
Type Description
FirewallPolicy.Builder

This builder for chaining.

clone()

public FirewallPolicy.Builder clone()
Returns
Type Description
FirewallPolicy.Builder
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
Name Description
index int
Returns
Type Description
FirewallPolicyAssociation

getAssociationsBuilder(int index)

public FirewallPolicyAssociation.Builder getAssociationsBuilder(int index)

A list of associations that belong to this firewall policy.

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

Parameter
Name Description
index int
Returns
Type Description
FirewallPolicyAssociation.Builder

getAssociationsBuilderList()

public List<FirewallPolicyAssociation.Builder> getAssociationsBuilderList()

A list of associations that belong to this firewall policy.

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

Returns
Type Description
List<Builder>

getAssociationsCount()

public int getAssociationsCount()

A list of associations that belong to this firewall policy.

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

Returns
Type Description
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
Type Description
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
Name Description
index int
Returns
Type Description
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
Type Description
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
Type Description
String

The creationTimestamp.

getCreationTimestampBytes()

public ByteString getCreationTimestampBytes()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
ByteString

The bytes for creationTimestamp.

getDefaultInstanceForType()

public FirewallPolicy getDefaultInstanceForType()
Returns
Type Description
FirewallPolicy

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.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
long

The id.

getKind()

public String getKind()

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

optional string kind = 3292052;

Returns
Type Description
String

The kind.

getKindBytes()

public ByteString getKindBytes()

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

optional string kind = 3292052;

Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for parent.

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
Type Description
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
Type Description
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
Type Description
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
Name Description
index int
Returns
Type Description
FirewallPolicyRule

getRulesBuilder(int index)

public FirewallPolicyRule.Builder getRulesBuilder(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
Name Description
index int
Returns
Type Description
FirewallPolicyRule.Builder

getRulesBuilderList()

public List<FirewallPolicyRule.Builder> getRulesBuilderList()

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
Type Description
List<Builder>

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
Type Description
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
Type Description
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
Name Description
index int
Returns
Type Description
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
Type Description
List<? extends com.google.cloud.compute.v1.FirewallPolicyRuleOrBuilder>

getSelfLink()

public String getSelfLink()

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

optional string self_link = 456214797;

Returns
Type Description
String

The selfLink.

getSelfLinkBytes()

public ByteString getSelfLinkBytes()

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

optional string self_link = 456214797;

Returns
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for selfLinkWithId.

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
Type Description
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
Type Description
ByteString

The bytes for shortName.

hasCreationTimestamp()

public boolean hasCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
boolean

Whether the ruleTupleCount field is set.

hasSelfLink()

public boolean hasSelfLink()

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

optional string self_link = 456214797;

Returns
Type Description
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
Type Description
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
Type Description
boolean

Whether the shortName field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(FirewallPolicy other)

public FirewallPolicy.Builder mergeFrom(FirewallPolicy other)
Parameter
Name Description
other FirewallPolicy
Returns
Type Description
FirewallPolicy.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public FirewallPolicy.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FirewallPolicy.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public FirewallPolicy.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
FirewallPolicy.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final FirewallPolicy.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
FirewallPolicy.Builder
Overrides

removeAssociations(int index)

public FirewallPolicy.Builder removeAssociations(int index)

A list of associations that belong to this firewall policy.

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

Parameter
Name Description
index int
Returns
Type Description
FirewallPolicy.Builder

removeRules(int index)

public FirewallPolicy.Builder removeRules(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
Name Description
index int
Returns
Type Description
FirewallPolicy.Builder

setAssociations(int index, FirewallPolicyAssociation value)

public FirewallPolicy.Builder setAssociations(int index, FirewallPolicyAssociation value)

A list of associations that belong to this firewall policy.

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

Parameters
Name Description
index int
value FirewallPolicyAssociation
Returns
Type Description
FirewallPolicy.Builder

setAssociations(int index, FirewallPolicyAssociation.Builder builderForValue)

public FirewallPolicy.Builder setAssociations(int index, FirewallPolicyAssociation.Builder builderForValue)

A list of associations that belong to this firewall policy.

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

Parameters
Name Description
index int
builderForValue FirewallPolicyAssociation.Builder
Returns
Type Description
FirewallPolicy.Builder

setCreationTimestamp(String value)

public FirewallPolicy.Builder setCreationTimestamp(String value)

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Parameter
Name Description
value String

The creationTimestamp to set.
Returns
Type Description
FirewallPolicy.Builder

This builder for chaining.

setCreationTimestampBytes(ByteString value)

public FirewallPolicy.Builder setCreationTimestampBytes(ByteString value)

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Parameter
Name Description
value ByteString

The bytes for creationTimestamp to set.
Returns
Type Description
FirewallPolicy.Builder

This builder for chaining.

setDescription(String value)

public FirewallPolicy.Builder setDescription(String value)

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

optional string description = 422937596;

Parameter
Name Description
value String

The description to set.
Returns
Type Description
FirewallPolicy.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public FirewallPolicy.Builder setDescriptionBytes(ByteString value)

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

optional string description = 422937596;

Parameter
Name Description
value ByteString

The bytes for description to set.
Returns
Type Description
FirewallPolicy.Builder

This builder for chaining.

setDisplayName(String value)

public FirewallPolicy.Builder setDisplayName(String value)

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;

Parameter
Name Description
value String

The displayName to set.
Returns
Type Description
FirewallPolicy.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public FirewallPolicy.Builder setDisplayNameBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for displayName to set.
Returns
Type Description
FirewallPolicy.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public FirewallPolicy.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
FirewallPolicy.Builder
Overrides

setFingerprint(String value)

public FirewallPolicy.Builder setFingerprint(String value)

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;

Parameter
Name Description
value String

The fingerprint to set.
Returns
Type Description
FirewallPolicy.Builder

This builder for chaining.

setFingerprintBytes(ByteString value)

public FirewallPolicy.Builder setFingerprintBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for fingerprint to set.
Returns
Type Description
FirewallPolicy.Builder

This builder for chaining.

setId(long value)

public FirewallPolicy.Builder setId(long value)

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

optional uint64 id = 3355;

Parameter
Name Description
value long

The id to set.
Returns
Type Description
FirewallPolicy.Builder

This builder for chaining.

setKind(String value)

public FirewallPolicy.Builder setKind(String value)

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

optional string kind = 3292052;

Parameter
Name Description
value String

The kind to set.
Returns
Type Description
FirewallPolicy.Builder

This builder for chaining.

setKindBytes(ByteString value)

public FirewallPolicy.Builder setKindBytes(ByteString value)

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

optional string kind = 3292052;

Parameter
Name Description
value ByteString

The bytes for kind to set.
Returns
Type Description
FirewallPolicy.Builder

This builder for chaining.

setName(String value)

public FirewallPolicy.Builder setName(String value)

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;

Parameter
Name Description
value String

The name to set.
Returns
Type Description
FirewallPolicy.Builder

This builder for chaining.

setNameBytes(ByteString value)

public FirewallPolicy.Builder setNameBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
FirewallPolicy.Builder

This builder for chaining.

setParent(String value)

public FirewallPolicy.Builder setParent(String value)

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

optional string parent = 78317738;

Parameter
Name Description
value String

The parent to set.
Returns
Type Description
FirewallPolicy.Builder

This builder for chaining.

setParentBytes(ByteString value)

public FirewallPolicy.Builder setParentBytes(ByteString value)

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

optional string parent = 78317738;

Parameter
Name Description
value ByteString

The bytes for parent to set.
Returns
Type Description
FirewallPolicy.Builder

This builder for chaining.

setRegion(String value)

public FirewallPolicy.Builder setRegion(String value)

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

Parameter
Name Description
value String

The region to set.
Returns
Type Description
FirewallPolicy.Builder

This builder for chaining.

setRegionBytes(ByteString value)

public FirewallPolicy.Builder setRegionBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for region to set.
Returns
Type Description
FirewallPolicy.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public FirewallPolicy.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
FirewallPolicy.Builder
Overrides

setRuleTupleCount(int value)

public FirewallPolicy.Builder setRuleTupleCount(int value)

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

Parameter
Name Description
value int

The ruleTupleCount to set.
Returns
Type Description
FirewallPolicy.Builder

This builder for chaining.

setRules(int index, FirewallPolicyRule value)

public FirewallPolicy.Builder setRules(int index, FirewallPolicyRule value)

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;

Parameters
Name Description
index int
value FirewallPolicyRule
Returns
Type Description
FirewallPolicy.Builder

setRules(int index, FirewallPolicyRule.Builder builderForValue)

public FirewallPolicy.Builder setRules(int index, FirewallPolicyRule.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue FirewallPolicyRule.Builder
Returns
Type Description
FirewallPolicy.Builder

setSelfLink(String value)

public FirewallPolicy.Builder setSelfLink(String value)

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

optional string self_link = 456214797;

Parameter
Name Description
value String

The selfLink to set.
Returns
Type Description
FirewallPolicy.Builder

This builder for chaining.

setSelfLinkBytes(ByteString value)

public FirewallPolicy.Builder setSelfLinkBytes(ByteString value)

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

optional string self_link = 456214797;

Parameter
Name Description
value ByteString

The bytes for selfLink to set.
Returns
Type Description
FirewallPolicy.Builder

This builder for chaining.

setSelfLinkWithId(String value)

public FirewallPolicy.Builder setSelfLinkWithId(String value)

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

optional string self_link_with_id = 44520962;

Parameter
Name Description
value String

The selfLinkWithId to set.
Returns
Type Description
FirewallPolicy.Builder

This builder for chaining.

setSelfLinkWithIdBytes(ByteString value)

public FirewallPolicy.Builder setSelfLinkWithIdBytes(ByteString value)

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

optional string self_link_with_id = 44520962;

Parameter
Name Description
value ByteString

The bytes for selfLinkWithId to set.
Returns
Type Description
FirewallPolicy.Builder

This builder for chaining.

setShortName(String value)

public FirewallPolicy.Builder setShortName(String value)

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;

Parameter
Name Description
value String

The shortName to set.
Returns
Type Description
FirewallPolicy.Builder

This builder for chaining.

setShortNameBytes(ByteString value)

public FirewallPolicy.Builder setShortNameBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for shortName to set.
Returns
Type Description
FirewallPolicy.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final FirewallPolicy.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
FirewallPolicy.Builder
Overrides