com.google.api.services.compute

Class Compute.InstanceGroupManagers.SuspendInstances

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>

com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

com.google.api.services.compute.ComputeRequest<Operation>

com.google.api.services.compute.Compute.InstanceGroupManagers.SuspendInstances

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Compute.InstanceGroupManagers

public class Compute.InstanceGroupManagers.SuspendInstances
extends ComputeRequest<Operation>

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SuspendInstances(String project, String zone, String instanceGroupManager, InstanceGroupManagersSuspendInstancesRequest content) Flags the specified instances in the managed instance group to be immediately suspended.

Method Summary

Modifier and Type	Method and Description
String	getInstanceGroupManager() The name of the managed instance group.
String	getProject() Project ID for this request.
String	getRequestId() An optional request ID to identify requests.
String	getZone() The name of the zone where the managed instance group is located.
Compute.InstanceGroupManagers.SuspendInstances	set(String parameterName, Object value)
Compute.InstanceGroupManagers.SuspendInstances	setAlt(String alt) Data format for the response.
Compute.InstanceGroupManagers.SuspendInstances	setFields(String fields) Selector specifying which fields to include in a partial response.
Compute.InstanceGroupManagers.SuspendInstances	setInstanceGroupManager(String instanceGroupManager) The name of the managed instance group.
Compute.InstanceGroupManagers.SuspendInstances	setKey(String key) API key.
Compute.InstanceGroupManagers.SuspendInstances	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Compute.InstanceGroupManagers.SuspendInstances	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Compute.InstanceGroupManagers.SuspendInstances	setProject(String project) Project ID for this request.
Compute.InstanceGroupManagers.SuspendInstances	setQuotaUser(String quotaUser) An opaque string that represents a user for quota purposes.
Compute.InstanceGroupManagers.SuspendInstances	setRequestId(String requestId) An optional request ID to identify requests.
Compute.InstanceGroupManagers.SuspendInstances	setUserIp(String userIp) Deprecated.
Compute.InstanceGroupManagers.SuspendInstances	setZone(String zone) The name of the zone where the managed instance group is located.

Methods inherited from class com.google.api.services.compute.ComputeRequest

getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

buildHttpRequest, buildHttpRequestUrl, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

Methods inherited from class com.google.api.client.util.GenericData

clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

SuspendInstances

protected SuspendInstances(String project,
                           String zone,
                           String instanceGroupManager,
                           InstanceGroupManagersSuspendInstancesRequest content)

Flags the specified instances in the managed instance group to be immediately suspended. You can only specify instances that are running in this request. This method reduces the targetSize and increases the targetSuspendedSize of the managed instance group by the number of instances that you suspend. The suspendInstances operation is marked DONE if the suspendInstances request is successful. The underlying actions take additional time. You must separately verify the status of the SUSPENDING action with the listmanagedinstances method. If the instanceLifecyclePolicy.metadataBasedReadinessSignal field is set on the Instance Group Manager, each instance will be initialized before it is suspended, to give user programs time to perform necessary tasks. To initialize an instance, the Instance Group Manager sets the metadata key google-compute-initialization-intent to value INITIALIZE_AND_SUSPEND on the instance, and waits for the user program to signal it is ready. This is done by setting the guest attribute path google-compute/initialization-state to value INITIALIZED. If the instance does not signal successful initialization (does not set the guest attribute to INITIALIZED) before timeout, the initialization is considered failed and the instance is not suspended. 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 suspended. Suspended instances can be resumed using the resumeInstances method. You can specify a maximum of 1000 instances with this method per request. Create a request for the method "instanceGroupManagers.suspendInstances". This request holds the parameters needed by the the compute server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

SuspendInstances#initialize(com.google.api.client.googleapis.services.AbstractGoogle ClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

project - Project ID for this request.

zone - The name of the zone where the managed instance group is located.

instanceGroupManager - The name of the managed instance group.

content - the InstanceGroupManagersSuspendInstancesRequest

Since:

1.13

Method Detail

setAlt

public Compute.InstanceGroupManagers.SuspendInstances setAlt(String alt)

Description copied from class: ComputeRequest

Data format for the response.

Overrides:

setAlt in class ComputeRequest<Operation>

setFields

public Compute.InstanceGroupManagers.SuspendInstances setFields(String fields)

Description copied from class: ComputeRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class ComputeRequest<Operation>

setKey

public Compute.InstanceGroupManagers.SuspendInstances setKey(String key)

Description copied from class: ComputeRequest

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Overrides:

setKey in class ComputeRequest<Operation>

setOauthToken

public Compute.InstanceGroupManagers.SuspendInstances setOauthToken(String oauthToken)

Description copied from class: ComputeRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class ComputeRequest<Operation>

setPrettyPrint

public Compute.InstanceGroupManagers.SuspendInstances setPrettyPrint(Boolean prettyPrint)

Description copied from class: ComputeRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class ComputeRequest<Operation>

setQuotaUser

public Compute.InstanceGroupManagers.SuspendInstances setQuotaUser(String quotaUser)

Description copied from class: ComputeRequest

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Overrides:

setQuotaUser in class ComputeRequest<Operation>

setUserIp

public Compute.InstanceGroupManagers.SuspendInstances setUserIp(String userIp)

Description copied from class: ComputeRequest

Deprecated. Please use quotaUser instead.

Overrides:

setUserIp in class ComputeRequest<Operation>

getProject

public String getProject()

Project ID for this request.

setProject

public Compute.InstanceGroupManagers.SuspendInstances setProject(String project)

Project ID for this request.

getZone

public String getZone()

The name of the zone where the managed instance group is located.

setZone

public Compute.InstanceGroupManagers.SuspendInstances setZone(String zone)

The name of the zone where the managed instance group is located.

getInstanceGroupManager

public String getInstanceGroupManager()

The name of the managed instance group.

setInstanceGroupManager

public Compute.InstanceGroupManagers.SuspendInstances setInstanceGroupManager(String instanceGroupManager)

The name of the managed instance group.

getRequestId

public String getRequestId()

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

setRequestId

public Compute.InstanceGroupManagers.SuspendInstances setRequestId(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).

set

public Compute.InstanceGroupManagers.SuspendInstances set(String parameterName,
                                                          Object value)

Overrides:

set in class ComputeRequest<Operation>