Documentation

Google_Service_Compute_Resource_NodeGroups extends Google_Service_Resource
in package

The "nodeGroups" collection of methods.

Typical usage is: $computeService = new Google_Service_Compute(...); $nodeGroups = $computeService->nodeGroups;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
addNodes()  : Google_Service_Compute_Operation
Adds specified number of nodes to the node group. (nodeGroups.addNodes)
aggregatedList()  : Google_Service_Compute_NodeGroupAggregatedList
Retrieves an aggregated list of node groups. Note: use nodeGroups.listNodes for more details about each group. (nodeGroups.aggregatedList)
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_Compute_Operation
Deletes the specified NodeGroup resource. (nodeGroups.delete)
deleteNodes()  : Google_Service_Compute_Operation
Deletes specified nodes from the node group. (nodeGroups.deleteNodes)
get()  : Google_Service_Compute_NodeGroup
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. (nodeGroups.get)
getIamPolicy()  : Google_Service_Compute_Policy
Gets the access control policy for a resource. May be empty if no such policy or resource exists. (nodeGroups.getIamPolicy)
insert()  : Google_Service_Compute_Operation
Creates a NodeGroup resource in the specified project using the data included in the request. (nodeGroups.insert)
listNodeGroups()  : Google_Service_Compute_NodeGroupList
Retrieves a list of node groups available to the specified project. Note: use nodeGroups.listNodes for more details about each group.
listNodes()  : Google_Service_Compute_NodeGroupsListNodes
Lists nodes in the node group. (nodeGroups.listNodes)
patch()  : Google_Service_Compute_Operation
Updates the specified node group. (nodeGroups.patch)
setIamPolicy()  : Google_Service_Compute_Policy
Sets the access control policy on the specified resource. Replaces any existing policy. (nodeGroups.setIamPolicy)
setNodeTemplate()  : Google_Service_Compute_Operation
Updates the node template of the node group. (nodeGroups.setNodeTemplate)
testIamPermissions()  : Google_Service_Compute_TestPermissionsResponse
Returns permissions that a caller has on the specified resource.
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

addNodes()

Adds specified number of nodes to the node group. (nodeGroups.addNodes)

public addNodes(string $project, string $zone, string $nodeGroup, Google_Service_Compute_NodeGroupsAddNodesRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Compute_Operation
Parameters
$project : string

Project ID for this request.

$zone : string

The name of the zone for this request.

$nodeGroup : string

Name of the NodeGroup resource.

$postBody : Google_Service_Compute_NodeGroupsAddNodesRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Return values
Google_Service_Compute_Operation —

aggregatedList()

Retrieves an aggregated list of node groups. Note: use nodeGroups.listNodes for more details about each group. (nodeGroups.aggregatedList)

public aggregatedList(string $project[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Compute_NodeGroupAggregatedList
Parameters
$project : string

Project ID for this request.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example: (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example: (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true)

opt_param

bool includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

opt_param

string maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

opt_param

string orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

opt_param

string pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

opt_param

bool returnPartialSuccess Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.

Return values
Google_Service_Compute_NodeGroupAggregatedList —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

delete()

Deletes the specified NodeGroup resource. (nodeGroups.delete)

public delete(string $project, string $zone, string $nodeGroup[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Compute_Operation
Parameters
$project : string

Project ID for this request.

$zone : string

The name of the zone for this request.

$nodeGroup : string

Name of the NodeGroup resource to delete.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Return values
Google_Service_Compute_Operation —

deleteNodes()

Deletes specified nodes from the node group. (nodeGroups.deleteNodes)

public deleteNodes(string $project, string $zone, string $nodeGroup, Google_Service_Compute_NodeGroupsDeleteNodesRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Compute_Operation
Parameters
$project : string

Project ID for this request.

$zone : string

The name of the zone for this request.

$nodeGroup : string

Name of the NodeGroup resource whose nodes will be deleted.

$postBody : Google_Service_Compute_NodeGroupsDeleteNodesRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Return values
Google_Service_Compute_Operation —

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. (nodeGroups.get)

public get(string $project, string $zone, string $nodeGroup[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Compute_NodeGroup
Parameters
$project : string

Project ID for this request.

$zone : string

The name of the zone for this request.

$nodeGroup : string

Name of the node group to return.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Compute_NodeGroup —

getIamPolicy()

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

public getIamPolicy(string $project, string $zone, string $resource[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Compute_Policy
Parameters
$project : string

Project ID for this request.

$zone : string

The name of the zone for this request.

$resource : string

Name or id of the resource for this request.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

int optionsRequestedPolicyVersion Requested IAM Policy version.

Return values
Google_Service_Compute_Policy —

insert()

Creates a NodeGroup resource in the specified project using the data included in the request. (nodeGroups.insert)

public insert(string $project, string $zone, int $initialNodeCount, Google_Service_Compute_NodeGroup $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Compute_Operation
Parameters
$project : string

Project ID for this request.

$zone : string

The name of the zone for this request.

$initialNodeCount : int

Initial count of nodes in the node group.

$postBody : Google_Service_Compute_NodeGroup
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Return values
Google_Service_Compute_Operation —

listNodeGroups()

Retrieves a list of node groups available to the specified project. Note: use nodeGroups.listNodes for more details about each group.

public listNodeGroups(string $project, string $zone[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Compute_NodeGroupList

(nodeGroups.listNodeGroups)

Parameters
$project : string

Project ID for this request.

$zone : string

The name of the zone for this request.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example: (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example: (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true)

opt_param

string maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

opt_param

string orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

opt_param

string pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

opt_param

bool returnPartialSuccess Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.

Return values
Google_Service_Compute_NodeGroupList —

listNodes()

Lists nodes in the node group. (nodeGroups.listNodes)

public listNodes(string $project, string $zone, string $nodeGroup[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Compute_NodeGroupsListNodes
Parameters
$project : string

Project ID for this request.

$zone : string

The name of the zone for this request.

$nodeGroup : string

Name of the NodeGroup resource whose nodes you want to list.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example: (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example: (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true)

opt_param

string maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

opt_param

string orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

opt_param

string pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

opt_param

bool returnPartialSuccess Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.

Return values
Google_Service_Compute_NodeGroupsListNodes —

patch()

Updates the specified node group. (nodeGroups.patch)

public patch(string $project, string $zone, string $nodeGroup, Google_Service_Compute_NodeGroup $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Compute_Operation
Parameters
$project : string

Project ID for this request.

$zone : string

The name of the zone for this request.

$nodeGroup : string

Name of the NodeGroup resource to update.

$postBody : Google_Service_Compute_NodeGroup
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Return values
Google_Service_Compute_Operation —

setIamPolicy()

Sets the access control policy on the specified resource. Replaces any existing policy. (nodeGroups.setIamPolicy)

public setIamPolicy(string $project, string $zone, string $resource, Google_Service_Compute_ZoneSetPolicyRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Compute_Policy
Parameters
$project : string

Project ID for this request.

$zone : string

The name of the zone for this request.

$resource : string

Name or id of the resource for this request.

$postBody : Google_Service_Compute_ZoneSetPolicyRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Compute_Policy —

setNodeTemplate()

Updates the node template of the node group. (nodeGroups.setNodeTemplate)

public setNodeTemplate(string $project, string $zone, string $nodeGroup, Google_Service_Compute_NodeGroupsSetNodeTemplateRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Compute_Operation
Parameters
$project : string

Project ID for this request.

$zone : string

The name of the zone for this request.

$nodeGroup : string

Name of the NodeGroup resource to update.

$postBody : Google_Service_Compute_NodeGroupsSetNodeTemplateRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Return values
Google_Service_Compute_Operation —

testIamPermissions()

Returns permissions that a caller has on the specified resource.

public testIamPermissions(string $project, string $zone, string $resource, Google_Service_Compute_TestPermissionsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Compute_TestPermissionsResponse

(nodeGroups.testIamPermissions)

Parameters
$project : string

Project ID for this request.

$zone : string

The name of the zone for this request.

$resource : string

Name or id of the resource for this request.

$postBody : Google_Service_Compute_TestPermissionsRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Compute_TestPermissionsResponse —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results