Google Cloud Compute V1 API - Class Google::Cloud::Compute::V1::Network (v2.1.0)

Reference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::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.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#I_pv4_range

def I_pv4_range() -> ::String

Returns

(::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.

#I_pv4_range=

def I_pv4_range=(value) -> ::String

Parameter

value (::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.

Returns

(::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

def auto_create_subnetworks() -> ::Boolean

Returns

(::Boolean) — 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.

#auto_create_subnetworks=

def auto_create_subnetworks=(value) -> ::Boolean

Parameter

value (::Boolean) — 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

(::Boolean) — 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

def creation_timestamp() -> ::String

Returns

(::String) — [Output Only] Creation timestamp in RFC3339 text format.

#creation_timestamp=

def creation_timestamp=(value) -> ::String

Parameter

value (::String) — [Output Only] Creation timestamp in RFC3339 text format.

Returns

(::String) — [Output Only] Creation timestamp in RFC3339 text format.

#description

def description() -> ::String

Returns

(::String) — An optional description of this resource. Provide this field when you create the resource.

#description=

def description=(value) -> ::String

Parameter

value (::String) — An optional description of this resource. Provide this field when you create the resource.

Returns

(::String) — An optional description of this resource. Provide this field when you create the resource.

#enable_ula_internal_ipv6

def enable_ula_internal_ipv6() -> ::Boolean

Returns

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

#enable_ula_internal_ipv6=

def enable_ula_internal_ipv6=(value) -> ::Boolean

Parameter

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

Returns

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

#firewall_policy

def firewall_policy() -> ::String

Returns

(::String) — [Output Only] URL of the firewall policy the network is associated with.

#firewall_policy=

def firewall_policy=(value) -> ::String

Parameter

value (::String) — [Output Only] URL of the firewall policy the network is associated with.

Returns

(::String) — [Output Only] URL of the firewall policy the network is associated with.

#gateway_i_pv4

def gateway_i_pv4() -> ::String

Returns

(::String) — [Output Only] The gateway address for default routing out of the network, selected by GCP.

#gateway_i_pv4=

def gateway_i_pv4=(value) -> ::String

Parameter

value (::String) — [Output Only] The gateway address for default routing out of the network, selected by GCP.

Returns

(::String) — [Output Only] The gateway address for default routing out of the network, selected by GCP.

#id

def id() -> ::Integer

Returns

(::Integer) — [Output Only] The unique identifier for the resource. This identifier is defined by the server.

#id=

def id=(value) -> ::Integer

Parameter

value (::Integer) — [Output Only] The unique identifier for the resource. This identifier is defined by the server.

Returns

(::Integer) — [Output Only] The unique identifier for the resource. This identifier is defined by the server.

#internal_ipv6_range

def internal_ipv6_range() -> ::String

Returns

(::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. .

#internal_ipv6_range=

def internal_ipv6_range=(value) -> ::String

Parameter

value (::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. .

Returns

(::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

def kind() -> ::String

Returns

(::String) — [Output Only] Type of the resource. Always compute#network for networks.

#kind=

def kind=(value) -> ::String

Parameter

value (::String) — [Output Only] Type of the resource. Always compute#network for networks.

Returns

(::String) — [Output Only] Type of the resource. Always compute#network for networks.

#mtu

def mtu() -> ::Integer

Returns

(::Integer) — 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.

#mtu=

def mtu=(value) -> ::Integer

Parameter

value (::Integer) — 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

(::Integer) — 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

def name() -> ::String

Returns

(::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.

#name=

def name=(value) -> ::String

Parameter

value (::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.

Returns

(::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

def network_firewall_policy_enforcement_order() -> ::String

Returns

(::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.

#network_firewall_policy_enforcement_order=

def network_firewall_policy_enforcement_order=(value) -> ::String

Parameter

value (::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.

Returns

(::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

def peerings() -> ::Array<::Google::Cloud::Compute::V1::NetworkPeering>

Returns

(::Array<::Google::Cloud::Compute::V1::NetworkPeering>) — [Output Only] A list of network peerings for the resource.

#peerings=

def peerings=(value) -> ::Array<::Google::Cloud::Compute::V1::NetworkPeering>

Parameter

value (::Array<::Google::Cloud::Compute::V1::NetworkPeering>) — [Output Only] A list of network peerings for the resource.

Returns

(::Array<::Google::Cloud::Compute::V1::NetworkPeering>) — [Output Only] A list of network peerings for the resource.

#routing_config

def routing_config() -> ::Google::Cloud::Compute::V1::NetworkRoutingConfig

Returns

(::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.

#routing_config=

def routing_config=(value) -> ::Google::Cloud::Compute::V1::NetworkRoutingConfig

Parameter

value (::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.

Returns

(::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

def self_link() -> ::String

Returns

(::String) — [Output Only] Server-defined URL for the resource.

#self_link=

def self_link=(value) -> ::String

Parameter

value (::String) — [Output Only] Server-defined URL for the resource.

Returns

(::String) — [Output Only] Server-defined URL for the resource.

#self_link_with_id

def self_link_with_id() -> ::String

Returns

(::String) — [Output Only] Server-defined URL for this resource with the resource id.

#self_link_with_id=

def self_link_with_id=(value) -> ::String

Parameter

value (::String) — [Output Only] Server-defined URL for this resource with the resource id.

Returns

(::String) — [Output Only] Server-defined URL for this resource with the resource id.

#subnetworks

def subnetworks() -> ::Array<::String>

Returns

(::Array<::String>) — [Output Only] Server-defined fully-qualified URLs for all subnetworks in this VPC network.

#subnetworks=

def subnetworks=(value) -> ::Array<::String>

Parameter

value (::Array<::String>) — [Output Only] Server-defined fully-qualified URLs for all subnetworks in this VPC network.

Returns

(::Array<::String>) — [Output Only] Server-defined fully-qualified URLs for all subnetworks in this VPC network.