Compute Engine v1 API - Class Regions.RegionsBase (3.0.0)

[BindServiceMethod(typeof(Regions), "BindService")]
public abstract class Regions.RegionsBase

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

Base class for server-side implementations of Regions

Inheritance

object > Regions.RegionsBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Methods

Get(GetRegionRequest, ServerCallContext)

public virtual Task<Region> Get(GetRegionRequest request, ServerCallContext context)

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 received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskRegion`	The response to send back to the client (wrapped by a task).

List(ListRegionsRequest, ServerCallContext)

public virtual Task<RegionList> List(ListRegionsRequest request, ServerCallContext context)

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 received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskRegionList`	The response to send back to the client (wrapped by a task).