Reference documentation and code samples for the Compute V1 Client class NodeGroupsClient.
Service Description: The NodeGroups API.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods.
Namespace
Google \ Cloud \ Compute \ V1 \ ClientMethods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
options |
array
Optional. Options for configuring the service API wrapper. |
↳ apiEndpoint |
string
The address of the API remote host. May optionally include the port, formatted as "
|
↳ credentials |
string|array|FetchAuthTokenInterface|CredentialsWrapper
The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. Important: If you accept a credential configuration (credential JSON/File/Stream) from an external source for authentication to Google Cloud Platform, you must validate it before providing it to any Google API or library. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data. For more information https://cloud.google.com/docs/authentication/external/externally-sourced-credentials |
↳ credentialsConfig |
array
Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() . |
↳ disableRetries |
bool
Determines whether or not retries defined by the client configuration should be disabled. Defaults to |
↳ clientConfig |
string|array
Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder. |
↳ transport |
string|TransportInterface
The transport used for executing network requests. At the moment, supports only |
↳ transportConfig |
array
Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'rest' => [...], ]; See the Google\ApiCore\Transport\RestTransport::build() method for the supported options. |
↳ clientCertSource |
callable
A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS. |
↳ logger |
false|LoggerInterface
A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag |
addNodes
Adds specified number of nodes to the node group.
The async variant is NodeGroupsClient::addNodesAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\AddNodesNodeGroupRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\AddNodesNodeGroupRequest;
use Google\Cloud\Compute\V1\Client\NodeGroupsClient;
use Google\Cloud\Compute\V1\NodeGroupsAddNodesRequest;
use Google\Rpc\Status;
/**
* @param string $nodeGroup Name of the NodeGroup resource.
* @param string $project Project ID for this request.
* @param string $zone The name of the zone for this request.
*/
function add_nodes_sample(string $nodeGroup, string $project, string $zone): void
{
// Create a client.
$nodeGroupsClient = new NodeGroupsClient();
// Prepare the request message.
$nodeGroupsAddNodesRequestResource = new NodeGroupsAddNodesRequest();
$request = (new AddNodesNodeGroupRequest())
->setNodeGroup($nodeGroup)
->setNodeGroupsAddNodesRequestResource($nodeGroupsAddNodesRequestResource)
->setProject($project)
->setZone($zone);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $nodeGroupsClient->addNodes($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
printf('Operation completed successfully.' . PHP_EOL);
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$nodeGroup = '[NODE_GROUP]';
$project = '[PROJECT]';
$zone = '[ZONE]';
add_nodes_sample($nodeGroup, $project, $zone);
}
aggregatedList
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
.
The async variant is NodeGroupsClient::aggregatedListAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\AggregatedListNodeGroupsRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Compute\V1\AggregatedListNodeGroupsRequest;
use Google\Cloud\Compute\V1\Client\NodeGroupsClient;
/**
* @param string $project Project ID for this request.
*/
function aggregated_list_sample(string $project): void
{
// Create a client.
$nodeGroupsClient = new NodeGroupsClient();
// Prepare the request message.
$request = (new AggregatedListNodeGroupsRequest())
->setProject($project);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $nodeGroupsClient->aggregatedList($request);
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$project = '[PROJECT]';
aggregated_list_sample($project);
}
delete
Deletes the specified NodeGroup resource.
The async variant is NodeGroupsClient::deleteAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\DeleteNodeGroupRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\Client\NodeGroupsClient;
use Google\Cloud\Compute\V1\DeleteNodeGroupRequest;
use Google\Rpc\Status;
/**
* @param string $nodeGroup Name of the NodeGroup resource to delete.
* @param string $project Project ID for this request.
* @param string $zone The name of the zone for this request.
*/
function delete_sample(string $nodeGroup, string $project, string $zone): void
{
// Create a client.
$nodeGroupsClient = new NodeGroupsClient();
// Prepare the request message.
$request = (new DeleteNodeGroupRequest())
->setNodeGroup($nodeGroup)
->setProject($project)
->setZone($zone);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $nodeGroupsClient->delete($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
printf('Operation completed successfully.' . PHP_EOL);
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$nodeGroup = '[NODE_GROUP]';
$project = '[PROJECT]';
$zone = '[ZONE]';
delete_sample($nodeGroup, $project, $zone);
}
deleteNodes
Deletes specified nodes from the node group.
The async variant is NodeGroupsClient::deleteNodesAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\DeleteNodesNodeGroupRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\Client\NodeGroupsClient;
use Google\Cloud\Compute\V1\DeleteNodesNodeGroupRequest;
use Google\Cloud\Compute\V1\NodeGroupsDeleteNodesRequest;
use Google\Rpc\Status;
/**
* @param string $nodeGroup Name of the NodeGroup resource whose nodes will be deleted.
* @param string $project Project ID for this request.
* @param string $zone The name of the zone for this request.
*/
function delete_nodes_sample(string $nodeGroup, string $project, string $zone): void
{
// Create a client.
$nodeGroupsClient = new NodeGroupsClient();
// Prepare the request message.
$nodeGroupsDeleteNodesRequestResource = new NodeGroupsDeleteNodesRequest();
$request = (new DeleteNodesNodeGroupRequest())
->setNodeGroup($nodeGroup)
->setNodeGroupsDeleteNodesRequestResource($nodeGroupsDeleteNodesRequestResource)
->setProject($project)
->setZone($zone);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $nodeGroupsClient->deleteNodes($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
printf('Operation completed successfully.' . PHP_EOL);
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$nodeGroup = '[NODE_GROUP]';
$project = '[PROJECT]';
$zone = '[ZONE]';
delete_nodes_sample($nodeGroup, $project, $zone);
}
get
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.
The async variant is NodeGroupsClient::getAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\GetNodeGroupRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Compute\V1\NodeGroup |
use Google\ApiCore\ApiException;
use Google\Cloud\Compute\V1\Client\NodeGroupsClient;
use Google\Cloud\Compute\V1\GetNodeGroupRequest;
use Google\Cloud\Compute\V1\NodeGroup;
/**
* @param string $nodeGroup Name of the node group to return.
* @param string $project Project ID for this request.
* @param string $zone The name of the zone for this request.
*/
function get_sample(string $nodeGroup, string $project, string $zone): void
{
// Create a client.
$nodeGroupsClient = new NodeGroupsClient();
// Prepare the request message.
$request = (new GetNodeGroupRequest())
->setNodeGroup($nodeGroup)
->setProject($project)
->setZone($zone);
// Call the API and handle any network failures.
try {
/** @var NodeGroup $response */
$response = $nodeGroupsClient->get($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$nodeGroup = '[NODE_GROUP]';
$project = '[PROJECT]';
$zone = '[ZONE]';
get_sample($nodeGroup, $project, $zone);
}
getIamPolicy
Gets the access control policy for a resource. May be empty if no such policy or resource exists.
The async variant is NodeGroupsClient::getIamPolicyAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\GetIamPolicyNodeGroupRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Compute\V1\Policy |
use Google\ApiCore\ApiException;
use Google\Cloud\Compute\V1\Client\NodeGroupsClient;
use Google\Cloud\Compute\V1\GetIamPolicyNodeGroupRequest;
use Google\Cloud\Compute\V1\Policy;
/**
* @param string $project Project ID for this request.
* @param string $resource Name or id of the resource for this request.
* @param string $zone The name of the zone for this request.
*/
function get_iam_policy_sample(string $project, string $resource, string $zone): void
{
// Create a client.
$nodeGroupsClient = new NodeGroupsClient();
// Prepare the request message.
$request = (new GetIamPolicyNodeGroupRequest())
->setProject($project)
->setResource($resource)
->setZone($zone);
// Call the API and handle any network failures.
try {
/** @var Policy $response */
$response = $nodeGroupsClient->getIamPolicy($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$project = '[PROJECT]';
$resource = '[RESOURCE]';
$zone = '[ZONE]';
get_iam_policy_sample($project, $resource, $zone);
}
insert
Creates a NodeGroup resource in the specified project using the data included in the request.
The async variant is NodeGroupsClient::insertAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\InsertNodeGroupRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\Client\NodeGroupsClient;
use Google\Cloud\Compute\V1\InsertNodeGroupRequest;
use Google\Cloud\Compute\V1\NodeGroup;
use Google\Rpc\Status;
/**
* @param int $initialNodeCount Initial count of nodes in the node group.
* @param string $project Project ID for this request.
* @param string $zone The name of the zone for this request.
*/
function insert_sample(int $initialNodeCount, string $project, string $zone): void
{
// Create a client.
$nodeGroupsClient = new NodeGroupsClient();
// Prepare the request message.
$nodeGroupResource = new NodeGroup();
$request = (new InsertNodeGroupRequest())
->setInitialNodeCount($initialNodeCount)
->setNodeGroupResource($nodeGroupResource)
->setProject($project)
->setZone($zone);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $nodeGroupsClient->insert($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
printf('Operation completed successfully.' . PHP_EOL);
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$initialNodeCount = 0;
$project = '[PROJECT]';
$zone = '[ZONE]';
insert_sample($initialNodeCount, $project, $zone);
}
list
Retrieves a list of node groups available to the specified project. Note: use nodeGroups.listNodes for more details about each group.
The async variant is NodeGroupsClient::listAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\ListNodeGroupsRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Compute\V1\Client\NodeGroupsClient;
use Google\Cloud\Compute\V1\ListNodeGroupsRequest;
/**
* @param string $project Project ID for this request.
* @param string $zone The name of the zone for this request.
*/
function list_sample(string $project, string $zone): void
{
// Create a client.
$nodeGroupsClient = new NodeGroupsClient();
// Prepare the request message.
$request = (new ListNodeGroupsRequest())
->setProject($project)
->setZone($zone);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $nodeGroupsClient->list($request);
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$project = '[PROJECT]';
$zone = '[ZONE]';
list_sample($project, $zone);
}
listNodes
Lists nodes in the node group.
The async variant is NodeGroupsClient::listNodesAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\ListNodesNodeGroupsRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Compute\V1\Client\NodeGroupsClient;
use Google\Cloud\Compute\V1\ListNodesNodeGroupsRequest;
/**
* @param string $nodeGroup Name of the NodeGroup resource whose nodes you want to list.
* @param string $project Project ID for this request.
* @param string $zone The name of the zone for this request.
*/
function list_nodes_sample(string $nodeGroup, string $project, string $zone): void
{
// Create a client.
$nodeGroupsClient = new NodeGroupsClient();
// Prepare the request message.
$request = (new ListNodesNodeGroupsRequest())
->setNodeGroup($nodeGroup)
->setProject($project)
->setZone($zone);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $nodeGroupsClient->listNodes($request);
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$nodeGroup = '[NODE_GROUP]';
$project = '[PROJECT]';
$zone = '[ZONE]';
list_nodes_sample($nodeGroup, $project, $zone);
}
patch
Updates the specified node group.
The async variant is NodeGroupsClient::patchAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\PatchNodeGroupRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\Client\NodeGroupsClient;
use Google\Cloud\Compute\V1\NodeGroup;
use Google\Cloud\Compute\V1\PatchNodeGroupRequest;
use Google\Rpc\Status;
/**
* @param string $nodeGroup Name of the NodeGroup resource to update.
* @param string $project Project ID for this request.
* @param string $zone The name of the zone for this request.
*/
function patch_sample(string $nodeGroup, string $project, string $zone): void
{
// Create a client.
$nodeGroupsClient = new NodeGroupsClient();
// Prepare the request message.
$nodeGroupResource = new NodeGroup();
$request = (new PatchNodeGroupRequest())
->setNodeGroup($nodeGroup)
->setNodeGroupResource($nodeGroupResource)
->setProject($project)
->setZone($zone);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $nodeGroupsClient->patch($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
printf('Operation completed successfully.' . PHP_EOL);
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$nodeGroup = '[NODE_GROUP]';
$project = '[PROJECT]';
$zone = '[ZONE]';
patch_sample($nodeGroup, $project, $zone);
}
performMaintenance
Perform maintenance on a subset of nodes in the node group.
The async variant is NodeGroupsClient::performMaintenanceAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\PerformMaintenanceNodeGroupRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\Client\NodeGroupsClient;
use Google\Cloud\Compute\V1\NodeGroupsPerformMaintenanceRequest;
use Google\Cloud\Compute\V1\PerformMaintenanceNodeGroupRequest;
use Google\Rpc\Status;
/**
* @param string $nodeGroup Name of the node group scoping this request.
* @param string $project Project ID for this request.
* @param string $zone The name of the zone for this request.
*/
function perform_maintenance_sample(string $nodeGroup, string $project, string $zone): void
{
// Create a client.
$nodeGroupsClient = new NodeGroupsClient();
// Prepare the request message.
$nodeGroupsPerformMaintenanceRequestResource = new NodeGroupsPerformMaintenanceRequest();
$request = (new PerformMaintenanceNodeGroupRequest())
->setNodeGroup($nodeGroup)
->setNodeGroupsPerformMaintenanceRequestResource($nodeGroupsPerformMaintenanceRequestResource)
->setProject($project)
->setZone($zone);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $nodeGroupsClient->performMaintenance($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
printf('Operation completed successfully.' . PHP_EOL);
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$nodeGroup = '[NODE_GROUP]';
$project = '[PROJECT]';
$zone = '[ZONE]';
perform_maintenance_sample($nodeGroup, $project, $zone);
}
setIamPolicy
Sets the access control policy on the specified resource. Replaces any existing policy.
The async variant is NodeGroupsClient::setIamPolicyAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\SetIamPolicyNodeGroupRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Compute\V1\Policy |
use Google\ApiCore\ApiException;
use Google\Cloud\Compute\V1\Client\NodeGroupsClient;
use Google\Cloud\Compute\V1\Policy;
use Google\Cloud\Compute\V1\SetIamPolicyNodeGroupRequest;
use Google\Cloud\Compute\V1\ZoneSetPolicyRequest;
/**
* @param string $project Project ID for this request.
* @param string $resource Name or id of the resource for this request.
* @param string $zone The name of the zone for this request.
*/
function set_iam_policy_sample(string $project, string $resource, string $zone): void
{
// Create a client.
$nodeGroupsClient = new NodeGroupsClient();
// Prepare the request message.
$zoneSetPolicyRequestResource = new ZoneSetPolicyRequest();
$request = (new SetIamPolicyNodeGroupRequest())
->setProject($project)
->setResource($resource)
->setZone($zone)
->setZoneSetPolicyRequestResource($zoneSetPolicyRequestResource);
// Call the API and handle any network failures.
try {
/** @var Policy $response */
$response = $nodeGroupsClient->setIamPolicy($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$project = '[PROJECT]';
$resource = '[RESOURCE]';
$zone = '[ZONE]';
set_iam_policy_sample($project, $resource, $zone);
}
setNodeTemplate
Updates the node template of the node group.
The async variant is NodeGroupsClient::setNodeTemplateAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\SetNodeTemplateNodeGroupRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\Client\NodeGroupsClient;
use Google\Cloud\Compute\V1\NodeGroupsSetNodeTemplateRequest;
use Google\Cloud\Compute\V1\SetNodeTemplateNodeGroupRequest;
use Google\Rpc\Status;
/**
* @param string $nodeGroup Name of the NodeGroup resource to update.
* @param string $project Project ID for this request.
* @param string $zone The name of the zone for this request.
*/
function set_node_template_sample(string $nodeGroup, string $project, string $zone): void
{
// Create a client.
$nodeGroupsClient = new NodeGroupsClient();
// Prepare the request message.
$nodeGroupsSetNodeTemplateRequestResource = new NodeGroupsSetNodeTemplateRequest();
$request = (new SetNodeTemplateNodeGroupRequest())
->setNodeGroup($nodeGroup)
->setNodeGroupsSetNodeTemplateRequestResource($nodeGroupsSetNodeTemplateRequestResource)
->setProject($project)
->setZone($zone);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $nodeGroupsClient->setNodeTemplate($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
printf('Operation completed successfully.' . PHP_EOL);
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$nodeGroup = '[NODE_GROUP]';
$project = '[PROJECT]';
$zone = '[ZONE]';
set_node_template_sample($nodeGroup, $project, $zone);
}
simulateMaintenanceEvent
Simulates maintenance event on specified nodes from the node group.
The async variant is NodeGroupsClient::simulateMaintenanceEventAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\SimulateMaintenanceEventNodeGroupRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\Client\NodeGroupsClient;
use Google\Cloud\Compute\V1\NodeGroupsSimulateMaintenanceEventRequest;
use Google\Cloud\Compute\V1\SimulateMaintenanceEventNodeGroupRequest;
use Google\Rpc\Status;
/**
* @param string $nodeGroup Name of the NodeGroup resource whose nodes will go under maintenance simulation.
* @param string $project Project ID for this request.
* @param string $zone The name of the zone for this request.
*/
function simulate_maintenance_event_sample(string $nodeGroup, string $project, string $zone): void
{
// Create a client.
$nodeGroupsClient = new NodeGroupsClient();
// Prepare the request message.
$nodeGroupsSimulateMaintenanceEventRequestResource = new NodeGroupsSimulateMaintenanceEventRequest();
$request = (new SimulateMaintenanceEventNodeGroupRequest())
->setNodeGroup($nodeGroup)
->setNodeGroupsSimulateMaintenanceEventRequestResource(
$nodeGroupsSimulateMaintenanceEventRequestResource
)
->setProject($project)
->setZone($zone);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $nodeGroupsClient->simulateMaintenanceEvent($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
printf('Operation completed successfully.' . PHP_EOL);
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$nodeGroup = '[NODE_GROUP]';
$project = '[PROJECT]';
$zone = '[ZONE]';
simulate_maintenance_event_sample($nodeGroup, $project, $zone);
}
testIamPermissions
Returns permissions that a caller has on the specified resource.
The async variant is NodeGroupsClient::testIamPermissionsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\TestIamPermissionsNodeGroupRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Compute\V1\TestPermissionsResponse |
use Google\ApiCore\ApiException;
use Google\Cloud\Compute\V1\Client\NodeGroupsClient;
use Google\Cloud\Compute\V1\TestIamPermissionsNodeGroupRequest;
use Google\Cloud\Compute\V1\TestPermissionsRequest;
use Google\Cloud\Compute\V1\TestPermissionsResponse;
/**
* @param string $project Project ID for this request.
* @param string $resource Name or id of the resource for this request.
* @param string $zone The name of the zone for this request.
*/
function test_iam_permissions_sample(string $project, string $resource, string $zone): void
{
// Create a client.
$nodeGroupsClient = new NodeGroupsClient();
// Prepare the request message.
$testPermissionsRequestResource = new TestPermissionsRequest();
$request = (new TestIamPermissionsNodeGroupRequest())
->setProject($project)
->setResource($resource)
->setTestPermissionsRequestResource($testPermissionsRequestResource)
->setZone($zone);
// Call the API and handle any network failures.
try {
/** @var TestPermissionsResponse $response */
$response = $nodeGroupsClient->testIamPermissions($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$project = '[PROJECT]';
$resource = '[RESOURCE]';
$zone = '[ZONE]';
test_iam_permissions_sample($project, $resource, $zone);
}
addNodesAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\AddNodesNodeGroupRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
aggregatedListAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\AggregatedListNodeGroupsRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
deleteAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\DeleteNodeGroupRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
deleteNodesAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\DeleteNodesNodeGroupRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
getAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\GetNodeGroupRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Compute\V1\NodeGroup> |
getIamPolicyAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\GetIamPolicyNodeGroupRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Compute\V1\Policy> |
insertAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\InsertNodeGroupRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
listAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\ListNodeGroupsRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
listNodesAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\ListNodesNodeGroupsRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
patchAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\PatchNodeGroupRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
performMaintenanceAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\PerformMaintenanceNodeGroupRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
setIamPolicyAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\SetIamPolicyNodeGroupRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Compute\V1\Policy> |
setNodeTemplateAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\SetNodeTemplateNodeGroupRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
simulateMaintenanceEventAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\SimulateMaintenanceEventNodeGroupRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
testIamPermissionsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\TestIamPermissionsNodeGroupRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Compute\V1\TestPermissionsResponse> |
getOperationsClient
Return an ZoneOperationsClient object with the same endpoint as $this.
Returns | |
---|---|
Type | Description |
Google\Cloud\Compute\V1\ZoneOperationsClient |
resumeOperation
Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.
Parameters | |
---|---|
Name | Description |
operationName |
string
The name of the long running operation |
methodName |
string
The name of the method used to start the operation |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |