target.apidocs.com.google.api.services.spanner.v1.Spanner.Projects.InstanceConfigs.Patch.html Maven / Gradle / Ivy
Spanner.Projects.InstanceConfigs.Patch (Cloud Spanner API v1-rev20240910-2.0.0)
com.google.api.services.spanner.v1
Class Spanner.Projects.InstanceConfigs.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.InstanceConfigs.Patch
-
- Enclosing class:
- Spanner.Projects.InstanceConfigs
public class Spanner.Projects.InstanceConfigs.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,
UpdateInstanceConfigRequest content)
Updates an instance configuration.
-
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,
UpdateInstanceConfigRequest content)
Updates an instance configuration. The returned long-running operation can be used to track the
progress of updating the instance. If the named instance configuration does not exist, returns
`NOT_FOUND`. Only user-managed configurations can be updated. Immediately after the request
returns: * The instance configuration's reconciling field is set to true. While the operation
is pending: * Cancelling the operation sets its metadata's cancel_time. The operation is
guaranteed to succeed at undoing all changes, after which point it terminates with a
`CANCELLED` status. * All other attempts to modify the instance configuration are rejected. *
Reading the instance configuration via the API continues to give the pre-request values. Upon
completion of the returned operation: * Creating instances using the instance configuration
uses the new values. * The new values of the instance configuration are readable via the API. *
The instance configuration's reconciling field becomes false. The returned long-running
operation will have a name of the format `/operations/` and can be used to track the instance
configuration modification. The metadata field type is UpdateInstanceConfigMetadata. The
response field type is InstanceConfig, if successful. Authorization requires
`spanner.instanceConfigs.update` permission on the resource name.
Create a request for the method "instanceConfigs.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 - A unique identifier for the instance configuration. Values are of the form
`projects//instanceConfigs/a-z*`. User instance configuration must start with `custom-`.content - the UpdateInstanceConfigRequest- Since:
- 1.13
-
Method Detail
-
set$Xgafv
public Spanner.Projects.InstanceConfigs.Patch set$Xgafv(String $Xgafv)
Description copied from class: SpannerRequest
V1 error format.
- Overrides:
set$Xgafv in class SpannerRequest<Operation>
-
setAccessToken
public Spanner.Projects.InstanceConfigs.Patch setAccessToken(String accessToken)
Description copied from class: SpannerRequest
OAuth access token.
- Overrides:
setAccessToken in class SpannerRequest<Operation>
-
setAlt
public Spanner.Projects.InstanceConfigs.Patch setAlt(String alt)
Description copied from class: SpannerRequest
Data format for response.
- Overrides:
setAlt in class SpannerRequest<Operation>
-
setCallback
public Spanner.Projects.InstanceConfigs.Patch setCallback(String callback)
Description copied from class: SpannerRequest
JSONP
- Overrides:
setCallback in class SpannerRequest<Operation>
-
setFields
public Spanner.Projects.InstanceConfigs.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.InstanceConfigs.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.InstanceConfigs.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.InstanceConfigs.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.InstanceConfigs.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.InstanceConfigs.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.InstanceConfigs.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()
A unique identifier for the instance configuration. Values are of the form
`projects//instanceConfigs/a-z*`. User instance configuration must start with `custom-`.
-
setName
public Spanner.Projects.InstanceConfigs.Patch setName(String name)
A unique identifier for the instance configuration. Values are of the form
`projects//instanceConfigs/a-z*`. User instance configuration must start with `custom-`.
-
set
public Spanner.Projects.InstanceConfigs.Patch set(String parameterName,
Object value)
- Overrides:
set in class SpannerRequest<Operation>
Copyright © 2011–2024 Google. All rights reserved.
© 2015 - 2025 Weber Informatics LLC | Privacy Policy