Compute V1 Client - Class Network (1.20.0)

Reference documentation and code samples for the Compute V1 Client class Network.

Represents a VPC Network resource. Networks connect resources to each other and to the internet. For more information, read Virtual Private Cloud (VPC) Network.

Generated from protobuf message google.cloud.compute.v1.Network

Namespace

Google \ Cloud \ Compute \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ I_pv4_range string

Deprecated in favor of subnet mode networks. The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created.
↳ auto_create_subnetworks bool

Must be set to create a VPC network. If not set, a legacy network is created. When set to true, the VPC network is created in auto mode. When set to false, the VPC network is created in custom mode. An auto mode VPC network starts with one subnet per region. Each subnet has a predetermined range as described in Auto mode VPC network IP ranges. For custom mode VPC networks, you can add subnets using the subnetworks insert method.
↳ creation_timestamp string

[Output Only] Creation timestamp in RFC3339 text format.
↳ description string

An optional description of this resource. Provide this field when you create the resource.
↳ enable_ula_internal_ipv6 bool

Enable ULA internal ipv6 on this network. Enabling this feature will assign a /48 from google defined ULA prefix fd20::/20. .
↳ firewall_policy string

[Output Only] URL of the firewall policy the network is associated with.
↳ gateway_i_pv4 string

[Output Only] The gateway address for default routing out of the network, selected by Google Cloud.
↳ id int|string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.
↳ internal_ipv6_range string

When enabling ula internal ipv6, caller optionally can specify the /48 range they want from the google defined ULA prefix fd20::/20. The input must be a valid /48 ULA IPv6 address and must be within the fd20::/20. Operation will fail if the speficied /48 is already in used by another resource. If the field is not speficied, then a /48 range will be randomly allocated from fd20::/20 and returned via this field. .
↳ kind string

[Output Only] Type of the resource. Always compute#network for networks.
↳ mtu int

Maximum Transmission Unit in bytes. The minimum value for this field is 1300 and the maximum value is 8896. The suggested value is 1500, which is the default MTU used on the Internet, or 8896 if you want to use Jumbo frames. If unspecified, the value defaults to 1460.
↳ name string

Name of the resource. Provided by the client when the resource is created. 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])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.
↳ network_firewall_policy_enforcement_order string

The network firewall policy enforcement order. Can be either AFTER_CLASSIC_FIREWALL or BEFORE_CLASSIC_FIREWALL. Defaults to AFTER_CLASSIC_FIREWALL if the field is not specified. Check the NetworkFirewallPolicyEnforcementOrder enum for the list of possible values.
↳ peerings array<Google\Cloud\Compute\V1\NetworkPeering>

[Output Only] A list of network peerings for the resource.
↳ routing_config Google\Cloud\Compute\V1\NetworkRoutingConfig

The network-level routing configuration for this network. Used by Cloud Router to determine what type of network-wide routing behavior to enforce.
↳ 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.
↳ subnetworks array

[Output Only] Server-defined fully-qualified URLs for all subnetworks in this VPC network.

getIPv4Range

Deprecated in favor of subnet mode networks. The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created.

Returns
Type Description
string

hasIPv4Range

clearIPv4Range

setIPv4Range

Deprecated in favor of subnet mode networks. The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created.

Parameter
Name Description
var string
Returns
Type Description
$this

getAutoCreateSubnetworks

Must be set to create a VPC network. If not set, a legacy network is created. When set to true, the VPC network is created in auto mode. When set to false, the VPC network is created in custom mode. An auto mode VPC network starts with one subnet per region. Each subnet has a predetermined range as described in Auto mode VPC network IP ranges. For custom mode VPC networks, you can add subnets using the subnetworks insert method.

Returns
Type Description
bool

hasAutoCreateSubnetworks

clearAutoCreateSubnetworks

setAutoCreateSubnetworks

Must be set to create a VPC network. If not set, a legacy network is created. When set to true, the VPC network is created in auto mode. When set to false, the VPC network is created in custom mode. An auto mode VPC network starts with one subnet per region. Each subnet has a predetermined range as described in Auto mode VPC network IP ranges. For custom mode VPC networks, you can add subnets using the subnetworks insert method.

Parameter
Name Description
var bool
Returns
Type Description
$this

getCreationTimestamp

[Output Only] Creation timestamp in RFC3339 text format.

Returns
Type Description
string

hasCreationTimestamp

clearCreationTimestamp

setCreationTimestamp

[Output Only] Creation timestamp in RFC3339 text format.

Parameter
Name Description
var string
Returns
Type Description
$this

getDescription

An optional description of this resource. Provide this field when you create the resource.

Returns
Type Description
string

hasDescription

clearDescription

setDescription

An optional description of this resource. Provide this field when you create the resource.

Parameter
Name Description
var string
Returns
Type Description
$this

getEnableUlaInternalIpv6

Enable ULA internal ipv6 on this network. Enabling this feature will assign a /48 from google defined ULA prefix fd20::/20. .

Returns
Type Description
bool

hasEnableUlaInternalIpv6

clearEnableUlaInternalIpv6

setEnableUlaInternalIpv6

Enable ULA internal ipv6 on this network. Enabling this feature will assign a /48 from google defined ULA prefix fd20::/20. .

Parameter
Name Description
var bool
Returns
Type Description
$this

getFirewallPolicy

[Output Only] URL of the firewall policy the network is associated with.

Returns
Type Description
string

hasFirewallPolicy

clearFirewallPolicy

setFirewallPolicy

[Output Only] URL of the firewall policy the network is associated with.

Parameter
Name Description
var string
Returns
Type Description
$this

getGatewayIPv4

[Output Only] The gateway address for default routing out of the network, selected by Google Cloud.

Returns
Type Description
string

hasGatewayIPv4

clearGatewayIPv4

setGatewayIPv4

[Output Only] The gateway address for default routing out of the network, selected by Google Cloud.

Parameter
Name Description
var string
Returns
Type Description
$this

getId

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

Returns
Type Description
int|string

hasId

clearId

setId

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getInternalIpv6Range

When enabling ula internal ipv6, caller optionally can specify the /48 range they want from the google defined ULA prefix fd20::/20. The input must be a valid /48 ULA IPv6 address and must be within the fd20::/20. Operation will fail if the speficied /48 is already in used by another resource. If the field is not speficied, then a /48 range will be randomly allocated from fd20::/20 and returned via this field. .

Returns
Type Description
string

hasInternalIpv6Range

clearInternalIpv6Range

setInternalIpv6Range

When enabling ula internal ipv6, caller optionally can specify the /48 range they want from the google defined ULA prefix fd20::/20. The input must be a valid /48 ULA IPv6 address and must be within the fd20::/20. Operation will fail if the speficied /48 is already in used by another resource. If the field is not speficied, then a /48 range will be randomly allocated from fd20::/20 and returned via this field. .

Parameter
Name Description
var string
Returns
Type Description
$this

getKind

[Output Only] Type of the resource. Always compute#network for networks.

Returns
Type Description
string

hasKind

clearKind

setKind

[Output Only] Type of the resource. Always compute#network for networks.

Parameter
Name Description
var string
Returns
Type Description
$this

getMtu

Maximum Transmission Unit in bytes. The minimum value for this field is 1300 and the maximum value is 8896. The suggested value is 1500, which is the default MTU used on the Internet, or 8896 if you want to use Jumbo frames. If unspecified, the value defaults to 1460.

Returns
Type Description
int

hasMtu

clearMtu

setMtu

Maximum Transmission Unit in bytes. The minimum value for this field is 1300 and the maximum value is 8896. The suggested value is 1500, which is the default MTU used on the Internet, or 8896 if you want to use Jumbo frames. If unspecified, the value defaults to 1460.

Parameter
Name Description
var int
Returns
Type Description
$this

getName

Name of the resource. Provided by the client when the resource is created. 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])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.

Returns
Type Description
string

hasName

clearName

setName

Name of the resource. Provided by the client when the resource is created. 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])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.

Parameter
Name Description
var string
Returns
Type Description
$this

getNetworkFirewallPolicyEnforcementOrder

The network firewall policy enforcement order. Can be either AFTER_CLASSIC_FIREWALL or BEFORE_CLASSIC_FIREWALL. Defaults to AFTER_CLASSIC_FIREWALL if the field is not specified.

Check the NetworkFirewallPolicyEnforcementOrder enum for the list of possible values.

Returns
Type Description
string

hasNetworkFirewallPolicyEnforcementOrder

clearNetworkFirewallPolicyEnforcementOrder

setNetworkFirewallPolicyEnforcementOrder

The network firewall policy enforcement order. Can be either AFTER_CLASSIC_FIREWALL or BEFORE_CLASSIC_FIREWALL. Defaults to AFTER_CLASSIC_FIREWALL if the field is not specified.

Check the NetworkFirewallPolicyEnforcementOrder enum for the list of possible values.

Parameter
Name Description
var string
Returns
Type Description
$this

getPeerings

[Output Only] A list of network peerings for the resource.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setPeerings

[Output Only] A list of network peerings for the resource.

Parameter
Name Description
var array<Google\Cloud\Compute\V1\NetworkPeering>
Returns
Type Description
$this

getRoutingConfig

The network-level routing configuration for this network. Used by Cloud Router to determine what type of network-wide routing behavior to enforce.

Returns
Type Description
Google\Cloud\Compute\V1\NetworkRoutingConfig|null

hasRoutingConfig

clearRoutingConfig

setRoutingConfig

The network-level routing configuration for this network. Used by Cloud Router to determine what type of network-wide routing behavior to enforce.

Parameter
Name Description
var Google\Cloud\Compute\V1\NetworkRoutingConfig
Returns
Type Description
$this

getSelfLink

[Output Only] Server-defined URL for the resource.

Returns
Type Description
string

hasSelfLink

clearSelfLink

setSelfLink

[Output Only] Server-defined URL for the resource.

Parameter
Name Description
var string
Returns
Type Description
$this

getSelfLinkWithId

[Output Only] Server-defined URL for this resource with the resource id.

Returns
Type Description
string

hasSelfLinkWithId

clearSelfLinkWithId

setSelfLinkWithId

[Output Only] Server-defined URL for this resource with the resource id.

Parameter
Name Description
var string
Returns
Type Description
$this

getSubnetworks

[Output Only] Server-defined fully-qualified URLs for all subnetworks in this VPC network.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setSubnetworks

[Output Only] Server-defined fully-qualified URLs for all subnetworks in this VPC network.

Parameter
Name Description
var string[]
Returns
Type Description
$this