Class InstanceGroupManagersClient (0.1.0)

InstanceGroupManagersClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.compute_v1.services.instance_group_managers.transports.base.InstanceGroupManagersTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

The InstanceGroupManagers API.

Properties

transport

Return the transport used by the client instance.

Returns
Type	Description
`InstanceGroupManagersTransport`	The transport used by the client instance.

Methods

InstanceGroupManagersClient

InstanceGroupManagersClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.compute_v1.services.instance_group_managers.transports.base.InstanceGroupManagersTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiate the instance group managers client.

Parameters
Name	Description
`credentials`	`Optional[google.auth.credentials.Credentials]` The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
`transport`	`Union[str, InstanceGroupManagersTransport]` The transport to use. If set to None, a transport is chosen automatically.
`client_options`	`google.api_core.client_options.ClientOptions` Custom options for the client. It won't take effect if a `transport` instance is provided. (1) The `api_endpoint` property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the `api_endpoint` property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the `client_cert_source` property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.
`client_info`	`google.api_core.gapic_v1.client_info.ClientInfo` The client info used to send a user-agent string along with API requests. If `None`, then default info will be used. Generally, you only need to set this if you're developing your own client library.

Exceptions
Type	Description
`google.auth.exceptions.MutualTLSChannelError`	If mutual TLS transport creation failed for any reason.

abandon_instances

abandon_instances(request: Optional[google.cloud.compute_v1.types.compute.AbandonInstancesInstanceGroupManagerRequest] = None, *, project: Optional[str] = None, zone: Optional[str] = None, instance_group_manager: Optional[str] = None, instance_group_managers_abandon_instances_request_resource: Optional[google.cloud.compute_v1.types.compute.InstanceGroupManagersAbandonInstancesRequest] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Flags the specified instances to be 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. 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 has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.

Parameters
Name	Description
`request`	`google.cloud.compute_v1.types.AbandonInstancesInstanceGroupManagerRequest` The request object. A request message for InstanceGroupManagers.AbandonInstances. See the method description for details.
`project`	`str` Project ID for this request. This corresponds to the `project` field on the `request` instance; if `request` is provided, this should not be set.
`zone`	`str` The name of the zone where the managed instance group is located. This corresponds to the `zone` field on the `request` instance; if `request` is provided, this should not be set.
`instance_group_manager`	`str` The name of the managed instance group. This corresponds to the `instance_group_manager` field on the `request` instance; if `request` is provided, this should not be set.
`instance_group_managers_abandon_instances_request_resource`	`google.cloud.compute_v1.types.InstanceGroupManagersAbandonInstancesRequest` The body resource for this request This corresponds to the `instance_group_managers_abandon_instances_request_resource` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type Description

google.cloud.compute_v1.types.Operation Represents an Operation resource. Google Compute Engine has three Operation resources: - [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) \* [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) \* [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the globalOperations resource. - For regional operations, use the regionOperations resource. - For zonal operations, use the zonalOperations resource. For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

aggregated_list

aggregated_list(request: Optional[google.cloud.compute_v1.types.compute.AggregatedListInstanceGroupManagersRequest] = None, *, project: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

Parameters
Name	Description
`request`	`google.cloud.compute_v1.types.AggregatedListInstanceGroupManagersRequest` The request object. A request message for InstanceGroupManagers.AggregatedList. See the method description for details.
`project`	`str` Project ID for this request. This corresponds to the `project` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

apply_updates_to_instances

apply_updates_to_instances(request: Optional[google.cloud.compute_v1.types.compute.ApplyUpdatesToInstancesInstanceGroupManagerRequest] = None, *, project: Optional[str] = None, zone: Optional[str] = None, instance_group_manager: Optional[str] = None, instance_group_managers_apply_updates_request_resource: Optional[google.cloud.compute_v1.types.compute.InstanceGroupManagersApplyUpdatesRequest] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

Parameters
Name	Description
`request`	`google.cloud.compute_v1.types.ApplyUpdatesToInstancesInstanceGroupManagerRequest` The request object. A request message for InstanceGroupManagers.ApplyUpdatesToInstances. See the method description for details.
`project`	`str` Project ID for this request. This corresponds to the `project` field on the `request` instance; if `request` is provided, this should not be set.
`zone`	`str` The name of the zone where the managed instance group is located. Should conform to RFC1035. This corresponds to the `zone` field on the `request` instance; if `request` is provided, this should not be set.
`instance_group_manager`	`str` The name of the managed instance group, should conform to RFC1035. This corresponds to the `instance_group_manager` field on the `request` instance; if `request` is provided, this should not be set.
`instance_group_managers_apply_updates_request_resource`	`google.cloud.compute_v1.types.InstanceGroupManagersApplyUpdatesRequest` The body resource for this request This corresponds to the `instance_group_managers_apply_updates_request_resource` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type Description

common_billing_account_path

common_billing_account_path(billing_account: str)

Return a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Return a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Return a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Return a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Return a fully-qualified project string.

create_instances

create_instances(request: Optional[google.cloud.compute_v1.types.compute.CreateInstancesInstanceGroupManagerRequest] = None, *, project: Optional[str] = None, zone: Optional[str] = None, instance_group_manager: Optional[str] = None, instance_group_managers_create_instances_request_resource: Optional[google.cloud.compute_v1.types.compute.InstanceGroupManagersCreateInstancesRequest] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates instances with per-instance configs in this 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.

Parameters
Name	Description
`request`	`google.cloud.compute_v1.types.CreateInstancesInstanceGroupManagerRequest` The request object. A request message for InstanceGroupManagers.CreateInstances. See the method description for details.
`project`	`str` Project ID for this request. This corresponds to the `project` field on the `request` instance; if `request` is provided, this should not be set.
`zone`	`str` The name of the zone where the managed instance group is located. It should conform to RFC1035. This corresponds to the `zone` field on the `request` instance; if `request` is provided, this should not be set.
`instance_group_manager`	`str` The name of the managed instance group. It should conform to RFC1035. This corresponds to the `instance_group_manager` field on the `request` instance; if `request` is provided, this should not be set.
`instance_group_managers_create_instances_request_resource`	`google.cloud.compute_v1.types.InstanceGroupManagersCreateInstancesRequest` The body resource for this request This corresponds to the `instance_group_managers_create_instances_request_resource` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type Description

delete

delete(request: Optional[google.cloud.compute_v1.types.compute.DeleteInstanceGroupManagerRequest] = None, *, project: Optional[str] = None, zone: Optional[str] = None, instance_group_manager: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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. Read Deleting an instance group for more information.

Parameters
Name	Description
`request`	`google.cloud.compute_v1.types.DeleteInstanceGroupManagerRequest` The request object. A request message for InstanceGroupManagers.Delete. See the method description for details.
`project`	`str` Project ID for this request. This corresponds to the `project` field on the `request` instance; if `request` is provided, this should not be set.
`zone`	`str` The name of the zone where the managed instance group is located. This corresponds to the `zone` field on the `request` instance; if `request` is provided, this should not be set.
`instance_group_manager`	`str` The name of the managed instance group to delete. This corresponds to the `instance_group_manager` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type Description

delete_instances

delete_instances(request: Optional[google.cloud.compute_v1.types.compute.DeleteInstancesInstanceGroupManagerRequest] = None, *, project: Optional[str] = None, zone: Optional[str] = None, instance_group_manager: Optional[str] = None, instance_group_managers_delete_instances_request_resource: Optional[google.cloud.compute_v1.types.compute.InstanceGroupManagersDeleteInstancesRequest] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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. 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 has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.

Parameters
Name	Description
`request`	`google.cloud.compute_v1.types.DeleteInstancesInstanceGroupManagerRequest` The request object. A request message for InstanceGroupManagers.DeleteInstances. See the method description for details.
`project`	`str` Project ID for this request. This corresponds to the `project` field on the `request` instance; if `request` is provided, this should not be set.
`zone`	`str` The name of the zone where the managed instance group is located. This corresponds to the `zone` field on the `request` instance; if `request` is provided, this should not be set.
`instance_group_manager`	`str` The name of the managed instance group. This corresponds to the `instance_group_manager` field on the `request` instance; if `request` is provided, this should not be set.
`instance_group_managers_delete_instances_request_resource`	`google.cloud.compute_v1.types.InstanceGroupManagersDeleteInstancesRequest` The body resource for this request This corresponds to the `instance_group_managers_delete_instances_request_resource` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type Description

delete_per_instance_configs

delete_per_instance_configs(request: Optional[google.cloud.compute_v1.types.compute.DeletePerInstanceConfigsInstanceGroupManagerRequest] = None, *, project: Optional[str] = None, zone: Optional[str] = None, instance_group_manager: Optional[str] = None, instance_group_managers_delete_per_instance_configs_req_resource: Optional[google.cloud.compute_v1.types.compute.InstanceGroupManagersDeletePerInstanceConfigsReq] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

Parameters
Name	Description
`request`	`google.cloud.compute_v1.types.DeletePerInstanceConfigsInstanceGroupManagerRequest` The request object. A request message for InstanceGroupManagers.DeletePerInstanceConfigs. See the method description for details.
`project`	`str` Project ID for this request. This corresponds to the `project` field on the `request` instance; if `request` is provided, this should not be set.
`zone`	`str` The name of the zone where the managed instance group is located. It should conform to RFC1035. This corresponds to the `zone` field on the `request` instance; if `request` is provided, this should not be set.
`instance_group_manager`	`str` The name of the managed instance group. It should conform to RFC1035. This corresponds to the `instance_group_manager` field on the `request` instance; if `request` is provided, this should not be set.
`instance_group_managers_delete_per_instance_configs_req_resource`	`google.cloud.compute_v1.types.InstanceGroupManagersDeletePerInstanceConfigsReq` The body resource for this request This corresponds to the `instance_group_managers_delete_per_instance_configs_req_resource` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type Description

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name	Description
`filename`	`str` The path to the service account private key json file.

Returns
Type	Description
`InstanceGroupManagersClient`	The constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

Parameter
Name	Description
`info`	`dict` The service account private key info.

Returns
Type	Description
`InstanceGroupManagersClient`	The constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name	Description
`filename`	`str` The path to the service account private key json file.

Returns
Type	Description
`InstanceGroupManagersClient`	The constructed client.

get

get(request: Optional[google.cloud.compute_v1.types.compute.GetInstanceGroupManagerRequest] = None, *, project: Optional[str] = None, zone: Optional[str] = None, instance_group_manager: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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
Name	Description
`request`	`google.cloud.compute_v1.types.GetInstanceGroupManagerRequest` The request object. A request message for InstanceGroupManagers.Get. See the method description for details.
`project`	`str` Project ID for this request. This corresponds to the `project` field on the `request` instance; if `request` is provided, this should not be set.
`zone`	`str` The name of the zone where the managed instance group is located. This corresponds to the `zone` field on the `request` instance; if `request` is provided, this should not be set.
`instance_group_manager`	`str` The name of the managed instance group. This corresponds to the `instance_group_manager` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type Description

google.cloud.compute_v1.types.InstanceGroupManager Represents a Managed Instance Group resource. An instance group is a collection of VM instances that you can manage as a single entity. For more information, read Instance groups. For zonal Managed Instance Group, use the instanceGroupManagers resource. For regional Managed Instance Group, use the regionInstanceGroupManagers resource. (== resource_for {$api_version}.instanceGroupManagers ==) (== resource_for {$api_version}.regionInstanceGroupManagers ==)

insert

insert(request: Optional[google.cloud.compute_v1.types.compute.InsertInstanceGroupManagerRequest] = None, *, project: Optional[str] = None, zone: Optional[str] = None, instance_group_manager_resource: Optional[google.cloud.compute_v1.types.compute.InstanceGroupManager] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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. A managed instance group can have up to 1000 VM instances per group. Please contact Cloud Support if you need an increase in this limit.

Parameters
Name	Description
`request`	`google.cloud.compute_v1.types.InsertInstanceGroupManagerRequest` The request object. A request message for InstanceGroupManagers.Insert. See the method description for details.
`project`	`str` Project ID for this request. This corresponds to the `project` field on the `request` instance; if `request` is provided, this should not be set.
`zone`	`str` The name of the zone where you want to create the managed instance group. This corresponds to the `zone` field on the `request` instance; if `request` is provided, this should not be set.
`instance_group_manager_resource`	`google.cloud.compute_v1.types.InstanceGroupManager` The body resource for this request This corresponds to the `instance_group_manager_resource` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type Description

list

list(request: Optional[google.cloud.compute_v1.types.compute.ListInstanceGroupManagersRequest] = None, *, project: Optional[str] = None, zone: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

Parameters
Name	Description
`request`	`google.cloud.compute_v1.types.ListInstanceGroupManagersRequest` The request object. A request message for InstanceGroupManagers.List. See the method description for details.
`project`	`str` Project ID for this request. This corresponds to the `project` field on the `request` instance; if `request` is provided, this should not be set.
`zone`	`str` The name of the zone where the managed instance group is located. This corresponds to the `zone` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.compute_v1.types.InstanceGroupManagerList`	[Output Only] A list of managed instance groups.

list_errors

list_errors(request: Optional[google.cloud.compute_v1.types.compute.ListErrorsInstanceGroupManagersRequest] = None, *, project: Optional[str] = None, zone: Optional[str] = None, instance_group_manager: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

Parameters
Name	Description
`request`	`google.cloud.compute_v1.types.ListErrorsInstanceGroupManagersRequest` The request object. A request message for InstanceGroupManagers.ListErrors. See the method description for details.
`project`	`str` Project ID for this request. This corresponds to the `project` field on the `request` instance; if `request` is provided, this should not be set.
`zone`	`str` The name of the zone where the managed instance group is located. It should conform to RFC1035. This corresponds to the `zone` field on the `request` instance; if `request` is provided, this should not be set.
`instance_group_manager`	`str` 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 <?:[-a-z0-9]{0,61}[a-z0-9]>`__?)\|`1-9][0-9]`{0,19}. This corresponds to the `instance_group_manager` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

list_managed_instances

list_managed_instances(request: Optional[google.cloud.compute_v1.types.compute.ListManagedInstancesInstanceGroupManagersRequest] = None, *, project: Optional[str] = None, zone: Optional[str] = None, instance_group_manager: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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
Name	Description
`request`	`google.cloud.compute_v1.types.ListManagedInstancesInstanceGroupManagersRequest` The request object. A request message for InstanceGroupManagers.ListManagedInstances. See the method description for details.
`project`	`str` Project ID for this request. This corresponds to the `project` field on the `request` instance; if `request` is provided, this should not be set.
`zone`	`str` The name of the zone where the managed instance group is located. This corresponds to the `zone` field on the `request` instance; if `request` is provided, this should not be set.
`instance_group_manager`	`str` The name of the managed instance group. This corresponds to the `instance_group_manager` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

list_per_instance_configs

list_per_instance_configs(request: Optional[google.cloud.compute_v1.types.compute.ListPerInstanceConfigsInstanceGroupManagersRequest] = None, *, project: Optional[str] = None, zone: Optional[str] = None, instance_group_manager: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists all of the per-instance configs defined for the managed instance group. The orderBy query parameter is not supported.

Parameters
Name	Description
`request`	`google.cloud.compute_v1.types.ListPerInstanceConfigsInstanceGroupManagersRequest` The request object. A request message for InstanceGroupManagers.ListPerInstanceConfigs. See the method description for details.
`project`	`str` Project ID for this request. This corresponds to the `project` field on the `request` instance; if `request` is provided, this should not be set.
`zone`	`str` The name of the zone where the managed instance group is located. It should conform to RFC1035. This corresponds to the `zone` field on the `request` instance; if `request` is provided, this should not be set.
`instance_group_manager`	`str` The name of the managed instance group. It should conform to RFC1035. This corresponds to the `instance_group_manager` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

patch

patch(request: Optional[google.cloud.compute_v1.types.compute.PatchInstanceGroupManagerRequest] = None, *, project: Optional[str] = None, zone: Optional[str] = None, instance_group_manager: Optional[str] = None, instance_group_manager_resource: Optional[google.cloud.compute_v1.types.compute.InstanceGroupManager] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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
Name	Description
`request`	`google.cloud.compute_v1.types.PatchInstanceGroupManagerRequest` The request object. A request message for InstanceGroupManagers.Patch. See the method description for details.
`project`	`str` Project ID for this request. This corresponds to the `project` field on the `request` instance; if `request` is provided, this should not be set.
`zone`	`str` The name of the zone where you want to create the managed instance group. This corresponds to the `zone` field on the `request` instance; if `request` is provided, this should not be set.
`instance_group_manager`	`str` The name of the instance group manager. This corresponds to the `instance_group_manager` field on the `request` instance; if `request` is provided, this should not be set.
`instance_group_manager_resource`	`google.cloud.compute_v1.types.InstanceGroupManager` The body resource for this request This corresponds to the `instance_group_manager_resource` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type Description

patch_per_instance_configs

patch_per_instance_configs(request: Optional[google.cloud.compute_v1.types.compute.PatchPerInstanceConfigsInstanceGroupManagerRequest] = None, *, project: Optional[str] = None, zone: Optional[str] = None, instance_group_manager: Optional[str] = None, instance_group_managers_patch_per_instance_configs_req_resource: Optional[google.cloud.compute_v1.types.compute.InstanceGroupManagersPatchPerInstanceConfigsReq] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Inserts or patches per-instance configs for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.

Parameters
Name	Description
`request`	`google.cloud.compute_v1.types.PatchPerInstanceConfigsInstanceGroupManagerRequest` The request object. A request message for InstanceGroupManagers.PatchPerInstanceConfigs. See the method description for details.
`project`	`str` Project ID for this request. This corresponds to the `project` field on the `request` instance; if `request` is provided, this should not be set.
`zone`	`str` The name of the zone where the managed instance group is located. It should conform to RFC1035. This corresponds to the `zone` field on the `request` instance; if `request` is provided, this should not be set.
`instance_group_manager`	`str` The name of the managed instance group. It should conform to RFC1035. This corresponds to the `instance_group_manager` field on the `request` instance; if `request` is provided, this should not be set.
`instance_group_managers_patch_per_instance_configs_req_resource`	`google.cloud.compute_v1.types.InstanceGroupManagersPatchPerInstanceConfigsReq` The body resource for this request This corresponds to the `instance_group_managers_patch_per_instance_configs_req_resource` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type Description

recreate_instances

recreate_instances(request: Optional[google.cloud.compute_v1.types.compute.RecreateInstancesInstanceGroupManagerRequest] = None, *, project: Optional[str] = None, zone: Optional[str] = None, instance_group_manager: Optional[str] = None, instance_group_managers_recreate_instances_request_resource: Optional[google.cloud.compute_v1.types.compute.InstanceGroupManagersRecreateInstancesRequest] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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. 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 has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.

Parameters
Name	Description
`request`	`google.cloud.compute_v1.types.RecreateInstancesInstanceGroupManagerRequest` The request object. A request message for InstanceGroupManagers.RecreateInstances. See the method description for details.
`project`	`str` Project ID for this request. This corresponds to the `project` field on the `request` instance; if `request` is provided, this should not be set.
`zone`	`str` The name of the zone where the managed instance group is located. This corresponds to the `zone` field on the `request` instance; if `request` is provided, this should not be set.
`instance_group_manager`	`str` The name of the managed instance group. This corresponds to the `instance_group_manager` field on the `request` instance; if `request` is provided, this should not be set.
`instance_group_managers_recreate_instances_request_resource`	`google.cloud.compute_v1.types.InstanceGroupManagersRecreateInstancesRequest` The body resource for this request This corresponds to the `instance_group_managers_recreate_instances_request_resource` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type Description

resize

resize(request: Optional[google.cloud.compute_v1.types.compute.ResizeInstanceGroupManagerRequest] = None, *, project: Optional[str] = None, zone: Optional[str] = None, instance_group_manager: Optional[str] = None, size: Optional[int] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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. When resizing down, the instance group arbitrarily chooses the order in which VMs are deleted. The group takes into account some VM attributes when making the selection including:

The status of the VM instance. + The health of the VM instance. + The instance template version the VM is based on. + For regional managed instance groups, the location of the VM instance. This list is subject to change.

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 has elapsed before the VM instance is removed or deleted.

Parameters
Name	Description
`request`	`google.cloud.compute_v1.types.ResizeInstanceGroupManagerRequest` The request object. A request message for InstanceGroupManagers.Resize. See the method description for details.
`project`	`str` Project ID for this request. This corresponds to the `project` field on the `request` instance; if `request` is provided, this should not be set.
`zone`	`str` The name of the zone where the managed instance group is located. This corresponds to the `zone` field on the `request` instance; if `request` is provided, this should not be set.
`instance_group_manager`	`str` The name of the managed instance group. This corresponds to the `instance_group_manager` field on the `request` instance; if `request` is provided, this should not be set.
`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. This corresponds to the `size` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type Description

set_instance_template

set_instance_template(request: Optional[google.cloud.compute_v1.types.compute.SetInstanceTemplateInstanceGroupManagerRequest] = None, *, project: Optional[str] = None, zone: Optional[str] = None, instance_group_manager: Optional[str] = None, instance_group_managers_set_instance_template_request_resource: Optional[google.cloud.compute_v1.types.compute.InstanceGroupManagersSetInstanceTemplateRequest] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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 run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE.

Parameters
Name	Description
`request`	`google.cloud.compute_v1.types.SetInstanceTemplateInstanceGroupManagerRequest` The request object. A request message for InstanceGroupManagers.SetInstanceTemplate. See the method description for details.
`project`	`str` Project ID for this request. This corresponds to the `project` field on the `request` instance; if `request` is provided, this should not be set.
`zone`	`str` The name of the zone where the managed instance group is located. This corresponds to the `zone` field on the `request` instance; if `request` is provided, this should not be set.
`instance_group_manager`	`str` The name of the managed instance group. This corresponds to the `instance_group_manager` field on the `request` instance; if `request` is provided, this should not be set.
`instance_group_managers_set_instance_template_request_resource`	`google.cloud.compute_v1.types.InstanceGroupManagersSetInstanceTemplateRequest` The body resource for this request This corresponds to the `instance_group_managers_set_instance_template_request_resource` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type Description

set_target_pools

set_target_pools(request: Optional[google.cloud.compute_v1.types.compute.SetTargetPoolsInstanceGroupManagerRequest] = None, *, project: Optional[str] = None, zone: Optional[str] = None, instance_group_manager: Optional[str] = None, instance_group_managers_set_target_pools_request_resource: Optional[google.cloud.compute_v1.types.compute.InstanceGroupManagersSetTargetPoolsRequest] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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
Name	Description
`request`	`google.cloud.compute_v1.types.SetTargetPoolsInstanceGroupManagerRequest` The request object. A request message for InstanceGroupManagers.SetTargetPools. See the method description for details.
`project`	`str` Project ID for this request. This corresponds to the `project` field on the `request` instance; if `request` is provided, this should not be set.
`zone`	`str` The name of the zone where the managed instance group is located. This corresponds to the `zone` field on the `request` instance; if `request` is provided, this should not be set.
`instance_group_manager`	`str` The name of the managed instance group. This corresponds to the `instance_group_manager` field on the `request` instance; if `request` is provided, this should not be set.
`instance_group_managers_set_target_pools_request_resource`	`google.cloud.compute_v1.types.InstanceGroupManagersSetTargetPoolsRequest` The body resource for this request This corresponds to the `instance_group_managers_set_target_pools_request_resource` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type Description

update_per_instance_configs

update_per_instance_configs(request: Optional[google.cloud.compute_v1.types.compute.UpdatePerInstanceConfigsInstanceGroupManagerRequest] = None, *, project: Optional[str] = None, zone: Optional[str] = None, instance_group_manager: Optional[str] = None, instance_group_managers_update_per_instance_configs_req_resource: Optional[google.cloud.compute_v1.types.compute.InstanceGroupManagersUpdatePerInstanceConfigsReq] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Inserts or updates per-instance configs for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.

Parameters
Name	Description
`request`	`google.cloud.compute_v1.types.UpdatePerInstanceConfigsInstanceGroupManagerRequest` The request object. A request message for InstanceGroupManagers.UpdatePerInstanceConfigs. See the method description for details.
`project`	`str` Project ID for this request. This corresponds to the `project` field on the `request` instance; if `request` is provided, this should not be set.
`zone`	`str` The name of the zone where the managed instance group is located. It should conform to RFC1035. This corresponds to the `zone` field on the `request` instance; if `request` is provided, this should not be set.
`instance_group_manager`	`str` The name of the managed instance group. It should conform to RFC1035. This corresponds to the `instance_group_manager` field on the `request` instance; if `request` is provided, this should not be set.
`instance_group_managers_update_per_instance_configs_req_resource`	`google.cloud.compute_v1.types.InstanceGroupManagersUpdatePerInstanceConfigsReq` The body resource for this request This corresponds to the `instance_group_managers_update_per_instance_configs_req_resource` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type Description