target.apidocs.com.google.api.services.compute.Compute.Instances.Update.html Maven / Gradle / Ivy
Compute.Instances.Update (Compute Engine API alpha-rev20200526-1.30.9)
com.google.api.services.compute
Class Compute.Instances.Update
- 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.Update
-
- Enclosing class:
- Compute.Instances
public class Compute.Instances.Update
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
Update(String project,
String zone,
String instance,
Instance content)
Updates an instance only if the necessary resources are available.
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
String
getInstance()
Name of the instance resource to update.
String
getMinimalAction()
Specifies the action to take when updating an instance even if the updated properties do not
require it.
String
getMostDisruptiveAllowedAction()
Specifies the most disruptive action that can be taken on the instance as part of the update.
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.Update
set(String parameterName,
Object value)
Compute.Instances.Update
setAlt(String alt)
Data format for the response.
Compute.Instances.Update
setFields(String fields)
Selector specifying which fields to include in a partial response.
Compute.Instances.Update
setInstance(String instance)
Name of the instance resource to update.
Compute.Instances.Update
setKey(String key)
API key.
Compute.Instances.Update
setMinimalAction(String minimalAction)
Specifies the action to take when updating an instance even if the updated properties do
not require it.
Compute.Instances.Update
setMostDisruptiveAllowedAction(String mostDisruptiveAllowedAction)
Specifies the most disruptive action that can be taken on the instance as part of the
update.
Compute.Instances.Update
setOauthToken(String oauthToken)
OAuth 2.0 token for the current user.
Compute.Instances.Update
setPrettyPrint(Boolean prettyPrint)
Returns response with indentations and line breaks.
Compute.Instances.Update
setProject(String project)
Project ID for this request.
Compute.Instances.Update
setQuotaUser(String quotaUser)
An opaque string that represents a user for quota purposes.
Compute.Instances.Update
setRequestId(String requestId)
An optional request ID to identify requests.
Compute.Instances.Update
setUserIp(String userIp)
Deprecated.
Compute.Instances.Update
setZone(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, 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
-
Update
protected Update(String project,
String zone,
String instance,
Instance content)
Updates an instance only if the necessary resources are available. This method can update only
a specific set of instance properties. See Updating a running instance for a list of updatable
instance properties.
Create a request for the method "instances.update".
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 update.
content
- the Instance
- Since:
- 1.13
-
Method Detail
-
setAlt
public Compute.Instances.Update setAlt(String alt)
Description copied from class: ComputeRequest
Data format for the response.
- Overrides:
setAlt
in class ComputeRequest<Operation>
-
setFields
public Compute.Instances.Update 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.Update 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.Update 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.Update 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.Update 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.Instances.Update 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.Instances.Update setProject(String project)
Project ID for this request.
-
getZone
public String getZone()
The name of the zone for this request.
-
setZone
public Compute.Instances.Update setZone(String zone)
The name of the zone for this request.
-
getInstance
public String getInstance()
Name of the instance resource to update.
-
setInstance
public Compute.Instances.Update setInstance(String instance)
Name of the instance resource to update.
-
getMinimalAction
public String getMinimalAction()
Specifies the action to take when updating an instance even if the updated properties do not
require it. If not specified, then Compute Engine acts based on the minimum action that the updated
properties require.
-
setMinimalAction
public Compute.Instances.Update setMinimalAction(String minimalAction)
Specifies the action to take when updating an instance even if the updated properties do
not require it. If not specified, then Compute Engine acts based on the minimum action that
the updated properties require.
-
getMostDisruptiveAllowedAction
public String getMostDisruptiveAllowedAction()
Specifies the most disruptive action that can be taken on the instance as part of the update.
Compute Engine returns an error if the instance properties require a more disruptive action as part
of the instance update. Valid options from lowest to highest are NO_EFFECT, REFRESH, and RESTART.
-
setMostDisruptiveAllowedAction
public Compute.Instances.Update setMostDisruptiveAllowedAction(String mostDisruptiveAllowedAction)
Specifies the most disruptive action that can be taken on the instance as part of the
update. Compute Engine returns an error if the instance properties require a more
disruptive action as part of the instance update. Valid options from lowest to highest are
NO_EFFECT, REFRESH, and RESTART.
-
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.Update 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.Update set(String parameterName,
Object value)
- Overrides:
set
in class ComputeRequest<Operation>
Copyright © 2011–2020 Google. All rights reserved.
© 2015 - 2025 Weber Informatics LLC | Privacy Policy