Viewing file:  InstanceGroups.php (20.78 KB) -rw-r--r--
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
/**
* The "instanceGroups" collection of methods.
* Typical usage is:
* <code>
* $computeService = new Google_Service_Compute(...);
* $instanceGroups = $computeService->instanceGroups;
* </code>
*/
class Google_Service_Compute_Resource_InstanceGroups extends Google_Service_Resource
{
/**
* Adds a list of instances to the specified instance group. All of the
* instances in the instance group must be in the same network/subnetwork. Read
* Adding instances for more information. (instanceGroups.addInstances)
*
* @param string $project Project ID for this request.
* @param string $zone The name of the zone where the instance group is located.
* @param string $instanceGroup The name of the instance group where you are
* adding instances.
* @param Google_Service_Compute_InstanceGroupsAddInstancesRequest $postBody
* @param array $optParams Optional parameters.
*
* @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 Google_Service_Compute_Operation
*/
public function addInstances($project, $zone, $instanceGroup, Google_Service_Compute_InstanceGroupsAddInstancesRequest $postBody, $optParams = array())
{
$params = array('project' => $project, 'zone' => $zone, 'instanceGroup' => $instanceGroup, 'postBody' => $postBody);
$params = array_merge($params, $optParams);
return $this->call('addInstances', array($params), "Google_Service_Compute_Operation");
}
/**
* Retrieves the list of instance groups and sorts them by zone.
* (instanceGroups.aggregatedList)
*
* @param string $project Project ID for this request.
* @param array $optParams Optional parameters.
*
* @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.
* @return Google_Service_Compute_InstanceGroupAggregatedList
*/
public function aggregatedList($project, $optParams = array())
{
$params = array('project' => $project);
$params = array_merge($params, $optParams);
return $this->call('aggregatedList', array($params), "Google_Service_Compute_InstanceGroupAggregatedList");
}
/**
* Deletes the specified instance group. The instances in the group are not
* deleted. Note that instance group must not belong to a backend service. Read
* Deleting an instance group for more information. (instanceGroups.delete)
*
* @param string $project Project ID for this request.
* @param string $zone The name of the zone where the instance group is located.
* @param string $instanceGroup The name of the instance group to delete.
* @param array $optParams Optional parameters.
*
* @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 Google_Service_Compute_Operation
*/
public function delete($project, $zone, $instanceGroup, $optParams = array())
{
$params = array('project' => $project, 'zone' => $zone, 'instanceGroup' => $instanceGroup);
$params = array_merge($params, $optParams);
return $this->call('delete', array($params), "Google_Service_Compute_Operation");
}
/**
* Returns the specified zonal instance group. Get a list of available zonal
* instance groups by making a list() request.
*
* For managed instance groups, use the instanceGroupManagers or
* regionInstanceGroupManagers methods instead. (instanceGroups.get)
*
* @param string $project Project ID for this request.
* @param string $zone The name of the zone where the instance group is located.
* @param string $instanceGroup The name of the instance group.
* @param array $optParams Optional parameters.
* @return Google_Service_Compute_InstanceGroup
*/
public function get($project, $zone, $instanceGroup, $optParams = array())
{
$params = array('project' => $project, 'zone' => $zone, 'instanceGroup' => $instanceGroup);
$params = array_merge($params, $optParams);
return $this->call('get', array($params), "Google_Service_Compute_InstanceGroup");
}
/**
* Creates an instance group in the specified project using the parameters that
* are included in the request. (instanceGroups.insert)
*
* @param string $project Project ID for this request.
* @param string $zone The name of the zone where you want to create the
* instance group.
* @param Google_Service_Compute_InstanceGroup $postBody
* @param array $optParams Optional parameters.
*
* @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 Google_Service_Compute_Operation
*/
public function insert($project, $zone, Google_Service_Compute_InstanceGroup $postBody, $optParams = array())
{
$params = array('project' => $project, 'zone' => $zone, 'postBody' => $postBody);
$params = array_merge($params, $optParams);
return $this->call('insert', array($params), "Google_Service_Compute_Operation");
}
/**
* Retrieves the list of zonal instance group resources contained within the
* specified zone.
*
* For managed instance groups, use the instanceGroupManagers or
* regionInstanceGroupManagers methods instead.
* (instanceGroups.listInstanceGroups)
*
* @param string $project Project ID for this request.
* @param string $zone The name of the zone where the instance group is located.
* @param array $optParams Optional parameters.
*
* @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.
* @return Google_Service_Compute_InstanceGroupList
*/
public function listInstanceGroups($project, $zone, $optParams = array())
{
$params = array('project' => $project, 'zone' => $zone);
$params = array_merge($params, $optParams);
return $this->call('list', array($params), "Google_Service_Compute_InstanceGroupList");
}
/**
* Lists the instances in the specified instance group. The orderBy query
* parameter is not supported. (instanceGroups.listInstances)
*
* @param string $project Project ID for this request.
* @param string $zone The name of the zone where the instance group is located.
* @param string $instanceGroup The name of the instance group from which you
* want to generate a list of included instances.
* @param Google_Service_Compute_InstanceGroupsListInstancesRequest $postBody
* @param array $optParams Optional parameters.
*
* @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.
* @return Google_Service_Compute_InstanceGroupsListInstances
*/
public function listInstances($project, $zone, $instanceGroup, Google_Service_Compute_InstanceGroupsListInstancesRequest $postBody, $optParams = array())
{
$params = array('project' => $project, 'zone' => $zone, 'instanceGroup' => $instanceGroup, 'postBody' => $postBody);
$params = array_merge($params, $optParams);
return $this->call('listInstances', array($params), "Google_Service_Compute_InstanceGroupsListInstances");
}
/**
* Removes one or more instances from the specified instance group, but does not
* delete those instances.
*
* If the group is part of a backend service that has enabled connection
* draining, it can take up to 60 seconds after the connection draining duration
* before the VM instance is removed or deleted.
* (instanceGroups.removeInstances)
*
* @param string $project Project ID for this request.
* @param string $zone The name of the zone where the instance group is located.
* @param string $instanceGroup The name of the instance group where the
* specified instances will be removed.
* @param Google_Service_Compute_InstanceGroupsRemoveInstancesRequest $postBody
* @param array $optParams Optional parameters.
*
* @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 Google_Service_Compute_Operation
*/
public function removeInstances($project, $zone, $instanceGroup, Google_Service_Compute_InstanceGroupsRemoveInstancesRequest $postBody, $optParams = array())
{
$params = array('project' => $project, 'zone' => $zone, 'instanceGroup' => $instanceGroup, 'postBody' => $postBody);
$params = array_merge($params, $optParams);
return $this->call('removeInstances', array($params), "Google_Service_Compute_Operation");
}
/**
* Sets the named ports for the specified instance group.
* (instanceGroups.setNamedPorts)
*
* @param string $project Project ID for this request.
* @param string $zone The name of the zone where the instance group is located.
* @param string $instanceGroup The name of the instance group where the named
* ports are updated.
* @param Google_Service_Compute_InstanceGroupsSetNamedPortsRequest $postBody
* @param array $optParams Optional parameters.
*
* @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 Google_Service_Compute_Operation
*/
public function setNamedPorts($project, $zone, $instanceGroup, Google_Service_Compute_InstanceGroupsSetNamedPortsRequest $postBody, $optParams = array())
{
$params = array('project' => $project, 'zone' => $zone, 'instanceGroup' => $instanceGroup, 'postBody' => $postBody);
$params = array_merge($params, $optParams);
return $this->call('setNamedPorts', array($params), "Google_Service_Compute_Operation");
}
}
|