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
Namespace
Google \ Cloud \ Compute \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ associations
↳ 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.
↳ packet_mirroring_rules
↳ 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< 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.
setAssociations
A list of associations that belong to this firewall policy.
$this
getCreationTimestamp
[Output Only] Creation timestamp in RFC3339 text format.
string
hasCreationTimestamp
clearCreationTimestamp
setCreationTimestamp
[Output Only] Creation timestamp in RFC3339 text format.
var
string
$this
getDescription
An optional description of this resource. Provide this property when you create the resource.
string
hasDescription
clearDescription
setDescription
An optional description of this resource. Provide this property when you create the resource.
var
string
$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.
string
hasDisplayName
clearDisplayName
setDisplayName
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.
var
string
$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.
string
hasFingerprint
clearFingerprint
setFingerprint
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.
var
string
$this
getId
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
int|string
hasId
clearId
setId
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
var
int|string
$this
getKind
[Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies
string
hasKind
clearKind
setKind
[Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies
var
string
$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.
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.
var
string
$this
getPacketMirroringRules
A list of packet mirroring rules that belong to this policy.
setPacketMirroringRules
A list of packet mirroring rules that belong to this policy.
$this
getParent
[Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies.
string
hasParent
clearParent
setParent
[Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies.
var
string
$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.
string
hasRegion
clearRegion
setRegion
[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.
var
string
$this
getRuleTupleCount
[Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples.
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.
var
int
$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.
setRules
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.
$this
getSelfLink
[Output Only] Server-defined URL for the resource.
string
hasSelfLink
clearSelfLink
setSelfLink
[Output Only] Server-defined URL for the resource.
var
string
$this
getSelfLinkWithId
[Output Only] Server-defined URL for this resource with the resource id.
string
hasSelfLinkWithId
clearSelfLinkWithId
setSelfLinkWithId
[Output Only] Server-defined URL for this resource with the resource id.
var
string
$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.
string
hasShortName
clearShortName
setShortName
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.
var
string
$this
