Class Firewall.Builder (1.44.0)

public static final class Firewall.Builder extends GeneratedMessageV3.Builder<Firewall.Builder> implements FirewallOrBuilder

Represents a Firewall Rule resource. Firewall rules allow or deny ingress traffic to, and egress traffic from your instances. For more information, read Firewall rules.

Protobuf type google.cloud.compute.v1.Firewall

Implements

FirewallOrBuilder

Static Methods

getDescriptor()

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

Methods

addAllAllowed(Iterable<? extends Allowed> values)

public Firewall.Builder addAllAllowed(Iterable<? extends Allowed> values)

The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.

repeated .google.cloud.compute.v1.Allowed allowed = 162398632;

Parameter
NameDescription
valuesIterable<? extends com.google.cloud.compute.v1.Allowed>
Returns
TypeDescription
Firewall.Builder

addAllDenied(Iterable<? extends Denied> values)

public Firewall.Builder addAllDenied(Iterable<? extends Denied> values)

The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection.

repeated .google.cloud.compute.v1.Denied denied = 275217307;

Parameter
NameDescription
valuesIterable<? extends com.google.cloud.compute.v1.Denied>
Returns
TypeDescription
Firewall.Builder

addAllDestinationRanges(Iterable<String> values)

public Firewall.Builder addAllDestinationRanges(Iterable<String> values)

If destination ranges are specified, the firewall rule applies only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Both IPv4 and IPv6 are supported.

repeated string destination_ranges = 305699879;

Parameter
NameDescription
valuesIterable<String>

The destinationRanges to add.

Returns
TypeDescription
Firewall.Builder

This builder for chaining.

addAllSourceRanges(Iterable<String> values)

public Firewall.Builder addAllSourceRanges(Iterable<String> values)

If source ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both fields are set, the rule applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the rule to apply. Both IPv4 and IPv6 are supported.

repeated string source_ranges = 200097658;

Parameter
NameDescription
valuesIterable<String>

The sourceRanges to add.

Returns
TypeDescription
Firewall.Builder

This builder for chaining.

addAllSourceServiceAccounts(Iterable<String> values)

public Firewall.Builder addAllSourceServiceAccounts(Iterable<String> values)

If source service accounts are specified, the firewall rules apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall applies to traffic that has a source IP address within the sourceRanges OR a source IP that belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both fields for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags.

repeated string source_service_accounts = 105100756;

Parameter
NameDescription
valuesIterable<String>

The sourceServiceAccounts to add.

Returns
TypeDescription
Firewall.Builder

This builder for chaining.

addAllSourceTags(Iterable<String> values)

public Firewall.Builder addAllSourceTags(Iterable<String> values)

If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network. Source tags cannot be used to control traffic to an instance's external IP address, it only applies to traffic between instances in the same virtual network. Because tags are associated with instances, not IP addresses. One or both of sourceRanges and sourceTags may be set. If both fields are set, the firewall applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the firewall to apply.

repeated string source_tags = 452222397;

Parameter
NameDescription
valuesIterable<String>

The sourceTags to add.

Returns
TypeDescription
Firewall.Builder

This builder for chaining.

addAllTargetServiceAccounts(Iterable<String> values)

public Firewall.Builder addAllTargetServiceAccounts(Iterable<String> values)

A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[]. targetServiceAccounts cannot be used at the same time as targetTags or sourceTags. If neither targetServiceAccounts nor targetTags are specified, the firewall rule applies to all instances on the specified network.

repeated string target_service_accounts = 457639710;

Parameter
NameDescription
valuesIterable<String>

The targetServiceAccounts to add.

Returns
TypeDescription
Firewall.Builder

This builder for chaining.

addAllTargetTags(Iterable<String> values)

public Firewall.Builder addAllTargetTags(Iterable<String> values)

A list of tags that controls which instances the firewall rule applies to. If targetTags are specified, then the firewall rule applies only to instances in the VPC network that have one of those tags. If no targetTags are specified, the firewall rule applies to all instances on the specified network.

repeated string target_tags = 62901767;

Parameter
NameDescription
valuesIterable<String>

The targetTags to add.

Returns
TypeDescription
Firewall.Builder

This builder for chaining.

addAllowed(Allowed value)

public Firewall.Builder addAllowed(Allowed value)

The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.

repeated .google.cloud.compute.v1.Allowed allowed = 162398632;

Parameter
NameDescription
valueAllowed
Returns
TypeDescription
Firewall.Builder

addAllowed(Allowed.Builder builderForValue)

public Firewall.Builder addAllowed(Allowed.Builder builderForValue)

The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.

repeated .google.cloud.compute.v1.Allowed allowed = 162398632;

Parameter
NameDescription
builderForValueAllowed.Builder
Returns
TypeDescription
Firewall.Builder

addAllowed(int index, Allowed value)

public Firewall.Builder addAllowed(int index, Allowed value)

The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.

repeated .google.cloud.compute.v1.Allowed allowed = 162398632;

Parameters
NameDescription
indexint
valueAllowed
Returns
TypeDescription
Firewall.Builder

addAllowed(int index, Allowed.Builder builderForValue)

public Firewall.Builder addAllowed(int index, Allowed.Builder builderForValue)

The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.

repeated .google.cloud.compute.v1.Allowed allowed = 162398632;

Parameters
NameDescription
indexint
builderForValueAllowed.Builder
Returns
TypeDescription
Firewall.Builder

addAllowedBuilder()

public Allowed.Builder addAllowedBuilder()

The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.

repeated .google.cloud.compute.v1.Allowed allowed = 162398632;

Returns
TypeDescription
Allowed.Builder

addAllowedBuilder(int index)

public Allowed.Builder addAllowedBuilder(int index)

The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.

repeated .google.cloud.compute.v1.Allowed allowed = 162398632;

Parameter
NameDescription
indexint
Returns
TypeDescription
Allowed.Builder

addDenied(Denied value)

public Firewall.Builder addDenied(Denied value)

The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection.

repeated .google.cloud.compute.v1.Denied denied = 275217307;

Parameter
NameDescription
valueDenied
Returns
TypeDescription
Firewall.Builder

addDenied(Denied.Builder builderForValue)

public Firewall.Builder addDenied(Denied.Builder builderForValue)

The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection.

repeated .google.cloud.compute.v1.Denied denied = 275217307;

Parameter
NameDescription
builderForValueDenied.Builder
Returns
TypeDescription
Firewall.Builder

addDenied(int index, Denied value)

public Firewall.Builder addDenied(int index, Denied value)

The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection.

repeated .google.cloud.compute.v1.Denied denied = 275217307;

Parameters
NameDescription
indexint
valueDenied
Returns
TypeDescription
Firewall.Builder

addDenied(int index, Denied.Builder builderForValue)

public Firewall.Builder addDenied(int index, Denied.Builder builderForValue)

The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection.

repeated .google.cloud.compute.v1.Denied denied = 275217307;

Parameters
NameDescription
indexint
builderForValueDenied.Builder
Returns
TypeDescription
Firewall.Builder

addDeniedBuilder()

public Denied.Builder addDeniedBuilder()

The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection.

repeated .google.cloud.compute.v1.Denied denied = 275217307;

Returns
TypeDescription
Denied.Builder

addDeniedBuilder(int index)

public Denied.Builder addDeniedBuilder(int index)

The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection.

repeated .google.cloud.compute.v1.Denied denied = 275217307;

Parameter
NameDescription
indexint
Returns
TypeDescription
Denied.Builder

addDestinationRanges(String value)

public Firewall.Builder addDestinationRanges(String value)

If destination ranges are specified, the firewall rule applies only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Both IPv4 and IPv6 are supported.

repeated string destination_ranges = 305699879;

Parameter
NameDescription
valueString

The destinationRanges to add.

Returns
TypeDescription
Firewall.Builder

This builder for chaining.

addDestinationRangesBytes(ByteString value)

public Firewall.Builder addDestinationRangesBytes(ByteString value)

If destination ranges are specified, the firewall rule applies only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Both IPv4 and IPv6 are supported.

repeated string destination_ranges = 305699879;

Parameter
NameDescription
valueByteString

The bytes of the destinationRanges to add.

Returns
TypeDescription
Firewall.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Firewall.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Firewall.Builder
Overrides

addSourceRanges(String value)

public Firewall.Builder addSourceRanges(String value)

If source ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both fields are set, the rule applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the rule to apply. Both IPv4 and IPv6 are supported.

repeated string source_ranges = 200097658;

Parameter
NameDescription
valueString

The sourceRanges to add.

Returns
TypeDescription
Firewall.Builder

This builder for chaining.

addSourceRangesBytes(ByteString value)

public Firewall.Builder addSourceRangesBytes(ByteString value)

If source ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both fields are set, the rule applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the rule to apply. Both IPv4 and IPv6 are supported.

repeated string source_ranges = 200097658;

Parameter
NameDescription
valueByteString

The bytes of the sourceRanges to add.

Returns
TypeDescription
Firewall.Builder

This builder for chaining.

addSourceServiceAccounts(String value)

public Firewall.Builder addSourceServiceAccounts(String value)

If source service accounts are specified, the firewall rules apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall applies to traffic that has a source IP address within the sourceRanges OR a source IP that belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both fields for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags.

repeated string source_service_accounts = 105100756;

Parameter
NameDescription
valueString

The sourceServiceAccounts to add.

Returns
TypeDescription
Firewall.Builder

This builder for chaining.

addSourceServiceAccountsBytes(ByteString value)

public Firewall.Builder addSourceServiceAccountsBytes(ByteString value)

If source service accounts are specified, the firewall rules apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall applies to traffic that has a source IP address within the sourceRanges OR a source IP that belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both fields for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags.

repeated string source_service_accounts = 105100756;

Parameter
NameDescription
valueByteString

The bytes of the sourceServiceAccounts to add.

Returns
TypeDescription
Firewall.Builder

This builder for chaining.

addSourceTags(String value)

public Firewall.Builder addSourceTags(String value)

If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network. Source tags cannot be used to control traffic to an instance's external IP address, it only applies to traffic between instances in the same virtual network. Because tags are associated with instances, not IP addresses. One or both of sourceRanges and sourceTags may be set. If both fields are set, the firewall applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the firewall to apply.

repeated string source_tags = 452222397;

Parameter
NameDescription
valueString

The sourceTags to add.

Returns
TypeDescription
Firewall.Builder

This builder for chaining.

addSourceTagsBytes(ByteString value)

public Firewall.Builder addSourceTagsBytes(ByteString value)

If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network. Source tags cannot be used to control traffic to an instance's external IP address, it only applies to traffic between instances in the same virtual network. Because tags are associated with instances, not IP addresses. One or both of sourceRanges and sourceTags may be set. If both fields are set, the firewall applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the firewall to apply.

repeated string source_tags = 452222397;

Parameter
NameDescription
valueByteString

The bytes of the sourceTags to add.

Returns
TypeDescription
Firewall.Builder

This builder for chaining.

addTargetServiceAccounts(String value)

public Firewall.Builder addTargetServiceAccounts(String value)

A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[]. targetServiceAccounts cannot be used at the same time as targetTags or sourceTags. If neither targetServiceAccounts nor targetTags are specified, the firewall rule applies to all instances on the specified network.

repeated string target_service_accounts = 457639710;

Parameter
NameDescription
valueString

The targetServiceAccounts to add.

Returns
TypeDescription
Firewall.Builder

This builder for chaining.

addTargetServiceAccountsBytes(ByteString value)

public Firewall.Builder addTargetServiceAccountsBytes(ByteString value)

A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[]. targetServiceAccounts cannot be used at the same time as targetTags or sourceTags. If neither targetServiceAccounts nor targetTags are specified, the firewall rule applies to all instances on the specified network.

repeated string target_service_accounts = 457639710;

Parameter
NameDescription
valueByteString

The bytes of the targetServiceAccounts to add.

Returns
TypeDescription
Firewall.Builder

This builder for chaining.

addTargetTags(String value)

public Firewall.Builder addTargetTags(String value)

A list of tags that controls which instances the firewall rule applies to. If targetTags are specified, then the firewall rule applies only to instances in the VPC network that have one of those tags. If no targetTags are specified, the firewall rule applies to all instances on the specified network.

repeated string target_tags = 62901767;

Parameter
NameDescription
valueString

The targetTags to add.

Returns
TypeDescription
Firewall.Builder

This builder for chaining.

addTargetTagsBytes(ByteString value)

public Firewall.Builder addTargetTagsBytes(ByteString value)

A list of tags that controls which instances the firewall rule applies to. If targetTags are specified, then the firewall rule applies only to instances in the VPC network that have one of those tags. If no targetTags are specified, the firewall rule applies to all instances on the specified network.

repeated string target_tags = 62901767;

Parameter
NameDescription
valueByteString

The bytes of the targetTags to add.

Returns
TypeDescription
Firewall.Builder

This builder for chaining.

build()

public Firewall build()
Returns
TypeDescription
Firewall

buildPartial()

public Firewall buildPartial()
Returns
TypeDescription
Firewall

clear()

public Firewall.Builder clear()
Returns
TypeDescription
Firewall.Builder
Overrides

clearAllowed()

public Firewall.Builder clearAllowed()

The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.

repeated .google.cloud.compute.v1.Allowed allowed = 162398632;

Returns
TypeDescription
Firewall.Builder

clearCreationTimestamp()

public Firewall.Builder clearCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
TypeDescription
Firewall.Builder

This builder for chaining.

clearDenied()

public Firewall.Builder clearDenied()

The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection.

repeated .google.cloud.compute.v1.Denied denied = 275217307;

Returns
TypeDescription
Firewall.Builder

clearDescription()

public Firewall.Builder clearDescription()

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

optional string description = 422937596;

Returns
TypeDescription
Firewall.Builder

This builder for chaining.

clearDestinationRanges()

public Firewall.Builder clearDestinationRanges()

If destination ranges are specified, the firewall rule applies only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Both IPv4 and IPv6 are supported.

repeated string destination_ranges = 305699879;

Returns
TypeDescription
Firewall.Builder

This builder for chaining.

clearDirection()

public Firewall.Builder clearDirection()

Direction of traffic to which this firewall applies, either INGRESS or EGRESS. The default is INGRESS. For EGRESS traffic, you cannot specify the sourceTags fields. Check the Direction enum for the list of possible values.

optional string direction = 111150975;

Returns
TypeDescription
Firewall.Builder

This builder for chaining.

clearDisabled()

public Firewall.Builder clearDisabled()

Denotes whether the firewall rule is disabled. When set to true, the firewall rule is not enforced and the network behaves as if it did not exist. If this is unspecified, the firewall rule will be enabled.

optional bool disabled = 270940796;

Returns
TypeDescription
Firewall.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Firewall.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Firewall.Builder
Overrides

clearId()

public Firewall.Builder clearId()

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

optional uint64 id = 3355;

Returns
TypeDescription
Firewall.Builder

This builder for chaining.

clearKind()

public Firewall.Builder clearKind()

[Output Only] Type of the resource. Always compute#firewall for firewall rules.

optional string kind = 3292052;

Returns
TypeDescription
Firewall.Builder

This builder for chaining.

clearLogConfig()

public Firewall.Builder clearLogConfig()

This field denotes the logging options for a particular firewall rule. If logging is enabled, logs will be exported to Cloud Logging.

optional .google.cloud.compute.v1.FirewallLogConfig log_config = 351299741;

Returns
TypeDescription
Firewall.Builder

clearName()

public Firewall.Builder clearName()

Name of the resource; provided by the client when the resource is created. 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?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.

optional string name = 3373707;

Returns
TypeDescription
Firewall.Builder

This builder for chaining.

clearNetwork()

public Firewall.Builder clearNetwork()

URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used: global/networks/default If you choose to specify this field, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network - projects/myproject/global/networks/my-network - global/networks/default

optional string network = 232872494;

Returns
TypeDescription
Firewall.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Firewall.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Firewall.Builder
Overrides

clearPriority()

public Firewall.Builder clearPriority()

Priority for this rule. This is an integer between 0 and 65535, both inclusive. The default value is 1000. Relative priorities determine which rule takes effect if multiple rules apply. Lower values indicate higher priority. For example, a rule with priority 0 has higher precedence than a rule with priority 1. DENY rules take precedence over ALLOW rules if they have equal priority. Note that VPC networks have implied rules with a priority of 65535. To avoid conflicts with the implied rules, use a priority number less than 65535.

optional int32 priority = 445151652;

Returns
TypeDescription
Firewall.Builder

This builder for chaining.

public Firewall.Builder clearSelfLink()

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

optional string self_link = 456214797;

Returns
TypeDescription
Firewall.Builder

This builder for chaining.

clearSourceRanges()

public Firewall.Builder clearSourceRanges()

If source ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both fields are set, the rule applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the rule to apply. Both IPv4 and IPv6 are supported.

repeated string source_ranges = 200097658;

Returns
TypeDescription
Firewall.Builder

This builder for chaining.

clearSourceServiceAccounts()

public Firewall.Builder clearSourceServiceAccounts()

If source service accounts are specified, the firewall rules apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall applies to traffic that has a source IP address within the sourceRanges OR a source IP that belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both fields for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags.

repeated string source_service_accounts = 105100756;

Returns
TypeDescription
Firewall.Builder

This builder for chaining.

clearSourceTags()

public Firewall.Builder clearSourceTags()

If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network. Source tags cannot be used to control traffic to an instance's external IP address, it only applies to traffic between instances in the same virtual network. Because tags are associated with instances, not IP addresses. One or both of sourceRanges and sourceTags may be set. If both fields are set, the firewall applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the firewall to apply.

repeated string source_tags = 452222397;

Returns
TypeDescription
Firewall.Builder

This builder for chaining.

clearTargetServiceAccounts()

public Firewall.Builder clearTargetServiceAccounts()

A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[]. targetServiceAccounts cannot be used at the same time as targetTags or sourceTags. If neither targetServiceAccounts nor targetTags are specified, the firewall rule applies to all instances on the specified network.

repeated string target_service_accounts = 457639710;

Returns
TypeDescription
Firewall.Builder

This builder for chaining.

clearTargetTags()

public Firewall.Builder clearTargetTags()

A list of tags that controls which instances the firewall rule applies to. If targetTags are specified, then the firewall rule applies only to instances in the VPC network that have one of those tags. If no targetTags are specified, the firewall rule applies to all instances on the specified network.

repeated string target_tags = 62901767;

Returns
TypeDescription
Firewall.Builder

This builder for chaining.

clone()

public Firewall.Builder clone()
Returns
TypeDescription
Firewall.Builder
Overrides

getAllowed(int index)

public Allowed getAllowed(int index)

The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.

repeated .google.cloud.compute.v1.Allowed allowed = 162398632;

Parameter
NameDescription
indexint
Returns
TypeDescription
Allowed

getAllowedBuilder(int index)

public Allowed.Builder getAllowedBuilder(int index)

The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.

repeated .google.cloud.compute.v1.Allowed allowed = 162398632;

Parameter
NameDescription
indexint
Returns
TypeDescription
Allowed.Builder

getAllowedBuilderList()

public List<Allowed.Builder> getAllowedBuilderList()

The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.

repeated .google.cloud.compute.v1.Allowed allowed = 162398632;

Returns
TypeDescription
List<Builder>

getAllowedCount()

public int getAllowedCount()

The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.

repeated .google.cloud.compute.v1.Allowed allowed = 162398632;

Returns
TypeDescription
int

getAllowedList()

public List<Allowed> getAllowedList()

The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.

repeated .google.cloud.compute.v1.Allowed allowed = 162398632;

Returns
TypeDescription
List<Allowed>

getAllowedOrBuilder(int index)

public AllowedOrBuilder getAllowedOrBuilder(int index)

The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.

repeated .google.cloud.compute.v1.Allowed allowed = 162398632;

Parameter
NameDescription
indexint
Returns
TypeDescription
AllowedOrBuilder

getAllowedOrBuilderList()

public List<? extends AllowedOrBuilder> getAllowedOrBuilderList()

The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.

repeated .google.cloud.compute.v1.Allowed allowed = 162398632;

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

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 Firewall getDefaultInstanceForType()
Returns
TypeDescription
Firewall

getDenied(int index)

public Denied getDenied(int index)

The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection.

repeated .google.cloud.compute.v1.Denied denied = 275217307;

Parameter
NameDescription
indexint
Returns
TypeDescription
Denied

getDeniedBuilder(int index)

public Denied.Builder getDeniedBuilder(int index)

The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection.

repeated .google.cloud.compute.v1.Denied denied = 275217307;

Parameter
NameDescription
indexint
Returns
TypeDescription
Denied.Builder

getDeniedBuilderList()

public List<Denied.Builder> getDeniedBuilderList()

The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection.

repeated .google.cloud.compute.v1.Denied denied = 275217307;

Returns
TypeDescription
List<Builder>

getDeniedCount()

public int getDeniedCount()

The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection.

repeated .google.cloud.compute.v1.Denied denied = 275217307;

Returns
TypeDescription
int

getDeniedList()

public List<Denied> getDeniedList()

The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection.

repeated .google.cloud.compute.v1.Denied denied = 275217307;

Returns
TypeDescription
List<Denied>

getDeniedOrBuilder(int index)

public DeniedOrBuilder getDeniedOrBuilder(int index)

The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection.

repeated .google.cloud.compute.v1.Denied denied = 275217307;

Parameter
NameDescription
indexint
Returns
TypeDescription
DeniedOrBuilder

getDeniedOrBuilderList()

public List<? extends DeniedOrBuilder> getDeniedOrBuilderList()

The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection.

repeated .google.cloud.compute.v1.Denied denied = 275217307;

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

getDescription()

public String getDescription()

An optional description of this resource. Provide this field 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 field when you create the resource.

optional string description = 422937596;

Returns
TypeDescription
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getDestinationRanges(int index)

public String getDestinationRanges(int index)

If destination ranges are specified, the firewall rule applies only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Both IPv4 and IPv6 are supported.

repeated string destination_ranges = 305699879;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The destinationRanges at the given index.

getDestinationRangesBytes(int index)

public ByteString getDestinationRangesBytes(int index)

If destination ranges are specified, the firewall rule applies only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Both IPv4 and IPv6 are supported.

repeated string destination_ranges = 305699879;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the destinationRanges at the given index.

getDestinationRangesCount()

public int getDestinationRangesCount()

If destination ranges are specified, the firewall rule applies only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Both IPv4 and IPv6 are supported.

repeated string destination_ranges = 305699879;

Returns
TypeDescription
int

The count of destinationRanges.

getDestinationRangesList()

public ProtocolStringList getDestinationRangesList()

If destination ranges are specified, the firewall rule applies only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Both IPv4 and IPv6 are supported.

repeated string destination_ranges = 305699879;

Returns
TypeDescription
ProtocolStringList

A list containing the destinationRanges.

getDirection()

public String getDirection()

Direction of traffic to which this firewall applies, either INGRESS or EGRESS. The default is INGRESS. For EGRESS traffic, you cannot specify the sourceTags fields. Check the Direction enum for the list of possible values.

optional string direction = 111150975;

Returns
TypeDescription
String

The direction.

getDirectionBytes()

public ByteString getDirectionBytes()

Direction of traffic to which this firewall applies, either INGRESS or EGRESS. The default is INGRESS. For EGRESS traffic, you cannot specify the sourceTags fields. Check the Direction enum for the list of possible values.

optional string direction = 111150975;

Returns
TypeDescription
ByteString

The bytes for direction.

getDisabled()

public boolean getDisabled()

Denotes whether the firewall rule is disabled. When set to true, the firewall rule is not enforced and the network behaves as if it did not exist. If this is unspecified, the firewall rule will be enabled.

optional bool disabled = 270940796;

Returns
TypeDescription
boolean

The disabled.

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#firewall for firewall rules.

optional string kind = 3292052;

Returns
TypeDescription
String

The kind.

getKindBytes()

public ByteString getKindBytes()

[Output Only] Type of the resource. Always compute#firewall for firewall rules.

optional string kind = 3292052;

Returns
TypeDescription
ByteString

The bytes for kind.

getLogConfig()

public FirewallLogConfig getLogConfig()

This field denotes the logging options for a particular firewall rule. If logging is enabled, logs will be exported to Cloud Logging.

optional .google.cloud.compute.v1.FirewallLogConfig log_config = 351299741;

Returns
TypeDescription
FirewallLogConfig

The logConfig.

getLogConfigBuilder()

public FirewallLogConfig.Builder getLogConfigBuilder()

This field denotes the logging options for a particular firewall rule. If logging is enabled, logs will be exported to Cloud Logging.

optional .google.cloud.compute.v1.FirewallLogConfig log_config = 351299741;

Returns
TypeDescription
FirewallLogConfig.Builder

getLogConfigOrBuilder()

public FirewallLogConfigOrBuilder getLogConfigOrBuilder()

This field denotes the logging options for a particular firewall rule. If logging is enabled, logs will be exported to Cloud Logging.

optional .google.cloud.compute.v1.FirewallLogConfig log_config = 351299741;

Returns
TypeDescription
FirewallLogConfigOrBuilder

getName()

public String getName()

Name of the resource; provided by the client when the resource is created. 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?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.

optional string name = 3373707;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Name of the resource; provided by the client when the resource is created. 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?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.

optional string name = 3373707;

Returns
TypeDescription
ByteString

The bytes for name.

getNetwork()

public String getNetwork()

URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used: global/networks/default If you choose to specify this field, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network - projects/myproject/global/networks/my-network - global/networks/default

optional string network = 232872494;

Returns
TypeDescription
String

The network.

getNetworkBytes()

public ByteString getNetworkBytes()

URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used: global/networks/default If you choose to specify this field, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network - projects/myproject/global/networks/my-network - global/networks/default

optional string network = 232872494;

Returns
TypeDescription
ByteString

The bytes for network.

getPriority()

public int getPriority()

Priority for this rule. This is an integer between 0 and 65535, both inclusive. The default value is 1000. Relative priorities determine which rule takes effect if multiple rules apply. Lower values indicate higher priority. For example, a rule with priority 0 has higher precedence than a rule with priority 1. DENY rules take precedence over ALLOW rules if they have equal priority. Note that VPC networks have implied rules with a priority of 65535. To avoid conflicts with the implied rules, use a priority number less than 65535.

optional int32 priority = 445151652;

Returns
TypeDescription
int

The priority.

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.

getSourceRanges(int index)

public String getSourceRanges(int index)

If source ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both fields are set, the rule applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the rule to apply. Both IPv4 and IPv6 are supported.

repeated string source_ranges = 200097658;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The sourceRanges at the given index.

getSourceRangesBytes(int index)

public ByteString getSourceRangesBytes(int index)

If source ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both fields are set, the rule applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the rule to apply. Both IPv4 and IPv6 are supported.

repeated string source_ranges = 200097658;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the sourceRanges at the given index.

getSourceRangesCount()

public int getSourceRangesCount()

If source ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both fields are set, the rule applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the rule to apply. Both IPv4 and IPv6 are supported.

repeated string source_ranges = 200097658;

Returns
TypeDescription
int

The count of sourceRanges.

getSourceRangesList()

public ProtocolStringList getSourceRangesList()

If source ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both fields are set, the rule applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the rule to apply. Both IPv4 and IPv6 are supported.

repeated string source_ranges = 200097658;

Returns
TypeDescription
ProtocolStringList

A list containing the sourceRanges.

getSourceServiceAccounts(int index)

public String getSourceServiceAccounts(int index)

If source service accounts are specified, the firewall rules apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall applies to traffic that has a source IP address within the sourceRanges OR a source IP that belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both fields for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags.

repeated string source_service_accounts = 105100756;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The sourceServiceAccounts at the given index.

getSourceServiceAccountsBytes(int index)

public ByteString getSourceServiceAccountsBytes(int index)

If source service accounts are specified, the firewall rules apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall applies to traffic that has a source IP address within the sourceRanges OR a source IP that belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both fields for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags.

repeated string source_service_accounts = 105100756;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the sourceServiceAccounts at the given index.

getSourceServiceAccountsCount()

public int getSourceServiceAccountsCount()

If source service accounts are specified, the firewall rules apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall applies to traffic that has a source IP address within the sourceRanges OR a source IP that belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both fields for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags.

repeated string source_service_accounts = 105100756;

Returns
TypeDescription
int

The count of sourceServiceAccounts.

getSourceServiceAccountsList()

public ProtocolStringList getSourceServiceAccountsList()

If source service accounts are specified, the firewall rules apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall applies to traffic that has a source IP address within the sourceRanges OR a source IP that belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both fields for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags.

repeated string source_service_accounts = 105100756;

Returns
TypeDescription
ProtocolStringList

A list containing the sourceServiceAccounts.

getSourceTags(int index)

public String getSourceTags(int index)

If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network. Source tags cannot be used to control traffic to an instance's external IP address, it only applies to traffic between instances in the same virtual network. Because tags are associated with instances, not IP addresses. One or both of sourceRanges and sourceTags may be set. If both fields are set, the firewall applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the firewall to apply.

repeated string source_tags = 452222397;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The sourceTags at the given index.

getSourceTagsBytes(int index)

public ByteString getSourceTagsBytes(int index)

If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network. Source tags cannot be used to control traffic to an instance's external IP address, it only applies to traffic between instances in the same virtual network. Because tags are associated with instances, not IP addresses. One or both of sourceRanges and sourceTags may be set. If both fields are set, the firewall applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the firewall to apply.

repeated string source_tags = 452222397;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the sourceTags at the given index.

getSourceTagsCount()

public int getSourceTagsCount()

If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network. Source tags cannot be used to control traffic to an instance's external IP address, it only applies to traffic between instances in the same virtual network. Because tags are associated with instances, not IP addresses. One or both of sourceRanges and sourceTags may be set. If both fields are set, the firewall applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the firewall to apply.

repeated string source_tags = 452222397;

Returns
TypeDescription
int

The count of sourceTags.

getSourceTagsList()

public ProtocolStringList getSourceTagsList()

If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network. Source tags cannot be used to control traffic to an instance's external IP address, it only applies to traffic between instances in the same virtual network. Because tags are associated with instances, not IP addresses. One or both of sourceRanges and sourceTags may be set. If both fields are set, the firewall applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the firewall to apply.

repeated string source_tags = 452222397;

Returns
TypeDescription
ProtocolStringList

A list containing the sourceTags.

getTargetServiceAccounts(int index)

public String getTargetServiceAccounts(int index)

A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[]. targetServiceAccounts cannot be used at the same time as targetTags or sourceTags. If neither targetServiceAccounts nor targetTags are specified, the firewall rule applies to all instances on the specified network.

repeated string target_service_accounts = 457639710;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The targetServiceAccounts at the given index.

getTargetServiceAccountsBytes(int index)

public ByteString getTargetServiceAccountsBytes(int index)

A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[]. targetServiceAccounts cannot be used at the same time as targetTags or sourceTags. If neither targetServiceAccounts nor targetTags are specified, the firewall rule applies to all instances on the specified network.

repeated string target_service_accounts = 457639710;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the targetServiceAccounts at the given index.

getTargetServiceAccountsCount()

public int getTargetServiceAccountsCount()

A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[]. targetServiceAccounts cannot be used at the same time as targetTags or sourceTags. If neither targetServiceAccounts nor targetTags are specified, the firewall rule applies to all instances on the specified network.

repeated string target_service_accounts = 457639710;

Returns
TypeDescription
int

The count of targetServiceAccounts.

getTargetServiceAccountsList()

public ProtocolStringList getTargetServiceAccountsList()

A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[]. targetServiceAccounts cannot be used at the same time as targetTags or sourceTags. If neither targetServiceAccounts nor targetTags are specified, the firewall rule applies to all instances on the specified network.

repeated string target_service_accounts = 457639710;

Returns
TypeDescription
ProtocolStringList

A list containing the targetServiceAccounts.

getTargetTags(int index)

public String getTargetTags(int index)

A list of tags that controls which instances the firewall rule applies to. If targetTags are specified, then the firewall rule applies only to instances in the VPC network that have one of those tags. If no targetTags are specified, the firewall rule applies to all instances on the specified network.

repeated string target_tags = 62901767;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The targetTags at the given index.

getTargetTagsBytes(int index)

public ByteString getTargetTagsBytes(int index)

A list of tags that controls which instances the firewall rule applies to. If targetTags are specified, then the firewall rule applies only to instances in the VPC network that have one of those tags. If no targetTags are specified, the firewall rule applies to all instances on the specified network.

repeated string target_tags = 62901767;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the targetTags at the given index.

getTargetTagsCount()

public int getTargetTagsCount()

A list of tags that controls which instances the firewall rule applies to. If targetTags are specified, then the firewall rule applies only to instances in the VPC network that have one of those tags. If no targetTags are specified, the firewall rule applies to all instances on the specified network.

repeated string target_tags = 62901767;

Returns
TypeDescription
int

The count of targetTags.

getTargetTagsList()

public ProtocolStringList getTargetTagsList()

A list of tags that controls which instances the firewall rule applies to. If targetTags are specified, then the firewall rule applies only to instances in the VPC network that have one of those tags. If no targetTags are specified, the firewall rule applies to all instances on the specified network.

repeated string target_tags = 62901767;

Returns
TypeDescription
ProtocolStringList

A list containing the targetTags.

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 field when you create the resource.

optional string description = 422937596;

Returns
TypeDescription
boolean

Whether the description field is set.

hasDirection()

public boolean hasDirection()

Direction of traffic to which this firewall applies, either INGRESS or EGRESS. The default is INGRESS. For EGRESS traffic, you cannot specify the sourceTags fields. Check the Direction enum for the list of possible values.

optional string direction = 111150975;

Returns
TypeDescription
boolean

Whether the direction field is set.

hasDisabled()

public boolean hasDisabled()

Denotes whether the firewall rule is disabled. When set to true, the firewall rule is not enforced and the network behaves as if it did not exist. If this is unspecified, the firewall rule will be enabled.

optional bool disabled = 270940796;

Returns
TypeDescription
boolean

Whether the disabled 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#firewall for firewall rules.

optional string kind = 3292052;

Returns
TypeDescription
boolean

Whether the kind field is set.

hasLogConfig()

public boolean hasLogConfig()

This field denotes the logging options for a particular firewall rule. If logging is enabled, logs will be exported to Cloud Logging.

optional .google.cloud.compute.v1.FirewallLogConfig log_config = 351299741;

Returns
TypeDescription
boolean

Whether the logConfig field is set.

hasName()

public boolean hasName()

Name of the resource; provided by the client when the resource is created. 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?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.

optional string name = 3373707;

Returns
TypeDescription
boolean

Whether the name field is set.

hasNetwork()

public boolean hasNetwork()

URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used: global/networks/default If you choose to specify this field, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network - projects/myproject/global/networks/my-network - global/networks/default

optional string network = 232872494;

Returns
TypeDescription
boolean

Whether the network field is set.

hasPriority()

public boolean hasPriority()

Priority for this rule. This is an integer between 0 and 65535, both inclusive. The default value is 1000. Relative priorities determine which rule takes effect if multiple rules apply. Lower values indicate higher priority. For example, a rule with priority 0 has higher precedence than a rule with priority 1. DENY rules take precedence over ALLOW rules if they have equal priority. Note that VPC networks have implied rules with a priority of 65535. To avoid conflicts with the implied rules, use a priority number less than 65535.

optional int32 priority = 445151652;

Returns
TypeDescription
boolean

Whether the priority 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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(Firewall other)

public Firewall.Builder mergeFrom(Firewall other)
Parameter
NameDescription
otherFirewall
Returns
TypeDescription
Firewall.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Firewall.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Firewall.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Firewall.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Firewall.Builder
Overrides

mergeLogConfig(FirewallLogConfig value)

public Firewall.Builder mergeLogConfig(FirewallLogConfig value)

This field denotes the logging options for a particular firewall rule. If logging is enabled, logs will be exported to Cloud Logging.

optional .google.cloud.compute.v1.FirewallLogConfig log_config = 351299741;

Parameter
NameDescription
valueFirewallLogConfig
Returns
TypeDescription
Firewall.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Firewall.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Firewall.Builder
Overrides

removeAllowed(int index)

public Firewall.Builder removeAllowed(int index)

The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.

repeated .google.cloud.compute.v1.Allowed allowed = 162398632;

Parameter
NameDescription
indexint
Returns
TypeDescription
Firewall.Builder

removeDenied(int index)

public Firewall.Builder removeDenied(int index)

The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection.

repeated .google.cloud.compute.v1.Denied denied = 275217307;

Parameter
NameDescription
indexint
Returns
TypeDescription
Firewall.Builder

setAllowed(int index, Allowed value)

public Firewall.Builder setAllowed(int index, Allowed value)

The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.

repeated .google.cloud.compute.v1.Allowed allowed = 162398632;

Parameters
NameDescription
indexint
valueAllowed
Returns
TypeDescription
Firewall.Builder

setAllowed(int index, Allowed.Builder builderForValue)

public Firewall.Builder setAllowed(int index, Allowed.Builder builderForValue)

The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.

repeated .google.cloud.compute.v1.Allowed allowed = 162398632;

Parameters
NameDescription
indexint
builderForValueAllowed.Builder
Returns
TypeDescription
Firewall.Builder

setCreationTimestamp(String value)

public Firewall.Builder setCreationTimestamp(String value)

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Parameter
NameDescription
valueString

The creationTimestamp to set.

Returns
TypeDescription
Firewall.Builder

This builder for chaining.

setCreationTimestampBytes(ByteString value)

public Firewall.Builder setCreationTimestampBytes(ByteString value)

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Parameter
NameDescription
valueByteString

The bytes for creationTimestamp to set.

Returns
TypeDescription
Firewall.Builder

This builder for chaining.

setDenied(int index, Denied value)

public Firewall.Builder setDenied(int index, Denied value)

The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection.

repeated .google.cloud.compute.v1.Denied denied = 275217307;

Parameters
NameDescription
indexint
valueDenied
Returns
TypeDescription
Firewall.Builder

setDenied(int index, Denied.Builder builderForValue)

public Firewall.Builder setDenied(int index, Denied.Builder builderForValue)

The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection.

repeated .google.cloud.compute.v1.Denied denied = 275217307;

Parameters
NameDescription
indexint
builderForValueDenied.Builder
Returns
TypeDescription
Firewall.Builder

setDescription(String value)

public Firewall.Builder setDescription(String value)

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

optional string description = 422937596;

Parameter
NameDescription
valueString

The description to set.

Returns
TypeDescription
Firewall.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public Firewall.Builder setDescriptionBytes(ByteString value)

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

optional string description = 422937596;

Parameter
NameDescription
valueByteString

The bytes for description to set.

Returns
TypeDescription
Firewall.Builder

This builder for chaining.

setDestinationRanges(int index, String value)

public Firewall.Builder setDestinationRanges(int index, String value)

If destination ranges are specified, the firewall rule applies only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Both IPv4 and IPv6 are supported.

repeated string destination_ranges = 305699879;

Parameters
NameDescription
indexint

The index to set the value at.

valueString

The destinationRanges to set.

Returns
TypeDescription
Firewall.Builder

This builder for chaining.

setDirection(String value)

public Firewall.Builder setDirection(String value)

Direction of traffic to which this firewall applies, either INGRESS or EGRESS. The default is INGRESS. For EGRESS traffic, you cannot specify the sourceTags fields. Check the Direction enum for the list of possible values.

optional string direction = 111150975;

Parameter
NameDescription
valueString

The direction to set.

Returns
TypeDescription
Firewall.Builder

This builder for chaining.

setDirectionBytes(ByteString value)

public Firewall.Builder setDirectionBytes(ByteString value)

Direction of traffic to which this firewall applies, either INGRESS or EGRESS. The default is INGRESS. For EGRESS traffic, you cannot specify the sourceTags fields. Check the Direction enum for the list of possible values.

optional string direction = 111150975;

Parameter
NameDescription
valueByteString

The bytes for direction to set.

Returns
TypeDescription
Firewall.Builder

This builder for chaining.

setDisabled(boolean value)

public Firewall.Builder setDisabled(boolean value)

Denotes whether the firewall rule is disabled. When set to true, the firewall rule is not enforced and the network behaves as if it did not exist. If this is unspecified, the firewall rule will be enabled.

optional bool disabled = 270940796;

Parameter
NameDescription
valueboolean

The disabled to set.

Returns
TypeDescription
Firewall.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Firewall.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Firewall.Builder
Overrides

setId(long value)

public Firewall.Builder setId(long value)

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

optional uint64 id = 3355;

Parameter
NameDescription
valuelong

The id to set.

Returns
TypeDescription
Firewall.Builder

This builder for chaining.

setKind(String value)

public Firewall.Builder setKind(String value)

[Output Only] Type of the resource. Always compute#firewall for firewall rules.

optional string kind = 3292052;

Parameter
NameDescription
valueString

The kind to set.

Returns
TypeDescription
Firewall.Builder

This builder for chaining.

setKindBytes(ByteString value)

public Firewall.Builder setKindBytes(ByteString value)

[Output Only] Type of the resource. Always compute#firewall for firewall rules.

optional string kind = 3292052;

Parameter
NameDescription
valueByteString

The bytes for kind to set.

Returns
TypeDescription
Firewall.Builder

This builder for chaining.

setLogConfig(FirewallLogConfig value)

public Firewall.Builder setLogConfig(FirewallLogConfig value)

This field denotes the logging options for a particular firewall rule. If logging is enabled, logs will be exported to Cloud Logging.

optional .google.cloud.compute.v1.FirewallLogConfig log_config = 351299741;

Parameter
NameDescription
valueFirewallLogConfig
Returns
TypeDescription
Firewall.Builder

setLogConfig(FirewallLogConfig.Builder builderForValue)

public Firewall.Builder setLogConfig(FirewallLogConfig.Builder builderForValue)

This field denotes the logging options for a particular firewall rule. If logging is enabled, logs will be exported to Cloud Logging.

optional .google.cloud.compute.v1.FirewallLogConfig log_config = 351299741;

Parameter
NameDescription
builderForValueFirewallLogConfig.Builder
Returns
TypeDescription
Firewall.Builder

setName(String value)

public Firewall.Builder setName(String value)

Name of the resource; provided by the client when the resource is created. 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?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.

optional string name = 3373707;

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
Firewall.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Firewall.Builder setNameBytes(ByteString value)

Name of the resource; provided by the client when the resource is created. 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?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.

optional string name = 3373707;

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
Firewall.Builder

This builder for chaining.

setNetwork(String value)

public Firewall.Builder setNetwork(String value)

URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used: global/networks/default If you choose to specify this field, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network - projects/myproject/global/networks/my-network - global/networks/default

optional string network = 232872494;

Parameter
NameDescription
valueString

The network to set.

Returns
TypeDescription
Firewall.Builder

This builder for chaining.

setNetworkBytes(ByteString value)

public Firewall.Builder setNetworkBytes(ByteString value)

URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used: global/networks/default If you choose to specify this field, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network - projects/myproject/global/networks/my-network - global/networks/default

optional string network = 232872494;

Parameter
NameDescription
valueByteString

The bytes for network to set.

Returns
TypeDescription
Firewall.Builder

This builder for chaining.

setPriority(int value)

public Firewall.Builder setPriority(int value)

Priority for this rule. This is an integer between 0 and 65535, both inclusive. The default value is 1000. Relative priorities determine which rule takes effect if multiple rules apply. Lower values indicate higher priority. For example, a rule with priority 0 has higher precedence than a rule with priority 1. DENY rules take precedence over ALLOW rules if they have equal priority. Note that VPC networks have implied rules with a priority of 65535. To avoid conflicts with the implied rules, use a priority number less than 65535.

optional int32 priority = 445151652;

Parameter
NameDescription
valueint

The priority to set.

Returns
TypeDescription
Firewall.Builder

This builder for chaining.

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

public Firewall.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Firewall.Builder
Overrides
public Firewall.Builder setSelfLink(String value)

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

optional string self_link = 456214797;

Parameter
NameDescription
valueString

The selfLink to set.

Returns
TypeDescription
Firewall.Builder

This builder for chaining.

setSelfLinkBytes(ByteString value)

public Firewall.Builder setSelfLinkBytes(ByteString value)

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

optional string self_link = 456214797;

Parameter
NameDescription
valueByteString

The bytes for selfLink to set.

Returns
TypeDescription
Firewall.Builder

This builder for chaining.

setSourceRanges(int index, String value)

public Firewall.Builder setSourceRanges(int index, String value)

If source ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both fields are set, the rule applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the rule to apply. Both IPv4 and IPv6 are supported.

repeated string source_ranges = 200097658;

Parameters
NameDescription
indexint

The index to set the value at.

valueString

The sourceRanges to set.

Returns
TypeDescription
Firewall.Builder

This builder for chaining.

setSourceServiceAccounts(int index, String value)

public Firewall.Builder setSourceServiceAccounts(int index, String value)

If source service accounts are specified, the firewall rules apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall applies to traffic that has a source IP address within the sourceRanges OR a source IP that belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both fields for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags.

repeated string source_service_accounts = 105100756;

Parameters
NameDescription
indexint

The index to set the value at.

valueString

The sourceServiceAccounts to set.

Returns
TypeDescription
Firewall.Builder

This builder for chaining.

setSourceTags(int index, String value)

public Firewall.Builder setSourceTags(int index, String value)

If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network. Source tags cannot be used to control traffic to an instance's external IP address, it only applies to traffic between instances in the same virtual network. Because tags are associated with instances, not IP addresses. One or both of sourceRanges and sourceTags may be set. If both fields are set, the firewall applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the firewall to apply.

repeated string source_tags = 452222397;

Parameters
NameDescription
indexint

The index to set the value at.

valueString

The sourceTags to set.

Returns
TypeDescription
Firewall.Builder

This builder for chaining.

setTargetServiceAccounts(int index, String value)

public Firewall.Builder setTargetServiceAccounts(int index, String value)

A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[]. targetServiceAccounts cannot be used at the same time as targetTags or sourceTags. If neither targetServiceAccounts nor targetTags are specified, the firewall rule applies to all instances on the specified network.

repeated string target_service_accounts = 457639710;

Parameters
NameDescription
indexint

The index to set the value at.

valueString

The targetServiceAccounts to set.

Returns
TypeDescription
Firewall.Builder

This builder for chaining.

setTargetTags(int index, String value)

public Firewall.Builder setTargetTags(int index, String value)

A list of tags that controls which instances the firewall rule applies to. If targetTags are specified, then the firewall rule applies only to instances in the VPC network that have one of those tags. If no targetTags are specified, the firewall rule applies to all instances on the specified network.

repeated string target_tags = 62901767;

Parameters
NameDescription
indexint

The index to set the value at.

valueString

The targetTags to set.

Returns
TypeDescription
Firewall.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Firewall.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Firewall.Builder
Overrides