Reference documentation and code samples for the Google Cloud Vmware Engine V1 Client class ExternalAccessRule.
External access firewall rules for filtering incoming traffic destined to ExternalAddress
resources.
Generated from protobuf message google.cloud.vmwareengine.v1.ExternalAccessRule
Namespace
Google \ Cloud \ VmwareEngine \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Output only. The resource name of this external access rule. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names
. For example: projects/my-project/locations/us-central1/networkPolicies/my-policy/externalAccessRules/my-rule
↳ create_time
↳ update_time
↳ description
string
User-provided description for this external access rule.
↳ priority
int
External access rule priority, which determines the external access rule to use when multiple rules apply. If multiple rules have the same priority, their ordering is non-deterministic. If specific ordering is required, assign unique priorities to enforce such ordering. The external access rule priority is an integer from 100 to 4096, both inclusive. Lower integers indicate higher precedence. For example, a rule with priority 100
has higher precedence than a rule with priority 101
.
↳ action
int
The action that the external access rule performs.
↳ ip_protocol
string
The IP protocol to which the external access rule applies. This value can be one of the following three protocol strings (not case-sensitive): tcp
, udp
, or icmp
.
↳ source_ip_ranges
array< ExternalAccessRule\IpRange
>
If source ranges are specified, the external access rule applies only to traffic that has a source IP address in these ranges. These ranges can either be expressed in the CIDR format or as an IP address. As only inbound rules are supported, ExternalAddress
resources cannot be the source IP addresses of an external access rule. To match all source addresses, specify 0.0.0.0/0
.
↳ source_ports
array
A list of source ports to which the external access rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. For example: ["22"]
, ["80","443"]
, or ["12345-12349"]
. To match all source ports, specify ["0-65535"]
.
↳ destination_ip_ranges
array< ExternalAccessRule\IpRange
>
If destination ranges are specified, the external access rule applies only to the traffic that has a destination IP address in these ranges. The specified IP addresses must have reserved external IP addresses in the scope of the parent network policy. To match all external IP addresses in the scope of the parent network policy, specify 0.0.0.0/0
. To match a specific external IP address, specify it using the IpRange.external_address
property.
↳ destination_ports
array
A list of destination ports to which the external access rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. For example: ["22"]
, ["80","443"]
, or ["12345-12349"]
. To match all destination ports, specify ["0-65535"]
.
↳ state
int
Output only. The state of the resource.
↳ uid
string
Output only. System-generated unique identifier for the resource.
getName
Output only. The resource name of this external access rule.
Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names
.
For example: projects/my-project/locations/us-central1/networkPolicies/my-policy/externalAccessRules/my-rule
string
setName
Output only. The resource name of this external access rule.
Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names
.
For example: projects/my-project/locations/us-central1/networkPolicies/my-policy/externalAccessRules/my-rule
var
string
$this
getCreateTime
Output only. Creation time of this resource.
hasCreateTime
clearCreateTime
setCreateTime
Output only. Creation time of this resource.
$this
getUpdateTime
Output only. Last update time of this resource.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Last update time of this resource.
$this
getDescription
User-provided description for this external access rule.
string
setDescription
User-provided description for this external access rule.
var
string
$this
getPriority
External access rule priority, which determines the external access rule to
use when multiple rules apply. If multiple rules have the same priority,
their ordering is non-deterministic. If specific ordering is required,
assign unique priorities to enforce such ordering. The external access rule
priority is an integer from 100 to 4096, both inclusive. Lower integers
indicate higher precedence. For example, a rule with priority 100
has
higher precedence than a rule with priority 101
.
int
setPriority
External access rule priority, which determines the external access rule to
use when multiple rules apply. If multiple rules have the same priority,
their ordering is non-deterministic. If specific ordering is required,
assign unique priorities to enforce such ordering. The external access rule
priority is an integer from 100 to 4096, both inclusive. Lower integers
indicate higher precedence. For example, a rule with priority 100
has
higher precedence than a rule with priority 101
.
var
int
$this
getAction
The action that the external access rule performs.
int
setAction
The action that the external access rule performs.
var
int
$this
getIpProtocol
The IP protocol to which the external access rule applies. This value can
be one of the following three protocol strings (not case-sensitive): tcp
, udp
, or icmp
.
string
setIpProtocol
The IP protocol to which the external access rule applies. This value can
be one of the following three protocol strings (not case-sensitive): tcp
, udp
, or icmp
.
var
string
$this
getSourceIpRanges
If source ranges are specified, the external access rule applies only to
traffic that has a source IP address in these ranges. These ranges can
either be expressed in the CIDR format or as an IP address. As only inbound
rules are supported, ExternalAddress
resources cannot be the source IP
addresses of an external access rule. To match all source addresses,
specify 0.0.0.0/0
.
setSourceIpRanges
If source ranges are specified, the external access rule applies only to
traffic that has a source IP address in these ranges. These ranges can
either be expressed in the CIDR format or as an IP address. As only inbound
rules are supported, ExternalAddress
resources cannot be the source IP
addresses of an external access rule. To match all source addresses,
specify 0.0.0.0/0
.
$this
getSourcePorts
A list of source ports to which the external access rule applies. This field is only applicable for the UDP or TCP protocol.
Each entry must be either an integer or a range. For example: ["22"]
, ["80","443"]
, or ["12345-12349"]
. To match all source ports, specify ["0-65535"]
.
setSourcePorts
A list of source ports to which the external access rule applies. This field is only applicable for the UDP or TCP protocol.
Each entry must be either an integer or a range. For example: ["22"]
, ["80","443"]
, or ["12345-12349"]
. To match all source ports, specify ["0-65535"]
.
var
string[]
$this
getDestinationIpRanges
If destination ranges are specified, the external access rule applies only
to the traffic that has a destination IP address in these ranges. The
specified IP addresses must have reserved external IP addresses in the
scope of the parent network policy. To match all external IP addresses in
the scope of the parent network policy, specify 0.0.0.0/0
. To match a
specific external IP address, specify it using the IpRange.external_address
property.
setDestinationIpRanges
If destination ranges are specified, the external access rule applies only
to the traffic that has a destination IP address in these ranges. The
specified IP addresses must have reserved external IP addresses in the
scope of the parent network policy. To match all external IP addresses in
the scope of the parent network policy, specify 0.0.0.0/0
. To match a
specific external IP address, specify it using the IpRange.external_address
property.
$this
getDestinationPorts
A list of destination ports to which the external access rule applies. This field is only applicable for the UDP or TCP protocol.
Each entry must be either an integer or a range. For example: ["22"]
, ["80","443"]
, or ["12345-12349"]
. To match all destination ports,
specify ["0-65535"]
.
setDestinationPorts
A list of destination ports to which the external access rule applies. This field is only applicable for the UDP or TCP protocol.
Each entry must be either an integer or a range. For example: ["22"]
, ["80","443"]
, or ["12345-12349"]
. To match all destination ports,
specify ["0-65535"]
.
var
string[]
$this
getState
Output only. The state of the resource.
int
setState
Output only. The state of the resource.
var
int
$this
getUid
Output only. System-generated unique identifier for the resource.
string
setUid
Output only. System-generated unique identifier for the resource.
var
string
$this