Compute V1 Client - Class AccessConfig (1.18.1)

Version 1.18.1

• 1.21.0 (latest)
• 1.20.0
• 1.19.0
• 1.18.1
• 1.17.0
• 1.16.2
• 1.14.0
• 1.13.0
• 1.12.1
• 1.11.1
• 1.10.1
• 1.9.1
• 1.8.3
• 1.7.1
• 1.6.1
• 1.5.0

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

Namespace

Google \ Cloud \ Compute \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ external_ipv6	string Applies to ipv6AccessConfigs only. The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. To use a static external IP address, it must be unused and in the same region as the instance's zone. If not specified, Google Cloud will automatically assign an external IPv6 address from the instance's subnetwork.
↳ external_ipv6_prefix_length	int Applies to ipv6AccessConfigs only. 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. In accessConfigs (IPv4), the default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. In ipv6AccessConfigs, the recommend name is External IPv6.
↳ nat_i_p	string Applies to accessConfigs (IPv4) only. 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 created for first IP in associated external IPv6 range.
↳ security_policy	string [Output Only] The resource URL for the security policy associated with this access config.
↳ 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. In accessConfigs (IPv4), the default and only option is ONE_TO_ONE_NAT. In ipv6AccessConfigs, the default and only option is DIRECT_IPV6. Check the Type enum for the list of possible values.

getExternalIpv6

Applies to ipv6AccessConfigs only. The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. To use a static external IP address, it must be unused and in the same region as the instance's zone. If not specified, Google Cloud will automatically assign an external IPv6 address from the instance's subnetwork.

Returns
Type	Description
string

hasExternalIpv6

clearExternalIpv6

setExternalIpv6

Applies to ipv6AccessConfigs only. The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. To use a static external IP address, it must be unused and in the same region as the instance's zone. If not specified, Google Cloud will automatically assign an external IPv6 address from the instance's subnetwork.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getExternalIpv6PrefixLength

Applies to ipv6AccessConfigs only. The prefix length of the external IPv6 range.

Returns
Type	Description
int

hasExternalIpv6PrefixLength

clearExternalIpv6PrefixLength

setExternalIpv6PrefixLength

Applies to ipv6AccessConfigs only. The prefix length of the external IPv6 range.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getKind

[Output Only] Type of the resource. Always compute#accessConfig for access configs.

Returns
Type	Description
string

hasKind

clearKind

setKind

[Output Only] Type of the resource. Always compute#accessConfig for access configs.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getName

The name of this access configuration. In accessConfigs (IPv4), the default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. In ipv6AccessConfigs, the recommend name is External IPv6.

Returns
Type	Description
string

hasName

clearName

setName

The name of this access configuration. In accessConfigs (IPv4), the default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. In ipv6AccessConfigs, the recommend name is External IPv6.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getNatIP

Applies to accessConfigs (IPv4) only. 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.

Returns
Type	Description
string

hasNatIP

clearNatIP

setNatIP

Applies to accessConfigs (IPv4) only. 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.

Parameter
Name	Description
var	string

Returns
Type	Description
$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.

Returns
Type	Description
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.

Parameter
Name	Description
var	string

Returns
Type	Description
$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 created for first IP in associated external IPv6 range.

Returns
Type	Description
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 created for first IP in associated external IPv6 range.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getSecurityPolicy

[Output Only] The resource URL for the security policy associated with this access config.

Returns
Type	Description
string

hasSecurityPolicy

clearSecurityPolicy

setSecurityPolicy

[Output Only] The resource URL for the security policy associated with this access config.

Parameter
Name	Description
var	string

Returns
Type	Description
$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.

Returns
Type	Description
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.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getType

The type of configuration. In accessConfigs (IPv4), the default and only option is ONE_TO_ONE_NAT. In ipv6AccessConfigs, the default and only option is DIRECT_IPV6.

Check the Type enum for the list of possible values.

Returns
Type	Description
string

hasType

clearType

setType

The type of configuration. In accessConfigs (IPv4), the default and only option is ONE_TO_ONE_NAT. In ipv6AccessConfigs, the default and only option is DIRECT_IPV6.

Check the Type enum for the list of possible values.

Parameter
Name	Description
var	string

Returns
Type	Description
$this