com.google.api.services.compute

Class Compute.InstanceGroupManagers.StopInstances

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Compute.InstanceGroupManagers

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

Nested Class Summary

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

com.google.api.client.util.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

API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
String	getInstanceGroupManager() The name of the managed instance group.
Boolean	getNoGracefulShutdown() When set, graceful shutdown is skipped for instance stopping even if it's configured for the instances.
String	getProject() Project ID for this request.
String	getRequestId() An optional request ID to identify requests.
String	getZone() The name of thezone where the managed instance group is located.
boolean	isNoGracefulShutdown() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
Compute.InstanceGroupManagers.StopInstances	set(String parameterName, Object value)
Compute.InstanceGroupManagers.StopInstances	set$Xgafv(String $Xgafv) V1 error format.
Compute.InstanceGroupManagers.StopInstances	setAccessToken(String accessToken) OAuth access token.
Compute.InstanceGroupManagers.StopInstances	setAlt(String alt) Data format for response.
Compute.InstanceGroupManagers.StopInstances	setCallback(String callback) JSONP
Compute.InstanceGroupManagers.StopInstances	setFields(String fields) Selector specifying which fields to include in a partial response.
Compute.InstanceGroupManagers.StopInstances	setInstanceGroupManager(String instanceGroupManager) The name of the managed instance group.
Compute.InstanceGroupManagers.StopInstances	setKey(String key) API key.
Compute.InstanceGroupManagers.StopInstances	setNoGracefulShutdown(Boolean noGracefulShutdown) When set, graceful shutdown is skipped for instance stopping even if it's configured for the instances.
Compute.InstanceGroupManagers.StopInstances	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Compute.InstanceGroupManagers.StopInstances	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Compute.InstanceGroupManagers.StopInstances	setProject(String project) Project ID for this request.
Compute.InstanceGroupManagers.StopInstances	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Compute.InstanceGroupManagers.StopInstances	setRequestId(String requestId) An optional request ID to identify requests.
Compute.InstanceGroupManagers.StopInstances	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Compute.InstanceGroupManagers.StopInstances	setUploadType(String uploadType) Legacy upload protocol for media (e.g.
Compute.InstanceGroupManagers.StopInstances	setUserIp(String userIp) Legacy name for parameter that has been superseded by `quotaUser`.
Compute.InstanceGroupManagers.StopInstances	setZone(String zone) The name of thezone where the managed instance group is located.

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

get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, 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

StopInstances

protected StopInstances(String project,
                        String zone,
                        String instanceGroupManager,
                        InstanceGroupManagersStopInstancesRequest content)

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 thetargetSize 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 theSTOPPING action with thelistmanagedinstances 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 thaninitialDelaySec seconds have passed sinceinstance.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. Create a request for the method "instanceGroupManagers.stopInstances". 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.

StopInstances#initialize(com.google.api.client.googleapis.services.AbstractGoogleClientR equest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

project - Project ID for this request.

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

instanceGroupManager - The name of the managed instance group.

content - the InstanceGroupManagersStopInstancesRequest

Since:

1.13

Method Detail

set$Xgafv

public Compute.InstanceGroupManagers.StopInstances set$Xgafv(String $Xgafv)

Description copied from class: ComputeRequest

V1 error format.

Overrides:

set$Xgafv in class ComputeRequest<Operation>

setAccessToken

public Compute.InstanceGroupManagers.StopInstances setAccessToken(String accessToken)

Description copied from class: ComputeRequest

OAuth access token.

Overrides:

setAccessToken in class ComputeRequest<Operation>

setAlt

public Compute.InstanceGroupManagers.StopInstances setAlt(String alt)

Description copied from class: ComputeRequest

Data format for response.

Overrides:

setAlt in class ComputeRequest<Operation>

setCallback

public Compute.InstanceGroupManagers.StopInstances setCallback(String callback)

Description copied from class: ComputeRequest

JSONP

Overrides:

setCallback in class ComputeRequest<Operation>

setFields

public Compute.InstanceGroupManagers.StopInstances 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.StopInstances 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.StopInstances 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.StopInstances 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.StopInstances setQuotaUser(String quotaUser)

Description copied from class: ComputeRequest

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Overrides:

setQuotaUser in class ComputeRequest<Operation>

setUploadType

public Compute.InstanceGroupManagers.StopInstances setUploadType(String uploadType)

Description copied from class: ComputeRequest

Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:

setUploadType in class ComputeRequest<Operation>

setUploadProtocol

public Compute.InstanceGroupManagers.StopInstances setUploadProtocol(String uploadProtocol)

Description copied from class: ComputeRequest

Upload protocol for media (e.g. "raw", "multipart").

Overrides:

setUploadProtocol in class ComputeRequest<Operation>

setUserIp

public Compute.InstanceGroupManagers.StopInstances setUserIp(String userIp)

Description copied from class: ComputeRequest

Legacy name for parameter that has been superseded by `quotaUser`.

Overrides:

setUserIp in class ComputeRequest<Operation>

getProject

public String getProject()

Project ID for this request.

setProject

public Compute.InstanceGroupManagers.StopInstances setProject(String project)

Project ID for this request.

getZone

public String getZone()

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

setZone

public Compute.InstanceGroupManagers.StopInstances setZone(String zone)

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

getInstanceGroupManager

public String getInstanceGroupManager()

The name of the managed instance group.

setInstanceGroupManager

public Compute.InstanceGroupManagers.StopInstances setInstanceGroupManager(String instanceGroupManager)

The name of the managed instance group.

getNoGracefulShutdown

public Boolean getNoGracefulShutdown()

When set, graceful shutdown is skipped for instance stopping even if it's configured for the instances. [default: false]

setNoGracefulShutdown

public Compute.InstanceGroupManagers.StopInstances setNoGracefulShutdown(Boolean noGracefulShutdown)

When set, graceful shutdown is skipped for instance stopping even if it's configured for the instances.

isNoGracefulShutdown

public boolean isNoGracefulShutdown()

Convenience method that returns only Boolean.TRUE or Boolean.FALSE.

Boolean properties can have four possible values: null, Data.NULL_BOOLEAN, Boolean.TRUE or Boolean.FALSE.

This method returns Boolean.TRUE if the default of the property is Boolean.TRUE and it is null or Data.NULL_BOOLEAN. Boolean.FALSE is returned if the default of the property is Boolean.FALSE and it is null or Data.NULL_BOOLEAN.

When set, graceful shutdown is skipped for instance stopping even if it's configured for the instances.

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.StopInstances 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.StopInstances set(String parameterName,
                                                       Object value)

Overrides:

set in class ComputeRequest<Operation>