Compute V1 Client - Class NetworksClient (2.5.0) Stay organized with collections Save and categorize content based on your preferences.
Reference documentation and code samples for the Compute V1 Client class NetworksClient.
Service Description: The Networks API.
This class provides the ability to make remote calls to the backing service through methodcalls that map to API methods.
Namespace
Google \ Cloud \ Compute \ V1 \ ClientMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
options | array|Google\ApiCore\Options\ClientOptionsOptional. Options for configuring the service API wrapper. |
↳ apiEndpoint | stringThe address of the API remote host. May optionally include the port, formatted as " |
↳ credentials | FetchAuthTokenInterface|CredentialsWrapperThis option should only be used with a pre-constructedGoogle\Auth\FetchAuthTokenInterface orGoogle\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.Important: If you are providing a path to a credentials file, or a decoded credentials file as a PHP array, this usage is now DEPRECATED. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data. It is recommended to create the credentials explicitly |
↳ credentialsConfig | arrayOptions used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, seeGoogle\ApiCore\CredentialsWrapper::build() . |
↳ disableRetries | boolDetermines whether or not retries defined by the client configuration should be disabled. Defaults to |
↳ clientConfig | string|arrayClient method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder. |
↳ transport | string|TransportInterfaceThe transport used for executing network requests. At the moment, supports only |
↳ transportConfig | arrayConfiguration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'rest' => [...], ]; See theGoogle\ApiCore\Transport\RestTransport::build() method for the supported options. |
↳ clientCertSource | callableA callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS. |
↳ logger | false|LoggerInterfaceA PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag |
↳ universeDomain | stringThe service domain for the client. Defaults to 'googleapis.com'. |
addPeering
Adds a peering to the specified network.
The async variant isNetworksClient::addPeeringAsync() .
| Parameters | |
|---|---|
| Name | Description |
request | Google\Cloud\Compute\V1\AddPeeringNetworkRequestA request to house fields associated with the call. |
callOptions | arrayOptional. |
↳ retrySettings | RetrySettings|arrayRetry settings to use for this call. Can be aGoogle\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation onGoogle\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse | |
use Google\ApiCore\ApiException;use Google\ApiCore\OperationResponse;use Google\Cloud\Compute\V1\AddPeeringNetworkRequest;use Google\Cloud\Compute\V1\Client\NetworksClient;use Google\Cloud\Compute\V1\NetworksAddPeeringRequest;use Google\Rpc\Status;/** * @param string $network Name of the network resource to add peering to. * @param string $project Project ID for this request. */function add_peering_sample(string $network, string $project): void{ // Create a client. $networksClient = new NetworksClient(); // Prepare the request message. $networksAddPeeringRequestResource = new NetworksAddPeeringRequest(); $request = (new AddPeeringNetworkRequest()) ->setNetwork($network) ->setNetworksAddPeeringRequestResource($networksAddPeeringRequestResource) ->setProject($project); // Call the API and handle any network failures. try { /** @var OperationResponse $response */ $response = $networksClient->addPeering($request); $response->pollUntilComplete(); if ($response->operationSucceeded()) { printf('Operation completed successfully.' . PHP_EOL); } else { /** @var Status $error */ $error = $response->getError(); printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString()); } } catch (ApiException $ex) { printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage()); }}/** * Helper to execute the sample. * * This sample has been automatically generated and should be regarded as a code * template only. It will require modifications to work: * - It may require correct/in-range values for request initialization. * - It may require specifying regional endpoints when creating the service client, * please see the apiEndpoint client configuration option for more details. */function callSample(): void{ $network = '[NETWORK]'; $project = '[PROJECT]'; add_peering_sample($network, $project);}delete
Deletes the specified network.
The async variant isNetworksClient::deleteAsync() .
| Parameters | |
|---|---|
| Name | Description |
request | Google\Cloud\Compute\V1\DeleteNetworkRequestA request to house fields associated with the call. |
callOptions | arrayOptional. |
↳ retrySettings | RetrySettings|arrayRetry settings to use for this call. Can be aGoogle\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation onGoogle\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse | |
use Google\ApiCore\ApiException;use Google\ApiCore\OperationResponse;use Google\Cloud\Compute\V1\Client\NetworksClient;use Google\Cloud\Compute\V1\DeleteNetworkRequest;use Google\Rpc\Status;/** * @param string $network Name of the network to delete. * @param string $project Project ID for this request. */function delete_sample(string $network, string $project): void{ // Create a client. $networksClient = new NetworksClient(); // Prepare the request message. $request = (new DeleteNetworkRequest()) ->setNetwork($network) ->setProject($project); // Call the API and handle any network failures. try { /** @var OperationResponse $response */ $response = $networksClient->delete($request); $response->pollUntilComplete(); if ($response->operationSucceeded()) { printf('Operation completed successfully.' . PHP_EOL); } else { /** @var Status $error */ $error = $response->getError(); printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString()); } } catch (ApiException $ex) { printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage()); }}/** * Helper to execute the sample. * * This sample has been automatically generated and should be regarded as a code * template only. It will require modifications to work: * - It may require correct/in-range values for request initialization. * - It may require specifying regional endpoints when creating the service client, * please see the apiEndpoint client configuration option for more details. */function callSample(): void{ $network = '[NETWORK]'; $project = '[PROJECT]'; delete_sample($network, $project);}get
Returns the specified network.
The async variant isNetworksClient::getAsync() .
| Parameters | |
|---|---|
| Name | Description |
request | Google\Cloud\Compute\V1\GetNetworkRequestA request to house fields associated with the call. |
callOptions | arrayOptional. |
↳ retrySettings | RetrySettings|arrayRetry settings to use for this call. Can be aGoogle\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation onGoogle\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Compute\V1\Network | |
use Google\ApiCore\ApiException;use Google\Cloud\Compute\V1\Client\NetworksClient;use Google\Cloud\Compute\V1\GetNetworkRequest;use Google\Cloud\Compute\V1\Network;/** * @param string $network Name of the network to return. * @param string $project Project ID for this request. */function get_sample(string $network, string $project): void{ // Create a client. $networksClient = new NetworksClient(); // Prepare the request message. $request = (new GetNetworkRequest()) ->setNetwork($network) ->setProject($project); // Call the API and handle any network failures. try { /** @var Network $response */ $response = $networksClient->get($request); printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString()); } catch (ApiException $ex) { printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage()); }}/** * Helper to execute the sample. * * This sample has been automatically generated and should be regarded as a code * template only. It will require modifications to work: * - It may require correct/in-range values for request initialization. * - It may require specifying regional endpoints when creating the service client, * please see the apiEndpoint client configuration option for more details. */function callSample(): void{ $network = '[NETWORK]'; $project = '[PROJECT]'; get_sample($network, $project);}getEffectiveFirewalls
Returns the effective firewalls on a given network.
The async variant isNetworksClient::getEffectiveFirewallsAsync() .
| Parameters | |
|---|---|
| Name | Description |
request | Google\Cloud\Compute\V1\GetEffectiveFirewallsNetworkRequestA request to house fields associated with the call. |
callOptions | arrayOptional. |
↳ retrySettings | RetrySettings|arrayRetry settings to use for this call. Can be aGoogle\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation onGoogle\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Compute\V1\NetworksGetEffectiveFirewallsResponse | |
use Google\ApiCore\ApiException;use Google\Cloud\Compute\V1\Client\NetworksClient;use Google\Cloud\Compute\V1\GetEffectiveFirewallsNetworkRequest;use Google\Cloud\Compute\V1\NetworksGetEffectiveFirewallsResponse;/** * @param string $network Name of the network for this request. * @param string $project Project ID for this request. */function get_effective_firewalls_sample(string $network, string $project): void{ // Create a client. $networksClient = new NetworksClient(); // Prepare the request message. $request = (new GetEffectiveFirewallsNetworkRequest()) ->setNetwork($network) ->setProject($project); // Call the API and handle any network failures. try { /** @var NetworksGetEffectiveFirewallsResponse $response */ $response = $networksClient->getEffectiveFirewalls($request); printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString()); } catch (ApiException $ex) { printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage()); }}/** * Helper to execute the sample. * * This sample has been automatically generated and should be regarded as a code * template only. It will require modifications to work: * - It may require correct/in-range values for request initialization. * - It may require specifying regional endpoints when creating the service client, * please see the apiEndpoint client configuration option for more details. */function callSample(): void{ $network = '[NETWORK]'; $project = '[PROJECT]'; get_effective_firewalls_sample($network, $project);}insert
Creates a network in the specified project using the data includedin the request.
The async variant isNetworksClient::insertAsync() .
| Parameters | |
|---|---|
| Name | Description |
request | Google\Cloud\Compute\V1\InsertNetworkRequestA request to house fields associated with the call. |
callOptions | arrayOptional. |
↳ retrySettings | RetrySettings|arrayRetry settings to use for this call. Can be aGoogle\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation onGoogle\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse | |
use Google\ApiCore\ApiException;use Google\ApiCore\OperationResponse;use Google\Cloud\Compute\V1\Client\NetworksClient;use Google\Cloud\Compute\V1\InsertNetworkRequest;use Google\Cloud\Compute\V1\Network;use Google\Rpc\Status;/** * @param string $project Project ID for this request. */function insert_sample(string $project): void{ // Create a client. $networksClient = new NetworksClient(); // Prepare the request message. $networkResource = new Network(); $request = (new InsertNetworkRequest()) ->setNetworkResource($networkResource) ->setProject($project); // Call the API and handle any network failures. try { /** @var OperationResponse $response */ $response = $networksClient->insert($request); $response->pollUntilComplete(); if ($response->operationSucceeded()) { printf('Operation completed successfully.' . PHP_EOL); } else { /** @var Status $error */ $error = $response->getError(); printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString()); } } catch (ApiException $ex) { printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage()); }}/** * Helper to execute the sample. * * This sample has been automatically generated and should be regarded as a code * template only. It will require modifications to work: * - It may require correct/in-range values for request initialization. * - It may require specifying regional endpoints when creating the service client, * please see the apiEndpoint client configuration option for more details. */function callSample(): void{ $project = '[PROJECT]'; insert_sample($project);}list
Retrieves the list of networks available to the specified project.
The async variant isNetworksClient::listAsync() .
| Parameters | |
|---|---|
| Name | Description |
request | Google\Cloud\Compute\V1\ListNetworksRequestA request to house fields associated with the call. |
callOptions | arrayOptional. |
↳ retrySettings | RetrySettings|arrayRetry settings to use for this call. Can be aGoogle\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation onGoogle\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\PagedListResponse | |
use Google\ApiCore\ApiException;use Google\ApiCore\PagedListResponse;use Google\Cloud\Compute\V1\Client\NetworksClient;use Google\Cloud\Compute\V1\ListNetworksRequest;/** * @param string $project Project ID for this request. */function list_sample(string $project): void{ // Create a client. $networksClient = new NetworksClient(); // Prepare the request message. $request = (new ListNetworksRequest()) ->setProject($project); // Call the API and handle any network failures. try { /** @var PagedListResponse $response */ $response = $networksClient->list($request); foreach ($response as $element) { printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString()); } } catch (ApiException $ex) { printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage()); }}/** * Helper to execute the sample. * * This sample has been automatically generated and should be regarded as a code * template only. It will require modifications to work: * - It may require correct/in-range values for request initialization. * - It may require specifying regional endpoints when creating the service client, * please see the apiEndpoint client configuration option for more details. */function callSample(): void{ $project = '[PROJECT]'; list_sample($project);}listPeeringRoutes
Lists the peering routes exchanged over peering connection.
The async variant isNetworksClient::listPeeringRoutesAsync() .
| Parameters | |
|---|---|
| Name | Description |
request | Google\Cloud\Compute\V1\ListPeeringRoutesNetworksRequestA request to house fields associated with the call. |
callOptions | arrayOptional. |
↳ retrySettings | RetrySettings|arrayRetry settings to use for this call. Can be aGoogle\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation onGoogle\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\PagedListResponse | |
use Google\ApiCore\ApiException;use Google\ApiCore\PagedListResponse;use Google\Cloud\Compute\V1\Client\NetworksClient;use Google\Cloud\Compute\V1\ListPeeringRoutesNetworksRequest;/** * @param string $network Name of the network for this request. * @param string $project Project ID for this request. */function list_peering_routes_sample(string $network, string $project): void{ // Create a client. $networksClient = new NetworksClient(); // Prepare the request message. $request = (new ListPeeringRoutesNetworksRequest()) ->setNetwork($network) ->setProject($project); // Call the API and handle any network failures. try { /** @var PagedListResponse $response */ $response = $networksClient->listPeeringRoutes($request); foreach ($response as $element) { printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString()); } } catch (ApiException $ex) { printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage()); }}/** * Helper to execute the sample. * * This sample has been automatically generated and should be regarded as a code * template only. It will require modifications to work: * - It may require correct/in-range values for request initialization. * - It may require specifying regional endpoints when creating the service client, * please see the apiEndpoint client configuration option for more details. */function callSample(): void{ $network = '[NETWORK]'; $project = '[PROJECT]'; list_peering_routes_sample($network, $project);}patch
Patches the specified network with the data included in the request.
Only routingConfig can be modified.
The async variant isNetworksClient::patchAsync() .
| Parameters | |
|---|---|
| Name | Description |
request | Google\Cloud\Compute\V1\PatchNetworkRequestA request to house fields associated with the call. |
callOptions | arrayOptional. |
↳ retrySettings | RetrySettings|arrayRetry settings to use for this call. Can be aGoogle\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation onGoogle\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse | |
use Google\ApiCore\ApiException;use Google\ApiCore\OperationResponse;use Google\Cloud\Compute\V1\Client\NetworksClient;use Google\Cloud\Compute\V1\Network;use Google\Cloud\Compute\V1\PatchNetworkRequest;use Google\Rpc\Status;/** * @param string $network Name of the network to update. * @param string $project Project ID for this request. */function patch_sample(string $network, string $project): void{ // Create a client. $networksClient = new NetworksClient(); // Prepare the request message. $networkResource = new Network(); $request = (new PatchNetworkRequest()) ->setNetwork($network) ->setNetworkResource($networkResource) ->setProject($project); // Call the API and handle any network failures. try { /** @var OperationResponse $response */ $response = $networksClient->patch($request); $response->pollUntilComplete(); if ($response->operationSucceeded()) { printf('Operation completed successfully.' . PHP_EOL); } else { /** @var Status $error */ $error = $response->getError(); printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString()); } } catch (ApiException $ex) { printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage()); }}/** * Helper to execute the sample. * * This sample has been automatically generated and should be regarded as a code * template only. It will require modifications to work: * - It may require correct/in-range values for request initialization. * - It may require specifying regional endpoints when creating the service client, * please see the apiEndpoint client configuration option for more details. */function callSample(): void{ $network = '[NETWORK]'; $project = '[PROJECT]'; patch_sample($network, $project);}removePeering
Removes a peering from the specified network.
The async variant isNetworksClient::removePeeringAsync() .
| Parameters | |
|---|---|
| Name | Description |
request | Google\Cloud\Compute\V1\RemovePeeringNetworkRequestA request to house fields associated with the call. |
callOptions | arrayOptional. |
↳ retrySettings | RetrySettings|arrayRetry settings to use for this call. Can be aGoogle\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation onGoogle\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse | |
use Google\ApiCore\ApiException;use Google\ApiCore\OperationResponse;use Google\Cloud\Compute\V1\Client\NetworksClient;use Google\Cloud\Compute\V1\NetworksRemovePeeringRequest;use Google\Cloud\Compute\V1\RemovePeeringNetworkRequest;use Google\Rpc\Status;/** * @param string $network Name of the network resource to remove peering from. * @param string $project Project ID for this request. */function remove_peering_sample(string $network, string $project): void{ // Create a client. $networksClient = new NetworksClient(); // Prepare the request message. $networksRemovePeeringRequestResource = new NetworksRemovePeeringRequest(); $request = (new RemovePeeringNetworkRequest()) ->setNetwork($network) ->setNetworksRemovePeeringRequestResource($networksRemovePeeringRequestResource) ->setProject($project); // Call the API and handle any network failures. try { /** @var OperationResponse $response */ $response = $networksClient->removePeering($request); $response->pollUntilComplete(); if ($response->operationSucceeded()) { printf('Operation completed successfully.' . PHP_EOL); } else { /** @var Status $error */ $error = $response->getError(); printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString()); } } catch (ApiException $ex) { printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage()); }}/** * Helper to execute the sample. * * This sample has been automatically generated and should be regarded as a code * template only. It will require modifications to work: * - It may require correct/in-range values for request initialization. * - It may require specifying regional endpoints when creating the service client, * please see the apiEndpoint client configuration option for more details. */function callSample(): void{ $network = '[NETWORK]'; $project = '[PROJECT]'; remove_peering_sample($network, $project);}requestRemovePeering
Requests to remove a peering from the specified network. Applicable onlyfor PeeringConnection with update_strategy=CONSENSUS.
The async variant isNetworksClient::requestRemovePeeringAsync() .
| Parameters | |
|---|---|
| Name | Description |
request | Google\Cloud\Compute\V1\RequestRemovePeeringNetworkRequestA request to house fields associated with the call. |
callOptions | arrayOptional. |
↳ retrySettings | RetrySettings|arrayRetry settings to use for this call. Can be aGoogle\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation onGoogle\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse | |
use Google\ApiCore\ApiException;use Google\ApiCore\OperationResponse;use Google\Cloud\Compute\V1\Client\NetworksClient;use Google\Cloud\Compute\V1\NetworksRequestRemovePeeringRequest;use Google\Cloud\Compute\V1\RequestRemovePeeringNetworkRequest;use Google\Rpc\Status;/** * @param string $network Name of the network resource to remove peering from. * @param string $project Project ID for this request. */function request_remove_peering_sample(string $network, string $project): void{ // Create a client. $networksClient = new NetworksClient(); // Prepare the request message. $networksRequestRemovePeeringRequestResource = new NetworksRequestRemovePeeringRequest(); $request = (new RequestRemovePeeringNetworkRequest()) ->setNetwork($network) ->setNetworksRequestRemovePeeringRequestResource($networksRequestRemovePeeringRequestResource) ->setProject($project); // Call the API and handle any network failures. try { /** @var OperationResponse $response */ $response = $networksClient->requestRemovePeering($request); $response->pollUntilComplete(); if ($response->operationSucceeded()) { printf('Operation completed successfully.' . PHP_EOL); } else { /** @var Status $error */ $error = $response->getError(); printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString()); } } catch (ApiException $ex) { printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage()); }}/** * Helper to execute the sample. * * This sample has been automatically generated and should be regarded as a code * template only. It will require modifications to work: * - It may require correct/in-range values for request initialization. * - It may require specifying regional endpoints when creating the service client, * please see the apiEndpoint client configuration option for more details. */function callSample(): void{ $network = '[NETWORK]'; $project = '[PROJECT]'; request_remove_peering_sample($network, $project);}switchToCustomMode
Switches the network mode from auto subnet mode to custom subnet mode.
The async variant isNetworksClient::switchToCustomModeAsync() .
| Parameters | |
|---|---|
| Name | Description |
request | Google\Cloud\Compute\V1\SwitchToCustomModeNetworkRequestA request to house fields associated with the call. |
callOptions | arrayOptional. |
↳ retrySettings | RetrySettings|arrayRetry settings to use for this call. Can be aGoogle\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation onGoogle\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse | |
use Google\ApiCore\ApiException;use Google\ApiCore\OperationResponse;use Google\Cloud\Compute\V1\Client\NetworksClient;use Google\Cloud\Compute\V1\SwitchToCustomModeNetworkRequest;use Google\Rpc\Status;/** * @param string $network Name of the network to be updated. * @param string $project Project ID for this request. */function switch_to_custom_mode_sample(string $network, string $project): void{ // Create a client. $networksClient = new NetworksClient(); // Prepare the request message. $request = (new SwitchToCustomModeNetworkRequest()) ->setNetwork($network) ->setProject($project); // Call the API and handle any network failures. try { /** @var OperationResponse $response */ $response = $networksClient->switchToCustomMode($request); $response->pollUntilComplete(); if ($response->operationSucceeded()) { printf('Operation completed successfully.' . PHP_EOL); } else { /** @var Status $error */ $error = $response->getError(); printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString()); } } catch (ApiException $ex) { printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage()); }}/** * Helper to execute the sample. * * This sample has been automatically generated and should be regarded as a code * template only. It will require modifications to work: * - It may require correct/in-range values for request initialization. * - It may require specifying regional endpoints when creating the service client, * please see the apiEndpoint client configuration option for more details. */function callSample(): void{ $network = '[NETWORK]'; $project = '[PROJECT]'; switch_to_custom_mode_sample($network, $project);}updatePeering
Updates the specified network peering with the data included in therequest. You can only modify the NetworkPeering.export_custom_routes fieldand the NetworkPeering.import_custom_routes field.
The async variant isNetworksClient::updatePeeringAsync() .
| Parameters | |
|---|---|
| Name | Description |
request | Google\Cloud\Compute\V1\UpdatePeeringNetworkRequestA request to house fields associated with the call. |
callOptions | arrayOptional. |
↳ retrySettings | RetrySettings|arrayRetry settings to use for this call. Can be aGoogle\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation onGoogle\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse | |
use Google\ApiCore\ApiException;use Google\ApiCore\OperationResponse;use Google\Cloud\Compute\V1\Client\NetworksClient;use Google\Cloud\Compute\V1\NetworksUpdatePeeringRequest;use Google\Cloud\Compute\V1\UpdatePeeringNetworkRequest;use Google\Rpc\Status;/** * @param string $network Name of the network resource which the updated peering is belonging to. * @param string $project Project ID for this request. */function update_peering_sample(string $network, string $project): void{ // Create a client. $networksClient = new NetworksClient(); // Prepare the request message. $networksUpdatePeeringRequestResource = new NetworksUpdatePeeringRequest(); $request = (new UpdatePeeringNetworkRequest()) ->setNetwork($network) ->setNetworksUpdatePeeringRequestResource($networksUpdatePeeringRequestResource) ->setProject($project); // Call the API and handle any network failures. try { /** @var OperationResponse $response */ $response = $networksClient->updatePeering($request); $response->pollUntilComplete(); if ($response->operationSucceeded()) { printf('Operation completed successfully.' . PHP_EOL); } else { /** @var Status $error */ $error = $response->getError(); printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString()); } } catch (ApiException $ex) { printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage()); }}/** * Helper to execute the sample. * * This sample has been automatically generated and should be regarded as a code * template only. It will require modifications to work: * - It may require correct/in-range values for request initialization. * - It may require specifying regional endpoints when creating the service client, * please see the apiEndpoint client configuration option for more details. */function callSample(): void{ $network = '[NETWORK]'; $project = '[PROJECT]'; update_peering_sample($network, $project);}addPeeringAsync
| Parameters | |
|---|---|
| Name | Description |
request | Google\Cloud\Compute\V1\AddPeeringNetworkRequest |
optionalArgs | array |
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> | |
deleteAsync
| Parameters | |
|---|---|
| Name | Description |
request | Google\Cloud\Compute\V1\DeleteNetworkRequest |
optionalArgs | array |
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> | |
getAsync
| Parameters | |
|---|---|
| Name | Description |
request | Google\Cloud\Compute\V1\GetNetworkRequest |
optionalArgs | array |
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Compute\V1\Network> | |
getEffectiveFirewallsAsync
| Parameters | |
|---|---|
| Name | Description |
request | Google\Cloud\Compute\V1\GetEffectiveFirewallsNetworkRequest |
optionalArgs | array |
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Compute\V1\NetworksGetEffectiveFirewallsResponse> | |
insertAsync
| Parameters | |
|---|---|
| Name | Description |
request | Google\Cloud\Compute\V1\InsertNetworkRequest |
optionalArgs | array |
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> | |
listAsync
| Parameters | |
|---|---|
| Name | Description |
request | Google\Cloud\Compute\V1\ListNetworksRequest |
optionalArgs | array |
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> | |
listPeeringRoutesAsync
| Parameters | |
|---|---|
| Name | Description |
request | Google\Cloud\Compute\V1\ListPeeringRoutesNetworksRequest |
optionalArgs | array |
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> | |
patchAsync
| Parameters | |
|---|---|
| Name | Description |
request | Google\Cloud\Compute\V1\PatchNetworkRequest |
optionalArgs | array |
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> | |
removePeeringAsync
| Parameters | |
|---|---|
| Name | Description |
request | Google\Cloud\Compute\V1\RemovePeeringNetworkRequest |
optionalArgs | array |
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> | |
requestRemovePeeringAsync
| Parameters | |
|---|---|
| Name | Description |
request | Google\Cloud\Compute\V1\RequestRemovePeeringNetworkRequest |
optionalArgs | array |
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> | |
switchToCustomModeAsync
| Parameters | |
|---|---|
| Name | Description |
request | Google\Cloud\Compute\V1\SwitchToCustomModeNetworkRequest |
optionalArgs | array |
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> | |
updatePeeringAsync
| Parameters | |
|---|---|
| Name | Description |
request | Google\Cloud\Compute\V1\UpdatePeeringNetworkRequest |
optionalArgs | array |
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> | |
getOperationsClient
Return an GlobalOperationsClient object with the same endpoint as $this.
| Returns | |
|---|---|
| Type | Description |
GlobalOperationsClient | |
resumeOperation
Resume an existing long running operation that was previously started by a longrunning API method. If $methodName is not provided, or does not match a longrunning API method, then the operation can still be resumed, but theOperationResponse object will not deserialize the final response.
| Parameters | |
|---|---|
| Name | Description |
operationName | stringThe name of the long running operation |
methodName | stringThe name of the method used to start the operation |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse | |
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-01-23 UTC.