Service for the regions resource.
https://cloud.google.com/compute/docs/reference/rest/v1/regions
Equality
Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.
Performance
Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.
Thread Safety
Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.
Constructors
RegionsClient(RegionsClient const &)
Copy and move support
| Parameter | |
|---|---|
| Name | Description |
|
RegionsClient const &
|
RegionsClient(RegionsClient &&)
Copy and move support
| Parameter | |
|---|---|
| Name | Description |
|
RegionsClient &&
|
RegionsClient(std::shared_ptr< RegionsConnection >, Options)
| Parameters | |
|---|---|
| Name | Description |
connection |
std::shared_ptr< RegionsConnection >
|
opts |
Options
|
Operators
operator=(RegionsClient const &)
Copy and move support
| Parameter | |
|---|---|
| Name | Description |
|
RegionsClient const &
|
| Returns | |
|---|---|
| Type | Description |
RegionsClient & |
|
operator=(RegionsClient &&)
Copy and move support
| Parameter | |
|---|---|
| Name | Description |
|
RegionsClient &&
|
| Returns | |
|---|---|
| Type | Description |
RegionsClient & |
|
Functions
GetRegion(std::string const &, std::string const &, Options)
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. https://cloud.google.com/compute/docs/reference/rest/v1/regions/get
| Parameters | |
|---|---|
| Name | Description |
project |
std::string const &
Project ID for this request. |
region |
std::string const &
Name of the region resource to return. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Region > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.Region) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetRegion(google::cloud::cpp::compute::regions::v1::GetRegionRequest const &, Options)
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. https://cloud.google.com/compute/docs/reference/rest/v1/regions/get
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::cpp::compute::regions::v1::GetRegionRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Region > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.Region) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListRegions(std::string const &, Options)
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. https://cloud.google.com/compute/docs/reference/rest/v1/regions/list
| Parameters | |
|---|---|
| Name | Description |
project |
std::string const &
Project ID for this request. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::cpp::compute::v1::Region > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListRegions(google::cloud::cpp::compute::regions::v1::ListRegionsRequest, Options)
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. https://cloud.google.com/compute/docs/reference/rest/v1/regions/list
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::cpp::compute::regions::v1::ListRegionsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::cpp::compute::v1::Region > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |