Interface FirewallOrBuilder (1.7.2)

public interface FirewallOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAllowed(int index)

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

Name	Description
index	`int`

Returns

Type	Description
Allowed

getAllowedCount()

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

Type	Description
int

getAllowedList()

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

Type	Description
List<Allowed>

getAllowedOrBuilder(int index)

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

Name	Description
index	`int`

Returns

Type	Description
AllowedOrBuilder

getAllowedOrBuilderList()

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

Type	Description
List<? extends com.google.cloud.compute.v1.AllowedOrBuilder>

getCreationTimestamp()

public abstract String getCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns

Type	Description
String	The creationTimestamp.

getCreationTimestampBytes()

public abstract ByteString getCreationTimestampBytes()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns

Type	Description
ByteString	The bytes for creationTimestamp.

getDenied(int index)

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

Name	Description
index	`int`

Returns

Type	Description
Denied

getDeniedCount()

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

Type	Description
int

getDeniedList()

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

Type	Description
List<Denied>

getDeniedOrBuilder(int index)

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

Name	Description
index	`int`

Returns

Type	Description
DeniedOrBuilder

getDeniedOrBuilderList()

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

Type	Description
List<? extends com.google.cloud.compute.v1.DeniedOrBuilder>

getDescription()

public abstract String getDescription()

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

optional string description = 422937596;

Returns

Type	Description
String	The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

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

optional string description = 422937596;

Returns

Type	Description
ByteString	The bytes for description.

getDestinationRanges(int index)

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

Name	Description
index	`int` The index of the element to return.

Returns

Type	Description
String	The destinationRanges at the given index.

getDestinationRangesBytes(int index)

public abstract ByteString getDestinationRangesBytes(int index)

repeated string destination_ranges = 305699879;

Parameter

Name	Description
index	`int` The index of the value to return.

Returns

Type	Description
ByteString	The bytes of the destinationRanges at the given index.

getDestinationRangesCount()

public abstract int getDestinationRangesCount()

repeated string destination_ranges = 305699879;

Returns

Type	Description
int	The count of destinationRanges.

getDestinationRangesList()

public abstract List<String> getDestinationRangesList()

repeated string destination_ranges = 305699879;

Returns

Type	Description
List<String>	A list containing the destinationRanges.

getDirection()

public abstract String getDirection()

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

optional string direction = 111150975;

Returns

Type	Description
String	The direction.

getDirectionBytes()

public abstract ByteString getDirectionBytes()

optional string direction = 111150975;

Returns

Type	Description
ByteString	The bytes for direction.

getDisabled()

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

Type	Description
boolean	The disabled.

getId()

public abstract 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 abstract String getKind()

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

optional string kind = 3292052;

Returns

Type	Description
String	The kind.

getKindBytes()

public abstract ByteString getKindBytes()

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

optional string kind = 3292052;

Returns

Type	Description
ByteString	The bytes for kind.

getLogConfig()

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

Type	Description
FirewallLogConfig	The logConfig.

getLogConfigOrBuilder()

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

Type	Description
FirewallLogConfigOrBuilder

getName()

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

Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

optional string name = 3373707;

Returns

Type	Description
ByteString	The bytes for name.

getNetwork()

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

Type	Description
String	The network.

getNetworkBytes()

public abstract ByteString getNetworkBytes()

optional string network = 232872494;

Returns

Type	Description
ByteString	The bytes for network.

getPriority()

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

Type	Description
int	The priority.

getSelfLink()

public abstract String getSelfLink()

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

optional string self_link = 456214797;

Returns

Type	Description
String	The selfLink.

getSelfLinkBytes()

public abstract ByteString getSelfLinkBytes()

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

optional string self_link = 456214797;

Returns

Type	Description
ByteString	The bytes for selfLink.

getSourceRanges(int index)

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

Name	Description
index	`int` The index of the element to return.

Returns

Type	Description
String	The sourceRanges at the given index.

getSourceRangesBytes(int index)

public abstract ByteString getSourceRangesBytes(int index)

repeated string source_ranges = 200097658;

Parameter

Name	Description
index	`int` The index of the value to return.

Returns

Type	Description
ByteString	The bytes of the sourceRanges at the given index.

getSourceRangesCount()

public abstract int getSourceRangesCount()

repeated string source_ranges = 200097658;

Returns

Type	Description
int	The count of sourceRanges.

getSourceRangesList()

public abstract List<String> getSourceRangesList()

repeated string source_ranges = 200097658;

Returns

Type	Description
List<String>	A list containing the sourceRanges.

getSourceServiceAccounts(int index)

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

Name	Description
index	`int` The index of the element to return.

Returns

Type	Description
String	The sourceServiceAccounts at the given index.

getSourceServiceAccountsBytes(int index)

public abstract ByteString getSourceServiceAccountsBytes(int index)

repeated string source_service_accounts = 105100756;

Parameter

Name	Description
index	`int` The index of the value to return.

Returns

Type	Description
ByteString	The bytes of the sourceServiceAccounts at the given index.

getSourceServiceAccountsCount()

public abstract int getSourceServiceAccountsCount()

repeated string source_service_accounts = 105100756;

Returns

Type	Description
int	The count of sourceServiceAccounts.

getSourceServiceAccountsList()

public abstract List<String> getSourceServiceAccountsList()

repeated string source_service_accounts = 105100756;

Returns

Type	Description
List<String>	A list containing the sourceServiceAccounts.

getSourceTags(int index)

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

Name	Description
index	`int` The index of the element to return.

Returns

Type	Description
String	The sourceTags at the given index.

getSourceTagsBytes(int index)

public abstract ByteString getSourceTagsBytes(int index)

repeated string source_tags = 452222397;

Parameter

Name	Description
index	`int` The index of the value to return.

Returns

Type	Description
ByteString	The bytes of the sourceTags at the given index.

getSourceTagsCount()

public abstract int getSourceTagsCount()

repeated string source_tags = 452222397;

Returns

Type	Description
int	The count of sourceTags.

getSourceTagsList()

public abstract List<String> getSourceTagsList()

repeated string source_tags = 452222397;

Returns

Type	Description
List<String>	A list containing the sourceTags.

getTargetServiceAccounts(int index)

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

Name	Description
index	`int` The index of the element to return.

Returns

Type	Description
String	The targetServiceAccounts at the given index.

getTargetServiceAccountsBytes(int index)

public abstract ByteString getTargetServiceAccountsBytes(int index)

repeated string target_service_accounts = 457639710;

Parameter

Name	Description
index	`int` The index of the value to return.

Returns

Type	Description
ByteString	The bytes of the targetServiceAccounts at the given index.

getTargetServiceAccountsCount()

public abstract int getTargetServiceAccountsCount()

repeated string target_service_accounts = 457639710;

Returns

Type	Description
int	The count of targetServiceAccounts.

getTargetServiceAccountsList()

public abstract List<String> getTargetServiceAccountsList()

repeated string target_service_accounts = 457639710;

Returns

Type	Description
List<String>	A list containing the targetServiceAccounts.

getTargetTags(int index)

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

Name	Description
index	`int` The index of the element to return.

Returns

Type	Description
String	The targetTags at the given index.

getTargetTagsBytes(int index)

public abstract ByteString getTargetTagsBytes(int index)

repeated string target_tags = 62901767;

Parameter

Name	Description
index	`int` The index of the value to return.

Returns

Type	Description
ByteString	The bytes of the targetTags at the given index.

getTargetTagsCount()

public abstract int getTargetTagsCount()

repeated string target_tags = 62901767;

Returns

Type	Description
int	The count of targetTags.

getTargetTagsList()

public abstract List<String> getTargetTagsList()

repeated string target_tags = 62901767;

Returns

Type	Description
List<String>	A list containing the targetTags.

hasCreationTimestamp()

public abstract 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 abstract boolean hasDescription()

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

optional string description = 422937596;

Returns

Type	Description
boolean	Whether the description field is set.

hasDirection()

public abstract boolean hasDirection()

optional string direction = 111150975;

Returns

Type	Description
boolean	Whether the direction field is set.

hasDisabled()

public abstract boolean hasDisabled()

optional bool disabled = 270940796;

Returns

Type	Description
boolean	Whether the disabled field is set.

hasId()

public abstract 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 abstract boolean hasKind()

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

optional string kind = 3292052;

Returns

Type	Description
boolean	Whether the kind field is set.

hasLogConfig()

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

Type	Description
boolean	Whether the logConfig field is set.

hasName()

public abstract boolean hasName()

optional string name = 3373707;

Returns

Type	Description
boolean	Whether the name field is set.

hasNetwork()

public abstract boolean hasNetwork()

optional string network = 232872494;

Returns

Type	Description
boolean	Whether the network field is set.

hasPriority()

public abstract boolean hasPriority()

optional int32 priority = 445151652;

Returns

Type	Description
boolean	Whether the priority field is set.

hasSelfLink()

public abstract 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.