Class InstanceGroupsClient (1.23.0) 

InstanceGroupsClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.compute_v1.services.instance_groups.transports.base.InstanceGroupsTransport, typing.Callable[[...], google.cloud.compute_v1.services.instance_groups.transports.base.InstanceGroupsTransport]]] = 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>)

The InstanceGroups API.

Properties

api_endpoint

Return the API endpoint used by the client instance.

Returns
Type Description
str The API endpoint used by the client instance.

transport

Returns the transport used by the client instance.

Returns
Type Description
InstanceGroupsTransport The transport used by the client instance.

universe_domain

Return the universe domain used by the client instance.

Returns
Type Description
str The universe domain used by the client instance.

Methods

InstanceGroupsClient

InstanceGroupsClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.compute_v1.services.instance_groups.transports.base.InstanceGroupsTransport, typing.Callable[[...], google.cloud.compute_v1.services.instance_groups.transports.base.InstanceGroupsTransport]]] = 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>)

Instantiates the instance groups client.

Parameters
Name Description
credentials Optional[google.auth.credentials.Credentials]

The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
transport Optional[Union[str,InstanceGroupsTransport,Callable[..., InstanceGroupsTransport]]]

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 InstanceGroupsTransport 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.
Exceptions
Type Description
google.auth.exceptions.MutualTLSChannelError If mutual TLS transport creation failed for any reason.

__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

add_instances

add_instances(
    request: typing.Optional[
        typing.Union[
            google.cloud.compute_v1.types.compute.AddInstancesInstanceGroupRequest, dict
        ]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    zone: typing.Optional[str] = None,
    instance_group: typing.Optional[str] = None,
    instance_groups_add_instances_request_resource: typing.Optional[
        google.cloud.compute_v1.types.compute.InstanceGroupsAddInstancesRequest
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.extended_operation.ExtendedOperation

Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances 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_add_instances():
    # Create a client
    client = compute_v1.InstanceGroupsClient()

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

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.compute_v1.types.AddInstancesInstanceGroupRequest, dict]

The request object. A request message for InstanceGroups.AddInstances. 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 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 str

The name of the instance group where you are adding instances. This corresponds to the instance_group field on the request instance; if request is provided, this should not be set.
instance_groups_add_instances_request_resource google.cloud.compute_v1.types.InstanceGroupsAddInstancesRequest

The body resource for this request This corresponds to the instance_groups_add_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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.api_core.extended_operation.ExtendedOperation An object representing a extended long-running operation.

add_instances_unary

add_instances_unary(
    request: typing.Optional[
        typing.Union[
            google.cloud.compute_v1.types.compute.AddInstancesInstanceGroupRequest, dict
        ]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    zone: typing.Optional[str] = None,
    instance_group: typing.Optional[str] = None,
    instance_groups_add_instances_request_resource: typing.Optional[
        google.cloud.compute_v1.types.compute.InstanceGroupsAddInstancesRequest
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.compute_v1.types.compute.Operation

Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances 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_add_instances():
    # Create a client
    client = compute_v1.InstanceGroupsClient()

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

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.compute_v1.types.AddInstancesInstanceGroupRequest, dict]

The request object. A request message for InstanceGroups.AddInstances. 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 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 str

The name of the instance group where you are adding instances. This corresponds to the instance_group field on the request instance; if request is provided, this should not be set.
instance_groups_add_instances_request_resource google.cloud.compute_v1.types.InstanceGroupsAddInstancesRequest

The body resource for this request This corresponds to the instance_groups_add_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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.api_core.extended_operation.ExtendedOperation An object representing a extended long-running operation.

aggregated_list

aggregated_list(
    request: typing.Optional[
        typing.Union[
            google.cloud.compute_v1.types.compute.AggregatedListInstanceGroupsRequest,
            dict,
        ]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.compute_v1.services.instance_groups.pagers.AggregatedListPager

Retrieves the list of instance groups and sorts 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.InstanceGroupsClient()

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

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

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Name Description
request Union[google.cloud.compute_v1.types.AggregatedListInstanceGroupsRequest, dict]

The request object. A request message for InstanceGroups.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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.compute_v1.services.instance_groups.pagers.AggregatedListPager Iterating over this object will yield results and resolve additional pages automatically.

common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

delete

delete(
    request: typing.Optional[
        typing.Union[
            google.cloud.compute_v1.types.compute.DeleteInstanceGroupRequest, dict
        ]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    zone: typing.Optional[str] = None,
    instance_group: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.extended_operation.ExtendedOperation

Deletes the specified instance group. The instances in the group are not deleted. Note that 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.InstanceGroupsClient()

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

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.compute_v1.types.DeleteInstanceGroupRequest, dict]

The request object. A request message for InstanceGroups.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 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 str

The name of the instance group to delete. This corresponds to the instance_group 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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.api_core.extended_operation.ExtendedOperation An object representing a extended long-running operation.

delete_unary

delete_unary(
    request: typing.Optional[
        typing.Union[
            google.cloud.compute_v1.types.compute.DeleteInstanceGroupRequest, dict
        ]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    zone: typing.Optional[str] = None,
    instance_group: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.compute_v1.types.compute.Operation

Deletes the specified instance group. The instances in the group are not deleted. Note that 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.InstanceGroupsClient()

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

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.compute_v1.types.DeleteInstanceGroupRequest, dict]

The request object. A request message for InstanceGroups.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 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 str

The name of the instance group to delete. This corresponds to the instance_group 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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.api_core.extended_operation.ExtendedOperation An object representing a extended long-running operation.

from_service_account_file

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

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

Parameter
Name Description
filename str

The path to the service account private key json file.
Returns
Type Description
InstanceGroupsClient The constructed client.

from_service_account_info

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

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

Parameter
Name Description
info dict

The service account private key info.
Returns
Type Description
InstanceGroupsClient The constructed client.

from_service_account_json

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

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

Parameter
Name Description
filename str

The path to the service account private key json file.
Returns
Type Description
InstanceGroupsClient The constructed client.

get

get(
    request: typing.Optional[
        typing.Union[
            google.cloud.compute_v1.types.compute.GetInstanceGroupRequest, dict
        ]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    zone: typing.Optional[str] = None,
    instance_group: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.compute_v1.types.compute.InstanceGroup

Returns the specified zonal instance group. Get a list of available zonal instance groups by making a list() request. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead.

# 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.InstanceGroupsClient()

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

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.compute_v1.types.GetInstanceGroupRequest, dict]

The request object. A request message for InstanceGroups.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 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 str

The name of the instance group. This corresponds to the instance_group 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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.compute_v1.types.InstanceGroup Represents an Instance Group resource. Instance Groups can be used to configure a target for load balancing. Instance groups can either be managed or unmanaged. To create managed instance groups, use the instanceGroupManager or regionInstanceGroupManager resource instead. Use zonal unmanaged instance groups if you need to apply load balancing to groups of heterogeneous instances or if you need to manage the instances yourself. You cannot create regional unmanaged instance groups. For more information, read Instance groups.

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

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.

Parameter
Name Description
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.
Exceptions
Type Description
google.auth.exceptions.MutualTLSChannelError If any errors happen.
Returns
Type Description
Tuple[str, Callable[[], Tuple[bytes, bytes]]] returns the API endpoint and the client cert source to use.

insert

insert(
    request: typing.Optional[
        typing.Union[
            google.cloud.compute_v1.types.compute.InsertInstanceGroupRequest, dict
        ]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    zone: typing.Optional[str] = None,
    instance_group_resource: typing.Optional[
        google.cloud.compute_v1.types.compute.InstanceGroup
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.extended_operation.ExtendedOperation

Creates an instance group in the specified project using the parameters that are included in the 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_insert():
    # Create a client
    client = compute_v1.InstanceGroupsClient()

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

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.compute_v1.types.InsertInstanceGroupRequest, dict]

The request object. A request message for InstanceGroups.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 instance group. This corresponds to the zone field on the request instance; if request is provided, this should not be set.
instance_group_resource google.cloud.compute_v1.types.InstanceGroup

The body resource for this request This corresponds to the instance_group_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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.api_core.extended_operation.ExtendedOperation An object representing a extended long-running operation.

insert_unary

insert_unary(
    request: typing.Optional[
        typing.Union[
            google.cloud.compute_v1.types.compute.InsertInstanceGroupRequest, dict
        ]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    zone: typing.Optional[str] = None,
    instance_group_resource: typing.Optional[
        google.cloud.compute_v1.types.compute.InstanceGroup
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.compute_v1.types.compute.Operation

Creates an instance group in the specified project using the parameters that are included in the 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_insert():
    # Create a client
    client = compute_v1.InstanceGroupsClient()

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

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.compute_v1.types.InsertInstanceGroupRequest, dict]

The request object. A request message for InstanceGroups.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 instance group. This corresponds to the zone field on the request instance; if request is provided, this should not be set.
instance_group_resource google.cloud.compute_v1.types.InstanceGroup

The body resource for this request This corresponds to the instance_group_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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.api_core.extended_operation.ExtendedOperation An object representing a extended long-running operation.

list

list(
    request: typing.Optional[
        typing.Union[
            google.cloud.compute_v1.types.compute.ListInstanceGroupsRequest, dict
        ]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    zone: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.compute_v1.services.instance_groups.pagers.ListPager

Retrieves the list of zonal instance group resources contained within the specified zone. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead.

# 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.InstanceGroupsClient()

    # Initialize request argument(s)
    request = compute_v1.ListInstanceGroupsRequest(
        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
Name Description
request Union[google.cloud.compute_v1.types.ListInstanceGroupsRequest, dict]

The request object. A request message for InstanceGroups.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 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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.compute_v1.services.instance_groups.pagers.ListPager A list of InstanceGroup resources. Iterating over this object will yield results and resolve additional pages automatically.

list_instances

list_instances(
    request: typing.Optional[
        typing.Union[
            google.cloud.compute_v1.types.compute.ListInstancesInstanceGroupsRequest,
            dict,
        ]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    zone: typing.Optional[str] = None,
    instance_group: typing.Optional[str] = None,
    instance_groups_list_instances_request_resource: typing.Optional[
        google.cloud.compute_v1.types.compute.InstanceGroupsListInstancesRequest
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.compute_v1.services.instance_groups.pagers.ListInstancesPager

Lists the instances in the specified instance group. The orderBy query parameter is not supported. The filter query parameter is supported, but only for expressions that use eq (equal) or ne (not equal) operators.

# 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_instances():
    # Create a client
    client = compute_v1.InstanceGroupsClient()

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

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

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Name Description
request Union[google.cloud.compute_v1.types.ListInstancesInstanceGroupsRequest, dict]

The request object. A request message for InstanceGroups.ListInstances. 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 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 str

The name of the instance group from which you want to generate a list of included instances. This corresponds to the instance_group field on the request instance; if request is provided, this should not be set.
instance_groups_list_instances_request_resource google.cloud.compute_v1.types.InstanceGroupsListInstancesRequest

The body resource for this request This corresponds to the instance_groups_list_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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.compute_v1.services.instance_groups.pagers.ListInstancesPager Iterating over this object will yield results and resolve additional pages automatically.

parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

remove_instances

remove_instances(
    request: typing.Optional[
        typing.Union[
            google.cloud.compute_v1.types.compute.RemoveInstancesInstanceGroupRequest,
            dict,
        ]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    zone: typing.Optional[str] = None,
    instance_group: typing.Optional[str] = None,
    instance_groups_remove_instances_request_resource: typing.Optional[
        google.cloud.compute_v1.types.compute.InstanceGroupsRemoveInstancesRequest
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.extended_operation.ExtendedOperation

Removes one or more instances from the specified instance group, but does not delete those 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 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_remove_instances():
    # Create a client
    client = compute_v1.InstanceGroupsClient()

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

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.compute_v1.types.RemoveInstancesInstanceGroupRequest, dict]

The request object. A request message for InstanceGroups.RemoveInstances. 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 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 str

The name of the instance group where the specified instances will be removed. This corresponds to the instance_group field on the request instance; if request is provided, this should not be set.
instance_groups_remove_instances_request_resource google.cloud.compute_v1.types.InstanceGroupsRemoveInstancesRequest

The body resource for this request This corresponds to the instance_groups_remove_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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.api_core.extended_operation.ExtendedOperation An object representing a extended long-running operation.

remove_instances_unary

remove_instances_unary(
    request: typing.Optional[
        typing.Union[
            google.cloud.compute_v1.types.compute.RemoveInstancesInstanceGroupRequest,
            dict,
        ]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    zone: typing.Optional[str] = None,
    instance_group: typing.Optional[str] = None,
    instance_groups_remove_instances_request_resource: typing.Optional[
        google.cloud.compute_v1.types.compute.InstanceGroupsRemoveInstancesRequest
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.compute_v1.types.compute.Operation

Removes one or more instances from the specified instance group, but does not delete those 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 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_remove_instances():
    # Create a client
    client = compute_v1.InstanceGroupsClient()

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

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.compute_v1.types.RemoveInstancesInstanceGroupRequest, dict]

The request object. A request message for InstanceGroups.RemoveInstances. 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 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 str

The name of the instance group where the specified instances will be removed. This corresponds to the instance_group field on the request instance; if request is provided, this should not be set.
instance_groups_remove_instances_request_resource google.cloud.compute_v1.types.InstanceGroupsRemoveInstancesRequest

The body resource for this request This corresponds to the instance_groups_remove_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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.api_core.extended_operation.ExtendedOperation An object representing a extended long-running operation.

set_named_ports

set_named_ports(
    request: typing.Optional[
        typing.Union[
            google.cloud.compute_v1.types.compute.SetNamedPortsInstanceGroupRequest,
            dict,
        ]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    zone: typing.Optional[str] = None,
    instance_group: typing.Optional[str] = None,
    instance_groups_set_named_ports_request_resource: typing.Optional[
        google.cloud.compute_v1.types.compute.InstanceGroupsSetNamedPortsRequest
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.extended_operation.ExtendedOperation

Sets the named ports for the specified 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_set_named_ports():
    # Create a client
    client = compute_v1.InstanceGroupsClient()

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

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.compute_v1.types.SetNamedPortsInstanceGroupRequest, dict]

The request object. A request message for InstanceGroups.SetNamedPorts. 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 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 str

The name of the instance group where the named ports are updated. This corresponds to the instance_group field on the request instance; if request is provided, this should not be set.
instance_groups_set_named_ports_request_resource google.cloud.compute_v1.types.InstanceGroupsSetNamedPortsRequest

The body resource for this request This corresponds to the instance_groups_set_named_ports_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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.api_core.extended_operation.ExtendedOperation An object representing a extended long-running operation.

set_named_ports_unary

set_named_ports_unary(
    request: typing.Optional[
        typing.Union[
            google.cloud.compute_v1.types.compute.SetNamedPortsInstanceGroupRequest,
            dict,
        ]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    zone: typing.Optional[str] = None,
    instance_group: typing.Optional[str] = None,
    instance_groups_set_named_ports_request_resource: typing.Optional[
        google.cloud.compute_v1.types.compute.InstanceGroupsSetNamedPortsRequest
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.compute_v1.types.compute.Operation

Sets the named ports for the specified 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_set_named_ports():
    # Create a client
    client = compute_v1.InstanceGroupsClient()

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

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.compute_v1.types.SetNamedPortsInstanceGroupRequest, dict]

The request object. A request message for InstanceGroups.SetNamedPorts. 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 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 str

The name of the instance group where the named ports are updated. This corresponds to the instance_group field on the request instance; if request is provided, this should not be set.
instance_groups_set_named_ports_request_resource google.cloud.compute_v1.types.InstanceGroupsSetNamedPortsRequest

The body resource for this request This corresponds to the instance_groups_set_named_ports_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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.api_core.extended_operation.ExtendedOperation An object representing a extended long-running operation.