Compute Engine v1 API - Class NetworksClientImpl (2.16.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

Inherited Members

NetworksClient.DefaultEndpoint

NetworksClient.DefaultScopes

NetworksClient.ServiceMetadata

NetworksClient.CreateAsync(CancellationToken)

NetworksClient.Create()

NetworksClient.ShutdownDefaultChannelsAsync()

NetworksClient.AddPeeringAsync(AddPeeringNetworkRequest, CancellationToken)

NetworksClient.PollOnceAddPeering(string, CallSettings)

NetworksClient.PollOnceAddPeeringAsync(string, CallSettings)

NetworksClient.AddPeering(string, string, NetworksAddPeeringRequest, CallSettings)

NetworksClient.AddPeeringAsync(string, string, NetworksAddPeeringRequest, CallSettings)

NetworksClient.AddPeeringAsync(string, string, NetworksAddPeeringRequest, CancellationToken)

NetworksClient.DeleteAsync(DeleteNetworkRequest, CancellationToken)

NetworksClient.PollOnceDelete(string, CallSettings)

NetworksClient.PollOnceDeleteAsync(string, CallSettings)

NetworksClient.Delete(string, string, CallSettings)

NetworksClient.DeleteAsync(string, string, CallSettings)

NetworksClient.DeleteAsync(string, string, CancellationToken)

NetworksClient.GetAsync(GetNetworkRequest, CancellationToken)

NetworksClient.Get(string, string, CallSettings)

NetworksClient.GetAsync(string, string, CallSettings)

NetworksClient.GetAsync(string, string, CancellationToken)

NetworksClient.GetEffectiveFirewallsAsync(GetEffectiveFirewallsNetworkRequest, CancellationToken)

NetworksClient.GetEffectiveFirewalls(string, string, CallSettings)

NetworksClient.GetEffectiveFirewallsAsync(string, string, CallSettings)

NetworksClient.GetEffectiveFirewallsAsync(string, string, CancellationToken)

NetworksClient.InsertAsync(InsertNetworkRequest, CancellationToken)

NetworksClient.PollOnceInsert(string, CallSettings)

NetworksClient.PollOnceInsertAsync(string, CallSettings)

NetworksClient.Insert(string, Network, CallSettings)

NetworksClient.InsertAsync(string, Network, CallSettings)

NetworksClient.InsertAsync(string, Network, CancellationToken)

NetworksClient.List(string, string, int?, CallSettings)

NetworksClient.ListAsync(string, string, int?, CallSettings)

NetworksClient.ListPeeringRoutes(string, string, string, int?, CallSettings)

NetworksClient.ListPeeringRoutesAsync(string, string, string, int?, CallSettings)

NetworksClient.PatchAsync(PatchNetworkRequest, CancellationToken)

NetworksClient.PollOncePatch(string, CallSettings)

NetworksClient.PollOncePatchAsync(string, CallSettings)

NetworksClient.Patch(string, string, Network, CallSettings)

NetworksClient.PatchAsync(string, string, Network, CallSettings)

NetworksClient.PatchAsync(string, string, Network, CancellationToken)

NetworksClient.RemovePeeringAsync(RemovePeeringNetworkRequest, CancellationToken)

NetworksClient.PollOnceRemovePeering(string, CallSettings)

NetworksClient.PollOnceRemovePeeringAsync(string, CallSettings)

NetworksClient.RemovePeering(string, string, NetworksRemovePeeringRequest, CallSettings)

NetworksClient.RemovePeeringAsync(string, string, NetworksRemovePeeringRequest, CallSettings)

NetworksClient.RemovePeeringAsync(string, string, NetworksRemovePeeringRequest, CancellationToken)

NetworksClient.SwitchToCustomModeAsync(SwitchToCustomModeNetworkRequest, CancellationToken)

NetworksClient.PollOnceSwitchToCustomMode(string, CallSettings)

NetworksClient.PollOnceSwitchToCustomModeAsync(string, CallSettings)

NetworksClient.SwitchToCustomMode(string, string, CallSettings)

NetworksClient.SwitchToCustomModeAsync(string, string, CallSettings)

NetworksClient.SwitchToCustomModeAsync(string, string, CancellationToken)

NetworksClient.UpdatePeeringAsync(UpdatePeeringNetworkRequest, CancellationToken)

NetworksClient.PollOnceUpdatePeering(string, CallSettings)

NetworksClient.PollOnceUpdatePeeringAsync(string, CallSettings)

NetworksClient.UpdatePeering(string, string, NetworksUpdatePeeringRequest, CallSettings)

NetworksClient.UpdatePeeringAsync(string, string, NetworksUpdatePeeringRequest, CallSettings)

NetworksClient.UpdatePeeringAsync(string, string, NetworksUpdatePeeringRequest, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The Networks API.

Constructors

NetworksClientImpl(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
Name	Description
`grpcClient`	`NetworksNetworksClient` The underlying gRPC client.
`settings`	`NetworksSettings` The base NetworksSettings used within this client.
`logger`	`ILogger` Optional ILogger to use within this client.

Properties

AddPeeringOperationsClient

public override OperationsClient AddPeeringOperationsClient { get; }

The long-running operations client for AddPeering.

Property Value
Type	Description
`OperationsClient`

Overrides

NetworksClient.AddPeeringOperationsClient

DeleteOperationsClient

public override OperationsClient DeleteOperationsClient { get; }

The long-running operations client for Delete.

Property Value
Type	Description
`OperationsClient`

Overrides

NetworksClient.DeleteOperationsClient

GrpcClient

public override Networks.NetworksClient GrpcClient { get; }

The underlying gRPC Networks client

Property Value
Type	Description
`NetworksNetworksClient`

Overrides

NetworksClient.GrpcClient

InsertOperationsClient

public override OperationsClient InsertOperationsClient { get; }

The long-running operations client for Insert.

Property Value
Type	Description
`OperationsClient`

Overrides

NetworksClient.InsertOperationsClient

PatchOperationsClient

public override OperationsClient PatchOperationsClient { get; }

The long-running operations client for Patch.

Property Value
Type	Description
`OperationsClient`

Overrides

NetworksClient.PatchOperationsClient

RemovePeeringOperationsClient

public override OperationsClient RemovePeeringOperationsClient { get; }

The long-running operations client for RemovePeering.

Property Value
Type	Description
`OperationsClient`

Overrides

NetworksClient.RemovePeeringOperationsClient

SwitchToCustomModeOperationsClient

public override OperationsClient SwitchToCustomModeOperationsClient { get; }

The long-running operations client for SwitchToCustomMode.

Property Value
Type	Description
`OperationsClient`

Overrides

NetworksClient.SwitchToCustomModeOperationsClient

UpdatePeeringOperationsClient

public override OperationsClient UpdatePeeringOperationsClient { get; }

The long-running operations client for UpdatePeering.

Property Value
Type	Description
`OperationsClient`

Overrides

NetworksClient.UpdatePeeringOperationsClient

Methods

AddPeering(AddPeeringNetworkRequest, CallSettings)

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

Adds a peering to the specified network.

Parameters
Name	Description
`request`	`AddPeeringNetworkRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`OperationOperationOperation`	The RPC response.

Overrides

NetworksClient.AddPeering(AddPeeringNetworkRequest, CallSettings)

AddPeeringAsync(AddPeeringNetworkRequest, CallSettings)

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

Adds a peering to the specified network.

Parameters
Name	Description
`request`	`AddPeeringNetworkRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskOperationOperationOperation`	A Task containing the RPC response.

Overrides

NetworksClient.AddPeeringAsync(AddPeeringNetworkRequest, CallSettings)

Delete(DeleteNetworkRequest, CallSettings)

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

Deletes the specified network.

Parameters
Name	Description
`request`	`DeleteNetworkRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`OperationOperationOperation`	The RPC response.

Overrides

NetworksClient.Delete(DeleteNetworkRequest, CallSettings)

DeleteAsync(DeleteNetworkRequest, CallSettings)

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

Deletes the specified network.

Parameters
Name	Description
`request`	`DeleteNetworkRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskOperationOperationOperation`	A Task containing the RPC response.

Overrides

NetworksClient.DeleteAsync(DeleteNetworkRequest, CallSettings)

Get(GetNetworkRequest, CallSettings)

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

Returns the specified network.

Parameters
Name	Description
`request`	`GetNetworkRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Network`	The RPC response.

Overrides

NetworksClient.Get(GetNetworkRequest, CallSettings)

GetAsync(GetNetworkRequest, CallSettings)

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

Returns the specified network.

Parameters
Name	Description
`request`	`GetNetworkRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskNetwork`	A Task containing the RPC response.

Overrides

NetworksClient.GetAsync(GetNetworkRequest, CallSettings)

GetEffectiveFirewalls(GetEffectiveFirewallsNetworkRequest, CallSettings)

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

Returns the effective firewalls on a given network.

Parameters
Name	Description
`request`	`GetEffectiveFirewallsNetworkRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`NetworksGetEffectiveFirewallsResponse`	The RPC response.

Overrides

NetworksClient.GetEffectiveFirewalls(GetEffectiveFirewallsNetworkRequest, CallSettings)

GetEffectiveFirewallsAsync(GetEffectiveFirewallsNetworkRequest, CallSettings)

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

Returns the effective firewalls on a given network.

Parameters
Name	Description
`request`	`GetEffectiveFirewallsNetworkRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskNetworksGetEffectiveFirewallsResponse`	A Task containing the RPC response.

Overrides

NetworksClient.GetEffectiveFirewallsAsync(GetEffectiveFirewallsNetworkRequest, CallSettings)

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
Name	Description
`request`	`InsertNetworkRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`OperationOperationOperation`	The RPC response.

Overrides

NetworksClient.Insert(InsertNetworkRequest, CallSettings)

InsertAsync(InsertNetworkRequest, CallSettings)

public override 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
Name	Description
`request`	`InsertNetworkRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskOperationOperationOperation`	A Task containing the RPC response.

Overrides

NetworksClient.InsertAsync(InsertNetworkRequest, CallSettings)

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
Name	Description
`request`	`ListNetworksRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedEnumerableNetworkListNetwork`	A pageable sequence of Network resources.

Overrides

NetworksClient.List(ListNetworksRequest, CallSettings)

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
Name	Description
`request`	`ListNetworksRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedAsyncEnumerableNetworkListNetwork`	A pageable asynchronous sequence of Network resources.

Overrides

NetworksClient.ListAsync(ListNetworksRequest, CallSettings)

ListPeeringRoutes(ListPeeringRoutesNetworksRequest, CallSettings)

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

Lists the peering routes exchanged over peering connection.

Parameters
Name	Description
`request`	`ListPeeringRoutesNetworksRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedEnumerableExchangedPeeringRoutesListExchangedPeeringRoute`	A pageable sequence of ExchangedPeeringRoute resources.

Overrides

NetworksClient.ListPeeringRoutes(ListPeeringRoutesNetworksRequest, CallSettings)

ListPeeringRoutesAsync(ListPeeringRoutesNetworksRequest, CallSettings)

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

Lists the peering routes exchanged over peering connection.

Parameters
Name	Description
`request`	`ListPeeringRoutesNetworksRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedAsyncEnumerableExchangedPeeringRoutesListExchangedPeeringRoute`	A pageable asynchronous sequence of ExchangedPeeringRoute resources.

Overrides

NetworksClient.ListPeeringRoutesAsync(ListPeeringRoutesNetworksRequest, CallSettings)

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
Name	Description
`request`	`PatchNetworkRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`OperationOperationOperation`	The RPC response.

Overrides

NetworksClient.Patch(PatchNetworkRequest, CallSettings)

PatchAsync(PatchNetworkRequest, CallSettings)

public override 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
Name	Description
`request`	`PatchNetworkRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskOperationOperationOperation`	A Task containing the RPC response.

Overrides

NetworksClient.PatchAsync(PatchNetworkRequest, CallSettings)

RemovePeering(RemovePeeringNetworkRequest, CallSettings)

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

Removes a peering from the specified network.

Parameters
Name	Description
`request`	`RemovePeeringNetworkRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`OperationOperationOperation`	The RPC response.

Overrides

NetworksClient.RemovePeering(RemovePeeringNetworkRequest, CallSettings)

RemovePeeringAsync(RemovePeeringNetworkRequest, CallSettings)

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

Removes a peering from the specified network.

Parameters
Name	Description
`request`	`RemovePeeringNetworkRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskOperationOperationOperation`	A Task containing the RPC response.

Overrides

NetworksClient.RemovePeeringAsync(RemovePeeringNetworkRequest, CallSettings)

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
Name	Description
`request`	`SwitchToCustomModeNetworkRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`OperationOperationOperation`	The RPC response.

Overrides

NetworksClient.SwitchToCustomMode(SwitchToCustomModeNetworkRequest, CallSettings)

SwitchToCustomModeAsync(SwitchToCustomModeNetworkRequest, CallSettings)

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

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

Parameters
Name	Description
`request`	`SwitchToCustomModeNetworkRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskOperationOperationOperation`	A Task containing the RPC response.

Overrides

NetworksClient.SwitchToCustomModeAsync(SwitchToCustomModeNetworkRequest, CallSettings)

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
Name	Description
`request`	`UpdatePeeringNetworkRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`OperationOperationOperation`	The RPC response.

Overrides

NetworksClient.UpdatePeering(UpdatePeeringNetworkRequest, CallSettings)

UpdatePeeringAsync(UpdatePeeringNetworkRequest, CallSettings)

public override 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
Name	Description
`request`	`UpdatePeeringNetworkRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskOperationOperationOperation`	A Task containing the RPC response.

Overrides

NetworksClient.UpdatePeeringAsync(UpdatePeeringNetworkRequest, CallSettings)