The "instanceGroups" collection of methods.
More...
|
| addInstances ($project, $zone, $instanceGroup, Google_Service_Compute_InstanceGroupsAddInstancesRequest $postBody, $optParams=array()) |
| Adds a list of instances to the specified instance group.
|
|
| aggregatedList ($project, $optParams=array()) |
| Retrieves the list of instance groups and sorts them by zone.
|
|
| call ($name, $arguments, $expected_class=null) |
| TODO: This function needs simplifying.
|
|
| delete ($project, $zone, $instanceGroup, $optParams=array()) |
| Deletes the specified instance group.
|
|
| get ($project, $zone, $instanceGroup, $optParams=array()) |
| Returns the specified instance group resource.
|
|
| insert ($project, $zone, Google_Service_Compute_InstanceGroup $postBody, $optParams=array()) |
| Creates an instance group in the specified project using the parameters that are included in the request.
|
|
| listInstanceGroups ($project, $zone, $optParams=array()) |
| Retrieves the list of instance groups that are located in the specified project and zone.
|
|
| listInstances ($project, $zone, $instanceGroup, Google_Service_Compute_InstanceGroupsListInstancesRequest $postBody, $optParams=array()) |
| Lists the instances in the specified instance group.
|
|
| removeInstances ($project, $zone, $instanceGroup, Google_Service_Compute_InstanceGroupsRemoveInstancesRequest $postBody, $optParams=array()) |
| Removes one or more instances from the specified instance group, but does not delete those instances.
|
|
| setNamedPorts ($project, $zone, $instanceGroup, Google_Service_Compute_InstanceGroupsSetNamedPortsRequest $postBody, $optParams=array()) |
| Sets the named ports for the specified instance group.
|
|
|
| convertToArrayAndStripNulls ($o) |
|
The "instanceGroups" collection of methods.
Typical usage is: $computeService = new Google_Service_Compute(...); $instanceGroups = $computeService->instanceGroups;
◆ addInstances()
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. (instanceGroups.addInstances)
- Parameters
-
string | $project | The project ID for this request. |
string | $zone | The name of the zone where the instance group is located. |
string | $instanceGroup | The name of the instance group where you are adding instances. |
Google_InstanceGroupsAddInstancesRequest | $postBody | |
array | $optParams | Optional parameters. |
- Return values
-
◆ aggregatedList()
Google_Service_Compute_InstanceGroups_Resource::aggregatedList |
( |
| $project, |
|
|
| $optParams = array() ) |
Retrieves the list of instance groups and sorts them by zone.
(instanceGroups.aggregatedList)
- Parameters
-
string | $project | The project ID for this request. |
array | $optParams | Optional parameters. |
@opt_param string filter Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.
The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
For example, filter=name ne example-instance. @opt_param string pageToken Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request. @opt_param string maxResults Maximum count of results to be returned.
- Return values
-
◆ call()
Google_Service_Resource::call |
( |
| $name, |
|
|
| $arguments, |
|
|
| $expected_class = null ) |
|
inherited |
TODO: This function needs simplifying.
- Parameters
-
$name | |
$arguments | |
$expected_class | - optional, the expected class name |
- Return values
-
Google_Http_Request|expected_class | |
- Exceptions
-
◆ delete()
Google_Service_Compute_InstanceGroups_Resource::delete |
( |
| $project, |
|
|
| $zone, |
|
|
| $instanceGroup, |
|
|
| $optParams = array() ) |
Deletes the specified instance group.
The instances in the group are not deleted. (instanceGroups.delete)
- Parameters
-
string | $project | The project ID for this request. |
string | $zone | The name of the zone where the instance group is located. |
string | $instanceGroup | The name of the instance group to delete. |
array | $optParams | Optional parameters. |
- Return values
-
◆ get()
Google_Service_Compute_InstanceGroups_Resource::get |
( |
| $project, |
|
|
| $zone, |
|
|
| $instanceGroup, |
|
|
| $optParams = array() ) |
Returns the specified instance group resource.
(instanceGroups.get)
- Parameters
-
string | $project | The project ID for this request. |
string | $zone | The name of the zone where the instance group is located. |
string | $instanceGroup | The name of the instance group. |
array | $optParams | Optional parameters. |
- Return values
-
◆ insert()
Creates an instance group in the specified project using the parameters that are included in the request.
(instanceGroups.insert)
- Parameters
-
string | $project | The project ID for this request. |
string | $zone | The name of the zone where you want to create the instance group. |
Google_InstanceGroup | $postBody | |
array | $optParams | Optional parameters. |
- Return values
-
◆ listInstanceGroups()
Google_Service_Compute_InstanceGroups_Resource::listInstanceGroups |
( |
| $project, |
|
|
| $zone, |
|
|
| $optParams = array() ) |
Retrieves the list of instance groups that are located in the specified project and zone.
(instanceGroups.listInstanceGroups)
- Parameters
-
string | $project | The project ID for this request. |
string | $zone | The name of the zone where the instance group is located. |
array | $optParams | Optional parameters. |
@opt_param string filter Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.
The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
For example, filter=name ne example-instance. @opt_param string pageToken Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request. @opt_param string maxResults Maximum count of results to be returned.
- Return values
-
◆ listInstances()
Lists the instances in the specified instance group.
(instanceGroups.listInstances)
- Parameters
-
string | $project | The project ID for this request. |
string | $zone | The name of the zone where the instance group is located. |
string | $instanceGroup | The name of the instance group from which you want to generate a list of included instances. |
Google_InstanceGroupsListInstancesRequest | $postBody | |
array | $optParams | Optional parameters. |
@opt_param string maxResults Maximum count of results to be returned. @opt_param string filter Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.
The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
For example, filter=name ne example-instance. @opt_param string pageToken Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.
- Return values
-
◆ removeInstances()
Removes one or more instances from the specified instance group, but does not delete those instances.
(instanceGroups.removeInstances)
- Parameters
-
string | $project | The project ID for this request. |
string | $zone | The name of the zone where the instance group is located. |
string | $instanceGroup | The name of the instance group where the specified instances will be removed. |
Google_InstanceGroupsRemoveInstancesRequest | $postBody | |
array | $optParams | Optional parameters. |
- Return values
-
◆ setNamedPorts()
Sets the named ports for the specified instance group.
(instanceGroups.setNamedPorts)
- Parameters
-
string | $project | The project ID for this request. |
string | $zone | The name of the zone where the instance group is located. |
string | $instanceGroup | The name of the instance group where the named ports are updated. |
Google_InstanceGroupsSetNamedPortsRequest | $postBody | |
array | $optParams | Optional parameters. |
- Return values
-
The documentation for this class was generated from the following file:
- lib/google/src/Google/Service/Compute.php