| Copyright | (c) 2015-2016 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.Google.Resource.Compute.InstanceGroupManagers.AbandonInstances
Description
Flags the specified instances to be removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.
See: Compute Engine API Reference for compute.instanceGroupManagers.abandonInstances.
Synopsis
- type InstanceGroupManagersAbandonInstancesResource = "compute" :> ("v1" :> ("projects" :> (Capture "project" Text :> ("zones" :> (Capture "zone" Text :> ("instanceGroupManagers" :> (Capture "instanceGroupManager" Text :> ("abandonInstances" :> (QueryParam "requestId" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] InstanceGroupManagersAbandonInstancesRequest :> Post '[JSON] Operation)))))))))))
- instanceGroupManagersAbandonInstances :: Text -> Text -> Text -> InstanceGroupManagersAbandonInstancesRequest -> InstanceGroupManagersAbandonInstances
- data InstanceGroupManagersAbandonInstances
- igmaiRequestId :: Lens' InstanceGroupManagersAbandonInstances (Maybe Text)
- igmaiProject :: Lens' InstanceGroupManagersAbandonInstances Text
- igmaiInstanceGroupManager :: Lens' InstanceGroupManagersAbandonInstances Text
- igmaiZone :: Lens' InstanceGroupManagersAbandonInstances Text
- igmaiPayload :: Lens' InstanceGroupManagersAbandonInstances InstanceGroupManagersAbandonInstancesRequest
REST Resource
type InstanceGroupManagersAbandonInstancesResource = "compute" :> ("v1" :> ("projects" :> (Capture "project" Text :> ("zones" :> (Capture "zone" Text :> ("instanceGroupManagers" :> (Capture "instanceGroupManager" Text :> ("abandonInstances" :> (QueryParam "requestId" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] InstanceGroupManagersAbandonInstancesRequest :> Post '[JSON] Operation))))))))))) Source #
A resource alias for compute.instanceGroupManagers.abandonInstances method which the
InstanceGroupManagersAbandonInstances request conforms to.
Creating a Request
instanceGroupManagersAbandonInstances Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> InstanceGroupManagersAbandonInstancesRequest | |
| -> InstanceGroupManagersAbandonInstances |
Creates a value of InstanceGroupManagersAbandonInstances with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data InstanceGroupManagersAbandonInstances Source #
Flags the specified instances to be removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.
See: instanceGroupManagersAbandonInstances smart constructor.
Instances
Request Lenses
igmaiRequestId :: Lens' InstanceGroupManagersAbandonInstances (Maybe Text) Source #
An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
igmaiProject :: Lens' InstanceGroupManagersAbandonInstances Text Source #
Project ID for this request.
igmaiInstanceGroupManager :: Lens' InstanceGroupManagersAbandonInstances Text Source #
The name of the managed instance group.
igmaiZone :: Lens' InstanceGroupManagersAbandonInstances Text Source #
The name of the zone where the managed instance group is located.
igmaiPayload :: Lens' InstanceGroupManagersAbandonInstances InstanceGroupManagersAbandonInstancesRequest Source #
Multipart request metadata.