Google Cloud VMware Engine V1 API - Class Google::Cloud::VmwareEngine::V1::NetworkPeering (v0.9.1)

Reference documentation and code samples for the Google Cloud VMware Engine V1 API class Google::Cloud::VmwareEngine::V1::NetworkPeering.

Details of a network peering.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#create_time

def create_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. Creation time of this resource.

#description

def description() -> ::String

Returns

(::String) — Optional. User-provided description for this network peering.

#description=

def description=(value) -> ::String

Parameter

value (::String) — Optional. User-provided description for this network peering.

Returns

(::String) — Optional. User-provided description for this network peering.

#exchange_subnet_routes

def exchange_subnet_routes() -> ::Boolean

Returns

(::Boolean) — Optional. True if full mesh connectivity is created and managed automatically between peered networks; false otherwise. Currently this field is always true because Google Compute Engine automatically creates and manages subnetwork routes between two VPC networks when peering state is 'ACTIVE'.

#exchange_subnet_routes=

def exchange_subnet_routes=(value) -> ::Boolean

Parameter

value (::Boolean) — Optional. True if full mesh connectivity is created and managed automatically between peered networks; false otherwise. Currently this field is always true because Google Compute Engine automatically creates and manages subnetwork routes between two VPC networks when peering state is 'ACTIVE'.

Returns

(::Boolean) — Optional. True if full mesh connectivity is created and managed automatically between peered networks; false otherwise. Currently this field is always true because Google Compute Engine automatically creates and manages subnetwork routes between two VPC networks when peering state is 'ACTIVE'.

#export_custom_routes

def export_custom_routes() -> ::Boolean

Returns

(::Boolean) — Optional. True if custom routes are exported to the peered network; false otherwise. The default value is true.

#export_custom_routes=

def export_custom_routes=(value) -> ::Boolean

Parameter

value (::Boolean) — Optional. True if custom routes are exported to the peered network; false otherwise. The default value is true.

Returns

(::Boolean) — Optional. True if custom routes are exported to the peered network; false otherwise. The default value is true.

#export_custom_routes_with_public_ip

def export_custom_routes_with_public_ip() -> ::Boolean

Returns

(::Boolean) — Optional. True if all subnet routes with a public IP address range are exported; false otherwise. The default value is true. IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always exported to peers and are not controlled by this field.

#export_custom_routes_with_public_ip=

def export_custom_routes_with_public_ip=(value) -> ::Boolean

Parameter

value (::Boolean) — Optional. True if all subnet routes with a public IP address range are exported; false otherwise. The default value is true. IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always exported to peers and are not controlled by this field.

Returns

(::Boolean) — Optional. True if all subnet routes with a public IP address range are exported; false otherwise. The default value is true. IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always exported to peers and are not controlled by this field.

#import_custom_routes

def import_custom_routes() -> ::Boolean

Returns

(::Boolean) — Optional. True if custom routes are imported from the peered network; false otherwise. The default value is true.

#import_custom_routes=

def import_custom_routes=(value) -> ::Boolean

Parameter

value (::Boolean) — Optional. True if custom routes are imported from the peered network; false otherwise. The default value is true.

Returns

(::Boolean) — Optional. True if custom routes are imported from the peered network; false otherwise. The default value is true.

#import_custom_routes_with_public_ip

def import_custom_routes_with_public_ip() -> ::Boolean

Returns

(::Boolean) — Optional. True if all subnet routes with public IP address range are imported; false otherwise. The default value is true. IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always imported to peers and are not controlled by this field.

#import_custom_routes_with_public_ip=

def import_custom_routes_with_public_ip=(value) -> ::Boolean

Parameter

value (::Boolean) — Optional. True if all subnet routes with public IP address range are imported; false otherwise. The default value is true. IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always imported to peers and are not controlled by this field.

Returns

(::Boolean) — Optional. True if all subnet routes with public IP address range are imported; false otherwise. The default value is true. IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always imported to peers and are not controlled by this field.

#name

def name() -> ::String

Returns

(::String) — Output only. The resource name of the network peering. NetworkPeering is a global resource and location can only be global. Resource names are scheme-less URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/global/networkPeerings/my-peering

#peer_mtu

def peer_mtu() -> ::Integer

Returns

(::Integer) — Optional. Maximum transmission unit (MTU) in bytes. The default value is 1500. If a value of 0 is provided for this field, VMware Engine uses the default value instead.

#peer_mtu=

def peer_mtu=(value) -> ::Integer

Parameter

value (::Integer) — Optional. Maximum transmission unit (MTU) in bytes. The default value is 1500. If a value of 0 is provided for this field, VMware Engine uses the default value instead.

Returns

(::Integer) — Optional. Maximum transmission unit (MTU) in bytes. The default value is 1500. If a value of 0 is provided for this field, VMware Engine uses the default value instead.

#peer_network

def peer_network() -> ::String

Returns

(::String) — Required. The relative resource name of the network to peer with a standard VMware Engine network. The provided network can be a consumer VPC network or another standard VMware Engine network. If the peer_network_type is VMWARE_ENGINE_NETWORK, specify the name in the form: projects/{project}/locations/global/vmwareEngineNetworks/{vmware_engine_network_id}. Otherwise specify the name in the form: projects/{project}/global/networks/{network_id}, where {project} can either be a project number or a project ID.

#peer_network=

def peer_network=(value) -> ::String

Parameter

value (::String) — Required. The relative resource name of the network to peer with a standard VMware Engine network. The provided network can be a consumer VPC network or another standard VMware Engine network. If the peer_network_type is VMWARE_ENGINE_NETWORK, specify the name in the form: projects/{project}/locations/global/vmwareEngineNetworks/{vmware_engine_network_id}. Otherwise specify the name in the form: projects/{project}/global/networks/{network_id}, where {project} can either be a project number or a project ID.

Returns

(::String) — Required. The relative resource name of the network to peer with a standard VMware Engine network. The provided network can be a consumer VPC network or another standard VMware Engine network. If the peer_network_type is VMWARE_ENGINE_NETWORK, specify the name in the form: projects/{project}/locations/global/vmwareEngineNetworks/{vmware_engine_network_id}. Otherwise specify the name in the form: projects/{project}/global/networks/{network_id}, where {project} can either be a project number or a project ID.

#peer_network_type

def peer_network_type() -> ::Google::Cloud::VmwareEngine::V1::NetworkPeering::PeerNetworkType

Returns

(::Google::Cloud::VmwareEngine::V1::NetworkPeering::PeerNetworkType) — Required. The type of the network to peer with the VMware Engine network.

#peer_network_type=

def peer_network_type=(value) -> ::Google::Cloud::VmwareEngine::V1::NetworkPeering::PeerNetworkType

Parameter

value (::Google::Cloud::VmwareEngine::V1::NetworkPeering::PeerNetworkType) — Required. The type of the network to peer with the VMware Engine network.

Returns

(::Google::Cloud::VmwareEngine::V1::NetworkPeering::PeerNetworkType) — Required. The type of the network to peer with the VMware Engine network.

#state

def state() -> ::Google::Cloud::VmwareEngine::V1::NetworkPeering::State

Returns

(::Google::Cloud::VmwareEngine::V1::NetworkPeering::State) — Output only. State of the network peering. This field has a value of 'ACTIVE' when there's a matching configuration in the peer network. New values may be added to this enum when appropriate.

#state_details

def state_details() -> ::String

Returns

(::String) — Output only. Output Only. Details about the current state of the network peering.

#uid

def uid() -> ::String

Returns

(::String) — Output only. System-generated unique identifier for the resource.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. Last update time of this resource.

#vmware_engine_network

def vmware_engine_network() -> ::String

Returns

(::String) — Required. The relative resource name of the VMware Engine network. Specify the name in the following form: projects/{project}/locations/{location}/vmwareEngineNetworks/{vmware_engine_network_id} where {project} can either be a project number or a project ID.

#vmware_engine_network=

def vmware_engine_network=(value) -> ::String

Parameter

value (::String) — Required. The relative resource name of the VMware Engine network. Specify the name in the following form: projects/{project}/locations/{location}/vmwareEngineNetworks/{vmware_engine_network_id} where {project} can either be a project number or a project ID.

Returns

(::String) — Required. The relative resource name of the VMware Engine network. Specify the name in the following form: projects/{project}/locations/{location}/vmwareEngineNetworks/{vmware_engine_network_id} where {project} can either be a project number or a project ID.