Compute V1 Client - Class NetworksAddPeeringRequest (1.14.0)

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

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

Namespace

Google \ Cloud \ Compute \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ auto_create_routes bool

This field will be deprecated soon. Use exchange_subnet_routes in network_peering 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.

↳ name string

Name of the peering, which should conform to RFC1035.

↳ network_peering Google\Cloud\Compute\V1\NetworkPeering

Network peering parameters. In order to specify route policies for peering using import and export custom routes, you must specify all peering related parameters (name, peer network, exchange_subnet_routes) in the network_peering field. The corresponding fields in NetworksAddPeeringRequest will be deprecated soon.

↳ peer_network string

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.

getAutoCreateRoutes

This field will be deprecated soon. Use exchange_subnet_routes in network_peering 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
TypeDescription
bool

hasAutoCreateRoutes

clearAutoCreateRoutes

setAutoCreateRoutes

This field will be deprecated soon. Use exchange_subnet_routes in network_peering 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.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getName

Name of the peering, which should conform to RFC1035.

Returns
TypeDescription
string

hasName

clearName

setName

Name of the peering, which should conform to RFC1035.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getNetworkPeering

Network peering parameters. In order to specify route policies for peering using import and export custom routes, you must specify all peering related parameters (name, peer network, exchange_subnet_routes) in the network_peering field. The corresponding fields in NetworksAddPeeringRequest will be deprecated soon.

Returns
TypeDescription
Google\Cloud\Compute\V1\NetworkPeering|null

hasNetworkPeering

clearNetworkPeering

setNetworkPeering

Network peering parameters. In order to specify route policies for peering using import and export custom routes, you must specify all peering related parameters (name, peer network, exchange_subnet_routes) in the network_peering field. The corresponding fields in NetworksAddPeeringRequest will be deprecated soon.

Parameter
NameDescription
var Google\Cloud\Compute\V1\NetworkPeering
Returns
TypeDescription
$this

getPeerNetwork

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
TypeDescription
string

hasPeerNetwork

clearPeerNetwork

setPeerNetwork

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.

Parameter
NameDescription
var string
Returns
TypeDescription
$this