Class InstanceGroupsClient (0.6.0)

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

The InstanceGroups API.

Properties

transport

Returns the transport used by the client instance.

Returns

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

Methods

InstanceGroupsClient

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

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`	`Union[str, InstanceGroupsTransport]` The transport to use. If set to None, a transport is chosen automatically.
`client_options`	`google.api_core.client_options.ClientOptions` Custom options for the client. It won't take effect if a `transport` instance is provided. (1) The `api_endpoint` property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the `api_endpoint` property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the `client_cert_source` property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.
`client_info`	`google.api_core.gapic_v1.client_info.ClientInfo` The client info used to send a user-agent string along with API requests. If `None`, then default info will be used. Generally, you only need to set this if you're developing your own client library.

Exceptions

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

add_instances

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

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.

Parameters

Name	Description
`request`	`google.cloud.compute_v1.types.AddInstancesInstanceGroupRequest` 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, str]]` Strings which should be sent along with the request as metadata.

Returns

Type Description

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

aggregated_list

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

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

Parameters

Name	Description
`request`	`google.cloud.compute_v1.types.AggregatedListInstanceGroupsRequest` 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, str]]` Strings which should be sent along with the request as metadata.

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)

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

delete

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

Deletes the specified 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.

Parameters

Name	Description
`request`	`google.cloud.compute_v1.types.DeleteInstanceGroupRequest` 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, str]]` Strings which should be sent along with the request as metadata.

Returns

Type Description

from_service_account_file

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

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

Parameter

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

Returns

Type	Description
`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: Optional[google.cloud.compute_v1.types.compute.GetInstanceGroupRequest] = None, *, project: Optional[str] = None, zone: Optional[str] = None, instance_group: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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.

Parameters

Name	Description
`request`	`google.cloud.compute_v1.types.GetInstanceGroupRequest` 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, str]]` Strings which should be sent along with the request as metadata.

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. (== resource_for {$api_version}.instanceGroups ==) (== resource_for {$api_version}.regionInstanceGroups ==)

insert

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

Creates an instance group in the specified project using the parameters that are included in the request.

Parameters

Name	Description
`request`	`google.cloud.compute_v1.types.InsertInstanceGroupRequest` 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, str]]` Strings which should be sent along with the request as metadata.

Returns

Type Description

list

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

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

Parameters

Name	Description
`request`	`google.cloud.compute_v1.types.ListInstanceGroupsRequest` 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, str]]` Strings which should be sent along with the request as metadata.

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: Optional[google.cloud.compute_v1.types.compute.ListInstancesInstanceGroupsRequest] = None, *, project: Optional[str] = None, zone: Optional[str] = None, instance_group: Optional[str] = None, instance_groups_list_instances_request_resource: Optional[google.cloud.compute_v1.types.compute.InstanceGroupsListInstancesRequest] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists the instances in the specified instance group. The orderBy query parameter is not supported.

Parameters

Name	Description
`request`	`google.cloud.compute_v1.types.ListInstancesInstanceGroupsRequest` 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, str]]` Strings which should be sent along with the request as metadata.

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)

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

remove_instances

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

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.

Parameters

Name	Description
`request`	`google.cloud.compute_v1.types.RemoveInstancesInstanceGroupRequest` 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, str]]` Strings which should be sent along with the request as metadata.

Returns

Type Description

set_named_ports

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

Sets the named ports for the specified instance group.

Parameters

Name	Description
`request`	`google.cloud.compute_v1.types.SetNamedPortsInstanceGroupRequest` 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, str]]` Strings which should be sent along with the request as metadata.

Returns

Type Description