Compute Engine v1 API - Class NetworksClientImpl (2.5.0)

public sealed class NetworksClientImpl : NetworksClient

Reference documentation and code samples for the Compute Engine v1 API class NetworksClientImpl.

Networks client wrapper implementation, for convenient use.

Inheritance

Object > NetworksClient > NetworksClientImpl

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The Networks API.

Constructors

NetworksClientImpl(Networks.NetworksClient, NetworksSettings, ILogger)

public NetworksClientImpl(Networks.NetworksClient grpcClient, NetworksSettings settings, ILogger logger)

Constructs a client wrapper for the Networks service, with the specified gRPC client and settings.

Parameters
NameDescription
grpcClientNetworks.NetworksClient

The underlying gRPC client.

settingsNetworksSettings

The base NetworksSettings used within this client.

loggerILogger

Optional ILogger to use within this client.

Properties

AddPeeringOperationsClient

public override OperationsClient AddPeeringOperationsClient { get; }

The long-running operations client for AddPeering.

Property Value
TypeDescription
OperationsClient
Overrides

DeleteOperationsClient

public override OperationsClient DeleteOperationsClient { get; }

The long-running operations client for Delete.

Property Value
TypeDescription
OperationsClient
Overrides

GrpcClient

public override Networks.NetworksClient GrpcClient { get; }

The underlying gRPC Networks client

Property Value
TypeDescription
Networks.NetworksClient
Overrides

InsertOperationsClient

public override OperationsClient InsertOperationsClient { get; }

The long-running operations client for Insert.

Property Value
TypeDescription
OperationsClient
Overrides

PatchOperationsClient

public override OperationsClient PatchOperationsClient { get; }

The long-running operations client for Patch.

Property Value
TypeDescription
OperationsClient
Overrides

RemovePeeringOperationsClient

public override OperationsClient RemovePeeringOperationsClient { get; }

The long-running operations client for RemovePeering.

Property Value
TypeDescription
OperationsClient
Overrides

SwitchToCustomModeOperationsClient

public override OperationsClient SwitchToCustomModeOperationsClient { get; }

The long-running operations client for SwitchToCustomMode.

Property Value
TypeDescription
OperationsClient
Overrides

UpdatePeeringOperationsClient

public override OperationsClient UpdatePeeringOperationsClient { get; }

The long-running operations client for UpdatePeering.

Property Value
TypeDescription
OperationsClient
Overrides

Methods

AddPeering(AddPeeringNetworkRequest, CallSettings)

public override Operation<Operation, Operation> AddPeering(AddPeeringNetworkRequest request, CallSettings callSettings = null)

Adds a peering to the specified network.

Parameters
NameDescription
requestAddPeeringNetworkRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Operation, Operation>

The RPC response.

Overrides

AddPeeringAsync(AddPeeringNetworkRequest, CallSettings)

public override async Task<Operation<Operation, Operation>> AddPeeringAsync(AddPeeringNetworkRequest request, CallSettings callSettings = null)

Adds a peering to the specified network.

Parameters
NameDescription
requestAddPeeringNetworkRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Operation, Operation>>

A Task containing the RPC response.

Overrides

Delete(DeleteNetworkRequest, CallSettings)

public override Operation<Operation, Operation> Delete(DeleteNetworkRequest request, CallSettings callSettings = null)

Deletes the specified network.

Parameters
NameDescription
requestDeleteNetworkRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Operation, Operation>

The RPC response.

Overrides

DeleteAsync(DeleteNetworkRequest, CallSettings)

public override async Task<Operation<Operation, Operation>> DeleteAsync(DeleteNetworkRequest request, CallSettings callSettings = null)

Deletes the specified network.

Parameters
NameDescription
requestDeleteNetworkRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Operation, Operation>>

A Task containing the RPC response.

Overrides

Get(GetNetworkRequest, CallSettings)

public override Network Get(GetNetworkRequest request, CallSettings callSettings = null)

Returns the specified network. Gets a list of available networks by making a list() request.

Parameters
NameDescription
requestGetNetworkRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Network

The RPC response.

Overrides

GetAsync(GetNetworkRequest, CallSettings)

public override Task<Network> GetAsync(GetNetworkRequest request, CallSettings callSettings = null)

Returns the specified network. Gets a list of available networks by making a list() request.

Parameters
NameDescription
requestGetNetworkRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Network>

A Task containing the RPC response.

Overrides

GetEffectiveFirewalls(GetEffectiveFirewallsNetworkRequest, CallSettings)

public override NetworksGetEffectiveFirewallsResponse GetEffectiveFirewalls(GetEffectiveFirewallsNetworkRequest request, CallSettings callSettings = null)

Returns the effective firewalls on a given network.

Parameters
NameDescription
requestGetEffectiveFirewallsNetworkRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
NetworksGetEffectiveFirewallsResponse

The RPC response.

Overrides

GetEffectiveFirewallsAsync(GetEffectiveFirewallsNetworkRequest, CallSettings)

public override Task<NetworksGetEffectiveFirewallsResponse> GetEffectiveFirewallsAsync(GetEffectiveFirewallsNetworkRequest request, CallSettings callSettings = null)

Returns the effective firewalls on a given network.

Parameters
NameDescription
requestGetEffectiveFirewallsNetworkRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<NetworksGetEffectiveFirewallsResponse>

A Task containing the RPC response.

Overrides

Insert(InsertNetworkRequest, CallSettings)

public override Operation<Operation, Operation> Insert(InsertNetworkRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestInsertNetworkRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Operation, Operation>

The RPC response.

Overrides

InsertAsync(InsertNetworkRequest, CallSettings)

public override async Task<Operation<Operation, Operation>> InsertAsync(InsertNetworkRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestInsertNetworkRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Operation, Operation>>

A Task containing the RPC response.

Overrides

List(ListNetworksRequest, CallSettings)

public override PagedEnumerable<NetworkList, Network> List(ListNetworksRequest request, CallSettings callSettings = null)

Retrieves the list of networks available to the specified project.

Parameters
NameDescription
requestListNetworksRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<NetworkList, Network>

A pageable sequence of Network resources.

Overrides

ListAsync(ListNetworksRequest, CallSettings)

public override PagedAsyncEnumerable<NetworkList, Network> ListAsync(ListNetworksRequest request, CallSettings callSettings = null)

Retrieves the list of networks available to the specified project.

Parameters
NameDescription
requestListNetworksRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<NetworkList, Network>

A pageable asynchronous sequence of Network resources.

Overrides

ListPeeringRoutes(ListPeeringRoutesNetworksRequest, CallSettings)

public override PagedEnumerable<ExchangedPeeringRoutesList, ExchangedPeeringRoute> ListPeeringRoutes(ListPeeringRoutesNetworksRequest request, CallSettings callSettings = null)

Lists the peering routes exchanged over peering connection.

Parameters
NameDescription
requestListPeeringRoutesNetworksRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ExchangedPeeringRoutesList, ExchangedPeeringRoute>

A pageable sequence of ExchangedPeeringRoute resources.

Overrides

ListPeeringRoutesAsync(ListPeeringRoutesNetworksRequest, CallSettings)

public override PagedAsyncEnumerable<ExchangedPeeringRoutesList, ExchangedPeeringRoute> ListPeeringRoutesAsync(ListPeeringRoutesNetworksRequest request, CallSettings callSettings = null)

Lists the peering routes exchanged over peering connection.

Parameters
NameDescription
requestListPeeringRoutesNetworksRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ExchangedPeeringRoutesList, ExchangedPeeringRoute>

A pageable asynchronous sequence of ExchangedPeeringRoute resources.

Overrides

Patch(PatchNetworkRequest, CallSettings)

public override Operation<Operation, Operation> Patch(PatchNetworkRequest request, CallSettings callSettings = null)

Patches the specified network with the data included in the request. Only the following fields can be modified: routingConfig.routingMode.

Parameters
NameDescription
requestPatchNetworkRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Operation, Operation>

The RPC response.

Overrides

PatchAsync(PatchNetworkRequest, CallSettings)

public override async Task<Operation<Operation, Operation>> PatchAsync(PatchNetworkRequest request, CallSettings callSettings = null)

Patches the specified network with the data included in the request. Only the following fields can be modified: routingConfig.routingMode.

Parameters
NameDescription
requestPatchNetworkRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Operation, Operation>>

A Task containing the RPC response.

Overrides

RemovePeering(RemovePeeringNetworkRequest, CallSettings)

public override Operation<Operation, Operation> RemovePeering(RemovePeeringNetworkRequest request, CallSettings callSettings = null)

Removes a peering from the specified network.

Parameters
NameDescription
requestRemovePeeringNetworkRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Operation, Operation>

The RPC response.

Overrides

RemovePeeringAsync(RemovePeeringNetworkRequest, CallSettings)

public override async Task<Operation<Operation, Operation>> RemovePeeringAsync(RemovePeeringNetworkRequest request, CallSettings callSettings = null)

Removes a peering from the specified network.

Parameters
NameDescription
requestRemovePeeringNetworkRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Operation, Operation>>

A Task containing the RPC response.

Overrides

SwitchToCustomMode(SwitchToCustomModeNetworkRequest, CallSettings)

public override Operation<Operation, Operation> SwitchToCustomMode(SwitchToCustomModeNetworkRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestSwitchToCustomModeNetworkRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Operation, Operation>

The RPC response.

Overrides

SwitchToCustomModeAsync(SwitchToCustomModeNetworkRequest, CallSettings)

public override async Task<Operation<Operation, Operation>> SwitchToCustomModeAsync(SwitchToCustomModeNetworkRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestSwitchToCustomModeNetworkRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Operation, Operation>>

A Task containing the RPC response.

Overrides

UpdatePeering(UpdatePeeringNetworkRequest, CallSettings)

public override Operation<Operation, Operation> UpdatePeering(UpdatePeeringNetworkRequest request, CallSettings callSettings = null)

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.

Parameters
NameDescription
requestUpdatePeeringNetworkRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Operation, Operation>

The RPC response.

Overrides

UpdatePeeringAsync(UpdatePeeringNetworkRequest, CallSettings)

public override async Task<Operation<Operation, Operation>> UpdatePeeringAsync(UpdatePeeringNetworkRequest request, CallSettings callSettings = null)

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.

Parameters
NameDescription
requestUpdatePeeringNetworkRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Operation, Operation>>

A Task containing the RPC response.

Overrides