Compute Engine v1 API - Class SubnetworksClientImpl (3.0.0)

Version 3.0.0

• 3.1.0 (latest)
• 3.0.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.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

Inherited Members

SubnetworksClient.DefaultEndpoint

SubnetworksClient.DefaultScopes

SubnetworksClient.ServiceMetadata

SubnetworksClient.CreateAsync(CancellationToken)

SubnetworksClient.Create()

SubnetworksClient.ShutdownDefaultChannelsAsync()

SubnetworksClient.AggregatedList(string, string, int?, CallSettings)

SubnetworksClient.AggregatedListAsync(string, string, int?, CallSettings)

SubnetworksClient.DeleteAsync(DeleteSubnetworkRequest, CancellationToken)

SubnetworksClient.PollOnceDelete(string, CallSettings)

SubnetworksClient.PollOnceDeleteAsync(string, CallSettings)

SubnetworksClient.Delete(string, string, string, CallSettings)

SubnetworksClient.DeleteAsync(string, string, string, CallSettings)

SubnetworksClient.DeleteAsync(string, string, string, CancellationToken)

SubnetworksClient.ExpandIpCidrRangeAsync(ExpandIpCidrRangeSubnetworkRequest, CancellationToken)

SubnetworksClient.PollOnceExpandIpCidrRange(string, CallSettings)

SubnetworksClient.PollOnceExpandIpCidrRangeAsync(string, CallSettings)

SubnetworksClient.ExpandIpCidrRange(string, string, string, SubnetworksExpandIpCidrRangeRequest, CallSettings)

SubnetworksClient.ExpandIpCidrRangeAsync(string, string, string, SubnetworksExpandIpCidrRangeRequest, CallSettings)

SubnetworksClient.ExpandIpCidrRangeAsync(string, string, string, SubnetworksExpandIpCidrRangeRequest, CancellationToken)

SubnetworksClient.GetAsync(GetSubnetworkRequest, CancellationToken)

SubnetworksClient.Get(string, string, string, CallSettings)

SubnetworksClient.GetAsync(string, string, string, CallSettings)

SubnetworksClient.GetAsync(string, string, string, CancellationToken)

SubnetworksClient.GetIamPolicyAsync(GetIamPolicySubnetworkRequest, CancellationToken)

SubnetworksClient.GetIamPolicy(string, string, string, CallSettings)

SubnetworksClient.GetIamPolicyAsync(string, string, string, CallSettings)

SubnetworksClient.GetIamPolicyAsync(string, string, string, CancellationToken)

SubnetworksClient.InsertAsync(InsertSubnetworkRequest, CancellationToken)

SubnetworksClient.PollOnceInsert(string, CallSettings)

SubnetworksClient.PollOnceInsertAsync(string, CallSettings)

SubnetworksClient.Insert(string, string, Subnetwork, CallSettings)

SubnetworksClient.InsertAsync(string, string, Subnetwork, CallSettings)

SubnetworksClient.InsertAsync(string, string, Subnetwork, CancellationToken)

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

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

SubnetworksClient.ListUsable(string, string, int?, CallSettings)

SubnetworksClient.ListUsableAsync(string, string, int?, CallSettings)

SubnetworksClient.PatchAsync(PatchSubnetworkRequest, CancellationToken)

SubnetworksClient.PollOncePatch(string, CallSettings)

SubnetworksClient.PollOncePatchAsync(string, CallSettings)

SubnetworksClient.Patch(string, string, string, Subnetwork, CallSettings)

SubnetworksClient.PatchAsync(string, string, string, Subnetwork, CallSettings)

SubnetworksClient.PatchAsync(string, string, string, Subnetwork, CancellationToken)

SubnetworksClient.SetIamPolicyAsync(SetIamPolicySubnetworkRequest, CancellationToken)

SubnetworksClient.SetIamPolicy(string, string, string, RegionSetPolicyRequest, CallSettings)

SubnetworksClient.SetIamPolicyAsync(string, string, string, RegionSetPolicyRequest, CallSettings)

SubnetworksClient.SetIamPolicyAsync(string, string, string, RegionSetPolicyRequest, CancellationToken)

SubnetworksClient.SetPrivateIpGoogleAccessAsync(SetPrivateIpGoogleAccessSubnetworkRequest, CancellationToken)

SubnetworksClient.PollOnceSetPrivateIpGoogleAccess(string, CallSettings)

SubnetworksClient.PollOnceSetPrivateIpGoogleAccessAsync(string, CallSettings)

SubnetworksClient.SetPrivateIpGoogleAccess(string, string, string, SubnetworksSetPrivateIpGoogleAccessRequest, CallSettings)

SubnetworksClient.SetPrivateIpGoogleAccessAsync(string, string, string, SubnetworksSetPrivateIpGoogleAccessRequest, CallSettings)

SubnetworksClient.SetPrivateIpGoogleAccessAsync(string, string, string, SubnetworksSetPrivateIpGoogleAccessRequest, CancellationToken)

SubnetworksClient.TestIamPermissionsAsync(TestIamPermissionsSubnetworkRequest, CancellationToken)

SubnetworksClient.TestIamPermissions(string, string, string, TestPermissionsRequest, CallSettings)

SubnetworksClient.TestIamPermissionsAsync(string, string, string, TestPermissionsRequest, CallSettings)

SubnetworksClient.TestIamPermissionsAsync(string, string, string, TestPermissionsRequest, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

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

SubnetworksClient.DeleteOperationsClient

ExpandIpCidrRangeOperationsClient

public override OperationsClient ExpandIpCidrRangeOperationsClient { get; }

The long-running operations client for ExpandIpCidrRange.

Property Value
Type	Description
OperationsClient

Overrides

SubnetworksClient.ExpandIpCidrRangeOperationsClient

GrpcClient

public override Subnetworks.SubnetworksClient GrpcClient { get; }

The underlying gRPC Subnetworks client

Property Value
Type	Description
SubnetworksSubnetworksClient

Overrides

SubnetworksClient.GrpcClient

InsertOperationsClient

public override OperationsClient InsertOperationsClient { get; }

The long-running operations client for Insert.

Property Value
Type	Description
OperationsClient

Overrides

SubnetworksClient.InsertOperationsClient

PatchOperationsClient

public override OperationsClient PatchOperationsClient { get; }

The long-running operations client for Patch.

Property Value
Type	Description
OperationsClient

Overrides

SubnetworksClient.PatchOperationsClient

SetPrivateIpGoogleAccessOperationsClient

public override OperationsClient SetPrivateIpGoogleAccessOperationsClient { get; }

The long-running operations client for SetPrivateIpGoogleAccess.

Property Value
Type	Description
OperationsClient

Overrides

SubnetworksClient.SetPrivateIpGoogleAccessOperationsClient

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

SubnetworksClient.AggregatedList(AggregatedListSubnetworksRequest, CallSettings)

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

SubnetworksClient.AggregatedListAsync(AggregatedListSubnetworksRequest, CallSettings)

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

SubnetworksClient.Delete(DeleteSubnetworkRequest, CallSettings)

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

SubnetworksClient.DeleteAsync(DeleteSubnetworkRequest, CallSettings)

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

SubnetworksClient.ExpandIpCidrRange(ExpandIpCidrRangeSubnetworkRequest, CallSettings)

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

SubnetworksClient.ExpandIpCidrRangeAsync(ExpandIpCidrRangeSubnetworkRequest, CallSettings)

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

SubnetworksClient.Get(GetSubnetworkRequest, CallSettings)

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

SubnetworksClient.GetAsync(GetSubnetworkRequest, CallSettings)

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

SubnetworksClient.GetIamPolicy(GetIamPolicySubnetworkRequest, CallSettings)

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

SubnetworksClient.GetIamPolicyAsync(GetIamPolicySubnetworkRequest, CallSettings)

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

SubnetworksClient.Insert(InsertSubnetworkRequest, CallSettings)

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

SubnetworksClient.InsertAsync(InsertSubnetworkRequest, CallSettings)

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

SubnetworksClient.List(ListSubnetworksRequest, CallSettings)

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

SubnetworksClient.ListAsync(ListSubnetworksRequest, CallSettings)

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

SubnetworksClient.ListUsable(ListUsableSubnetworksRequest, CallSettings)

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

SubnetworksClient.ListUsableAsync(ListUsableSubnetworksRequest, CallSettings)

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

SubnetworksClient.Patch(PatchSubnetworkRequest, CallSettings)

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

SubnetworksClient.PatchAsync(PatchSubnetworkRequest, CallSettings)

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

SubnetworksClient.SetIamPolicy(SetIamPolicySubnetworkRequest, CallSettings)

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

SubnetworksClient.SetIamPolicyAsync(SetIamPolicySubnetworkRequest, CallSettings)

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

SubnetworksClient.SetPrivateIpGoogleAccess(SetPrivateIpGoogleAccessSubnetworkRequest, CallSettings)

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

SubnetworksClient.SetPrivateIpGoogleAccessAsync(SetPrivateIpGoogleAccessSubnetworkRequest, CallSettings)

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

SubnetworksClient.TestIamPermissions(TestIamPermissionsSubnetworkRequest, CallSettings)

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

SubnetworksClient.TestIamPermissionsAsync(TestIamPermissionsSubnetworkRequest, CallSettings)