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.
| Parameters | |
|---|---|
| Name | Description |
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: |
↳ create_time |
Google\Protobuf\Timestamp
Output only. Creation time of this resource. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. Last update time of this resource. |
↳ 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 |
↳ 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): |
↳ source_ip_ranges |
array<Google\Cloud\VmwareEngine\V1\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, |
↳ 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: |
↳ destination_ip_ranges |
array<Google\Cloud\VmwareEngine\V1\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 |
↳ 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: |
↳ 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
| Returns | |
|---|---|
| Type | Description |
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
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. Creation time of this resource.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. Creation time of this resource.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
Output only. Last update time of this resource.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Last update time of this resource.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
User-provided description for this external access rule.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
User-provided description for this external access rule.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAction
The action that the external access rule performs.
| Returns | |
|---|---|
| Type | Description |
int |
|
setAction
The action that the external access rule performs.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
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.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\VmwareEngine\V1\ExternalAccessRule\IpRange>
|
| Returns | |
|---|---|
| Type | Description |
$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"].
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
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"].
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
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.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\VmwareEngine\V1\ExternalAccessRule\IpRange>
|
| Returns | |
|---|---|
| Type | Description |
$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"].
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
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"].
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getState
Output only. The state of the resource.
| Returns | |
|---|---|
| Type | Description |
int |
|
setState
Output only. The state of the resource.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUid
Output only. System-generated unique identifier for the resource.
| Returns | |
|---|---|
| Type | Description |
string |
|
setUid
Output only. System-generated unique identifier for the resource.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|