Google Cloud Vmware Engine V1 Client - Class NetworkPeering (0.5.6)

Reference documentation and code samples for the Google Cloud Vmware Engine V1 Client class NetworkPeering.

Details of a network peering.

Generated from protobuf message google.cloud.vmwareengine.v1.NetworkPeering

Namespace

Google \ Cloud \ VmwareEngine \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name 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
↳ create_time Google\Protobuf\Timestamp

Output only. Creation time of this resource.
↳ update_time Google\Protobuf\Timestamp

Output only. Last update time of this resource.
↳ peer_network 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.
↳ export_custom_routes bool

Optional. True if custom routes are exported to the peered network; false otherwise. The default value is true.
↳ import_custom_routes bool

Optional. True if custom routes are imported from the peered network; false otherwise. The default value is true.
↳ exchange_subnet_routes bool

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_with_public_ip bool

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_with_public_ip bool

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.
↳ state int

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 string

Output only. Output Only. Details about the current state of the network peering.
↳ peer_mtu int

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_type int

Required. The type of the network to peer with the VMware Engine network.
↳ uid string

Output only. System-generated unique identifier for the resource.
↳ vmware_engine_network 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.
↳ description string

Optional. User-provided description for this network peering.

getName

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

Returns
Type Description
string

setName

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

Parameter
Name Description
var string
Returns
Type Description
$this

getCreateTime

Output only. Creation time of this resource.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Creation time of this resource.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getUpdateTime

Output only. Last update time of this resource.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Last update time of this resource.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getPeerNetwork

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
Type Description
string

setPeerNetwork

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getExportCustomRoutes

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

Returns
Type Description
bool

hasExportCustomRoutes

clearExportCustomRoutes

setExportCustomRoutes

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

Parameter
Name Description
var bool
Returns
Type Description
$this

getImportCustomRoutes

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

Returns
Type Description
bool

hasImportCustomRoutes

clearImportCustomRoutes

setImportCustomRoutes

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

Parameter
Name Description
var bool
Returns
Type Description
$this

getExchangeSubnetRoutes

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
Type Description
bool

hasExchangeSubnetRoutes

clearExchangeSubnetRoutes

setExchangeSubnetRoutes

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'.

Parameter
Name Description
var bool
Returns
Type Description
$this

getExportCustomRoutesWithPublicIp

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
Type Description
bool

hasExportCustomRoutesWithPublicIp

clearExportCustomRoutesWithPublicIp

setExportCustomRoutesWithPublicIp

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.

Parameter
Name Description
var bool
Returns
Type Description
$this

getImportCustomRoutesWithPublicIp

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
Type Description
bool

hasImportCustomRoutesWithPublicIp

clearImportCustomRoutesWithPublicIp

setImportCustomRoutesWithPublicIp

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.

Parameter
Name Description
var bool
Returns
Type Description
$this

getState

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.

Returns
Type Description
int

setState

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.

Parameter
Name Description
var int
Returns
Type Description
$this

getStateDetails

Output only. Output Only. Details about the current state of the network peering.

Returns
Type Description
string

setStateDetails

Output only. Output Only. Details about the current state of the network peering.

Parameter
Name Description
var string
Returns
Type Description
$this

getPeerMtu

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
Type Description
int

setPeerMtu

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.

Parameter
Name Description
var int
Returns
Type Description
$this

getPeerNetworkType

Required. The type of the network to peer with the VMware Engine network.

Returns
Type Description
int

setPeerNetworkType

Required. The type of the network to peer with the VMware Engine network.

Parameter
Name Description
var int
Returns
Type Description
$this

getUid

Output only. System-generated unique identifier for the resource.

Returns
Type Description
string

setUid

Output only. System-generated unique identifier for the resource.

Parameter
Name Description
var string
Returns
Type Description
$this

getVmwareEngineNetwork

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
Type Description
string

setVmwareEngineNetwork

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getDescription

Optional. User-provided description for this network peering.

Returns
Type Description
string

setDescription

Optional. User-provided description for this network peering.

Parameter
Name Description
var string
Returns
Type Description
$this