target.apidocs.com.google.api.services.compute.Compute.Instances.Suspend.html Maven / Gradle / Ivy
Compute.Instances.Suspend (Compute Engine API beta-rev20220312-1.32.1)
com.google.api.services.compute
Class Compute.Instances.Suspend
- 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.Suspend
-
- Enclosing class:
- Compute.Instances
public class Compute.Instances.Suspend
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>
-
Field Summary
-
Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
USER_AGENT_SUFFIX
-
Constructor Summary
Constructors
Modifier
Constructor and Description
protected Suspend(String project,
String zone,
String instance)
This method suspends a running instance, saving its state to persistent storage, and allows you
to resume the instance at a later time.
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
BooleangetDiscardLocalSsd()
If true, discard the contents of any attached localSSD partitions.
StringgetInstance()
Name of the instance resource to suspend.
StringgetProject()
Project ID for this request.
StringgetRequestId()
An optional request ID to identify requests.
StringgetZone()
The name of the zone for this request.
Compute.Instances.Suspendset(String parameterName,
Object value)
Compute.Instances.Suspendset$Xgafv(String $Xgafv)
V1 error format.
Compute.Instances.SuspendsetAccessToken(String accessToken)
OAuth access token.
Compute.Instances.SuspendsetAlt(String alt)
Data format for response.
Compute.Instances.SuspendsetCallback(String callback)
JSONP
Compute.Instances.SuspendsetDiscardLocalSsd(Boolean discardLocalSsd)
If true, discard the contents of any attached localSSD partitions.
Compute.Instances.SuspendsetFields(String fields)
Selector specifying which fields to include in a partial response.
Compute.Instances.SuspendsetInstance(String instance)
Name of the instance resource to suspend.
Compute.Instances.SuspendsetKey(String key)
API key.
Compute.Instances.SuspendsetOauthToken(String oauthToken)
OAuth 2.0 token for the current user.
Compute.Instances.SuspendsetPrettyPrint(Boolean prettyPrint)
Returns response with indentations and line breaks.
Compute.Instances.SuspendsetProject(String project)
Project ID for this request.
Compute.Instances.SuspendsetQuotaUser(String quotaUser)
Available to use for quota purposes for server-side applications.
Compute.Instances.SuspendsetRequestId(String requestId)
An optional request ID to identify requests.
Compute.Instances.SuspendsetUploadProtocol(String uploadProtocol)
Upload protocol for media (e.g.
Compute.Instances.SuspendsetUploadType(String uploadType)
Legacy upload protocol for media (e.g.
Compute.Instances.SuspendsetUserIp(String userIp)
Legacy name for parameter that has been superseded by `quotaUser`.
Compute.Instances.SuspendsetZone(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
-
Suspend
protected Suspend(String project,
String zone,
String instance)
This method suspends a running instance, saving its state to persistent storage, and allows you
to resume the instance at a later time. Suspended instances have no compute costs (cores or
RAM), and incur only storage charges for the saved VM memory and localSSD data. Any charged
resources the virtual machine was using, such as persistent disks and static IP addresses, will
continue to be charged while the instance is suspended. For more information, see Suspending
and resuming an instance.
Create a request for the method "instances.suspend".
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 suspend.- Since:
- 1.13
-
Method Detail
-
set$Xgafv
public Compute.Instances.Suspend set$Xgafv(String $Xgafv)
Description copied from class: ComputeRequest
V1 error format.
- Overrides:
set$Xgafv in class ComputeRequest<Operation>
-
setAccessToken
public Compute.Instances.Suspend setAccessToken(String accessToken)
Description copied from class: ComputeRequest
OAuth access token.
- Overrides:
setAccessToken in class ComputeRequest<Operation>
-
setAlt
public Compute.Instances.Suspend setAlt(String alt)
Description copied from class: ComputeRequest
Data format for response.
- Overrides:
setAlt in class ComputeRequest<Operation>
-
setCallback
public Compute.Instances.Suspend setCallback(String callback)
Description copied from class: ComputeRequest
JSONP
- Overrides:
setCallback in class ComputeRequest<Operation>
-
setFields
public Compute.Instances.Suspend 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.Suspend 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.Suspend 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.Suspend 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.Suspend 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.Suspend 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.Suspend 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.Suspend 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.Suspend setProject(String project)
Project ID for this request.
-
getZone
public String getZone()
The name of the zone for this request.
-
setZone
public Compute.Instances.Suspend setZone(String zone)
The name of the zone for this request.
-
getInstance
public String getInstance()
Name of the instance resource to suspend.
-
setInstance
public Compute.Instances.Suspend setInstance(String instance)
Name of the instance resource to suspend.
-
getDiscardLocalSsd
public Boolean getDiscardLocalSsd()
If true, discard the contents of any attached localSSD partitions. Default value is false (==
preserve localSSD data).
-
setDiscardLocalSsd
public Compute.Instances.Suspend setDiscardLocalSsd(Boolean discardLocalSsd)
If true, discard the contents of any attached localSSD partitions. Default value is false
(== preserve localSSD data).
-
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.Suspend 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.Suspend set(String parameterName,
Object value)
- Overrides:
set in class ComputeRequest<Operation>
Copyright © 2011–2022 Google. All rights reserved.
© 2015 - 2025 Weber Informatics LLC | Privacy Policy