Compute V1 Client - Class Firewall (1.17.0)

Reference documentation and code samples for the Compute V1 Client class Firewall.

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.

Generated from protobuf message google.cloud.compute.v1.Firewall

Namespace

Google \ Cloud \ Compute \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ allowed`	`array<Google\Cloud\Compute\V1\Allowed>` The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
`↳ creation_timestamp`	`string` [Output Only] Creation timestamp in RFC3339 text format.
`↳ denied`	`array<Google\Cloud\Compute\V1\Denied>` The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection.
`↳ description`	`string` An optional description of this resource. Provide this field when you create the resource.
`↳ destination_ranges`	`array` 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.
`↳ direction`	`string` 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.
`↳ disabled`	`bool` 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.
`↳ id`	`int\|string` [Output Only] The unique identifier for the resource. This identifier is defined by the server.
`↳ kind`	`string` [Output Only] Type of the resource. Always compute#firewall for firewall rules.
`↳ log_config`	`Google\Cloud\Compute\V1\FirewallLogConfig` This field denotes the logging options for a particular firewall rule. If logging is enabled, logs will be exported to Cloud Logging.
`↳ name`	`string` 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]([-a-z0-9]*[a-z0-9])?`. 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.
`↳ network`	`string` 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
`↳ priority`	`int` 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`.
`↳ self_link`	`string` [Output Only] Server-defined URL for the resource.
`↳ source_ranges`	`array` 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.
`↳ source_service_accounts`	`array` 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.
`↳ source_tags`	`array` 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.
`↳ target_service_accounts`	`array` 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.
`↳ target_tags`	`array` 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.

getAllowed

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

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setAllowed

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

Parameter
Name	Description
`var`	`array<Google\Cloud\Compute\V1\Allowed>`

Returns
Type	Description
`$this`

getCreationTimestamp

[Output Only] Creation timestamp in RFC3339 text format.

Returns
Type	Description
`string`

hasCreationTimestamp

clearCreationTimestamp

setCreationTimestamp

[Output Only] Creation timestamp in RFC3339 text format.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDenied

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

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setDenied

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

Parameter
Name	Description
`var`	`array<Google\Cloud\Compute\V1\Denied>`

Returns
Type	Description
`$this`

getDescription

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

Returns
Type	Description
`string`

hasDescription

clearDescription

setDescription

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDestinationRanges

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.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setDestinationRanges

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

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.

Returns
Type	Description
`string`

hasDirection

clearDirection

setDirection

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.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

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.

Returns
Type	Description
`bool`

hasDisabled

clearDisabled

setDisabled

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getId

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

Returns
Type	Description
`int\|string`

hasId

clearId

setId

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

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getKind

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

Returns
Type	Description
`string`

hasKind

clearKind

setKind

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getLogConfig

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

Returns
Type	Description
`Google\Cloud\Compute\V1\FirewallLogConfig\|null`

hasLogConfig

clearLogConfig

setLogConfig

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

Parameter
Name	Description
`var`	`Google\Cloud\Compute\V1\FirewallLogConfig`

Returns
Type	Description
`$this`

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]([-a-z0-9]*[a-z0-9])?. 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.

Returns
Type	Description
`string`

hasName

clearName

setName

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

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

Returns
Type	Description
`string`

hasNetwork

clearNetwork

setNetwork

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

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.

Returns
Type	Description
`int`

hasPriority

clearPriority

setPriority

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getSelfLink

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

Returns
Type	Description
`string`

hasSelfLink

clearSelfLink

setSelfLink

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSourceRanges

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.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setSourceRanges

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

getSourceServiceAccounts

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.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setSourceServiceAccounts

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

getSourceTags

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.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setSourceTags

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

getTargetServiceAccounts

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.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setTargetServiceAccounts

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

getTargetTags

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.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setTargetTags

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`