Class RegionInstanceGroupManagersResource.StopInstancesRequest

Flags the specified instances in the managed instance group to be immediately stopped. You can only specify instances that are running in this request. This method reduces the targetSize and increases the targetStoppedSize of the managed instance group by the number of instances that you stop. The stopInstances operation is marked DONE if the stopInstances request is successful. The underlying actions take additional time. You must separately verify the status of the STOPPING action with the listmanagedinstances method. If the standbyPolicy.initialDelaySec field is set, the group delays stopping the instances until initialDelaySec have passed from instance.creationTimestamp (that is, when the instance was created). This delay gives your application time to set itself up and initialize on the instance. If more than initialDelaySec seconds have passed since instance.creationTimestamp when this method is called, there will be zero delay. 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 stopped. Stopped instances can be started using the startInstances method. You can specify a maximum of 1000 instances with this method per request.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<Operation>
ComputeBaseServiceRequest<Operation>
RegionInstanceGroupManagersResource.StopInstancesRequest
Implements
Inherited Members
Namespace: Google.Apis.Compute.alpha
Assembly: Google.Apis.Compute.alpha.dll
Syntax
public class RegionInstanceGroupManagersResource.StopInstancesRequest : ComputeBaseServiceRequest<Operation>, IClientServiceRequest<Operation>, IClientServiceRequest

Constructors

StopInstancesRequest(IClientService, RegionInstanceGroupManagersStopInstancesRequest, string, string, string)

Constructs a new StopInstances request.

Declaration
public StopInstancesRequest(IClientService service, RegionInstanceGroupManagersStopInstancesRequest body, string project, string region, string instanceGroupManager)
Parameters
Type Name Description
IClientService service
RegionInstanceGroupManagersStopInstancesRequest body
string project
string region
string instanceGroupManager

Properties

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides

InstanceGroupManager

The name of the managed instance group.

Declaration
[RequestParameter("instanceGroupManager", RequestParameterType.Path)]
public virtual string InstanceGroupManager { get; }
Property Value
Type Description
string

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides

Project

Project ID for this request.

Declaration
[RequestParameter("project", RequestParameterType.Path)]
public virtual string Project { get; }
Property Value
Type Description
string

Region

Name of the region scoping this request.

Declaration
[RequestParameter("region", RequestParameterType.Path)]
public virtual string Region { get; }
Property Value
Type Description
string

RequestId

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).

Declaration
[RequestParameter("requestId", RequestParameterType.Query)]
public virtual string RequestId { get; set; }
Property Value
Type Description
string

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides

Methods

GetBody()

Returns the body of the request.

Declaration
protected override object GetBody()
Returns
Type Description
object
Overrides

InitParameters()

Initializes StopInstances parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements