Compute Engine v1 API - Class SubnetworksClientImpl (2.16.0)

public sealed class SubnetworksClientImpl : SubnetworksClient

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

Subnetworks client wrapper implementation, for convenient use.

Inheritance

object > SubnetworksClient > SubnetworksClientImpl

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The Subnetworks API.

Constructors

SubnetworksClientImpl(SubnetworksClient, SubnetworksSettings, ILogger)

public SubnetworksClientImpl(Subnetworks.SubnetworksClient grpcClient, SubnetworksSettings settings, ILogger logger)

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

Parameters
Name Description
grpcClient SubnetworksSubnetworksClient

The underlying gRPC client.

settings SubnetworksSettings

The base SubnetworksSettings used within this client.

logger ILogger

Optional ILogger to use within this client.

Properties

DeleteOperationsClient

public override OperationsClient DeleteOperationsClient { get; }

The long-running operations client for Delete.

Property Value
Type Description
OperationsClient
Overrides

ExpandIpCidrRangeOperationsClient

public override OperationsClient ExpandIpCidrRangeOperationsClient { get; }

The long-running operations client for ExpandIpCidrRange.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override Subnetworks.SubnetworksClient GrpcClient { get; }

The underlying gRPC Subnetworks client

Property Value
Type Description
SubnetworksSubnetworksClient
Overrides

InsertOperationsClient

public override OperationsClient InsertOperationsClient { get; }

The long-running operations client for Insert.

Property Value
Type Description
OperationsClient
Overrides

PatchOperationsClient

public override OperationsClient PatchOperationsClient { get; }

The long-running operations client for Patch.

Property Value
Type Description
OperationsClient
Overrides

SetPrivateIpGoogleAccessOperationsClient

public override OperationsClient SetPrivateIpGoogleAccessOperationsClient { get; }

The long-running operations client for SetPrivateIpGoogleAccess.

Property Value
Type Description
OperationsClient
Overrides

Methods

AggregatedList(AggregatedListSubnetworksRequest, CallSettings)

public override PagedEnumerable<SubnetworkAggregatedList, KeyValuePair<string, SubnetworksScopedList>> AggregatedList(AggregatedListSubnetworksRequest request, CallSettings callSettings = null)

Retrieves an aggregated list of subnetworks. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Parameters
Name Description
request AggregatedListSubnetworksRequest

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
PagedEnumerableSubnetworkAggregatedListKeyValuePairstringSubnetworksScopedList

A pageable sequence of KeyValuePair<TKey, TValue> resources.

Overrides

AggregatedListAsync(AggregatedListSubnetworksRequest, CallSettings)

public override PagedAsyncEnumerable<SubnetworkAggregatedList, KeyValuePair<string, SubnetworksScopedList>> AggregatedListAsync(AggregatedListSubnetworksRequest request, CallSettings callSettings = null)

Retrieves an aggregated list of subnetworks. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Parameters
Name Description
request AggregatedListSubnetworksRequest

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
PagedAsyncEnumerableSubnetworkAggregatedListKeyValuePairstringSubnetworksScopedList

A pageable asynchronous sequence of KeyValuePair<TKey, TValue> resources.

Overrides

Delete(DeleteSubnetworkRequest, CallSettings)

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

Deletes the specified subnetwork.

Parameters
Name Description
request DeleteSubnetworkRequest

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

DeleteAsync(DeleteSubnetworkRequest, CallSettings)

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

Deletes the specified subnetwork.

Parameters
Name Description
request DeleteSubnetworkRequest

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

ExpandIpCidrRange(ExpandIpCidrRangeSubnetworkRequest, CallSettings)

public override Operation<Operation, Operation> ExpandIpCidrRange(ExpandIpCidrRangeSubnetworkRequest request, CallSettings callSettings = null)

Expands the IP CIDR range of the subnetwork to a specified value.

Parameters
Name Description
request ExpandIpCidrRangeSubnetworkRequest

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

ExpandIpCidrRangeAsync(ExpandIpCidrRangeSubnetworkRequest, CallSettings)

public override Task<Operation<Operation, Operation>> ExpandIpCidrRangeAsync(ExpandIpCidrRangeSubnetworkRequest request, CallSettings callSettings = null)

Expands the IP CIDR range of the subnetwork to a specified value.

Parameters
Name Description
request ExpandIpCidrRangeSubnetworkRequest

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

Get(GetSubnetworkRequest, CallSettings)

public override Subnetwork Get(GetSubnetworkRequest request, CallSettings callSettings = null)

Returns the specified subnetwork.

Parameters
Name Description
request GetSubnetworkRequest

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
Subnetwork

The RPC response.

Overrides

GetAsync(GetSubnetworkRequest, CallSettings)

public override Task<Subnetwork> GetAsync(GetSubnetworkRequest request, CallSettings callSettings = null)

Returns the specified subnetwork.

Parameters
Name Description
request GetSubnetworkRequest

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
TaskSubnetwork

A Task containing the RPC response.

Overrides

GetIamPolicy(GetIamPolicySubnetworkRequest, CallSettings)

public override Policy GetIamPolicy(GetIamPolicySubnetworkRequest request, CallSettings callSettings = null)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Parameters
Name Description
request GetIamPolicySubnetworkRequest

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
Policy

The RPC response.

Overrides

GetIamPolicyAsync(GetIamPolicySubnetworkRequest, CallSettings)

public override Task<Policy> GetIamPolicyAsync(GetIamPolicySubnetworkRequest request, CallSettings callSettings = null)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Parameters
Name Description
request GetIamPolicySubnetworkRequest

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
TaskPolicy

A Task containing the RPC response.

Overrides

Insert(InsertSubnetworkRequest, CallSettings)

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

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

Parameters
Name Description
request InsertSubnetworkRequest

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

InsertAsync(InsertSubnetworkRequest, CallSettings)

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

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

Parameters
Name Description
request InsertSubnetworkRequest

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

List(ListSubnetworksRequest, CallSettings)

public override PagedEnumerable<SubnetworkList, Subnetwork> List(ListSubnetworksRequest request, CallSettings callSettings = null)

Retrieves a list of subnetworks available to the specified project.

Parameters
Name Description
request ListSubnetworksRequest

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
PagedEnumerableSubnetworkListSubnetwork

A pageable sequence of Subnetwork resources.

Overrides

ListAsync(ListSubnetworksRequest, CallSettings)

public override PagedAsyncEnumerable<SubnetworkList, Subnetwork> ListAsync(ListSubnetworksRequest request, CallSettings callSettings = null)

Retrieves a list of subnetworks available to the specified project.

Parameters
Name Description
request ListSubnetworksRequest

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
PagedAsyncEnumerableSubnetworkListSubnetwork

A pageable asynchronous sequence of Subnetwork resources.

Overrides

ListUsable(ListUsableSubnetworksRequest, CallSettings)

public override PagedEnumerable<UsableSubnetworksAggregatedList, UsableSubnetwork> ListUsable(ListUsableSubnetworksRequest request, CallSettings callSettings = null)

Retrieves an aggregated list of all usable subnetworks in the project.

Parameters
Name Description
request ListUsableSubnetworksRequest

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
PagedEnumerableUsableSubnetworksAggregatedListUsableSubnetwork

A pageable sequence of UsableSubnetwork resources.

Overrides

ListUsableAsync(ListUsableSubnetworksRequest, CallSettings)

public override PagedAsyncEnumerable<UsableSubnetworksAggregatedList, UsableSubnetwork> ListUsableAsync(ListUsableSubnetworksRequest request, CallSettings callSettings = null)

Retrieves an aggregated list of all usable subnetworks in the project.

Parameters
Name Description
request ListUsableSubnetworksRequest

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
PagedAsyncEnumerableUsableSubnetworksAggregatedListUsableSubnetwork

A pageable asynchronous sequence of UsableSubnetwork resources.

Overrides

Patch(PatchSubnetworkRequest, CallSettings)

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

Patches the specified subnetwork with the data included in the request. Only certain fields can be updated with a patch request as indicated in the field descriptions. You must specify the current fingerprint of the subnetwork resource being patched.

Parameters
Name Description
request PatchSubnetworkRequest

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

PatchAsync(PatchSubnetworkRequest, CallSettings)

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

Patches the specified subnetwork with the data included in the request. Only certain fields can be updated with a patch request as indicated in the field descriptions. You must specify the current fingerprint of the subnetwork resource being patched.

Parameters
Name Description
request PatchSubnetworkRequest

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

SetIamPolicy(SetIamPolicySubnetworkRequest, CallSettings)

public override Policy SetIamPolicy(SetIamPolicySubnetworkRequest request, CallSettings callSettings = null)

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters
Name Description
request SetIamPolicySubnetworkRequest

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
Policy

The RPC response.

Overrides

SetIamPolicyAsync(SetIamPolicySubnetworkRequest, CallSettings)

public override Task<Policy> SetIamPolicyAsync(SetIamPolicySubnetworkRequest request, CallSettings callSettings = null)

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters
Name Description
request SetIamPolicySubnetworkRequest

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
TaskPolicy

A Task containing the RPC response.

Overrides

SetPrivateIpGoogleAccess(SetPrivateIpGoogleAccessSubnetworkRequest, CallSettings)

public override Operation<Operation, Operation> SetPrivateIpGoogleAccess(SetPrivateIpGoogleAccessSubnetworkRequest request, CallSettings callSettings = null)

Set whether VMs in this subnet can access Google services without assigning external IP addresses through Private Google Access.

Parameters
Name Description
request SetPrivateIpGoogleAccessSubnetworkRequest

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

SetPrivateIpGoogleAccessAsync(SetPrivateIpGoogleAccessSubnetworkRequest, CallSettings)

public override Task<Operation<Operation, Operation>> SetPrivateIpGoogleAccessAsync(SetPrivateIpGoogleAccessSubnetworkRequest request, CallSettings callSettings = null)

Set whether VMs in this subnet can access Google services without assigning external IP addresses through Private Google Access.

Parameters
Name Description
request SetPrivateIpGoogleAccessSubnetworkRequest

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

TestIamPermissions(TestIamPermissionsSubnetworkRequest, CallSettings)

public override TestPermissionsResponse TestIamPermissions(TestIamPermissionsSubnetworkRequest request, CallSettings callSettings = null)

Returns permissions that a caller has on the specified resource.

Parameters
Name Description
request TestIamPermissionsSubnetworkRequest

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
TestPermissionsResponse

The RPC response.

Overrides

TestIamPermissionsAsync(TestIamPermissionsSubnetworkRequest, CallSettings)

public override Task<TestPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsSubnetworkRequest request, CallSettings callSettings = null)

Returns permissions that a caller has on the specified resource.

Parameters
Name Description
request TestIamPermissionsSubnetworkRequest

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
TaskTestPermissionsResponse

A Task containing the RPC response.

Overrides