Service for the nodeGroups resource.
https://cloud.google.com/compute/docs/reference/rest/v1/nodeGroups
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
NodeGroupsClient(NodeGroupsClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
NodeGroupsClient const &
|
NodeGroupsClient(NodeGroupsClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
NodeGroupsClient &&
|
NodeGroupsClient(std::shared_ptr< NodeGroupsConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< NodeGroupsConnection >
|
opts |
Options
|
Operators
operator=(NodeGroupsClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
NodeGroupsClient const &
|
Returns | |
---|---|
Type | Description |
NodeGroupsClient & |
operator=(NodeGroupsClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
NodeGroupsClient &&
|
Returns | |
---|---|
Type | Description |
NodeGroupsClient & |
Functions
AddNodes(std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::NodeGroupsAddNodesRequest const &, Options)
Adds specified number of nodes to the node group.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
zone |
std::string const &
The name of the zone for this request. |
node_group |
std::string const &
Name of the NodeGroup resource. |
node_groups_add_nodes_request_resource |
google::cloud::cpp::compute::v1::NodeGroupsAddNodesRequest const &
The NodeGroupsAddNodesRequest 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 |
AddNodes(NoAwaitTag, std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::NodeGroupsAddNodesRequest const &, Options)
Adds specified number of nodes to the node group.
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 &
|
zone |
std::string const &
|
node_group |
std::string const &
|
node_groups_add_nodes_request_resource |
google::cloud::cpp::compute::v1::NodeGroupsAddNodesRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
AddNodes(google::cloud::cpp::compute::node_groups::v1::AddNodesRequest const &, Options)
Adds specified number of nodes to the node group.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::node_groups::v1::AddNodesRequest 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 |
AddNodes(NoAwaitTag, google::cloud::cpp::compute::node_groups::v1::AddNodesRequest const &, Options)
Adds specified number of nodes to the node group.
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::node_groups::v1::AddNodesRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
AddNodes(google::cloud::cpp::compute::v1::Operation const &, Options)
Adds specified number of nodes to the node group.
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 > > |
AggregatedListNodeGroups(std::string const &, Options)
Retrieves an aggregated list of node groups.
Note: use nodeGroups.listNodes for more details about each group. To prevent failure, Google recommends that you set the returnPartialSuccess
parameter to true
. https://cloud.google.com/compute/docs/reference/rest/v1/nodeGroups/aggregatedList
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< std::pair< std::string, google::cloud::cpp::compute::v1::NodeGroupsScopedList > > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
AggregatedListNodeGroups(google::cloud::cpp::compute::node_groups::v1::AggregatedListNodeGroupsRequest, Options)
Retrieves an aggregated list of node groups.
Note: use nodeGroups.listNodes for more details about each group. To prevent failure, Google recommends that you set the returnPartialSuccess
parameter to true
. https://cloud.google.com/compute/docs/reference/rest/v1/nodeGroups/aggregatedList
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::node_groups::v1::AggregatedListNodeGroupsRequest
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::NodeGroupsScopedList > > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
DeleteNodeGroup(std::string const &, std::string const &, std::string const &, Options)
Deletes the specified NodeGroup resource.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
zone |
std::string const &
The name of the zone for this request. |
node_group |
std::string const &
Name of the NodeGroup resource 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 |
DeleteNodeGroup(NoAwaitTag, std::string const &, std::string const &, std::string const &, Options)
Deletes the specified NodeGroup resource.
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 &
|
zone |
std::string const &
|
node_group |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
DeleteNodeGroup(google::cloud::cpp::compute::node_groups::v1::DeleteNodeGroupRequest const &, Options)
Deletes the specified NodeGroup resource.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::node_groups::v1::DeleteNodeGroupRequest 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 |
DeleteNodeGroup(NoAwaitTag, google::cloud::cpp::compute::node_groups::v1::DeleteNodeGroupRequest const &, Options)
Deletes the specified NodeGroup resource.
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::node_groups::v1::DeleteNodeGroupRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
DeleteNodeGroup(google::cloud::cpp::compute::v1::Operation const &, Options)
Deletes the specified NodeGroup resource.
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 > > |
DeleteNodes(std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::NodeGroupsDeleteNodesRequest const &, Options)
Deletes specified nodes from the node group.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
zone |
std::string const &
The name of the zone for this request. |
node_group |
std::string const &
Name of the NodeGroup resource whose nodes will be deleted. |
node_groups_delete_nodes_request_resource |
google::cloud::cpp::compute::v1::NodeGroupsDeleteNodesRequest const &
The NodeGroupsDeleteNodesRequest 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 |
DeleteNodes(NoAwaitTag, std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::NodeGroupsDeleteNodesRequest const &, Options)
Deletes specified nodes from the node group.
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 &
|
zone |
std::string const &
|
node_group |
std::string const &
|
node_groups_delete_nodes_request_resource |
google::cloud::cpp::compute::v1::NodeGroupsDeleteNodesRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
DeleteNodes(google::cloud::cpp::compute::node_groups::v1::DeleteNodesRequest const &, Options)
Deletes specified nodes from the node group.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::node_groups::v1::DeleteNodesRequest 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 |
DeleteNodes(NoAwaitTag, google::cloud::cpp::compute::node_groups::v1::DeleteNodesRequest const &, Options)
Deletes specified nodes from the node group.
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::node_groups::v1::DeleteNodesRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
DeleteNodes(google::cloud::cpp::compute::v1::Operation const &, Options)
Deletes specified nodes from the node group.
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 > > |
GetNodeGroup(std::string const &, std::string const &, std::string const &, Options)
Returns the specified NodeGroup.
Get a list of available NodeGroups by making a list() request. Note: the "nodes" field should not be used. Use nodeGroups.listNodes instead. https://cloud.google.com/compute/docs/reference/rest/v1/nodeGroups/get
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
zone |
std::string const &
The name of the zone for this request. |
node_group |
std::string const &
Name of the node group 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::NodeGroup > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.NodeGroup) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetNodeGroup(google::cloud::cpp::compute::node_groups::v1::GetNodeGroupRequest const &, Options)
Returns the specified NodeGroup.
Get a list of available NodeGroups by making a list() request. Note: the "nodes" field should not be used. Use nodeGroups.listNodes instead. https://cloud.google.com/compute/docs/reference/rest/v1/nodeGroups/get
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::node_groups::v1::GetNodeGroupRequest 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::NodeGroup > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.NodeGroup) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetIamPolicy(std::string const &, 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/nodeGroups/getIamPolicy
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
zone |
std::string const &
The name of the zone 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::node_groups::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/nodeGroups/getIamPolicy
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::node_groups::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 |
InsertNodeGroup(std::string const &, std::string const &, std::int32_t, google::cloud::cpp::compute::v1::NodeGroup const &, Options)
Creates a NodeGroup resource in the specified project using the data included in the request.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
zone |
std::string const &
The name of the zone for this request. |
initial_node_count |
std::int32_t
Initial count of nodes in the node group. |
node_group_resource |
google::cloud::cpp::compute::v1::NodeGroup const &
The NodeGroup 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 |
InsertNodeGroup(NoAwaitTag, std::string const &, std::string const &, std::int32_t, google::cloud::cpp::compute::v1::NodeGroup const &, Options)
Creates a NodeGroup resource in the specified project using the data 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 &
|
zone |
std::string const &
|
initial_node_count |
std::int32_t
|
node_group_resource |
google::cloud::cpp::compute::v1::NodeGroup const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
InsertNodeGroup(google::cloud::cpp::compute::node_groups::v1::InsertNodeGroupRequest const &, Options)
Creates a NodeGroup resource in the specified project using the data included in the request.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::node_groups::v1::InsertNodeGroupRequest 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 |
InsertNodeGroup(NoAwaitTag, google::cloud::cpp::compute::node_groups::v1::InsertNodeGroupRequest const &, Options)
Creates a NodeGroup resource in the specified project using the data 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::node_groups::v1::InsertNodeGroupRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
InsertNodeGroup(google::cloud::cpp::compute::v1::Operation const &, Options)
Creates a NodeGroup resource in the specified project using the data 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 > > |
ListNodeGroups(std::string const &, std::string const &, Options)
Retrieves a list of node groups available to the specified project.
Note: use nodeGroups.listNodes for more details about each group. https://cloud.google.com/compute/docs/reference/rest/v1/nodeGroups/list
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
zone |
std::string const &
The name of the zone 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::NodeGroup > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListNodeGroups(google::cloud::cpp::compute::node_groups::v1::ListNodeGroupsRequest, Options)
Retrieves a list of node groups available to the specified project.
Note: use nodeGroups.listNodes for more details about each group. https://cloud.google.com/compute/docs/reference/rest/v1/nodeGroups/list
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::node_groups::v1::ListNodeGroupsRequest
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::NodeGroup > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListNodes(std::string const &, std::string const &, std::string const &, Options)
Lists nodes in the node group.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
zone |
std::string const &
The name of the zone for this request. |
node_group |
std::string const &
Name of the NodeGroup resource whose nodes you want to list. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::cpp::compute::v1::NodeGroupNode > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListNodes(google::cloud::cpp::compute::node_groups::v1::ListNodesRequest, Options)
Lists nodes in the node group.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::node_groups::v1::ListNodesRequest
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::NodeGroupNode > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
PatchNodeGroup(std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::NodeGroup const &, Options)
Updates the specified node group.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
zone |
std::string const &
The name of the zone for this request. |
node_group |
std::string const &
Name of the NodeGroup resource to update. |
node_group_resource |
google::cloud::cpp::compute::v1::NodeGroup const &
The NodeGroup 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 |
PatchNodeGroup(NoAwaitTag, std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::NodeGroup const &, Options)
Updates the specified node group.
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 &
|
zone |
std::string const &
|
node_group |
std::string const &
|
node_group_resource |
google::cloud::cpp::compute::v1::NodeGroup const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
PatchNodeGroup(google::cloud::cpp::compute::node_groups::v1::PatchNodeGroupRequest const &, Options)
Updates the specified node group.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::node_groups::v1::PatchNodeGroupRequest 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 |
PatchNodeGroup(NoAwaitTag, google::cloud::cpp::compute::node_groups::v1::PatchNodeGroupRequest const &, Options)
Updates the specified node group.
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::node_groups::v1::PatchNodeGroupRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
PatchNodeGroup(google::cloud::cpp::compute::v1::Operation const &, Options)
Updates the specified node group.
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 > > |
PerformMaintenance(std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::NodeGroupsPerformMaintenanceRequest const &, Options)
Perform maintenance on a subset of nodes in the node group.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
zone |
std::string const &
The name of the zone for this request. |
node_group |
std::string const &
Name of the node group scoping this request. |
node_groups_perform_maintenance_request_resource |
google::cloud::cpp::compute::v1::NodeGroupsPerformMaintenanceRequest const &
The NodeGroupsPerformMaintenanceRequest 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 |
PerformMaintenance(NoAwaitTag, std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::NodeGroupsPerformMaintenanceRequest const &, Options)
Perform maintenance on a subset of nodes in the node group.
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 &
|
zone |
std::string const &
|
node_group |
std::string const &
|
node_groups_perform_maintenance_request_resource |
google::cloud::cpp::compute::v1::NodeGroupsPerformMaintenanceRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
PerformMaintenance(google::cloud::cpp::compute::node_groups::v1::PerformMaintenanceRequest const &, Options)
Perform maintenance on a subset of nodes in the node group.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::node_groups::v1::PerformMaintenanceRequest 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 |
PerformMaintenance(NoAwaitTag, google::cloud::cpp::compute::node_groups::v1::PerformMaintenanceRequest const &, Options)
Perform maintenance on a subset of nodes in the node group.
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::node_groups::v1::PerformMaintenanceRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
PerformMaintenance(google::cloud::cpp::compute::v1::Operation const &, Options)
Perform maintenance on a subset of nodes in the node group.
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 > > |
SetIamPolicy(std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::ZoneSetPolicyRequest const &, Options)
Sets the access control policy on the specified resource.
Replaces any existing policy. https://cloud.google.com/compute/docs/reference/rest/v1/nodeGroups/setIamPolicy
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
zone |
std::string const &
The name of the zone for this request. |
resource |
std::string const &
Name or id of the resource for this request. |
zone_set_policy_request_resource |
google::cloud::cpp::compute::v1::ZoneSetPolicyRequest const &
The ZoneSetPolicyRequest 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::node_groups::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/nodeGroups/setIamPolicy
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::node_groups::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 |
SetNodeTemplate(std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::NodeGroupsSetNodeTemplateRequest const &, Options)
Updates the node template of the node group.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
zone |
std::string const &
The name of the zone for this request. |
node_group |
std::string const &
Name of the NodeGroup resource to update. |
node_groups_set_node_template_request_resource |
google::cloud::cpp::compute::v1::NodeGroupsSetNodeTemplateRequest const &
The NodeGroupsSetNodeTemplateRequest 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 |
SetNodeTemplate(NoAwaitTag, std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::NodeGroupsSetNodeTemplateRequest const &, Options)
Updates the node template of the node group.
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 &
|
zone |
std::string const &
|
node_group |
std::string const &
|
node_groups_set_node_template_request_resource |
google::cloud::cpp::compute::v1::NodeGroupsSetNodeTemplateRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
SetNodeTemplate(google::cloud::cpp::compute::node_groups::v1::SetNodeTemplateRequest const &, Options)
Updates the node template of the node group.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::node_groups::v1::SetNodeTemplateRequest 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 |
SetNodeTemplate(NoAwaitTag, google::cloud::cpp::compute::node_groups::v1::SetNodeTemplateRequest const &, Options)
Updates the node template of the node group.
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::node_groups::v1::SetNodeTemplateRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
SetNodeTemplate(google::cloud::cpp::compute::v1::Operation const &, Options)
Updates the node template of the node group.
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 > > |
SimulateMaintenanceEvent(std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::NodeGroupsSimulateMaintenanceEventRequest const &, Options)
Simulates maintenance event on specified nodes from the node group.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
zone |
std::string const &
The name of the zone for this request. |
node_group |
std::string const &
Name of the NodeGroup resource whose nodes will go under maintenance simulation. |
node_groups_simulate_maintenance_event_request_resource |
google::cloud::cpp::compute::v1::NodeGroupsSimulateMaintenanceEventRequest const &
The NodeGroupsSimulateMaintenanceEventRequest 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 |
SimulateMaintenanceEvent(NoAwaitTag, std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::NodeGroupsSimulateMaintenanceEventRequest const &, Options)
Simulates maintenance event on specified nodes from the node group.
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 &
|
zone |
std::string const &
|
node_group |
std::string const &
|
node_groups_simulate_maintenance_event_request_resource |
google::cloud::cpp::compute::v1::NodeGroupsSimulateMaintenanceEventRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
SimulateMaintenanceEvent(google::cloud::cpp::compute::node_groups::v1::SimulateMaintenanceEventRequest const &, Options)
Simulates maintenance event on specified nodes from the node group.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::node_groups::v1::SimulateMaintenanceEventRequest 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 |
SimulateMaintenanceEvent(NoAwaitTag, google::cloud::cpp::compute::node_groups::v1::SimulateMaintenanceEventRequest const &, Options)
Simulates maintenance event on specified nodes from the node group.
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::node_groups::v1::SimulateMaintenanceEventRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
SimulateMaintenanceEvent(google::cloud::cpp::compute::v1::Operation const &, Options)
Simulates maintenance event on specified nodes from the node group.
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 > > |
TestIamPermissions(std::string const &, 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. |
zone |
std::string const &
The name of the zone 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::node_groups::v1::TestIamPermissionsRequest const &, Options)
Returns permissions that a caller has on the specified resource.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::node_groups::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 |