target.apidocs.com.google.api.services.spanner.v1.Spanner.Projects.Instances.Patch.html Maven / Gradle / Ivy
Spanner.Projects.Instances.Patch (Cloud Spanner API v1-rev20240711-2.0.0)
com.google.api.services.spanner.v1
Class Spanner.Projects.Instances.Patch
- 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.spanner.v1.SpannerRequest<Operation>
-
- com.google.api.services.spanner.v1.Spanner.Projects.Instances.Patch
-
- Enclosing class:
- Spanner.Projects.Instances
public class Spanner.Projects.Instances.Patch
extends SpannerRequest<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
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
-
Constructor Summary
Constructors
Modifier
Constructor and Description
protected Patch(String name,
UpdateInstanceRequest content)
Updates an instance, and begins allocating or releasing resources as requested.
-
Method Summary
-
Methods inherited from class com.google.api.services.spanner.v1.SpannerRequest
get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, 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
-
Patch
protected Patch(String name,
UpdateInstanceRequest content)
Updates an instance, and begins allocating or releasing resources as requested. The returned
long-running operation can be used to track the progress of updating the instance. If the named
instance does not exist, returns `NOT_FOUND`. Immediately upon completion of this request: *
For resource types for which a decrease in the instance's allocation has been requested,
billing is based on the newly-requested level. Until completion of the returned operation: *
Cancelling the operation sets its metadata's cancel_time, and begins restoring resources to
their pre-request values. The operation is guaranteed to succeed at undoing all resource
changes, after which point it terminates with a `CANCELLED` status. * All other attempts to
modify the instance are rejected. * Reading the instance via the API continues to give the pre-
request resource levels. Upon completion of the returned operation: * Billing begins for all
successfully-allocated resources (some types may have lower than the requested levels). * All
newly-reserved resources are available for serving the instance's tables. * The instance's new
resource levels are readable via the API. The returned long-running operation will have a name
of the format `/operations/` and can be used to track the instance modification. The metadata
field type is UpdateInstanceMetadata. The response field type is Instance, if successful.
Authorization requires `spanner.instances.update` permission on the resource name.
Create a request for the method "instances.patch".
This request holds the parameters needed by the the spanner server. After setting any optional
parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation. Spanner.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must
be called to initialize this instance immediately after invoking the constructor.
- Parameters:
name - Required. A unique identifier for the instance, which cannot be changed after the instance is
created. Values are of the form `projects//instances/a-z*[a-z0-9]`. The final segment of
the name must be between 2 and 64 characters in length.content - the UpdateInstanceRequest- Since:
- 1.13
-
Method Detail
-
set$Xgafv
public Spanner.Projects.Instances.Patch set$Xgafv(String $Xgafv)
Description copied from class: SpannerRequest
V1 error format.
- Overrides:
set$Xgafv in class SpannerRequest<Operation>
-
setAccessToken
public Spanner.Projects.Instances.Patch setAccessToken(String accessToken)
Description copied from class: SpannerRequest
OAuth access token.
- Overrides:
setAccessToken in class SpannerRequest<Operation>
-
setAlt
public Spanner.Projects.Instances.Patch setAlt(String alt)
Description copied from class: SpannerRequest
Data format for response.
- Overrides:
setAlt in class SpannerRequest<Operation>
-
setCallback
public Spanner.Projects.Instances.Patch setCallback(String callback)
Description copied from class: SpannerRequest
JSONP
- Overrides:
setCallback in class SpannerRequest<Operation>
-
setFields
public Spanner.Projects.Instances.Patch setFields(String fields)
Description copied from class: SpannerRequest
Selector specifying which fields to include in a partial response.
- Overrides:
setFields in class SpannerRequest<Operation>
-
setKey
public Spanner.Projects.Instances.Patch setKey(String key)
Description copied from class: SpannerRequest
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 SpannerRequest<Operation>
-
setOauthToken
public Spanner.Projects.Instances.Patch setOauthToken(String oauthToken)
Description copied from class: SpannerRequest
OAuth 2.0 token for the current user.
- Overrides:
setOauthToken in class SpannerRequest<Operation>
-
setPrettyPrint
public Spanner.Projects.Instances.Patch setPrettyPrint(Boolean prettyPrint)
Description copied from class: SpannerRequest
Returns response with indentations and line breaks.
- Overrides:
setPrettyPrint in class SpannerRequest<Operation>
-
setQuotaUser
public Spanner.Projects.Instances.Patch setQuotaUser(String quotaUser)
Description copied from class: SpannerRequest
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 SpannerRequest<Operation>
-
setUploadType
public Spanner.Projects.Instances.Patch setUploadType(String uploadType)
Description copied from class: SpannerRequest
Legacy upload protocol for media (e.g. "media", "multipart").
- Overrides:
setUploadType in class SpannerRequest<Operation>
-
setUploadProtocol
public Spanner.Projects.Instances.Patch setUploadProtocol(String uploadProtocol)
Description copied from class: SpannerRequest
Upload protocol for media (e.g. "raw", "multipart").
- Overrides:
setUploadProtocol in class SpannerRequest<Operation>
-
getName
public String getName()
Required. A unique identifier for the instance, which cannot be changed after the instance is
created. Values are of the form `projects//instances/a-z*[a-z0-9]`. The final segment of the name
must be between 2 and 64 characters in length.
-
setName
public Spanner.Projects.Instances.Patch setName(String name)
Required. A unique identifier for the instance, which cannot be changed after the
instance is created. Values are of the form `projects//instances/a-z*[a-z0-9]`. The final
segment of the name must be between 2 and 64 characters in length.
-
set
public Spanner.Projects.Instances.Patch set(String parameterName,
Object value)
- Overrides:
set in class SpannerRequest<Operation>
Copyright © 2011–2024 Google. All rights reserved.
© 2015 - 2024 Weber Informatics LLC | Privacy Policy