Compute V1 Client - Class NodeGroupsClient (1.18.0)

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 \ Client

Methods

__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.
↳ 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 false.
↳ 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 rest. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
↳ 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.

addNodes

Adds specified number of nodes to the node group.

The async variant is Google\Cloud\Compute\V1\Client\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

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 Google\Cloud\Compute\V1\Client\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

delete

Deletes the specified NodeGroup resource.

The async variant is Google\Cloud\Compute\V1\Client\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

deleteNodes

Deletes specified nodes from the node group.

The async variant is Google\Cloud\Compute\V1\Client\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

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 Google\Cloud\Compute\V1\Client\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

getIamPolicy

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

The async variant is Google\Cloud\Compute\V1\Client\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

insert

Creates a NodeGroup resource in the specified project using the data included in the request.

The async variant is Google\Cloud\Compute\V1\Client\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

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 Google\Cloud\Compute\V1\Client\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

listNodes

Lists nodes in the node group.

The async variant is Google\Cloud\Compute\V1\Client\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

patch

Updates the specified node group.

The async variant is Google\Cloud\Compute\V1\Client\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

performMaintenance

Perform maintenance on a subset of nodes in the node group.

The async variant is Google\Cloud\Compute\V1\Client\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

setIamPolicy

Sets the access control policy on the specified resource. Replaces any existing policy.

The async variant is Google\Cloud\Compute\V1\Client\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

setNodeTemplate

Updates the node template of the node group.

The async variant is Google\Cloud\Compute\V1\Client\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

simulateMaintenanceEvent

Simulates maintenance event on specified nodes from the node group.

The async variant is Google\Cloud\Compute\V1\Client\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

testIamPermissions

Returns permissions that a caller has on the specified resource.

The async variant is Google\Cloud\Compute\V1\Client\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

addNodesAsync

Parameters
Name Description
request Google\Cloud\Compute\V1\AddNodesNodeGroupRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

aggregatedListAsync

Parameters
Name Description
request Google\Cloud\Compute\V1\AggregatedListNodeGroupsRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

deleteAsync

Parameters
Name Description
request Google\Cloud\Compute\V1\DeleteNodeGroupRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

deleteNodesAsync

Parameters
Name Description
request Google\Cloud\Compute\V1\DeleteNodesNodeGroupRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

getAsync

Parameters
Name Description
request Google\Cloud\Compute\V1\GetNodeGroupRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

getIamPolicyAsync

Parameters
Name Description
request Google\Cloud\Compute\V1\GetIamPolicyNodeGroupRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

insertAsync

Parameters
Name Description
request Google\Cloud\Compute\V1\InsertNodeGroupRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

listAsync

Parameters
Name Description
request Google\Cloud\Compute\V1\ListNodeGroupsRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

listNodesAsync

Parameters
Name Description
request Google\Cloud\Compute\V1\ListNodesNodeGroupsRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

patchAsync

Parameters
Name Description
request Google\Cloud\Compute\V1\PatchNodeGroupRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

performMaintenanceAsync

Parameters
Name Description
request Google\Cloud\Compute\V1\PerformMaintenanceNodeGroupRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

setIamPolicyAsync

Parameters
Name Description
request Google\Cloud\Compute\V1\SetIamPolicyNodeGroupRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

setNodeTemplateAsync

Parameters
Name Description
request Google\Cloud\Compute\V1\SetNodeTemplateNodeGroupRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

simulateMaintenanceEventAsync

Parameters
Name Description
request Google\Cloud\Compute\V1\SimulateMaintenanceEventNodeGroupRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

testIamPermissionsAsync

Parameters
Name Description
request Google\Cloud\Compute\V1\TestIamPermissionsNodeGroupRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

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