Compute V1 Client - Class NetworksAddPeeringRequest (1.19.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
Name Description
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
Type Description
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
Name Description
var bool
Returns
Type Description
$this

getName

Name of the peering, which should conform to RFC1035.

Returns
Type Description
string

hasName

clearName

setName

Name of the peering, which should conform to RFC1035.

Parameter
Name Description
var string
Returns
Type Description
$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
Type Description
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
Name Description
var Google\Cloud\Compute\V1\NetworkPeering
Returns
Type Description
$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
Type Description
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
Name Description
var string
Returns
Type Description
$this