target.apidocs.com.google.api.services.spanner.v1.Spanner.Projects.Instances.Backups.Create.html Maven / Gradle / Ivy
Spanner.Projects.Instances.Backups.Create (Cloud Spanner API v1-rev20240711-2.0.0)
com.google.api.services.spanner.v1
Class Spanner.Projects.Instances.Backups.Create
- 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.Backups.Create
-
- Enclosing class:
- Spanner.Projects.Instances.Backups
public class Spanner.Projects.Instances.Backups.Create
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 Create(String parent,
Backup content)
Starts creating a new Cloud Spanner Backup.
-
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
-
Create
protected Create(String parent,
Backup content)
Starts creating a new Cloud Spanner Backup. The returned backup long-running operation will
have a name of the format `projects//instances//backups//operations/` and can be used to track
creation of the backup. The metadata field type is CreateBackupMetadata. The response field
type is Backup, if successful. Cancelling the returned operation will stop the creation and
delete the backup. There can be only one pending backup creation per database. Backup creation
of different databases can run concurrently.
Create a request for the method "backups.create".
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:
parent - Required. The name of the instance in which the backup will be created. This must be the same
instance that contains the database the backup will be created from. The backup will be
stored in the location(s) specified in the instance configuration of this instance. Values
are of the form `projects//instances/`.content - the Backup- Since:
- 1.13
-
Method Detail
-
set$Xgafv
public Spanner.Projects.Instances.Backups.Create set$Xgafv(String $Xgafv)
Description copied from class: SpannerRequest
V1 error format.
- Overrides:
set$Xgafv in class SpannerRequest<Operation>
-
setAccessToken
public Spanner.Projects.Instances.Backups.Create setAccessToken(String accessToken)
Description copied from class: SpannerRequest
OAuth access token.
- Overrides:
setAccessToken in class SpannerRequest<Operation>
-
setAlt
public Spanner.Projects.Instances.Backups.Create setAlt(String alt)
Description copied from class: SpannerRequest
Data format for response.
- Overrides:
setAlt in class SpannerRequest<Operation>
-
setCallback
public Spanner.Projects.Instances.Backups.Create setCallback(String callback)
Description copied from class: SpannerRequest
JSONP
- Overrides:
setCallback in class SpannerRequest<Operation>
-
setFields
public Spanner.Projects.Instances.Backups.Create 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.Backups.Create 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.Backups.Create 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.Backups.Create 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.Backups.Create 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.Backups.Create 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.Backups.Create setUploadProtocol(String uploadProtocol)
Description copied from class: SpannerRequest
Upload protocol for media (e.g. "raw", "multipart").
- Overrides:
setUploadProtocol in class SpannerRequest<Operation>
-
getParent
public String getParent()
Required. The name of the instance in which the backup will be created. This must be the same
instance that contains the database the backup will be created from. The backup will be stored in
the location(s) specified in the instance configuration of this instance. Values are of the form
`projects//instances/`.
-
setParent
public Spanner.Projects.Instances.Backups.Create setParent(String parent)
Required. The name of the instance in which the backup will be created. This must be
the same instance that contains the database the backup will be created from. The
backup will be stored in the location(s) specified in the instance configuration of
this instance. Values are of the form `projects//instances/`.
-
getBackupId
public String getBackupId()
Required. The id of the backup to be created. The `backup_id` appended to `parent` forms the full
backup name of the form `projects//instances//backups/`.
-
setBackupId
public Spanner.Projects.Instances.Backups.Create setBackupId(String backupId)
Required. The id of the backup to be created. The `backup_id` appended to `parent`
forms the full backup name of the form `projects//instances//backups/`.
-
getEncryptionConfigEncryptionType
public String getEncryptionConfigEncryptionType()
Required. The encryption type of the backup.
-
setEncryptionConfigEncryptionType
public Spanner.Projects.Instances.Backups.Create setEncryptionConfigEncryptionType(String encryptionConfigEncryptionType)
Required. The encryption type of the backup.
-
getEncryptionConfigKmsKeyName
public String getEncryptionConfigKmsKeyName()
Optional. The Cloud KMS key that will be used to protect the backup. This field should be set only
when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form
`projects//locations//keyRings//cryptoKeys/`.
-
setEncryptionConfigKmsKeyName
public Spanner.Projects.Instances.Backups.Create setEncryptionConfigKmsKeyName(String encryptionConfigKmsKeyName)
Optional. The Cloud KMS key that will be used to protect the backup. This field should
be set only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the
form `projects//locations//keyRings//cryptoKeys/`.
-
getEncryptionConfigKmsKeyNames
public List<String> getEncryptionConfigKmsKeyNames()
Optional. Specifies the KMS configuration for the one or more keys used to protect the backup.
Values are of the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by
kms_key_names must fully cover all regions of the backup's instance configuration. Some examples: *
For single region instance configs, specify a single regional location KMS key. * For multi-
regional instance configs of type GOOGLE_MANAGED, either specify a multi-regional location KMS key
or multiple regional location KMS keys that cover all regions in the instance config. * For an
instance config of type USER_MANAGED, please specify only regional location KMS keys to cover each
region in the instance config. Multi-regional location KMS keys are not supported for USER_MANAGED
instance configs.
-
setEncryptionConfigKmsKeyNames
public Spanner.Projects.Instances.Backups.Create setEncryptionConfigKmsKeyNames(List<String> encryptionConfigKmsKeyNames)
Optional. Specifies the KMS configuration for the one or more keys used to protect the
backup. Values are of the form `projects//locations//keyRings//cryptoKeys/`. The keys
referenced by kms_key_names must fully cover all regions of the backup's instance
configuration. Some examples: * For single region instance configs, specify a single
regional location KMS key. * For multi-regional instance configs of type
GOOGLE_MANAGED, either specify a multi-regional location KMS key or multiple regional
location KMS keys that cover all regions in the instance config. * For an instance
config of type USER_MANAGED, please specify only regional location KMS keys to cover
each region in the instance config. Multi-regional location KMS keys are not supported
for USER_MANAGED instance configs.
-
set
public Spanner.Projects.Instances.Backups.Create 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