Documentation

__construct()

Parameters

$service : mixed

$serviceName : mixed

$resourceName : mixed

$resource : mixed

Return values

abandonInstances()

Flags the specified instances to be removed from the managed instance group.

Parameters

$project : string

Project ID for this request.

$zone : string

The name of the zone where the managed instance group is located.

$instanceGroupManager : string

The name of the managed instance group.

$postBody : Google_Service_Compute_InstanceGroupManagersAbandonInstancesRequest

$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

aggregatedList()

Retrieves the list of managed instance groups and groups them by zone.

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

applyUpdatesToInstances()

Applies changes to selected instances on the managed instance group. This method can be used to apply new overrides and/or new versions.

Parameters

$project : string

Project ID for this request.

$zone : string

The name of the zone where the managed instance group is located. Should conform to RFC1035.

$instanceGroupManager : string

The name of the managed instance group, should conform to RFC1035.

$postBody : Google_Service_Compute_InstanceGroupManagersApplyUpdatesRequest

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

Optional parameters.

Return values

call()

TODO: This function needs simplifying.

Parameters

$name :

$arguments :

$expectedClass : = null

• optional, the expected class name

Tags

throws

Google_Exception

Return values

createInstances()

Creates instances with per-instance configs in this managed instance group.

Parameters

$project : string

Project ID for this request.

$zone : string

The name of the zone where the managed instance group is located. It should conform to RFC1035.

$instanceGroupManager : string

The name of the managed instance group. It should conform to RFC1035.

$postBody : Google_Service_Compute_InstanceGroupManagersCreateInstancesRequest

$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.

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

Return values

createRequestUri()

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

Parameters

$restPath : string

$params : array<string|int, mixed>

Tags

static

Return values

delete()

Deletes the specified managed instance group and all of the instances in that group. Note that the instance group must not belong to a backend service.

Parameters

$project : string

Project ID for this request.

$zone : string

The name of the zone where the managed instance group is located.

$instanceGroupManager : string

The name of the managed instance group 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

deleteInstances()

Flags the specified instances in the managed instance group for immediate deletion. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.

Parameters

$project : string

Project ID for this request.

$zone : string

The name of the zone where the managed instance group is located.

$instanceGroupManager : string

The name of the managed instance group.

$postBody : Google_Service_Compute_InstanceGroupManagersDeleteInstancesRequest

$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

deletePerInstanceConfigs()

Deletes selected per-instance configs for the managed instance group.

Parameters

$project : string

Project ID for this request.

$zone : string

The name of the zone where the managed instance group is located. It should conform to RFC1035.

$instanceGroupManager : string

The name of the managed instance group. It should conform to RFC1035.

$postBody : Google_Service_Compute_InstanceGroupManagersDeletePerInstanceConfigsReq

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

Optional parameters.

Return values

get()

Returns all of the details about the specified managed instance group. Gets a list of available managed instance groups by making a list() request.

Parameters

$project : string

Project ID for this request.

$zone : string

The name of the zone where the managed instance group is located.

$instanceGroupManager : string

The name of the managed instance group.

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

Optional parameters.

Return values

insert()

Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method.

Parameters

$project : string

Project ID for this request.

$zone : string

The name of the zone where you want to create the managed instance group.

$postBody : Google_Service_Compute_InstanceGroupManager

$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

listErrors()

Lists all errors thrown by actions on instances for a given managed instance group. The filter and orderBy query parameters are not supported.

Parameters

$project : string

Project ID for this request.

$zone : string

The name of the zone where the managed instance group is located. It should conform to RFC1035.

$instanceGroupManager : string

The name of the managed instance group. It must be a string that meets the requirements in RFC1035, or an unsigned long integer: must match regexp pattern: (?:a-z?)|[1-9][0-9]{0,19}.

$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

listInstanceGroupManagers()

Retrieves a list of managed instance groups that are contained within the specified project and zone. (instanceGroupManagers.listInstanceGroupManagers)

Parameters

$project : string

Project ID for this request.

$zone : string

The name of the zone where the managed instance group is located.

$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

listManagedInstances()

Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action. The orderBy query parameter is not supported.

Parameters

$project : string

Project ID for this request.

$zone : string

The name of the zone where the managed instance group is located.

$instanceGroupManager : string

The name of the managed instance group.

$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

listPerInstanceConfigs()

Lists all of the per-instance configs defined for the managed instance group.

Parameters

$project : string

Project ID for this request.

$zone : string

The name of the zone where the managed instance group is located. It should conform to RFC1035.

$instanceGroupManager : string

The name of the managed instance group. It should conform to RFC1035.

$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

patch()

Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listManagedInstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters

$project : string

Project ID for this request.

$zone : string

The name of the zone where you want to create the managed instance group.

$instanceGroupManager : string

The name of the instance group manager.

$postBody : Google_Service_Compute_InstanceGroupManager

$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

patchPerInstanceConfigs()

Inserts or patches per-instance configs for the managed instance group.

Parameters

$project : string

Project ID for this request.

$zone : string

The name of the zone where the managed instance group is located. It should conform to RFC1035.

$instanceGroupManager : string

The name of the managed instance group. It should conform to RFC1035.

$postBody : Google_Service_Compute_InstanceGroupManagersPatchPerInstanceConfigsReq

$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

recreateInstances()

Flags the specified instances in the managed instance group to be immediately recreated. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.

Parameters

$project : string

Project ID for this request.

$zone : string

The name of the zone where the managed instance group is located.

$instanceGroupManager : string

The name of the managed instance group.

$postBody : Google_Service_Compute_InstanceGroupManagersRecreateInstancesRequest

$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

resize()

Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.

Parameters

$project : string

Project ID for this request.

$zone : string

The name of the zone where the managed instance group is located.

$instanceGroupManager : string

The name of the managed instance group.

$size : int

The number of running instances that the managed instance group should maintain at any given time. The group automatically adds or removes instances to maintain the number of instances specified by this parameter.

$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

setInstanceTemplate()

Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you recreate them. (instanceGroupManagers.setInstanceTemplate)

Parameters

$project : string

Project ID for this request.

$zone : string

The name of the zone where the managed instance group is located.

$instanceGroupManager : string

The name of the managed instance group.

$postBody : Google_Service_Compute_InstanceGroupManagersSetInstanceTemplateRequest

$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

setTargetPools()

Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group.

Parameters

$project : string

Project ID for this request.

$zone : string

The name of the zone where the managed instance group is located.

$instanceGroupManager : string

The name of the managed instance group.

$postBody : Google_Service_Compute_InstanceGroupManagersSetTargetPoolsRequest

$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

updatePerInstanceConfigs()

Inserts or updates per-instance configs for the managed instance group.

Parameters

$project : string

Project ID for this request.

$zone : string

The name of the zone where the managed instance group is located. It should conform to RFC1035.

$instanceGroupManager : string

The name of the managed instance group. It should conform to RFC1035.

$postBody : Google_Service_Compute_InstanceGroupManagersUpdatePerInstanceConfigsReq

$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