• Home
• com.google.apis
• google-api-services-compute
• beta-rev20220312-1.32.1
• source code
• Compute.Instances.Stop.html

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

target.apidocs.com.google.api.services.compute.Compute.Instances.Stop.html Maven / Gradle / Ivy

Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.compute
Class Compute.Instances.Stop



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.Instances.Stop

















All Implemented Interfaces:
Cloneable, Map<String,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
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 
Stop(String project,
    String zone,
    String instance)
Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a
 later time.










Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


String
getInstance()
Name of the instance resource to stop.



String
getProject()
Project ID for this request.



String
getRequestId()
An optional request ID to identify requests.



String
getZone()
The name of the zone for this request.



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


Compute.Instances.Stop
set$Xgafv(String $Xgafv)
V1 error format.



Compute.Instances.Stop
setAccessToken(String accessToken)
OAuth access token.



Compute.Instances.Stop
setAlt(String alt)
Data format for response.



Compute.Instances.Stop
setCallback(String callback)
JSONP



Compute.Instances.Stop
setFields(String fields)
Selector specifying which fields to include in a partial response.



Compute.Instances.Stop
setInstance(String instance)
Name of the instance resource to stop.



Compute.Instances.Stop
setKey(String key)
API key.



Compute.Instances.Stop
setOauthToken(String oauthToken)
OAuth 2.0 token for the current user.



Compute.Instances.Stop
setPrettyPrint(Boolean prettyPrint)
Returns response with indentations and line breaks.



Compute.Instances.Stop
setProject(String project)
Project ID for this request.



Compute.Instances.Stop
setQuotaUser(String quotaUser)
Available to use for quota purposes for server-side applications.



Compute.Instances.Stop
setRequestId(String requestId)
An optional request ID to identify requests.



Compute.Instances.Stop
setUploadProtocol(String uploadProtocol)
Upload protocol for media (e.g.



Compute.Instances.Stop
setUploadType(String uploadType)
Legacy upload protocol for media (e.g.



Compute.Instances.Stop
setUserIp(String userIp)
Legacy name for parameter that has been superseded by `quotaUser`.



Compute.Instances.Stop
setZone(String zone)
The name of the zone for this request.







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





Stop
protected Stop(String project,
               String zone,
               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 VM usage charges while they are stopped. However,
 resources that the VM 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





set$Xgafv
public Compute.Instances.Stop set$Xgafv(String $Xgafv)
Description copied from class: ComputeRequest
V1 error format.

Overrides:
set$Xgafv in class ComputeRequest<Operation>








setAccessToken
public Compute.Instances.Stop setAccessToken(String accessToken)
Description copied from class: ComputeRequest
OAuth access token.

Overrides:
setAccessToken in class ComputeRequest<Operation>








setAlt
public Compute.Instances.Stop setAlt(String alt)
Description copied from class: ComputeRequest
Data format for response.

Overrides:
setAlt in class ComputeRequest<Operation>








setCallback
public Compute.Instances.Stop setCallback(String callback)
Description copied from class: ComputeRequest
JSONP

Overrides:
setCallback in class ComputeRequest<Operation>








setFields
public Compute.Instances.Stop 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.Instances.Stop 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.Instances.Stop 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.Instances.Stop setPrettyPrint(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(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.Instances.Stop 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.Instances.Stop 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.Instances.Stop 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.Instances.Stop setProject(String project)
Project ID for this request.







getZone
public String getZone()
The name of the zone for this request.







setZone
public Compute.Instances.Stop setZone(String zone)
The name of the zone for this request.







getInstance
public String getInstance()
Name of the instance resource to stop.







setInstance
public Compute.Instances.Stop setInstance(String instance)
Name of the instance resource to stop.







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

Overrides:
set in class ComputeRequest<Operation>














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2022 Google. All rights reserved.