Class RegionInstanceTemplatesClient (2.21.0)

Version 2.21.0

• 2.25.0-rc (latest)
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.1

Service for the regionInstanceTemplates resource.

https://cloud.google.com/compute/docs/reference/rest/v1/regionInstanceTemplates

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

RegionInstanceTemplatesClient(RegionInstanceTemplatesClient const &)

Copy and move support

Parameter
Name	Description
	RegionInstanceTemplatesClient const &

RegionInstanceTemplatesClient(RegionInstanceTemplatesClient &&)

Copy and move support

Parameter
Name	Description
	RegionInstanceTemplatesClient &&

RegionInstanceTemplatesClient(std::shared_ptr< RegionInstanceTemplatesConnection >, Options)

Parameters
Name	Description
connection	std::shared_ptr< RegionInstanceTemplatesConnection >
opts	Options

Operators

operator=(RegionInstanceTemplatesClient const &)

Copy and move support

Parameter
Name	Description
	RegionInstanceTemplatesClient const &

Returns
Type	Description
RegionInstanceTemplatesClient &

operator=(RegionInstanceTemplatesClient &&)

Copy and move support

Parameter
Name	Description
	RegionInstanceTemplatesClient &&

Returns
Type	Description
RegionInstanceTemplatesClient &

Functions

DeleteInstanceTemplate(std::string const &, std::string const &, std::string const &, Options)

Deletes the specified instance template.

Deleting an instance template is permanent and cannot be undone. https://cloud.google.com/compute/docs/reference/rest/v1/regionInstanceTemplates/delete

Parameters
Name	Description
project	std::string const & Project ID for this request.
region	std::string const & The name of the region for this request.
instance_template	std::string const & The name of the instance template to delete.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::cpp::compute::v1::Operation > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a [google.cloud.cpp.compute.v1.Operation] proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteInstanceTemplate(google::cloud::cpp::compute::region_instance_templates::v1::DeleteInstanceTemplateRequest const &, Options)

Deletes the specified instance template.

Deleting an instance template is permanent and cannot be undone. https://cloud.google.com/compute/docs/reference/rest/v1/regionInstanceTemplates/delete

Parameters
Name	Description
request	google::cloud::cpp::compute::region_instance_templates::v1::DeleteInstanceTemplateRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.cpp.compute.region_instance_templates.v1.DeleteInstanceTemplateRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::cpp::compute::v1::Operation > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a [google.cloud.cpp.compute.v1.Operation] proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

GetInstanceTemplate(std::string const &, std::string const &, std::string const &, Options)

Returns the specified instance template.

https://cloud.google.com/compute/docs/reference/rest/v1/regionInstanceTemplates/get

Parameters
Name	Description
project	std::string const & Project ID for this request.
region	std::string const & The name of the region for this request.
instance_template	std::string const & The name of the instance template.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::cpp::compute::v1::InstanceTemplate >	the result of the RPC. The response message type (google.cloud.cpp.compute.v1.InstanceTemplate) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetInstanceTemplate(google::cloud::cpp::compute::region_instance_templates::v1::GetInstanceTemplateRequest const &, Options)

Returns the specified instance template.

https://cloud.google.com/compute/docs/reference/rest/v1/regionInstanceTemplates/get

Parameters
Name	Description
request	google::cloud::cpp::compute::region_instance_templates::v1::GetInstanceTemplateRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.cpp.compute.region_instance_templates.v1.GetInstanceTemplateRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::cpp::compute::v1::InstanceTemplate >	the result of the RPC. The response message type (google.cloud.cpp.compute.v1.InstanceTemplate) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

InsertInstanceTemplate(std::string const &, std::string const &, google::cloud::cpp::compute::v1::InstanceTemplate const &, Options)

Creates an instance template in the specified project and region using the global instance template whose URL is included in the request.

https://cloud.google.com/compute/docs/reference/rest/v1/regionInstanceTemplates/insert

Parameters
Name	Description
project	std::string const & Project ID for this request.
region	std::string const & The name of the region for this request.
instance_template_resource	google::cloud::cpp::compute::v1::InstanceTemplate const & The InstanceTemplate for this request.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::cpp::compute::v1::Operation > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a [google.cloud.cpp.compute.v1.Operation] proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

InsertInstanceTemplate(google::cloud::cpp::compute::region_instance_templates::v1::InsertInstanceTemplateRequest const &, Options)

Creates an instance template in the specified project and region using the global instance template whose URL is included in the request.

https://cloud.google.com/compute/docs/reference/rest/v1/regionInstanceTemplates/insert

Parameters
Name	Description
request	google::cloud::cpp::compute::region_instance_templates::v1::InsertInstanceTemplateRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.cpp.compute.region_instance_templates.v1.InsertInstanceTemplateRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::cpp::compute::v1::Operation > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a [google.cloud.cpp.compute.v1.Operation] proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ListRegionInstanceTemplates(std::string const &, std::string const &, Options)

Retrieves a list of instance templates that are contained within the specified project and region.

https://cloud.google.com/compute/docs/reference/rest/v1/regionInstanceTemplates/list

Parameters
Name	Description
project	std::string const & Project ID for this request.
region	std::string const & The name of the regions 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::InstanceTemplate >	a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.cpp.compute.v1.InstanceTemplate, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListRegionInstanceTemplates(google::cloud::cpp::compute::region_instance_templates::v1::ListRegionInstanceTemplatesRequest, Options)

Retrieves a list of instance templates that are contained within the specified project and region.

https://cloud.google.com/compute/docs/reference/rest/v1/regionInstanceTemplates/list

Parameters
Name	Description
request	google::cloud::cpp::compute::region_instance_templates::v1::ListRegionInstanceTemplatesRequest Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.cpp.compute.region_instance_templates.v1.ListRegionInstanceTemplatesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::cpp::compute::v1::InstanceTemplate >	a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.cpp.compute.v1.InstanceTemplate, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.