Service for the instanceTemplates resource.
https://cloud.google.com/compute/docs/reference/rest/v1/instanceTemplates
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
InstanceTemplatesClient(InstanceTemplatesClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
InstanceTemplatesClient const &
|
InstanceTemplatesClient(InstanceTemplatesClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
InstanceTemplatesClient &&
|
InstanceTemplatesClient(std::shared_ptr< InstanceTemplatesConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< InstanceTemplatesConnection >
|
opts |
Options
|
Operators
operator=(InstanceTemplatesClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
InstanceTemplatesClient const &
|
Returns | |
---|---|
Type | Description |
InstanceTemplatesClient & |
operator=(InstanceTemplatesClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
InstanceTemplatesClient &&
|
Returns | |
---|---|
Type | Description |
InstanceTemplatesClient & |
Functions
AggregatedListInstanceTemplates(std::string const &, Options)
Retrieves the list of all InstanceTemplates resources, regional and global, available to the specified project.
To prevent failure, Google recommends that you set the returnPartialSuccess
parameter to true
. https://cloud.google.com/compute/docs/reference/rest/v1/instanceTemplates/aggregatedList
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Name of the project scoping this request. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< std::pair< std::string, google::cloud::cpp::compute::v1::InstanceTemplatesScopedList > > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
AggregatedListInstanceTemplates(google::cloud::cpp::compute::instance_templates::v1::AggregatedListInstanceTemplatesRequest, Options)
Retrieves the list of all InstanceTemplates resources, regional and global, available to the specified project.
To prevent failure, Google recommends that you set the returnPartialSuccess
parameter to true
. https://cloud.google.com/compute/docs/reference/rest/v1/instanceTemplates/aggregatedList
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::instance_templates::v1::AggregatedListInstanceTemplatesRequest
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< std::pair< std::string, google::cloud::cpp::compute::v1::InstanceTemplatesScopedList > > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
DeleteInstanceTemplate(std::string const &, std::string const &, Options)
Deletes the specified instance template.
Deleting an instance template is permanent and cannot be undone. It is not possible to delete templates that are already in use by a managed instance group. https://cloud.google.com/compute/docs/reference/rest/v1/instanceTemplates/delete
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID 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 |
DeleteInstanceTemplate(NoAwaitTag, std::string const &, std::string const &, Options)
Deletes the specified instance template.
Specifying the NoAwaitTag
immediately returns the [google::cloud::cpp::compute::v1::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
project |
std::string const &
|
instance_template |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
DeleteInstanceTemplate(google::cloud::cpp::compute::instance_templates::v1::DeleteInstanceTemplateRequest const &, Options)
Deletes the specified instance template.
Deleting an instance template is permanent and cannot be undone. It is not possible to delete templates that are already in use by a managed instance group. https://cloud.google.com/compute/docs/reference/rest/v1/instanceTemplates/delete
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::instance_templates::v1::DeleteInstanceTemplateRequest 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 |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
A |
DeleteInstanceTemplate(NoAwaitTag, google::cloud::cpp::compute::instance_templates::v1::DeleteInstanceTemplateRequest const &, Options)
Deletes the specified instance template.
Specifying the NoAwaitTag
immediately returns the [google::cloud::cpp::compute::v1::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::cpp::compute::instance_templates::v1::DeleteInstanceTemplateRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
DeleteInstanceTemplate(google::cloud::cpp::compute::v1::Operation const &, Options)
Deletes the specified instance template.
This method accepts a google::cloud::cpp::compute::v1::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::cloud::cpp::compute::v1::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
GetInstanceTemplate(std::string const &, std::string const &, Options)
Returns the specified instance template.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID 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 |
GetInstanceTemplate(google::cloud::cpp::compute::instance_templates::v1::GetInstanceTemplateRequest const &, Options)
Returns the specified instance template.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::instance_templates::v1::GetInstanceTemplateRequest 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::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 |
GetIamPolicy(std::string const &, std::string const &, Options)
Gets the access control policy for a resource.
May be empty if no such policy or resource exists. https://cloud.google.com/compute/docs/reference/rest/v1/instanceTemplates/getIamPolicy
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
resource |
std::string const &
Name or id of the resource for this request. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Policy > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetIamPolicy(google::cloud::cpp::compute::instance_templates::v1::GetIamPolicyRequest const &, Options)
Gets the access control policy for a resource.
May be empty if no such policy or resource exists. https://cloud.google.com/compute/docs/reference/rest/v1/instanceTemplates/getIamPolicy
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::instance_templates::v1::GetIamPolicyRequest 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::Policy > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
InsertInstanceTemplate(std::string const &, google::cloud::cpp::compute::v1::InstanceTemplate const &, Options)
Creates an instance template in the specified project using the data that is included in the request.
If you are creating a new template to update an existing instance group, your new instance template must use the same network or, if applicable, the same subnetwork as the original template. https://cloud.google.com/compute/docs/reference/rest/v1/instanceTemplates/insert
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID 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 |
InsertInstanceTemplate(NoAwaitTag, std::string const &, google::cloud::cpp::compute::v1::InstanceTemplate const &, Options)
Creates an instance template in the specified project using the data that is included in the request.
Specifying the NoAwaitTag
immediately returns the [google::cloud::cpp::compute::v1::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
project |
std::string const &
|
instance_template_resource |
google::cloud::cpp::compute::v1::InstanceTemplate const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
InsertInstanceTemplate(google::cloud::cpp::compute::instance_templates::v1::InsertInstanceTemplateRequest const &, Options)
Creates an instance template in the specified project using the data that is included in the request.
If you are creating a new template to update an existing instance group, your new instance template must use the same network or, if applicable, the same subnetwork as the original template. https://cloud.google.com/compute/docs/reference/rest/v1/instanceTemplates/insert
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::instance_templates::v1::InsertInstanceTemplateRequest 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 |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
A |
InsertInstanceTemplate(NoAwaitTag, google::cloud::cpp::compute::instance_templates::v1::InsertInstanceTemplateRequest const &, Options)
Creates an instance template in the specified project using the data that is included in the request.
Specifying the NoAwaitTag
immediately returns the [google::cloud::cpp::compute::v1::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::cpp::compute::instance_templates::v1::InsertInstanceTemplateRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
InsertInstanceTemplate(google::cloud::cpp::compute::v1::Operation const &, Options)
Creates an instance template in the specified project using the data that is included in the request.
This method accepts a google::cloud::cpp::compute::v1::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::cloud::cpp::compute::v1::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
ListInstanceTemplates(std::string const &, Options)
Retrieves a list of instance templates that are contained within the specified project.
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::InstanceTemplate > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListInstanceTemplates(google::cloud::cpp::compute::instance_templates::v1::ListInstanceTemplatesRequest, Options)
Retrieves a list of instance templates that are contained within the specified project.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::instance_templates::v1::ListInstanceTemplatesRequest
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::InstanceTemplate > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
SetIamPolicy(std::string const &, std::string const &, google::cloud::cpp::compute::v1::GlobalSetPolicyRequest const &, Options)
Sets the access control policy on the specified resource.
Replaces any existing policy. https://cloud.google.com/compute/docs/reference/rest/v1/instanceTemplates/setIamPolicy
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
resource |
std::string const &
Name or id of the resource for this request. |
global_set_policy_request_resource |
google::cloud::cpp::compute::v1::GlobalSetPolicyRequest const &
The GlobalSetPolicyRequest for this request. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Policy > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
SetIamPolicy(google::cloud::cpp::compute::instance_templates::v1::SetIamPolicyRequest const &, Options)
Sets the access control policy on the specified resource.
Replaces any existing policy. https://cloud.google.com/compute/docs/reference/rest/v1/instanceTemplates/setIamPolicy
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::instance_templates::v1::SetIamPolicyRequest 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::Policy > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
TestIamPermissions(std::string const &, std::string const &, google::cloud::cpp::compute::v1::TestPermissionsRequest const &, Options)
Returns permissions that a caller has on the specified resource.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
resource |
std::string const &
Name or id of the resource for this request. |
test_permissions_request_resource |
google::cloud::cpp::compute::v1::TestPermissionsRequest const &
The TestPermissionsRequest for this request. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::TestPermissionsResponse > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.TestPermissionsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
TestIamPermissions(google::cloud::cpp::compute::instance_templates::v1::TestIamPermissionsRequest const &, Options)
Returns permissions that a caller has on the specified resource.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::instance_templates::v1::TestIamPermissionsRequest 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::TestPermissionsResponse > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.TestPermissionsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |