Google Cloud Compute V1 API - Class Google::Cloud::Compute::V1::NetworkPeering (v1.4.0)

Reference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::NetworkPeering.

A network peering attached to a network resource. The message includes the peering name, peer network, peering state, and a flag indicating whether Google Compute Engine should automatically create routes for the peering.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#auto_create_routes

def auto_create_routes() -> ::Boolean

Returns

(::Boolean) — This field will be deprecated soon. Use the exchange_subnet_routes field instead. Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE.

#auto_create_routes=

def auto_create_routes=(value) -> ::Boolean

Parameter

value (::Boolean) — This field will be deprecated soon. Use the exchange_subnet_routes field instead. Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE.

Returns

(::Boolean) — This field will be deprecated soon. Use the exchange_subnet_routes field instead. Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE.

#exchange_subnet_routes

def exchange_subnet_routes() -> ::Boolean

Returns

(::Boolean) — Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE.

#exchange_subnet_routes=

def exchange_subnet_routes=(value) -> ::Boolean

Parameter

value (::Boolean) — Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE.

Returns

(::Boolean) — Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE.

#export_custom_routes

def export_custom_routes() -> ::Boolean

Returns

(::Boolean) — Whether to export the custom routes to peer network. The default value is false.

#export_custom_routes=

def export_custom_routes=(value) -> ::Boolean

Parameter

value (::Boolean) — Whether to export the custom routes to peer network. The default value is false.

Returns

(::Boolean) — Whether to export the custom routes to peer network. The default value is false.

#export_subnet_routes_with_public_ip

def export_subnet_routes_with_public_ip() -> ::Boolean

Returns

(::Boolean) — Whether subnet routes with public IP range are exported. The default value is true, all subnet routes are exported. IPv4 special-use ranges are always exported to peers and are not controlled by this field.

#export_subnet_routes_with_public_ip=

def export_subnet_routes_with_public_ip=(value) -> ::Boolean

Parameter

value (::Boolean) — Whether subnet routes with public IP range are exported. The default value is true, all subnet routes are exported. IPv4 special-use ranges are always exported to peers and are not controlled by this field.

Returns

(::Boolean) — Whether subnet routes with public IP range are exported. The default value is true, all subnet routes are exported. IPv4 special-use ranges are always exported to peers and are not controlled by this field.

#import_custom_routes

def import_custom_routes() -> ::Boolean

Returns

(::Boolean) — Whether to import the custom routes from peer network. The default value is false.

#import_custom_routes=

def import_custom_routes=(value) -> ::Boolean

Parameter

value (::Boolean) — Whether to import the custom routes from peer network. The default value is false.

Returns

(::Boolean) — Whether to import the custom routes from peer network. The default value is false.

#import_subnet_routes_with_public_ip

def import_subnet_routes_with_public_ip() -> ::Boolean

Returns

(::Boolean) — Whether subnet routes with public IP range are imported. The default value is false. IPv4 special-use ranges are always imported from peers and are not controlled by this field.

#import_subnet_routes_with_public_ip=

def import_subnet_routes_with_public_ip=(value) -> ::Boolean

Parameter

value (::Boolean) — Whether subnet routes with public IP range are imported. The default value is false. IPv4 special-use ranges are always imported from peers and are not controlled by this field.

Returns

(::Boolean) — Whether subnet routes with public IP range are imported. The default value is false. IPv4 special-use ranges are always imported from peers and are not controlled by this field.

#name

def name() -> ::String

Returns

(::String) — Name of this peering. Provided by the client when the peering is created. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match regular expression [a-z]([-a-z0-9]*[a-z0-9])?. The first character must be a lowercase letter, and all the following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

#name=

def name=(value) -> ::String

Parameter

value (::String) — Name of this peering. Provided by the client when the peering is created. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match regular expression [a-z]([-a-z0-9]*[a-z0-9])?. The first character must be a lowercase letter, and all the following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

Returns

(::String) — Name of this peering. Provided by the client when the peering is created. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match regular expression [a-z]([-a-z0-9]*[a-z0-9])?. The first character must be a lowercase letter, and all the following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

#network

def network() -> ::String

Returns

(::String) — The URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network.

#network=

def network=(value) -> ::String

Parameter

value (::String) — The URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network.

Returns

(::String) — The URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network.

#peer_mtu

def peer_mtu() -> ::Integer

Returns

(::Integer) — Maximum Transmission Unit in bytes.

#peer_mtu=

def peer_mtu=(value) -> ::Integer

Parameter

value (::Integer) — Maximum Transmission Unit in bytes.

Returns

(::Integer) — Maximum Transmission Unit in bytes.

#stack_type

def stack_type() -> ::String

Returns

(::String) — Which IP version(s) of traffic and routes are allowed to be imported or exported between peer networks. The default value is IPV4_ONLY. Check the StackType enum for the list of possible values.

#stack_type=

def stack_type=(value) -> ::String

Parameter

value (::String) — Which IP version(s) of traffic and routes are allowed to be imported or exported between peer networks. The default value is IPV4_ONLY. Check the StackType enum for the list of possible values.

Returns

(::String) — Which IP version(s) of traffic and routes are allowed to be imported or exported between peer networks. The default value is IPV4_ONLY. Check the StackType enum for the list of possible values.

#state

def state() -> ::String

Returns

(::String) — [Output Only] State for the peering, either ACTIVE or INACTIVE. The peering is ACTIVE when there's a matching configuration in the peer network. Check the State enum for the list of possible values.

#state=

def state=(value) -> ::String

Parameter

value (::String) — [Output Only] State for the peering, either ACTIVE or INACTIVE. The peering is ACTIVE when there's a matching configuration in the peer network. Check the State enum for the list of possible values.

Returns

(::String) — [Output Only] State for the peering, either ACTIVE or INACTIVE. The peering is ACTIVE when there's a matching configuration in the peer network. Check the State enum for the list of possible values.

#state_details

def state_details() -> ::String

Returns

(::String) — [Output Only] Details about the current state of the peering.

#state_details=

def state_details=(value) -> ::String

Parameter

value (::String) — [Output Only] Details about the current state of the peering.

Returns

(::String) — [Output Only] Details about the current state of the peering.