RegionInstanceGroupManagersClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.compute_v1.services.region_instance_group_managers.transports.base.RegionInstanceGroupManagersTransport]] = 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 RegionInstanceGroupManagers API.
Properties
transport
Returns the transport used by the client instance.
| Type | Description |
RegionInstanceGroupManagersTransport | The transport used by the client instance. |
Methods
RegionInstanceGroupManagersClient
RegionInstanceGroupManagersClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.compute_v1.services.region_instance_group_managers.transports.base.RegionInstanceGroupManagersTransport]] = 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 region instance group managers client.
| 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, RegionInstanceGroupManagersTransport]
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 |
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 |
| 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.
abandon_instances_unary
abandon_instances_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.AbandonInstancesRegionInstanceGroupManagerRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, instance_group_manager: Optional[str] = None, region_instance_group_managers_abandon_instances_request_resource: Optional[google.cloud.compute_v1.types.compute.RegionInstanceGroupManagersAbandonInstancesRequest] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Flags the specified instances to be immediately removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. 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.
| Name | Description |
request |
Union[google.cloud.compute_v1.types.AbandonInstancesRegionInstanceGroupManagerRequest, dict]
The request object. A request message for RegionInstanceGroupManagers.AbandonInstances. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
Name of the region scoping this request. This corresponds to the |
instance_group_manager |
str
Name of the managed instance group. This corresponds to the |
region_instance_group_managers_abandon_instances_request_resource |
google.cloud.compute_v1.types.RegionInstanceGroupManagersAbandonInstancesRequest
The body resource for this request This corresponds to the |
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. |
| Type | Description |
google.cloud.compute_v1.types.Operation | Represents an Operation resource. Google Compute Engine has three Operation resources: \* [Global](/compute/docs/reference/rest/v1/globalOperations) \* [Regional](/compute/docs/reference/rest/v1/regionOperations) \* [Zonal](/compute/docs/reference/rest/v1/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. |
apply_updates_to_instances_unary
apply_updates_to_instances_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.ApplyUpdatesToInstancesRegionInstanceGroupManagerRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, instance_group_manager: Optional[str] = None, region_instance_group_managers_apply_updates_request_resource: Optional[google.cloud.compute_v1.types.compute.RegionInstanceGroupManagersApplyUpdatesRequest] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Apply updates to selected instances the managed instance group.
| Name | Description |
request |
Union[google.cloud.compute_v1.types.ApplyUpdatesToInstancesRegionInstanceGroupManagerRequest, dict]
The request object. A request message for RegionInstanceGroupManagers.ApplyUpdatesToInstances. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
Name of the region scoping this request, should conform to RFC1035. This corresponds to the |
instance_group_manager |
str
The name of the managed instance group, should conform to RFC1035. This corresponds to the |
region_instance_group_managers_apply_updates_request_resource |
google.cloud.compute_v1.types.RegionInstanceGroupManagersApplyUpdatesRequest
The body resource for this request This corresponds to the |
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. |
| Type | Description |
google.cloud.compute_v1.types.Operation | Represents an Operation resource. Google Compute Engine has three Operation resources: \* [Global](/compute/docs/reference/rest/v1/globalOperations) \* [Regional](/compute/docs/reference/rest/v1/regionOperations) \* [Zonal](/compute/docs/reference/rest/v1/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. |
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.
create_instances_unary
create_instances_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.CreateInstancesRegionInstanceGroupManagerRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, instance_group_manager: Optional[str] = None, region_instance_group_managers_create_instances_request_resource: Optional[google.cloud.compute_v1.types.compute.RegionInstanceGroupManagersCreateInstancesRequest] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Creates instances with per-instance configs in this regional managed instance group. Instances are created using the current instance template. The create instances operation is marked DONE if the createInstances request is successful. The underlying actions take additional time. You must separately verify the status of the creating or actions with the listmanagedinstances method.
| Name | Description |
request |
Union[google.cloud.compute_v1.types.CreateInstancesRegionInstanceGroupManagerRequest, dict]
The request object. A request message for RegionInstanceGroupManagers.CreateInstances. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
The name of the region where the managed instance group is located. It should conform to RFC1035. This corresponds to the |
instance_group_manager |
str
The name of the managed instance group. It should conform to RFC1035. This corresponds to the |
region_instance_group_managers_create_instances_request_resource |
google.cloud.compute_v1.types.RegionInstanceGroupManagersCreateInstancesRequest
The body resource for this request This corresponds to the |
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. |
| Type | Description |
google.cloud.compute_v1.types.Operation | Represents an Operation resource. Google Compute Engine has three Operation resources: \* [Global](/compute/docs/reference/rest/v1/globalOperations) \* [Regional](/compute/docs/reference/rest/v1/regionOperations) \* [Zonal](/compute/docs/reference/rest/v1/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. |
delete_instances_unary
delete_instances_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.DeleteInstancesRegionInstanceGroupManagerRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, instance_group_manager: Optional[str] = None, region_instance_group_managers_delete_instances_request_resource: Optional[google.cloud.compute_v1.types.compute.RegionInstanceGroupManagersDeleteInstancesRequest] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Flags the specified instances in the managed instance group to be immediately deleted. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. The deleteInstances operation is marked DONE if the deleteInstances request is successful. The underlying actions take additional time. You must separately verify the status of the deleting action with the listmanagedinstances method. 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.
| Name | Description |
request |
Union[google.cloud.compute_v1.types.DeleteInstancesRegionInstanceGroupManagerRequest, dict]
The request object. A request message for RegionInstanceGroupManagers.DeleteInstances. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
Name of the region scoping this request. This corresponds to the |
instance_group_manager |
str
Name of the managed instance group. This corresponds to the |
region_instance_group_managers_delete_instances_request_resource |
google.cloud.compute_v1.types.RegionInstanceGroupManagersDeleteInstancesRequest
The body resource for this request This corresponds to the |
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. |
| Type | Description |
google.cloud.compute_v1.types.Operation | Represents an Operation resource. Google Compute Engine has three Operation resources: \* [Global](/compute/docs/reference/rest/v1/globalOperations) \* [Regional](/compute/docs/reference/rest/v1/regionOperations) \* [Zonal](/compute/docs/reference/rest/v1/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. |
delete_per_instance_configs_unary
delete_per_instance_configs_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.DeletePerInstanceConfigsRegionInstanceGroupManagerRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, instance_group_manager: Optional[str] = None, region_instance_group_manager_delete_instance_config_req_resource: Optional[google.cloud.compute_v1.types.compute.RegionInstanceGroupManagerDeleteInstanceConfigReq] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Deletes selected per-instance configs for the managed instance group.
| Name | Description |
request |
Union[google.cloud.compute_v1.types.DeletePerInstanceConfigsRegionInstanceGroupManagerRequest, dict]
The request object. A request message for RegionInstanceGroupManagers.DeletePerInstanceConfigs. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
Name of the region scoping this request, should conform to RFC1035. This corresponds to the |
instance_group_manager |
str
The name of the managed instance group. It should conform to RFC1035. This corresponds to the |
region_instance_group_manager_delete_instance_config_req_resource |
google.cloud.compute_v1.types.RegionInstanceGroupManagerDeleteInstanceConfigReq
The body resource for this request This corresponds to the |
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. |
| Type | Description |
google.cloud.compute_v1.types.Operation | Represents an Operation resource. Google Compute Engine has three Operation resources: \* [Global](/compute/docs/reference/rest/v1/globalOperations) \* [Regional](/compute/docs/reference/rest/v1/regionOperations) \* [Zonal](/compute/docs/reference/rest/v1/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. |
delete_unary
delete_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.DeleteRegionInstanceGroupManagerRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, instance_group_manager: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Deletes the specified managed instance group and all of the instances in that group.
| Name | Description |
request |
Union[google.cloud.compute_v1.types.DeleteRegionInstanceGroupManagerRequest, dict]
The request object. A request message for RegionInstanceGroupManagers.Delete. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
Name of the region scoping this request. This corresponds to the |
instance_group_manager |
str
Name of the managed instance group to delete. This corresponds to the |
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. |
| Type | Description |
google.cloud.compute_v1.types.Operation | Represents an Operation resource. Google Compute Engine has three Operation resources: \* [Global](/compute/docs/reference/rest/v1/globalOperations) \* [Regional](/compute/docs/reference/rest/v1/regionOperations) \* [Zonal](/compute/docs/reference/rest/v1/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. |
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
| Name | Description |
filename |
str
The path to the service account private key json file. |
| Type | Description |
RegionInstanceGroupManagersClient | 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.
| Name | Description |
info |
dict
The service account private key info. |
| Type | Description |
RegionInstanceGroupManagersClient | 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.
| Name | Description |
filename |
str
The path to the service account private key json file. |
| Type | Description |
RegionInstanceGroupManagersClient | The constructed client. |
get
get(request: Optional[Union[google.cloud.compute_v1.types.compute.GetRegionInstanceGroupManagerRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, instance_group_manager: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Returns all of the details about the specified managed instance group.
| Name | Description |
request |
Union[google.cloud.compute_v1.types.GetRegionInstanceGroupManagerRequest, dict]
The request object. A request message for RegionInstanceGroupManagers.Get. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
Name of the region scoping this request. This corresponds to the |
instance_group_manager |
str
Name of the managed instance group to return. This corresponds to the |
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. |
| Type | Description |
google.cloud.compute_v1.types.InstanceGroupManager | Represents a Managed Instance Group resource. An instance group is a collection of VM instances that you can manage as a single entity. For more information, read Instance groups. For zonal Managed Instance Group, use the instanceGroupManagers resource. For regional Managed Instance Group, use the regionInstanceGroupManagers resource. |
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)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 variabel 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.
| Name | Description |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
| Type | Description |
google.auth.exceptions.MutualTLSChannelError | If any errors happen. |
| Type | Description |
Tuple[str, Callable[[], Tuple[bytes, bytes]]] | returns the API endpoint and the client cert source to use. |
insert_unary
insert_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.InsertRegionInstanceGroupManagerRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, instance_group_manager_resource: Optional[google.cloud.compute_v1.types.compute.InstanceGroupManager] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A regional managed instance group can contain up to 2000 instances.
| Name | Description |
request |
Union[google.cloud.compute_v1.types.InsertRegionInstanceGroupManagerRequest, dict]
The request object. A request message for RegionInstanceGroupManagers.Insert. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
Name of the region scoping this request. This corresponds to the |
instance_group_manager_resource |
google.cloud.compute_v1.types.InstanceGroupManager
The body resource for this request This corresponds to the |
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. |
| Type | Description |
google.cloud.compute_v1.types.Operation | Represents an Operation resource. Google Compute Engine has three Operation resources: \* [Global](/compute/docs/reference/rest/v1/globalOperations) \* [Regional](/compute/docs/reference/rest/v1/regionOperations) \* [Zonal](/compute/docs/reference/rest/v1/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. |
list
list(request: Optional[Union[google.cloud.compute_v1.types.compute.ListRegionInstanceGroupManagersRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Retrieves the list of managed instance groups that are contained within the specified region.
| Name | Description |
request |
Union[google.cloud.compute_v1.types.ListRegionInstanceGroupManagersRequest, dict]
The request object. A request message for RegionInstanceGroupManagers.List. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
Name of the region scoping this request. This corresponds to the |
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. |
| Type | Description |
google.cloud.compute_v1.services.region_instance_group_managers.pagers.ListPager | Contains a list of managed instance groups. Iterating over this object will yield results and resolve additional pages automatically. |
list_errors
list_errors(request: Optional[Union[google.cloud.compute_v1.types.compute.ListErrorsRegionInstanceGroupManagersRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, instance_group_manager: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Lists all errors thrown by actions on instances for a given regional managed instance group. The filter and orderBy query parameters are not supported.
| Name | Description |
request |
Union[google.cloud.compute_v1.types.ListErrorsRegionInstanceGroupManagersRequest, dict]
The request object. A request message for RegionInstanceGroupManagers.ListErrors. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
Name of the region scoping this request. This should conform to RFC1035. This corresponds to the |
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: (?: |
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. |
| Type | Description |
google.cloud.compute_v1.services.region_instance_group_managers.pagers.ListErrorsPager | Iterating over this object will yield results and resolve additional pages automatically. |
list_managed_instances
list_managed_instances(request: Optional[Union[google.cloud.compute_v1.types.compute.ListManagedInstancesRegionInstanceGroupManagersRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, instance_group_manager: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances. The orderBy query parameter is not supported.
| Name | Description |
request |
Union[google.cloud.compute_v1.types.ListManagedInstancesRegionInstanceGroupManagersRequest, dict]
The request object. A request message for RegionInstanceGroupManagers.ListManagedInstances. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
Name of the region scoping this request. This corresponds to the |
instance_group_manager |
str
The name of the managed instance group. This corresponds to the |
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. |
| Type | Description |
google.cloud.compute_v1.services.region_instance_group_managers.pagers.ListManagedInstancesPager | Iterating over this object will yield results and resolve additional pages automatically. |
list_per_instance_configs
list_per_instance_configs(request: Optional[Union[google.cloud.compute_v1.types.compute.ListPerInstanceConfigsRegionInstanceGroupManagersRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, instance_group_manager: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Lists all of the per-instance configs defined for the managed instance group. The orderBy query parameter is not supported.
| Name | Description |
request |
Union[google.cloud.compute_v1.types.ListPerInstanceConfigsRegionInstanceGroupManagersRequest, dict]
The request object. A request message for RegionInstanceGroupManagers.ListPerInstanceConfigs. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
Name of the region scoping this request, should conform to RFC1035. This corresponds to the |
instance_group_manager |
str
The name of the managed instance group. It should conform to RFC1035. This corresponds to the |
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. |
| Type | Description |
google.cloud.compute_v1.services.region_instance_group_managers.pagers.ListPerInstanceConfigsPager | 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.
patch_per_instance_configs_unary
patch_per_instance_configs_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.PatchPerInstanceConfigsRegionInstanceGroupManagerRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, instance_group_manager: Optional[str] = None, region_instance_group_manager_patch_instance_config_req_resource: Optional[google.cloud.compute_v1.types.compute.RegionInstanceGroupManagerPatchInstanceConfigReq] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Inserts or patches per-instance configs for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.
| Name | Description |
request |
Union[google.cloud.compute_v1.types.PatchPerInstanceConfigsRegionInstanceGroupManagerRequest, dict]
The request object. A request message for RegionInstanceGroupManagers.PatchPerInstanceConfigs. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
Name of the region scoping this request, should conform to RFC1035. This corresponds to the |
instance_group_manager |
str
The name of the managed instance group. It should conform to RFC1035. This corresponds to the |
region_instance_group_manager_patch_instance_config_req_resource |
google.cloud.compute_v1.types.RegionInstanceGroupManagerPatchInstanceConfigReq
The body resource for this request This corresponds to the |
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. |
| Type | Description |
google.cloud.compute_v1.types.Operation | Represents an Operation resource. Google Compute Engine has three Operation resources: \* [Global](/compute/docs/reference/rest/v1/globalOperations) \* [Regional](/compute/docs/reference/rest/v1/regionOperations) \* [Zonal](/compute/docs/reference/rest/v1/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. |
patch_unary
patch_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.PatchRegionInstanceGroupManagerRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, instance_group_manager: Optional[str] = None, instance_group_manager_resource: Optional[google.cloud.compute_v1.types.compute.InstanceGroupManager] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listmanagedinstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. 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.
| Name | Description |
request |
Union[google.cloud.compute_v1.types.PatchRegionInstanceGroupManagerRequest, dict]
The request object. A request message for RegionInstanceGroupManagers.Patch. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
Name of the region scoping this request. This corresponds to the |
instance_group_manager |
str
The name of the instance group manager. This corresponds to the |
instance_group_manager_resource |
google.cloud.compute_v1.types.InstanceGroupManager
The body resource for this request This corresponds to the |
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. |
| Type | Description |
google.cloud.compute_v1.types.Operation | Represents an Operation resource. Google Compute Engine has three Operation resources: \* [Global](/compute/docs/reference/rest/v1/globalOperations) \* [Regional](/compute/docs/reference/rest/v1/regionOperations) \* [Zonal](/compute/docs/reference/rest/v1/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. |
recreate_instances_unary
recreate_instances_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.RecreateInstancesRegionInstanceGroupManagerRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, instance_group_manager: Optional[str] = None, region_instance_group_managers_recreate_request_resource: Optional[google.cloud.compute_v1.types.compute.RegionInstanceGroupManagersRecreateRequest] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())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.
| Name | Description |
request |
Union[google.cloud.compute_v1.types.RecreateInstancesRegionInstanceGroupManagerRequest, dict]
The request object. A request message for RegionInstanceGroupManagers.RecreateInstances. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
Name of the region scoping this request. This corresponds to the |
instance_group_manager |
str
Name of the managed instance group. This corresponds to the |
region_instance_group_managers_recreate_request_resource |
google.cloud.compute_v1.types.RegionInstanceGroupManagersRecreateRequest
The body resource for this request This corresponds to the |
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. |
| Type | Description |
google.cloud.compute_v1.types.Operation | Represents an Operation resource. Google Compute Engine has three Operation resources: \* [Global](/compute/docs/reference/rest/v1/globalOperations) \* [Regional](/compute/docs/reference/rest/v1/regionOperations) \* [Zonal](/compute/docs/reference/rest/v1/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. |
resize_unary
resize_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.ResizeRegionInstanceGroupManagerRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, instance_group_manager: Optional[str] = None, size: Optional[int] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Changes the intended size of the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes one or more instances. The resize operation is marked DONE if the resize request is successful. The underlying actions take additional time. You must separately verify the status of the creating or deleting actions 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.
| Name | Description |
request |
Union[google.cloud.compute_v1.types.ResizeRegionInstanceGroupManagerRequest, dict]
The request object. A request message for RegionInstanceGroupManagers.Resize. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
Name of the region scoping this request. This corresponds to the |
instance_group_manager |
str
Name of the managed instance group. This corresponds to the |
size |
int
Number of instances that should exist in this instance group manager. This corresponds to the |
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. |
| Type | Description |
google.cloud.compute_v1.types.Operation | Represents an Operation resource. Google Compute Engine has three Operation resources: \* [Global](/compute/docs/reference/rest/v1/globalOperations) \* [Regional](/compute/docs/reference/rest/v1/regionOperations) \* [Zonal](/compute/docs/reference/rest/v1/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. |
set_instance_template_unary
set_instance_template_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.SetInstanceTemplateRegionInstanceGroupManagerRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, instance_group_manager: Optional[str] = None, region_instance_group_managers_set_template_request_resource: Optional[google.cloud.compute_v1.types.compute.RegionInstanceGroupManagersSetTemplateRequest] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected.
| Name | Description |
request |
Union[google.cloud.compute_v1.types.SetInstanceTemplateRegionInstanceGroupManagerRequest, dict]
The request object. A request message for RegionInstanceGroupManagers.SetInstanceTemplate. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
Name of the region scoping this request. This corresponds to the |
instance_group_manager |
str
The name of the managed instance group. This corresponds to the |
region_instance_group_managers_set_template_request_resource |
google.cloud.compute_v1.types.RegionInstanceGroupManagersSetTemplateRequest
The body resource for this request This corresponds to the |
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. |
| Type | Description |
google.cloud.compute_v1.types.Operation | Represents an Operation resource. Google Compute Engine has three Operation resources: \* [Global](/compute/docs/reference/rest/v1/globalOperations) \* [Regional](/compute/docs/reference/rest/v1/regionOperations) \* [Zonal](/compute/docs/reference/rest/v1/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. |
set_target_pools_unary
set_target_pools_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.SetTargetPoolsRegionInstanceGroupManagerRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, instance_group_manager: Optional[str] = None, region_instance_group_managers_set_target_pools_request_resource: Optional[google.cloud.compute_v1.types.compute.RegionInstanceGroupManagersSetTargetPoolsRequest] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected.
| Name | Description |
request |
Union[google.cloud.compute_v1.types.SetTargetPoolsRegionInstanceGroupManagerRequest, dict]
The request object. A request message for RegionInstanceGroupManagers.SetTargetPools. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
Name of the region scoping this request. This corresponds to the |
instance_group_manager |
str
Name of the managed instance group. This corresponds to the |
region_instance_group_managers_set_target_pools_request_resource |
google.cloud.compute_v1.types.RegionInstanceGroupManagersSetTargetPoolsRequest
The body resource for this request This corresponds to the |
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. |
| Type | Description |
google.cloud.compute_v1.types.Operation | Represents an Operation resource. Google Compute Engine has three Operation resources: \* [Global](/compute/docs/reference/rest/v1/globalOperations) \* [Regional](/compute/docs/reference/rest/v1/regionOperations) \* [Zonal](/compute/docs/reference/rest/v1/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. |
update_per_instance_configs_unary
update_per_instance_configs_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.UpdatePerInstanceConfigsRegionInstanceGroupManagerRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, instance_group_manager: Optional[str] = None, region_instance_group_manager_update_instance_config_req_resource: Optional[google.cloud.compute_v1.types.compute.RegionInstanceGroupManagerUpdateInstanceConfigReq] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Inserts or updates per-instance configs for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.
| Name | Description |
request |
Union[google.cloud.compute_v1.types.UpdatePerInstanceConfigsRegionInstanceGroupManagerRequest, dict]
The request object. A request message for RegionInstanceGroupManagers.UpdatePerInstanceConfigs. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
Name of the region scoping this request, should conform to RFC1035. This corresponds to the |
instance_group_manager |
str
The name of the managed instance group. It should conform to RFC1035. This corresponds to the |
region_instance_group_manager_update_instance_config_req_resource |
google.cloud.compute_v1.types.RegionInstanceGroupManagerUpdateInstanceConfigReq
The body resource for this request This corresponds to the |
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. |
| Type | Description |
google.cloud.compute_v1.types.Operation | Represents an Operation resource. Google Compute Engine has three Operation resources: \* [Global](/compute/docs/reference/rest/v1/globalOperations) \* [Regional](/compute/docs/reference/rest/v1/regionOperations) \* [Zonal](/compute/docs/reference/rest/v1/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. |