1. class
  2. Google
  3. \
  4. Service
  5. \
  6. VMwareEngine
  7. \
  8. Resource
  9. \
  10. ProjectsLocationsNetworkPeerings

ProjectsLocationsNetworkPeerings

class ProjectsLocationsNetworkPeerings extends Resource (View source)

The "networkPeerings" collection of methods.

Typical usage is:

 $vmwareengineService = new Google\Service\VMwareEngine(...);
 $networkPeerings = $vmwareengineService->projects_locations_networkPeerings;

Methods

Operation
create(string $parent, NetworkPeering $postBody, array $optParams = [])

Creates a new network peering between the peer network and VMware Engine network provided in a NetworkPeering resource. NetworkPeering is a global resource and location can only be global. (networkPeerings.create)

Operation
delete(string $name, array $optParams = [])

Deletes a NetworkPeering resource. When a network peering is deleted for a VMware Engine network, the peer network becomes inaccessible to that VMware Engine network. NetworkPeering is a global resource and location can only be global. (networkPeerings.delete)

NetworkPeering
get(string $name, array $optParams = [])

Retrieves a NetworkPeering resource by its resource name. The resource contains details of the network peering, such as peered networks, import and export custom route configurations, and peering state. NetworkPeering is a global resource and location can only be global. (networkPeerings.get)

ListNetworkPeeringsResponse
listProjectsLocationsNetworkPeerings(string $parent, array $optParams = [])

Lists NetworkPeering resources in a given project. NetworkPeering is a global resource and location can only be global.

Operation
patch(string $name, NetworkPeering $postBody, array $optParams = [])

Modifies a NetworkPeering resource. Only the description field can be updated. Only fields specified in updateMask are applied. NetworkPeering is a global resource and location can only be global. (networkPeerings.patch)

Details

at line 70
Operation create(string $parent, NetworkPeering $postBody, array $optParams = [])

Creates a new network peering between the peer network and VMware Engine network provided in a NetworkPeering resource. NetworkPeering is a global resource and location can only be global. (networkPeerings.create)

Parameters

string $parent

Required. The resource name of the location to create the new network peering in. This value is always global, because NetworkPeering is a global resource. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/global
NetworkPeering $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 102
Operation delete(string $name, array $optParams = [])

Deletes a NetworkPeering resource. When a network peering is deleted for a VMware Engine network, the peer network becomes inaccessible to that VMware Engine network. NetworkPeering is a global resource and location can only be global. (networkPeerings.delete)

Parameters

string $name

Required. The resource name of the network peering to be deleted. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/global/networkPeerings/my-peering
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 122
NetworkPeering get(string $name, array $optParams = [])

Retrieves a NetworkPeering resource by its resource name. The resource contains details of the network peering, such as peered networks, import and export custom route configurations, and peering state. NetworkPeering is a global resource and location can only be global. (networkPeerings.get)

Parameters

string $name

Required. The resource name of the network peering to retrieve. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/global/networkPeerings/my-peering
array $optParams

Optional parameters.

Return Value

NetworkPeering

Exceptions

Exception

at line 165
ListNetworkPeeringsResponse listProjectsLocationsNetworkPeerings(string $parent, array $optParams = [])

Lists NetworkPeering resources in a given project. NetworkPeering is a global resource and location can only be global.

(networkPeerings.listProjectsLocationsNetworkPeerings)

Parameters

string $parent

Required. The resource name of the location (global) to query for network peerings. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/global
array $optParams

Optional parameters.

Return Value

ListNetworkPeeringsResponse

Exceptions

Exception

at line 203
Operation patch(string $name, NetworkPeering $postBody, array $optParams = [])

Modifies a NetworkPeering resource. Only the description field can be updated. Only fields specified in updateMask are applied. NetworkPeering is a global resource and location can only be global. (networkPeerings.patch)

Parameters

string $name

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
NetworkPeering $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception