com.google.api.services.compute

Class Compute.Instances.Stop

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.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.Instances.Stop

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

Enclosing class:

Compute.Instances

public class Compute.Instances.Stop
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

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

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

java.util.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	Compute.Instances.Stop(java.lang.String project, java.lang.String zone, java.lang.String instance) Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getInstance() Name of the instance resource to stop.
java.lang.String	getProject() Project ID for this request.
java.lang.String	getZone() The name of the zone for this request.
Compute.Instances.Stop	set(java.lang.String parameterName, java.lang.Object value)
Compute.Instances.Stop	setAlt(java.lang.String alt) Data format for the response.
Compute.Instances.Stop	setFields(java.lang.String fields) Selector specifying which fields to include in a partial response.
Compute.Instances.Stop	setInstance(java.lang.String instance) Name of the instance resource to stop.
Compute.Instances.Stop	setKey(java.lang.String key) API key.
Compute.Instances.Stop	setOauthToken(java.lang.String oauthToken) OAuth 2.0 token for the current user.
Compute.Instances.Stop	setPrettyPrint(java.lang.Boolean prettyPrint) Returns response with indentations and line breaks.
Compute.Instances.Stop	setProject(java.lang.String project) Project ID for this request.
Compute.Instances.Stop	setQuotaUser(java.lang.String quotaUser) Available to use for quota purposes for server-side applications.
Compute.Instances.Stop	setUserIp(java.lang.String userIp) IP address of the site where the request originates.
Compute.Instances.Stop	setZone(java.lang.String zone) The name of the zone for this request.

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

Constructor Detail

Compute.Instances.Stop

protected Compute.Instances.Stop(java.lang.String project,
                      java.lang.String zone,
                      java.lang.String instance)

Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur per-minute, virtual machine usage charges while they are stopped, but any resources that the virtual machine is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance. Create a request for the method "instances.stop". 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.

Compute.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) 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 for this request.

instance - Name of the instance resource to stop.

Since:

1.13

Method Detail

setAlt

public Compute.Instances.Stop setAlt(java.lang.String alt)

Description copied from class: ComputeRequest

Data format for the response.

Overrides:

setAlt in class ComputeRequest<Operation>

setFields

public Compute.Instances.Stop setFields(java.lang.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.Instances.Stop setKey(java.lang.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.Instances.Stop setOauthToken(java.lang.String oauthToken)

Description copied from class: ComputeRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class ComputeRequest<Operation>

setPrettyPrint

public Compute.Instances.Stop setPrettyPrint(java.lang.Boolean prettyPrint)

Description copied from class: ComputeRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class ComputeRequest<Operation>

setQuotaUser

public Compute.Instances.Stop setQuotaUser(java.lang.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 userIp if both are provided.

Overrides:

setQuotaUser in class ComputeRequest<Operation>

setUserIp

public Compute.Instances.Stop setUserIp(java.lang.String userIp)

Description copied from class: ComputeRequest

IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Overrides:

setUserIp in class ComputeRequest<Operation>

getProject

public java.lang.String getProject()

Project ID for this request.

setProject

public Compute.Instances.Stop setProject(java.lang.String project)

Project ID for this request.

getZone

public java.lang.String getZone()

The name of the zone for this request.

setZone

public Compute.Instances.Stop setZone(java.lang.String zone)

The name of the zone for this request.

getInstance

public java.lang.String getInstance()

Name of the instance resource to stop.

setInstance

public Compute.Instances.Stop setInstance(java.lang.String instance)

Name of the instance resource to stop.

set

public Compute.Instances.Stop set(java.lang.String parameterName,
                         java.lang.Object value)

Overrides:

set in class ComputeRequest<Operation>