As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

InstanceGroupManagers¶

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

The InstanceGroupManagers API.

Instantiates the instance group managers client.

Parameters

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 (Optional[Union[str,InstanceGroupManagersTransport,Callable[..., InstanceGroupManagersTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the InstanceGroupManagersTransport constructor. If set to None, a transport is chosen automatically. NOTE: “rest” transport functionality is currently in a beta state (preview). We welcome your feedback via an issue in this library’s source repository.
client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]) –
Custom options for the client.

1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “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).

2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide a client certificate for mTLS 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.

3. The universe_domain property can be used to override the default “googleapis.com” universe. Note that the api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.
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.

Raises

google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.

__exit__(type, value, traceback)[source]¶: Releases underlying transport’s resources.

Warning

ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

abandon_instances(request: Optional[Union[google.cloud.compute_v1.types.compute.AbandonInstancesInstanceGroupManagerRequest, dict]] = 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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.extended_operation.ExtendedOperation[source]¶

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_abandon_instances():
    # Create a client
    client = compute_v1.InstanceGroupManagersClient()

    # Initialize request argument(s)
    request = compute_v1.AbandonInstancesInstanceGroupManagerRequest(
        instance_group_manager="instance_group_manager_value",
        project="project_value",
        zone="zone_value",
    )

    # Make the request
    response = client.abandon_instances(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.compute_v1.types.AbandonInstancesInstanceGroupManagerRequest, dict]) – 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

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

abandon_instances_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.AbandonInstancesInstanceGroupManagerRequest, dict]] = 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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.compute_v1.types.compute.Operation[source]¶

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_abandon_instances():
    # Create a client
    client = compute_v1.InstanceGroupManagersClient()

    # Initialize request argument(s)
    request = compute_v1.AbandonInstancesInstanceGroupManagerRequest(
        instance_group_manager="instance_group_manager_value",
        project="project_value",
        zone="zone_value",
    )

    # Make the request
    response = client.abandon_instances(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.compute_v1.types.AbandonInstancesInstanceGroupManagerRequest, dict]) – 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

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

aggregated_list(request: Optional[Union[google.cloud.compute_v1.types.compute.AggregatedListInstanceGroupManagersRequest, dict]] = None, *, project: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.compute_v1.services.instance_group_managers.pagers.AggregatedListPager[source]¶

Retrieves the list of managed instance groups and groups them by zone. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_aggregated_list():
    # Create a client
    client = compute_v1.InstanceGroupManagersClient()

    # Initialize request argument(s)
    request = compute_v1.AggregatedListInstanceGroupManagersRequest(
        project="project_value",
    )

    # Make the request
    page_result = client.aggregated_list(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

request (Union[google.cloud.compute_v1.types.AggregatedListInstanceGroupManagersRequest, dict]) – 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.

Returns

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.compute_v1.services.instance_group_managers.pagers.AggregatedListPager

property api_endpoint¶

Return the API endpoint used by the client instance.

Returns: The API endpoint used by the client instance.
Return type: str

apply_updates_to_instances(request: Optional[Union[google.cloud.compute_v1.types.compute.ApplyUpdatesToInstancesInstanceGroupManagerRequest, dict]] = 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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.extended_operation.ExtendedOperation[source]¶

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_apply_updates_to_instances():
    # Create a client
    client = compute_v1.InstanceGroupManagersClient()

    # Initialize request argument(s)
    request = compute_v1.ApplyUpdatesToInstancesInstanceGroupManagerRequest(
        instance_group_manager="instance_group_manager_value",
        project="project_value",
        zone="zone_value",
    )

    # Make the request
    response = client.apply_updates_to_instances(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.compute_v1.types.ApplyUpdatesToInstancesInstanceGroupManagerRequest, dict]) – 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

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

apply_updates_to_instances_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.ApplyUpdatesToInstancesInstanceGroupManagerRequest, dict]] = 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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.compute_v1.types.compute.Operation[source]¶

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_apply_updates_to_instances():
    # Create a client
    client = compute_v1.InstanceGroupManagersClient()

    # Initialize request argument(s)
    request = compute_v1.ApplyUpdatesToInstancesInstanceGroupManagerRequest(
        instance_group_manager="instance_group_manager_value",
        project="project_value",
        zone="zone_value",
    )

    # Make the request
    response = client.apply_updates_to_instances(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.compute_v1.types.ApplyUpdatesToInstancesInstanceGroupManagerRequest, dict]) – 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

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

static common_billing_account_path(billing_account: str) → str[source]¶: Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str[source]¶: Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str[source]¶: Returns a fully-qualified location string.

static common_organization_path(organization: str) → str[source]¶: Returns a fully-qualified organization string.

static common_project_path(project: str) → str[source]¶: Returns a fully-qualified project string.

create_instances(request: Optional[Union[google.cloud.compute_v1.types.compute.CreateInstancesInstanceGroupManagerRequest, dict]] = 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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.extended_operation.ExtendedOperation[source]¶

Creates instances with per-instance configurations 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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_create_instances():
    # Create a client
    client = compute_v1.InstanceGroupManagersClient()

    # Initialize request argument(s)
    request = compute_v1.CreateInstancesInstanceGroupManagerRequest(
        instance_group_manager="instance_group_manager_value",
        project="project_value",
        zone="zone_value",
    )

    # Make the request
    response = client.create_instances(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.compute_v1.types.CreateInstancesInstanceGroupManagerRequest, dict]) – 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

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

create_instances_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.CreateInstancesInstanceGroupManagerRequest, dict]] = 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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.compute_v1.types.compute.Operation[source]¶

Creates instances with per-instance configurations 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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_create_instances():
    # Create a client
    client = compute_v1.InstanceGroupManagersClient()

    # Initialize request argument(s)
    request = compute_v1.CreateInstancesInstanceGroupManagerRequest(
        instance_group_manager="instance_group_manager_value",
        project="project_value",
        zone="zone_value",
    )

    # Make the request
    response = client.create_instances(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.compute_v1.types.CreateInstancesInstanceGroupManagerRequest, dict]) – 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

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

delete(request: Optional[Union[google.cloud.compute_v1.types.compute.DeleteInstanceGroupManagerRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, instance_group_manager: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.extended_operation.ExtendedOperation[source]¶

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_delete():
    # Create a client
    client = compute_v1.InstanceGroupManagersClient()

    # Initialize request argument(s)
    request = compute_v1.DeleteInstanceGroupManagerRequest(
        instance_group_manager="instance_group_manager_value",
        project="project_value",
        zone="zone_value",
    )

    # Make the request
    response = client.delete(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.compute_v1.types.DeleteInstanceGroupManagerRequest, dict]) – 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

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

delete_instances(request: Optional[Union[google.cloud.compute_v1.types.compute.DeleteInstancesInstanceGroupManagerRequest, dict]] = 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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.extended_operation.ExtendedOperation[source]¶

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_delete_instances():
    # Create a client
    client = compute_v1.InstanceGroupManagersClient()

    # Initialize request argument(s)
    request = compute_v1.DeleteInstancesInstanceGroupManagerRequest(
        instance_group_manager="instance_group_manager_value",
        project="project_value",
        zone="zone_value",
    )

    # Make the request
    response = client.delete_instances(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.compute_v1.types.DeleteInstancesInstanceGroupManagerRequest, dict]) – 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

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

delete_instances_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.DeleteInstancesInstanceGroupManagerRequest, dict]] = 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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.compute_v1.types.compute.Operation[source]¶

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_delete_instances():
    # Create a client
    client = compute_v1.InstanceGroupManagersClient()

    # Initialize request argument(s)
    request = compute_v1.DeleteInstancesInstanceGroupManagerRequest(
        instance_group_manager="instance_group_manager_value",
        project="project_value",
        zone="zone_value",
    )

    # Make the request
    response = client.delete_instances(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.compute_v1.types.DeleteInstancesInstanceGroupManagerRequest, dict]) – 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

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

delete_per_instance_configs(request: Optional[Union[google.cloud.compute_v1.types.compute.DeletePerInstanceConfigsInstanceGroupManagerRequest, dict]] = 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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.extended_operation.ExtendedOperation[source]¶

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_delete_per_instance_configs():
    # Create a client
    client = compute_v1.InstanceGroupManagersClient()

    # Initialize request argument(s)
    request = compute_v1.DeletePerInstanceConfigsInstanceGroupManagerRequest(
        instance_group_manager="instance_group_manager_value",
        project="project_value",
        zone="zone_value",
    )

    # Make the request
    response = client.delete_per_instance_configs(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.compute_v1.types.DeletePerInstanceConfigsInstanceGroupManagerRequest, dict]) – 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

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

delete_per_instance_configs_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.DeletePerInstanceConfigsInstanceGroupManagerRequest, dict]] = 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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.compute_v1.types.compute.Operation[source]¶

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_delete_per_instance_configs():
    # Create a client
    client = compute_v1.InstanceGroupManagersClient()

    # Initialize request argument(s)
    request = compute_v1.DeletePerInstanceConfigsInstanceGroupManagerRequest(
        instance_group_manager="instance_group_manager_value",
        project="project_value",
        zone="zone_value",
    )

    # Make the request
    response = client.delete_per_instance_configs(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.compute_v1.types.DeletePerInstanceConfigsInstanceGroupManagerRequest, dict]) – 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

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

delete_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.DeleteInstanceGroupManagerRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, instance_group_manager: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.compute_v1.types.compute.Operation[source]¶

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_delete():
    # Create a client
    client = compute_v1.InstanceGroupManagersClient()

    # Initialize request argument(s)
    request = compute_v1.DeleteInstanceGroupManagerRequest(
        instance_group_manager="instance_group_manager_value",
        project="project_value",
        zone="zone_value",
    )

    # Make the request
    response = client.delete(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.compute_v1.types.DeleteInstanceGroupManagerRequest, dict]) – 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

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶

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

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

InstanceGroupManagersClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶

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

Parameters

info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

InstanceGroupManagersClient

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

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

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

InstanceGroupManagersClient

get(request: Optional[Union[google.cloud.compute_v1.types.compute.GetInstanceGroupManagerRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, instance_group_manager: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.compute_v1.types.compute.InstanceGroupManager[source]¶

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_get():
    # Create a client
    client = compute_v1.InstanceGroupManagersClient()

    # Initialize request argument(s)
    request = compute_v1.GetInstanceGroupManagerRequest(
        instance_group_manager="instance_group_manager_value",
        project="project_value",
        zone="zone_value",
    )

    # Make the request
    response = client.get(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.compute_v1.types.GetInstanceGroupManagerRequest, dict]) – 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

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.

Return type

google.cloud.compute_v1.types.InstanceGroupManager

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶

Deprecated. Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not “true”, the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “always”, use the default mTLS endpoint; if the environment variable is “never”, use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameters

client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Returns

returns the API endpoint and the: client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

insert(request: Optional[Union[google.cloud.compute_v1.types.compute.InsertInstanceGroupManagerRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, instance_group_manager_resource: Optional[google.cloud.compute_v1.types.compute.InstanceGroupManager] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.extended_operation.ExtendedOperation[source]¶

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_insert():
    # Create a client
    client = compute_v1.InstanceGroupManagersClient()

    # Initialize request argument(s)
    request = compute_v1.InsertInstanceGroupManagerRequest(
        project="project_value",
        zone="zone_value",
    )

    # Make the request
    response = client.insert(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.compute_v1.types.InsertInstanceGroupManagerRequest, dict]) – 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

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

insert_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.InsertInstanceGroupManagerRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, instance_group_manager_resource: Optional[google.cloud.compute_v1.types.compute.InstanceGroupManager] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.compute_v1.types.compute.Operation[source]¶

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_insert():
    # Create a client
    client = compute_v1.InstanceGroupManagersClient()

    # Initialize request argument(s)
    request = compute_v1.InsertInstanceGroupManagerRequest(
        project="project_value",
        zone="zone_value",
    )

    # Make the request
    response = client.insert(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.compute_v1.types.InsertInstanceGroupManagerRequest, dict]) – 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

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

list(request: Optional[Union[google.cloud.compute_v1.types.compute.ListInstanceGroupManagersRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.compute_v1.services.instance_group_managers.pagers.ListPager[source]¶

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_list():
    # Create a client
    client = compute_v1.InstanceGroupManagersClient()

    # Initialize request argument(s)
    request = compute_v1.ListInstanceGroupManagersRequest(
        project="project_value",
        zone="zone_value",
    )

    # Make the request
    page_result = client.list(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

request (Union[google.cloud.compute_v1.types.ListInstanceGroupManagersRequest, dict]) – 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

[Output Only] A list of managed instance groups.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.compute_v1.services.instance_group_managers.pagers.ListPager

list_errors(request: Optional[Union[google.cloud.compute_v1.types.compute.ListErrorsInstanceGroupManagersRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, instance_group_manager: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.compute_v1.services.instance_group_managers.pagers.ListErrorsPager[source]¶

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_list_errors():
    # Create a client
    client = compute_v1.InstanceGroupManagersClient()

    # Initialize request argument(s)
    request = compute_v1.ListErrorsInstanceGroupManagersRequest(
        instance_group_manager="instance_group_manager_value",
        project="project_value",
        zone="zone_value",
    )

    # Make the request
    page_result = client.list_errors(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

request (Union[google.cloud.compute_v1.types.ListErrorsInstanceGroupManagersRequest, dict]) – 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?)|1-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.

Returns

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.compute_v1.services.instance_group_managers.pagers.ListErrorsPager

list_managed_instances(request: Optional[Union[google.cloud.compute_v1.types.compute.ListManagedInstancesInstanceGroupManagersRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, instance_group_manager: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.compute_v1.services.instance_group_managers.pagers.ListManagedInstancesPager[source]¶

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. The pageToken query parameter is supported only if the group’s listManagedInstancesResults field is set to PAGINATED.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_list_managed_instances():
    # Create a client
    client = compute_v1.InstanceGroupManagersClient()

    # Initialize request argument(s)
    request = compute_v1.ListManagedInstancesInstanceGroupManagersRequest(
        instance_group_manager="instance_group_manager_value",
        project="project_value",
        zone="zone_value",
    )

    # Make the request
    page_result = client.list_managed_instances(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

request (Union[google.cloud.compute_v1.types.ListManagedInstancesInstanceGroupManagersRequest, dict]) – 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.

Returns

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.compute_v1.services.instance_group_managers.pagers.ListManagedInstancesPager

list_per_instance_configs(request: Optional[Union[google.cloud.compute_v1.types.compute.ListPerInstanceConfigsInstanceGroupManagersRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, instance_group_manager: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.compute_v1.services.instance_group_managers.pagers.ListPerInstanceConfigsPager[source]¶

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_list_per_instance_configs():
    # Create a client
    client = compute_v1.InstanceGroupManagersClient()

    # Initialize request argument(s)
    request = compute_v1.ListPerInstanceConfigsInstanceGroupManagersRequest(
        instance_group_manager="instance_group_manager_value",
        project="project_value",
        zone="zone_value",
    )

    # Make the request
    page_result = client.list_per_instance_configs(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

request (Union[google.cloud.compute_v1.types.ListPerInstanceConfigsInstanceGroupManagersRequest, dict]) – 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.

Returns

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.compute_v1.services.instance_group_managers.pagers.ListPerInstanceConfigsPager

static parse_common_billing_account_path(path: str) → Dict[str, str][source]¶: Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str][source]¶: Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str][source]¶: Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str][source]¶: Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str][source]¶: Parse a project path into its component segments.

patch(request: Optional[Union[google.cloud.compute_v1.types.compute.PatchInstanceGroupManagerRequest, dict]] = 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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.extended_operation.ExtendedOperation[source]¶

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. If you update your group to specify a new template or instance configuration, it’s possible that your intended specification for each VM in the group is different from the current state of that VM. To learn how to apply an updated configuration to the VMs in a MIG, see Updating instances in a MIG.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_patch():
    # Create a client
    client = compute_v1.InstanceGroupManagersClient()

    # Initialize request argument(s)
    request = compute_v1.PatchInstanceGroupManagerRequest(
        instance_group_manager="instance_group_manager_value",
        project="project_value",
        zone="zone_value",
    )

    # Make the request
    response = client.patch(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.compute_v1.types.PatchInstanceGroupManagerRequest, dict]) – 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

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

patch_per_instance_configs(request: Optional[Union[google.cloud.compute_v1.types.compute.PatchPerInstanceConfigsInstanceGroupManagerRequest, dict]] = 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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.extended_operation.ExtendedOperation[source]¶

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_patch_per_instance_configs():
    # Create a client
    client = compute_v1.InstanceGroupManagersClient()

    # Initialize request argument(s)
    request = compute_v1.PatchPerInstanceConfigsInstanceGroupManagerRequest(
        instance_group_manager="instance_group_manager_value",
        project="project_value",
        zone="zone_value",
    )

    # Make the request
    response = client.patch_per_instance_configs(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.compute_v1.types.PatchPerInstanceConfigsInstanceGroupManagerRequest, dict]) – 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

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

patch_per_instance_configs_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.PatchPerInstanceConfigsInstanceGroupManagerRequest, dict]] = 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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.compute_v1.types.compute.Operation[source]¶

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_patch_per_instance_configs():
    # Create a client
    client = compute_v1.InstanceGroupManagersClient()

    # Initialize request argument(s)
    request = compute_v1.PatchPerInstanceConfigsInstanceGroupManagerRequest(
        instance_group_manager="instance_group_manager_value",
        project="project_value",
        zone="zone_value",
    )

    # Make the request
    response = client.patch_per_instance_configs(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.compute_v1.types.PatchPerInstanceConfigsInstanceGroupManagerRequest, dict]) – 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

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

patch_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.PatchInstanceGroupManagerRequest, dict]] = 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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.compute_v1.types.compute.Operation[source]¶

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. If you update your group to specify a new template or instance configuration, it’s possible that your intended specification for each VM in the group is different from the current state of that VM. To learn how to apply an updated configuration to the VMs in a MIG, see Updating instances in a MIG.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_patch():
    # Create a client
    client = compute_v1.InstanceGroupManagersClient()

    # Initialize request argument(s)
    request = compute_v1.PatchInstanceGroupManagerRequest(
        instance_group_manager="instance_group_manager_value",
        project="project_value",
        zone="zone_value",
    )

    # Make the request
    response = client.patch(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.compute_v1.types.PatchInstanceGroupManagerRequest, dict]) – 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

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

recreate_instances(request: Optional[Union[google.cloud.compute_v1.types.compute.RecreateInstancesInstanceGroupManagerRequest, dict]] = 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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.extended_operation.ExtendedOperation[source]¶

Flags the specified VM instances in the managed instance group to be immediately recreated. Each instance is recreated using the group’s current configuration. 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 each instance by checking its currentAction field; for more information, see Checking the status of managed instances. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_recreate_instances():
    # Create a client
    client = compute_v1.InstanceGroupManagersClient()

    # Initialize request argument(s)
    request = compute_v1.RecreateInstancesInstanceGroupManagerRequest(
        instance_group_manager="instance_group_manager_value",
        project="project_value",
        zone="zone_value",
    )

    # Make the request
    response = client.recreate_instances(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.compute_v1.types.RecreateInstancesInstanceGroupManagerRequest, dict]) – 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

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

recreate_instances_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.RecreateInstancesInstanceGroupManagerRequest, dict]] = 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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.compute_v1.types.compute.Operation[source]¶

Flags the specified VM instances in the managed instance group to be immediately recreated. Each instance is recreated using the group’s current configuration. 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 each instance by checking its currentAction field; for more information, see Checking the status of managed instances. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_recreate_instances():
    # Create a client
    client = compute_v1.InstanceGroupManagersClient()

    # Initialize request argument(s)
    request = compute_v1.RecreateInstancesInstanceGroupManagerRequest(
        instance_group_manager="instance_group_manager_value",
        project="project_value",
        zone="zone_value",
    )

    # Make the request
    response = client.recreate_instances(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.compute_v1.types.RecreateInstancesInstanceGroupManagerRequest, dict]) – 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

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

resize(request: Optional[Union[google.cloud.compute_v1.types.compute.ResizeInstanceGroupManagerRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, instance_group_manager: Optional[str] = None, size: Optional[int] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.extended_operation.ExtendedOperation[source]¶

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_resize():
    # Create a client
    client = compute_v1.InstanceGroupManagersClient()

    # Initialize request argument(s)
    request = compute_v1.ResizeInstanceGroupManagerRequest(
        instance_group_manager="instance_group_manager_value",
        project="project_value",
        size=443,
        zone="zone_value",
    )

    # Make the request
    response = client.resize(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.compute_v1.types.ResizeInstanceGroupManagerRequest, dict]) – 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

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

resize_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.ResizeInstanceGroupManagerRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, instance_group_manager: Optional[str] = None, size: Optional[int] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.compute_v1.types.compute.Operation[source]¶

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_resize():
    # Create a client
    client = compute_v1.InstanceGroupManagersClient()

    # Initialize request argument(s)
    request = compute_v1.ResizeInstanceGroupManagerRequest(
        instance_group_manager="instance_group_manager_value",
        project="project_value",
        size=443,
        zone="zone_value",
    )

    # Make the request
    response = client.resize(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.compute_v1.types.ResizeInstanceGroupManagerRequest, dict]) – 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

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

set_instance_template(request: Optional[Union[google.cloud.compute_v1.types.compute.SetInstanceTemplateInstanceGroupManagerRequest, dict]] = 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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.extended_operation.ExtendedOperation[source]¶

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_set_instance_template():
    # Create a client
    client = compute_v1.InstanceGroupManagersClient()

    # Initialize request argument(s)
    request = compute_v1.SetInstanceTemplateInstanceGroupManagerRequest(
        instance_group_manager="instance_group_manager_value",
        project="project_value",
        zone="zone_value",
    )

    # Make the request
    response = client.set_instance_template(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.compute_v1.types.SetInstanceTemplateInstanceGroupManagerRequest, dict]) – 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

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

set_instance_template_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.SetInstanceTemplateInstanceGroupManagerRequest, dict]] = 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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.compute_v1.types.compute.Operation[source]¶

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_set_instance_template():
    # Create a client
    client = compute_v1.InstanceGroupManagersClient()

    # Initialize request argument(s)
    request = compute_v1.SetInstanceTemplateInstanceGroupManagerRequest(
        instance_group_manager="instance_group_manager_value",
        project="project_value",
        zone="zone_value",
    )

    # Make the request
    response = client.set_instance_template(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.compute_v1.types.SetInstanceTemplateInstanceGroupManagerRequest, dict]) – 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

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

set_target_pools(request: Optional[Union[google.cloud.compute_v1.types.compute.SetTargetPoolsInstanceGroupManagerRequest, dict]] = 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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.extended_operation.ExtendedOperation[source]¶

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_set_target_pools():
    # Create a client
    client = compute_v1.InstanceGroupManagersClient()

    # Initialize request argument(s)
    request = compute_v1.SetTargetPoolsInstanceGroupManagerRequest(
        instance_group_manager="instance_group_manager_value",
        project="project_value",
        zone="zone_value",
    )

    # Make the request
    response = client.set_target_pools(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.compute_v1.types.SetTargetPoolsInstanceGroupManagerRequest, dict]) – 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

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

set_target_pools_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.SetTargetPoolsInstanceGroupManagerRequest, dict]] = 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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.compute_v1.types.compute.Operation[source]¶

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_set_target_pools():
    # Create a client
    client = compute_v1.InstanceGroupManagersClient()

    # Initialize request argument(s)
    request = compute_v1.SetTargetPoolsInstanceGroupManagerRequest(
        instance_group_manager="instance_group_manager_value",
        project="project_value",
        zone="zone_value",
    )

    # Make the request
    response = client.set_target_pools(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.compute_v1.types.SetTargetPoolsInstanceGroupManagerRequest, dict]) – 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

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

property transport: google.cloud.compute_v1.services.instance_group_managers.transports.base.InstanceGroupManagersTransport¶

Returns the transport used by the client instance.

Returns

The transport used by the client: instance.

Return type

InstanceGroupManagersTransport

property universe_domain: str¶

Return the universe domain used by the client instance.

Returns: The universe domain used by the client instance.
Return type: str

update_per_instance_configs(request: Optional[Union[google.cloud.compute_v1.types.compute.UpdatePerInstanceConfigsInstanceGroupManagerRequest, dict]] = 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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.extended_operation.ExtendedOperation[source]¶

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_update_per_instance_configs():
    # Create a client
    client = compute_v1.InstanceGroupManagersClient()

    # Initialize request argument(s)
    request = compute_v1.UpdatePerInstanceConfigsInstanceGroupManagerRequest(
        instance_group_manager="instance_group_manager_value",
        project="project_value",
        zone="zone_value",
    )

    # Make the request
    response = client.update_per_instance_configs(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.compute_v1.types.UpdatePerInstanceConfigsInstanceGroupManagerRequest, dict]) – 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

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

update_per_instance_configs_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.UpdatePerInstanceConfigsInstanceGroupManagerRequest, dict]] = 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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.compute_v1.types.compute.Operation[source]¶

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_update_per_instance_configs():
    # Create a client
    client = compute_v1.InstanceGroupManagersClient()

    # Initialize request argument(s)
    request = compute_v1.UpdatePerInstanceConfigsInstanceGroupManagerRequest(
        instance_group_manager="instance_group_manager_value",
        project="project_value",
        zone="zone_value",
    )

    # Make the request
    response = client.update_per_instance_configs(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.compute_v1.types.UpdatePerInstanceConfigsInstanceGroupManagerRequest, dict]) – 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

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

class google.cloud.compute_v1.services.instance_group_managers.pagers.AggregatedListPager(method: Callable[[...], google.cloud.compute_v1.types.compute.InstanceGroupManagerAggregatedList], request: google.cloud.compute_v1.types.compute.AggregatedListInstanceGroupManagersRequest, response: google.cloud.compute_v1.types.compute.InstanceGroupManagerAggregatedList, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through aggregated_list requests.

This class thinly wraps an initial google.cloud.compute_v1.types.InstanceGroupManagerAggregatedList object, and provides an __iter__ method to iterate through its items field.

If there are more pages, the __iter__ method will make additional AggregatedList requests and continue to iterate through the items field on the corresponding responses.

All the usual google.cloud.compute_v1.types.InstanceGroupManagerAggregatedList attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.compute_v1.types.AggregatedListInstanceGroupManagersRequest) – The initial request object.
response (google.cloud.compute_v1.types.InstanceGroupManagerAggregatedList) – The initial response object.
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.

class google.cloud.compute_v1.services.instance_group_managers.pagers.ListErrorsPager(method: Callable[[...], google.cloud.compute_v1.types.compute.InstanceGroupManagersListErrorsResponse], request: google.cloud.compute_v1.types.compute.ListErrorsInstanceGroupManagersRequest, response: google.cloud.compute_v1.types.compute.InstanceGroupManagersListErrorsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_errors requests.

This class thinly wraps an initial google.cloud.compute_v1.types.InstanceGroupManagersListErrorsResponse object, and provides an __iter__ method to iterate through its items field.

If there are more pages, the __iter__ method will make additional ListErrors requests and continue to iterate through the items field on the corresponding responses.

All the usual google.cloud.compute_v1.types.InstanceGroupManagersListErrorsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.compute_v1.types.ListErrorsInstanceGroupManagersRequest) – The initial request object.
response (google.cloud.compute_v1.types.InstanceGroupManagersListErrorsResponse) – The initial response object.
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.

class google.cloud.compute_v1.services.instance_group_managers.pagers.ListManagedInstancesPager(method: Callable[[...], google.cloud.compute_v1.types.compute.InstanceGroupManagersListManagedInstancesResponse], request: google.cloud.compute_v1.types.compute.ListManagedInstancesInstanceGroupManagersRequest, response: google.cloud.compute_v1.types.compute.InstanceGroupManagersListManagedInstancesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_managed_instances requests.

This class thinly wraps an initial google.cloud.compute_v1.types.InstanceGroupManagersListManagedInstancesResponse object, and provides an __iter__ method to iterate through its managed_instances field.

If there are more pages, the __iter__ method will make additional ListManagedInstances requests and continue to iterate through the managed_instances field on the corresponding responses.

All the usual google.cloud.compute_v1.types.InstanceGroupManagersListManagedInstancesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.compute_v1.types.ListManagedInstancesInstanceGroupManagersRequest) – The initial request object.
response (google.cloud.compute_v1.types.InstanceGroupManagersListManagedInstancesResponse) – The initial response object.
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.

class google.cloud.compute_v1.services.instance_group_managers.pagers.ListPager(method: Callable[[...], google.cloud.compute_v1.types.compute.InstanceGroupManagerList], request: google.cloud.compute_v1.types.compute.ListInstanceGroupManagersRequest, response: google.cloud.compute_v1.types.compute.InstanceGroupManagerList, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list requests.

This class thinly wraps an initial google.cloud.compute_v1.types.InstanceGroupManagerList object, and provides an __iter__ method to iterate through its items field.

If there are more pages, the __iter__ method will make additional List requests and continue to iterate through the items field on the corresponding responses.

All the usual google.cloud.compute_v1.types.InstanceGroupManagerList attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.compute_v1.types.ListInstanceGroupManagersRequest) – The initial request object.
response (google.cloud.compute_v1.types.InstanceGroupManagerList) – The initial response object.
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.

class google.cloud.compute_v1.services.instance_group_managers.pagers.ListPerInstanceConfigsPager(method: Callable[[...], google.cloud.compute_v1.types.compute.InstanceGroupManagersListPerInstanceConfigsResp], request: google.cloud.compute_v1.types.compute.ListPerInstanceConfigsInstanceGroupManagersRequest, response: google.cloud.compute_v1.types.compute.InstanceGroupManagersListPerInstanceConfigsResp, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_per_instance_configs requests.

This class thinly wraps an initial google.cloud.compute_v1.types.InstanceGroupManagersListPerInstanceConfigsResp object, and provides an __iter__ method to iterate through its items field.

If there are more pages, the __iter__ method will make additional ListPerInstanceConfigs requests and continue to iterate through the items field on the corresponding responses.

All the usual google.cloud.compute_v1.types.InstanceGroupManagersListPerInstanceConfigsResp attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.compute_v1.types.ListPerInstanceConfigsInstanceGroupManagersRequest) – The initial request object.
response (google.cloud.compute_v1.types.InstanceGroupManagersListPerInstanceConfigsResp) – The initial response object.
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.

InstanceGroupManagers¶

google-cloud-compute

Navigation

Related Topics