Documentation

__construct()

Parameters

$service : mixed

$serviceName : mixed

$resourceName : mixed

$resource : mixed

Return values

abandonInstances()

Flags the specified instances to be immediately removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.

Parameters

$project : string

Project ID for this request.

$region : string

Name of the region scoping this request.

$instanceGroupManager : string

Name of the managed instance group.

$postBody : Google_Service_Compute_RegionInstanceGroupManagersAbandonInstancesRequest

$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

applyUpdatesToInstances()

Apply updates to selected instances the managed instance group.

Parameters

$project : string

Project ID for this request.

$region : string

Name of the region scoping this request, should conform to RFC1035.

$instanceGroupManager : string

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

$postBody : Google_Service_Compute_RegionInstanceGroupManagersApplyUpdatesRequest

$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 regional managed instance group. Instances are created using the current instance template. The create instances operation is marked DONE if the createInstances request is successful. The underlying actions take additional time. You must separately verify the status of the creating or actions with the listmanagedinstances method. (regionInstanceGroupManagers.createInstances)

Parameters

$project : string

Project ID for this request.

$region : string

The name of the region 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_RegionInstanceGroupManagersCreateInstancesRequest

$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. (regionInstanceGroupManagers.delete)

Parameters

$project : string

Project ID for this request.

$region : string

Name of the region scoping this request.

$instanceGroupManager : string

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 to be immediately deleted. 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. The deleteInstances operation is marked DONE if the deleteInstances request is successful. The underlying actions take additional time. You must separately verify the status of the deleting action with the listmanagedinstances method.

Parameters

$project : string

Project ID for this request.

$region : string

Name of the region scoping this request.

$instanceGroupManager : string

Name of the managed instance group.

$postBody : Google_Service_Compute_RegionInstanceGroupManagersDeleteInstancesRequest

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

$region : string

Name of the region scoping this request, should conform to RFC1035.

$instanceGroupManager : string

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

$postBody : Google_Service_Compute_RegionInstanceGroupManagerDeleteInstanceConfigReq

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

Optional parameters.

Return values

get()

Returns all of the details about the specified managed instance group.

Parameters

$project : string

Project ID for this request.

$region : string

Name of the region scoping this request.

$instanceGroupManager : string

Name of the managed instance group to return.

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

$region : string

Name of the region scoping this request.

$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 regional managed instance group. The filter and orderBy query parameters are not supported.

Parameters

$project : string

Project ID for this request.

$region : string

Name of the region scoping this request. This 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

listManagedInstances()

Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances. The orderBy query parameter is not supported. (regionInstanceGroupManagers.listManagedInstances)

Parameters

$project : string

Project ID for this request.

$region : string

Name of the region scoping this request.

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

$region : string

Name of the region scoping this request, 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

listRegionInstanceGroupManagers()

Retrieves the list of managed instance groups that are contained within the specified region.

Parameters

$project : string

Project ID for this request.

$region : string

Name of the region scoping 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

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.

$region : string

Name of the region scoping this request.

$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()

Insert or patch (for the ones that already exist) per-instance configs for the managed instance group. perInstanceConfig.instance serves as a key used to distinguish whether to perform insert or patch.

Parameters

$project : string

Project ID for this request.

$region : string

Name of the region scoping this request, should conform to RFC1035.

$instanceGroupManager : string

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

$postBody : Google_Service_Compute_RegionInstanceGroupManagerPatchInstanceConfigReq

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

$region : string

Name of the region scoping this request.

$instanceGroupManager : string

Name of the managed instance group.

$postBody : Google_Service_Compute_RegionInstanceGroupManagersRecreateRequest

$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()

Changes the intended size of 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 one or more instances.

Parameters

$project : string

Project ID for this request.

$region : string

Name of the region scoping this request.

$instanceGroupManager : string

Name of the managed instance group.

$size : int

Number of instances that should exist in this instance group manager.

$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()

Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected.

Parameters

$project : string

Project ID for this request.

$region : string

Name of the region scoping this request.

$instanceGroupManager : string

The name of the managed instance group.

$postBody : Google_Service_Compute_RegionInstanceGroupManagersSetTemplateRequest

$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 new instances in this group are assigned. Existing instances in the group are not affected.

Parameters

$project : string

Project ID for this request.

$region : string

Name of the region scoping this request.

$instanceGroupManager : string

Name of the managed instance group.

$postBody : Google_Service_Compute_RegionInstanceGroupManagersSetTargetPoolsRequest

$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()

Insert or update (for the ones that already exist) per-instance configs for the managed instance group. perInstanceConfig.instance serves as a key used to distinguish whether to perform insert or patch.

Parameters

$project : string

Project ID for this request.

$region : string

Name of the region scoping this request, should conform to RFC1035.

$instanceGroupManager : string

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

$postBody : Google_Service_Compute_RegionInstanceGroupManagerUpdateInstanceConfigReq

$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