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 |
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.
See: Compute Engine API Reference for compute.instanceGroups.removeInstances
.
Synopsis
- type InstanceGroupsRemoveInstancesResource = "compute" :> ("v1" :> ("projects" :> (Capture "project" Text :> ("zones" :> (Capture "zone" Text :> ("instanceGroups" :> (Capture "instanceGroup" Text :> ("removeInstances" :> (QueryParam "requestId" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] InstanceGroupsRemoveInstancesRequest :> Post '[JSON] Operation)))))))))))
- instanceGroupsRemoveInstances :: Text -> Text -> InstanceGroupsRemoveInstancesRequest -> Text -> InstanceGroupsRemoveInstances
- data InstanceGroupsRemoveInstances
- igriRequestId :: Lens' InstanceGroupsRemoveInstances (Maybe Text)
- igriProject :: Lens' InstanceGroupsRemoveInstances Text
- igriZone :: Lens' InstanceGroupsRemoveInstances Text
- igriPayload :: Lens' InstanceGroupsRemoveInstances InstanceGroupsRemoveInstancesRequest
- igriInstanceGroup :: Lens' InstanceGroupsRemoveInstances Text
REST Resource
type InstanceGroupsRemoveInstancesResource = "compute" :> ("v1" :> ("projects" :> (Capture "project" Text :> ("zones" :> (Capture "zone" Text :> ("instanceGroups" :> (Capture "instanceGroup" Text :> ("removeInstances" :> (QueryParam "requestId" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] InstanceGroupsRemoveInstancesRequest :> Post '[JSON] Operation))))))))))) Source #
A resource alias for compute.instanceGroups.removeInstances
method which the
InstanceGroupsRemoveInstances
request conforms to.
Creating a Request
instanceGroupsRemoveInstances Source #
Creates a value of InstanceGroupsRemoveInstances
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data InstanceGroupsRemoveInstances Source #
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.
See: instanceGroupsRemoveInstances
smart constructor.
Instances
Request Lenses
igriRequestId :: Lens' InstanceGroupsRemoveInstances (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).
igriProject :: Lens' InstanceGroupsRemoveInstances Text Source #
Project ID for this request.
igriZone :: Lens' InstanceGroupsRemoveInstances Text Source #
The name of the zone where the instance group is located.
igriPayload :: Lens' InstanceGroupsRemoveInstances InstanceGroupsRemoveInstancesRequest Source #
Multipart request metadata.
igriInstanceGroup :: Lens' InstanceGroupsRemoveInstances Text Source #
The name of the instance group where the specified instances will be removed.