Compute V1 Client - Class FirewallPolicy (1.8.3)

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

Represents a Firewall Policy resource.

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

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ associations`	`array<Google\Cloud\Compute\V1\FirewallPolicyAssociation>` A list of associations that belong to this firewall policy.
`↳ creation_timestamp`	`string` [Output Only] Creation timestamp in RFC3339 text format.
`↳ description`	`string` An optional description of this resource. Provide this property when you create the resource.
`↳ display_name`	`string` Deprecated, please use short name instead. User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
`↳ fingerprint`	`string` Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the firewall policy.
`↳ 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#firewallPolicyfor firewall policies
`↳ name`	`string` Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy.
`↳ parent`	`string` [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies.
`↳ region`	`string` [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
`↳ rule_tuple_count`	`int` [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples.
`↳ rules`	`array<Google\Cloud\Compute\V1\FirewallPolicyRule>` A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match "*"). If no rules are provided when creating a firewall policy, a default rule with action "allow" will be added.
`↳ self_link`	`string` [Output Only] Server-defined URL for the resource.
`↳ self_link_with_id`	`string` [Output Only] Server-defined URL for this resource with the resource id.
`↳ short_name`	`string` User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

getAssociations

A list of associations that belong to this firewall policy.

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

setAssociations

A list of associations that belong to this firewall policy.

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

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`

getDescription

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

Returns
Type	Description
`string`

hasDescription

clearDescription

setDescription

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDisplayName

Deprecated, please use short name instead. User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

Returns
Type	Description
`string`

hasDisplayName

clearDisplayName

setDisplayName

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getFingerprint

Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the firewall policy.

Returns
Type	Description
`string`

hasFingerprint

clearFingerprint

setFingerprint

Parameter
Name	Description
`var`	`string`

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#firewallPolicyfor firewall policies

Returns
Type	Description
`string`

hasKind

clearKind

setKind

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getName

Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy.

Returns
Type	Description
`string`

hasName

clearName

setName

Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getParent

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

Returns
Type	Description
`string`

hasParent

clearParent

setParent

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getRegion

[Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

Returns
Type	Description
`string`

hasRegion

clearRegion

setRegion

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getRuleTupleCount

[Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples.

Returns
Type	Description
`int`

hasRuleTupleCount

clearRuleTupleCount

setRuleTupleCount

[Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getRules

A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match "*"). If no rules are provided when creating a firewall policy, a default rule with action "allow" will be added.

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

setRules

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

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`

getSelfLinkWithId

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

Returns
Type	Description
`string`

hasSelfLinkWithId

clearSelfLinkWithId

setSelfLinkWithId

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getShortName

User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

Returns
Type	Description
`string`

hasShortName

clearShortName

setShortName

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`