Compute Engine v1 API - Class RegionsClientImpl (3.2.0)

public sealed class RegionsClientImpl : RegionsClient

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

Regions client wrapper implementation, for convenient use.

Inheritance

object > RegionsClient > RegionsClientImpl

Inherited Members

RegionsClient.DefaultEndpoint

RegionsClient.DefaultScopes

RegionsClient.ServiceMetadata

RegionsClient.CreateAsync(CancellationToken)

RegionsClient.Create()

RegionsClient.ShutdownDefaultChannelsAsync()

RegionsClient.GetAsync(GetRegionRequest, CancellationToken)

RegionsClient.Get(string, string, CallSettings)

RegionsClient.GetAsync(string, string, CallSettings)

RegionsClient.GetAsync(string, string, CancellationToken)

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

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

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The Regions API.

Constructors

RegionsClientImpl(RegionsClient, RegionsSettings, ILogger)

public RegionsClientImpl(Regions.RegionsClient grpcClient, RegionsSettings settings, ILogger logger)

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

Parameters
Name	Description
`grpcClient`	`RegionsRegionsClient` The underlying gRPC client.
`settings`	`RegionsSettings` The base RegionsSettings used within this client.
`logger`	`ILogger` Optional ILogger to use within this client.

Properties

GrpcClient

public override Regions.RegionsClient GrpcClient { get; }

The underlying gRPC Regions client

Property Value
Type	Description
`RegionsRegionsClient`

Overrides

RegionsClient.GrpcClient

Methods

Get(GetRegionRequest, CallSettings)

public override Region Get(GetRegionRequest request, CallSettings callSettings = null)

Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the quotas field). To exclude one or more fields, set your request's fields query parameter to only include the fields you need. For example, to only include the id and selfLink fields, add the query parameter ?fields=id,selfLink to your request. This method fails if the quota information is unavailable for the region and if the organization policy constraint compute.requireBasicQuotaInResponse is enforced. This constraint, when enforced, disables the fail-open behaviour when quota information (the items.quotas field) is unavailable for the region. It is recommended to use the default setting for the constraint unless your application requires the fail-closed behaviour for this method.

Parameters
Name	Description
`request`	`GetRegionRequest` 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
`Region`	The RPC response.

Overrides

RegionsClient.Get(GetRegionRequest, CallSettings)

GetAsync(GetRegionRequest, CallSettings)

public override Task<Region> GetAsync(GetRegionRequest request, CallSettings callSettings = null)

Parameters
Name	Description
`request`	`GetRegionRequest` 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
`TaskRegion`	A Task containing the RPC response.

Overrides

RegionsClient.GetAsync(GetRegionRequest, CallSettings)

List(ListRegionsRequest, CallSettings)

public override PagedEnumerable<RegionList, Region> List(ListRegionsRequest request, CallSettings callSettings = null)

Retrieves the list of region resources available to the specified project. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the items.quotas field). To exclude one or more fields, set your request's fields query parameter to only include the fields you need. For example, to only include the id and selfLink fields, add the query parameter ?fields=id,selfLink to your request. This method fails if the quota information is unavailable for the region and if the organization policy constraint compute.requireBasicQuotaInResponse is enforced. This constraint, when enforced, disables the fail-open behaviour when quota information (the items.quotas field) is unavailable for the region. It is recommended to use the default setting for the constraint unless your application requires the fail-closed behaviour for this method.

Parameters
Name	Description
`request`	`ListRegionsRequest` 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
`PagedEnumerableRegionListRegion`	A pageable sequence of Region resources.

Overrides

RegionsClient.List(ListRegionsRequest, CallSettings)

ListAsync(ListRegionsRequest, CallSettings)

public override PagedAsyncEnumerable<RegionList, Region> ListAsync(ListRegionsRequest request, CallSettings callSettings = null)

Parameters
Name	Description
`request`	`ListRegionsRequest` 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
`PagedAsyncEnumerableRegionListRegion`	A pageable asynchronous sequence of Region resources.

Overrides

RegionsClient.ListAsync(ListRegionsRequest, CallSettings)