com.google.api.services.compute

Class Compute.InstanceGroups.RemoveInstances

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.InstanceGroups.RemoveInstances

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Compute.InstanceGroups

public class Compute.InstanceGroups.RemoveInstances
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	RemoveInstances(String project, String zone, String instanceGroup, InstanceGroupsRemoveInstancesRequest content) Removes one or more instances from the specified instance group, but does not delete those instances.

Method Summary

Modifier and Type	Method and Description
String	getInstanceGroup() The name of the instance group where the specified instances will be removed.
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 instance group is located.
Compute.InstanceGroups.RemoveInstances	set(String parameterName, Object value)
Compute.InstanceGroups.RemoveInstances	setAlt(String alt) Data format for the response.
Compute.InstanceGroups.RemoveInstances	setFields(String fields) Selector specifying which fields to include in a partial response.
Compute.InstanceGroups.RemoveInstances	setInstanceGroup(String instanceGroup) The name of the instance group where the specified instances will be removed.
Compute.InstanceGroups.RemoveInstances	setKey(String key) API key.
Compute.InstanceGroups.RemoveInstances	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Compute.InstanceGroups.RemoveInstances	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Compute.InstanceGroups.RemoveInstances	setProject(String project) Project ID for this request.
Compute.InstanceGroups.RemoveInstances	setQuotaUser(String quotaUser) An opaque string that represents a user for quota purposes.
Compute.InstanceGroups.RemoveInstances	setRequestId(String requestId) An optional request ID to identify requests.
Compute.InstanceGroups.RemoveInstances	setUserIp(String userIp) Deprecated.
Compute.InstanceGroups.RemoveInstances	setZone(String zone) The name of the zone where the 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, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue

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

clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, 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

RemoveInstances

protected RemoveInstances(String project,
                          String zone,
                          String instanceGroup,
                          InstanceGroupsRemoveInstancesRequest content)

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. Create a request for the method "instanceGroups.removeInstances". 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.

RemoveInstances#initialize(com.google.api.client.googleapis.services.AbstractGoogleC lientRequest) 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 instance group is located.

instanceGroup - The name of the instance group where the specified instances will be removed.

content - the InstanceGroupsRemoveInstancesRequest

Since:

1.13

Method Detail

setAlt

public Compute.InstanceGroups.RemoveInstances setAlt(String alt)

Description copied from class: ComputeRequest

Data format for the response.

Overrides:

setAlt in class ComputeRequest<Operation>

setFields

public Compute.InstanceGroups.RemoveInstances 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.InstanceGroups.RemoveInstances 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.InstanceGroups.RemoveInstances 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.InstanceGroups.RemoveInstances setPrettyPrint(Boolean prettyPrint)

Description copied from class: ComputeRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class ComputeRequest<Operation>

setQuotaUser

public Compute.InstanceGroups.RemoveInstances 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.InstanceGroups.RemoveInstances 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.InstanceGroups.RemoveInstances setProject(String project)

Project ID for this request.

getZone

public String getZone()

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

setZone

public Compute.InstanceGroups.RemoveInstances setZone(String zone)

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

getInstanceGroup

public String getInstanceGroup()

The name of the instance group where the specified instances will be removed.

setInstanceGroup

public Compute.InstanceGroups.RemoveInstances setInstanceGroup(String instanceGroup)

The name of the instance group where the specified instances will be removed.

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

Overrides:

set in class ComputeRequest<Operation>