public sealed class RegionsClientImpl : RegionsClientReference documentation and code samples for the Compute Engine v1 API class RegionsClientImpl.
Regions client wrapper implementation, for convenient use.
Namespace
Google.Cloud.Compute.V1Assembly
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 | RegionsRegionsClientThe underlying gRPC client. |
settings | RegionsSettingsThe base RegionsSettings used within this client. |
logger | ILoggerOptional ILogger to use within this client. |
Properties
GrpcClient
public override Regions.RegionsClient GrpcClient { get; }The underlying gRPC Regions client
| Property Value | |
|---|---|
| Type | Description |
RegionsRegionsClient | |
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.
| Parameters | |
|---|---|
| Name | Description |
request | GetRegionRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Region | The RPC response. |
GetAsync(GetRegionRequest, CallSettings)
public override Task<Region> GetAsync(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.
| Parameters | |
|---|---|
| Name | Description |
request | GetRegionRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskRegion | A Task containing the RPC response. |
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.
| Parameters | |
|---|---|
| Name | Description |
request | ListRegionsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableRegionListRegion | A pageable sequence of Region resources. |
ListAsync(ListRegionsRequest, CallSettings)
public override PagedAsyncEnumerable<RegionList, Region> ListAsync(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.
| Parameters | |
|---|---|
| Name | Description |
request | ListRegionsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableRegionListRegion | A pageable asynchronous sequence of Region resources. |