Reference documentation and code samples for the Compute V1 Client class AccessConfig.
An access configuration attached to an instance's network interface. Only one access config per instance is supported.
Generated from protobuf message google.cloud.compute.v1.AccessConfig
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ external_ipv6
string
The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.
↳ external_ipv6_prefix_length
int
The prefix length of the external IPv6 range.
↳ kind
string
[Output Only] Type of the resource. Always compute#accessConfig for access configs.
↳ name
string
The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access.
↳ nat_i_p
string
An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
↳ network_tier
string
This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP. Check the NetworkTier enum for the list of possible values.
↳ public_ptr_domain_name
string
The DNS domain name for the public PTR record. You can set this field only if the setPublicPtr
field is enabled in accessConfig. If this field is unspecified in ipv6AccessConfig, a default PTR record will be createc for first IP in associated external IPv6 range.
↳ set_public_ptr
bool
Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name. This field is not used in ipv6AccessConfig. A default PTR record will be created if the VM has external IPv6 range associated.
↳ type
string
The type of configuration. The default and only option is ONE_TO_ONE_NAT. Check the Type enum for the list of possible values.
getExternalIpv6
The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.
Generated from protobuf field optional string external_ipv6 = 532703707;
string
hasExternalIpv6
clearExternalIpv6
setExternalIpv6
The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.
Generated from protobuf field optional string external_ipv6 = 532703707;
var
string
$this
getExternalIpv6PrefixLength
The prefix length of the external IPv6 range.
Generated from protobuf field optional int32 external_ipv6_prefix_length = 425672143;
int
hasExternalIpv6PrefixLength
clearExternalIpv6PrefixLength
setExternalIpv6PrefixLength
The prefix length of the external IPv6 range.
Generated from protobuf field optional int32 external_ipv6_prefix_length = 425672143;
var
int
$this
getKind
[Output Only] Type of the resource. Always compute#accessConfig for access configs.
Generated from protobuf field optional string kind = 3292052;
string
hasKind
clearKind
setKind
[Output Only] Type of the resource. Always compute#accessConfig for access configs.
Generated from protobuf field optional string kind = 3292052;
var
string
$this
getName
The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access.
Generated from protobuf field optional string name = 3373707;
string
hasName
clearName
setName
The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access.
Generated from protobuf field optional string name = 3373707;
var
string
$this
getNatIP
An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
Generated from protobuf field optional string nat_i_p = 117634556;
string
hasNatIP
clearNatIP
setNatIP
An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
Generated from protobuf field optional string nat_i_p = 117634556;
var
string
$this
getNetworkTier
This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP.
Check the NetworkTier enum for the list of possible values.
Generated from protobuf field optional string network_tier = 517397843;
string
hasNetworkTier
clearNetworkTier
setNetworkTier
This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP.
Check the NetworkTier enum for the list of possible values.
Generated from protobuf field optional string network_tier = 517397843;
var
string
$this
getPublicPtrDomainName
The DNS domain name for the public PTR record. You can set this field only if the setPublicPtr
field is enabled in accessConfig. If this field is unspecified in ipv6AccessConfig, a default PTR record will be createc for first IP in associated external IPv6 range.
Generated from protobuf field optional string public_ptr_domain_name = 316599167;
string
hasPublicPtrDomainName
clearPublicPtrDomainName
setPublicPtrDomainName
The DNS domain name for the public PTR record. You can set this field only if the setPublicPtr
field is enabled in accessConfig. If this field is unspecified in ipv6AccessConfig, a default PTR record will be createc for first IP in associated external IPv6 range.
Generated from protobuf field optional string public_ptr_domain_name = 316599167;
var
string
$this
getSetPublicPtr
Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name. This field is not used in ipv6AccessConfig. A default PTR record will be created if the VM has external IPv6 range associated.
Generated from protobuf field optional bool set_public_ptr = 523870229;
bool
hasSetPublicPtr
clearSetPublicPtr
setSetPublicPtr
Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name. This field is not used in ipv6AccessConfig. A default PTR record will be created if the VM has external IPv6 range associated.
Generated from protobuf field optional bool set_public_ptr = 523870229;
var
bool
$this
getType
The type of configuration. The default and only option is ONE_TO_ONE_NAT.
Check the Type enum for the list of possible values.
Generated from protobuf field optional string type = 3575610;
string
hasType
clearType
setType
The type of configuration. The default and only option is ONE_TO_ONE_NAT.
Check the Type enum for the list of possible values.
Generated from protobuf field optional string type = 3575610;
var
string
$this