Compute V1 Client - Class NetworksClient (1.21.0)

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 method calls that map to API methods.

Namespace

Google \ Cloud \ Compute \ V1 \ Client

Methods

__construct

Constructor.

Parameters
Name	Description
`options`	`array` Optional. Options for configuring the service API wrapper.
`↳ apiEndpoint`	`string` The address of the API remote host. May optionally include the port, formatted as "
`↳ credentials`	`string\|array\|FetchAuthTokenInterface\|CredentialsWrapper` The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
`↳ credentialsConfig`	`array` Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
`↳ disableRetries`	`bool` Determines whether or not retries defined by the client configuration should be disabled. Defaults to `false`.
`↳ clientConfig`	`string\|array` Client 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\|TransportInterface` The transport used for executing network requests. At the moment, supports only `rest`. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
`↳ transportConfig`	`array` Configuration 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 the Google\ApiCore\Transport\RestTransport::build() method for the supported options.
`↳ clientCertSource`	`callable` A 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.

addPeering

Adds a peering to the specified network.

The async variant is NetworksClient::addPeeringAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\AddPeeringNetworkRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

delete

Deletes the specified network.

The async variant is NetworksClient::deleteAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\DeleteNetworkRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

get

Returns the specified network.

The async variant is NetworksClient::getAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\GetNetworkRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Compute\V1\Network`

getEffectiveFirewalls

Returns the effective firewalls on a given network.

The async variant is NetworksClient::getEffectiveFirewallsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\GetEffectiveFirewallsNetworkRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Compute\V1\NetworksGetEffectiveFirewallsResponse`

insert

Creates a network in the specified project using the data included in the request.

The async variant is NetworksClient::insertAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\InsertNetworkRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

list

Retrieves the list of networks available to the specified project.

The async variant is NetworksClient::listAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\ListNetworksRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

listPeeringRoutes

Lists the peering routes exchanged over peering connection.

The async variant is NetworksClient::listPeeringRoutesAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\ListPeeringRoutesNetworksRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

patch

Patches the specified network with the data included in the request. Only routingConfig can be modified.

The async variant is NetworksClient::patchAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\PatchNetworkRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

removePeering

Removes a peering from the specified network.

The async variant is NetworksClient::removePeeringAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\RemovePeeringNetworkRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

switchToCustomMode

Switches the network mode from auto subnet mode to custom subnet mode.

The async variant is NetworksClient::switchToCustomModeAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\SwitchToCustomModeNetworkRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

updatePeering

Updates the specified network peering with the data included in the request. You can only modify the NetworkPeering.export_custom_routes field and the NetworkPeering.import_custom_routes field.

The async variant is NetworksClient::updatePeeringAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\UpdatePeeringNetworkRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

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>`

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
`Google\Cloud\Compute\V1\GlobalOperationsClient`

resumeOperation

Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.

Parameters
Name	Description
`operationName`	`string` The name of the long running operation
`methodName`	`string` The name of the method used to start the operation

Returns
Type	Description
`Google\ApiCore\OperationResponse`