Backup (Cloud SQL Admin API v1beta4-rev20250613-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.sqladmin.model.Backup

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class Backup
extends com.google.api.client.json.GenericJson
```
A backup resource. Next ID: 30
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud SQL Admin API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

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>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

Backup()

Constructors
Constructor and Description
`Backup()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Backup`	`clone()`
`Interval`	`getBackupInterval()` Output only.
`String`	`getBackupKind()` Output only.
`String`	`getBackupRun()` Output only.
`String`	`getDatabaseVersion()` Output only.
`String`	`getDescription()` The description of this backup.
`OperationError`	`getError()` Output only.
`String`	`getExpiryTime()` Backup expiration time.
`String`	`getInstance()` The name of the database instance.
`String`	`getInstanceDeletionTime()` Optional.
`DatabaseInstance`	`getInstanceSettings()` Optional.
`String`	`getKind()` Output only.
`String`	`getKmsKey()` Output only.
`String`	`getKmsKeyVersion()` Output only.
`String`	`getLocation()` The storage location of the backups.
`Long`	`getMaxChargeableBytes()` Output only.
`String`	`getName()` Output only.
`Boolean`	`getSatisfiesPzi()` Output only.
`Boolean`	`getSatisfiesPzs()` Output only.
`String`	`getSelfLink()` Output only.
`String`	`getState()` Output only.
`String`	`getTimeZone()` Output only.
`Long`	`getTtlDays()` Input only.
`String`	`getType()` Output only.
`Backup`	`set(String fieldName, Object value)`
`Backup`	`setBackupInterval(Interval backupInterval)` Output only.
`Backup`	`setBackupKind(String backupKind)` Output only.
`Backup`	`setBackupRun(String backupRun)` Output only.
`Backup`	`setDatabaseVersion(String databaseVersion)` Output only.
`Backup`	`setDescription(String description)` The description of this backup.
`Backup`	`setError(OperationError error)` Output only.
`Backup`	`setExpiryTime(String expiryTime)` Backup expiration time.
`Backup`	`setInstance(String instance)` The name of the database instance.
`Backup`	`setInstanceDeletionTime(String instanceDeletionTime)` Optional.
`Backup`	`setInstanceSettings(DatabaseInstance instanceSettings)` Optional.
`Backup`	`setKind(String kind)` Output only.
`Backup`	`setKmsKey(String kmsKey)` Output only.
`Backup`	`setKmsKeyVersion(String kmsKeyVersion)` Output only.
`Backup`	`setLocation(String location)` The storage location of the backups.
`Backup`	`setMaxChargeableBytes(Long maxChargeableBytes)` Output only.
`Backup`	`setName(String name)` Output only.
`Backup`	`setSatisfiesPzi(Boolean satisfiesPzi)` Output only.
`Backup`	`setSatisfiesPzs(Boolean satisfiesPzs)` Output only.
`Backup`	`setSelfLink(String selfLink)` Output only.
`Backup`	`setState(String state)` Output only.
`Backup`	`setTimeZone(String timeZone)` Output only.
`Backup`	`setTtlDays(Long ttlDays)` Input only.
`Backup`	`setType(String type)` Output only.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

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
  - Backup
```
public Backup()
```
- Method Detail
  - getBackupInterval
```
public Interval getBackupInterval()
```
    Output only. This output contains the following values: start_time: All database writes up to this time are available. end_time: Any database writes after this time aren't available.
    
    Returns:
    
    value or null for none
  - setBackupInterval
```
public Backup setBackupInterval(Interval backupInterval)
```
    Output only. This output contains the following values: start_time: All database writes up to this time are available. end_time: Any database writes after this time aren't available.
    
    Parameters:
    
    backupInterval - backupInterval or null for none
  - getBackupKind
```
public String getBackupKind()
```
    Output only. Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.
    
    Returns:
    
    value or null for none
  - setBackupKind
```
public Backup setBackupKind(String backupKind)
```
    Output only. Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.
    
    Parameters:
    
    backupKind - backupKind or null for none
  - getBackupRun
```
public String getBackupRun()
```
    Output only. The mapping to backup run resource used for IAM validations.
    
    Returns:
    
    value or null for none
  - setBackupRun
```
public Backup setBackupRun(String backupRun)
```
    Output only. The mapping to backup run resource used for IAM validations.
    
    Parameters:
    
    backupRun - backupRun or null for none
  - getDatabaseVersion
```
public String getDatabaseVersion()
```
    Output only. The database version of the instance of at the time this backup was made.
    
    Returns:
    
    value or null for none
  - setDatabaseVersion
```
public Backup setDatabaseVersion(String databaseVersion)
```
    Output only. The database version of the instance of at the time this backup was made.
    
    Parameters:
    
    databaseVersion - databaseVersion or null for none
  - getDescription
```
public String getDescription()
```
    The description of this backup.
    
    Returns:
    
    value or null for none
  - setDescription
```
public Backup setDescription(String description)
```
    The description of this backup.
    
    Parameters:
    
    description - description or null for none
  - getError
```
public OperationError getError()
```
    Output only. Information about why the backup operation fails (for example, when the backup state fails).
    
    Returns:
    
    value or null for none
  - setError
```
public Backup setError(OperationError error)
```
    Output only. Information about why the backup operation fails (for example, when the backup state fails).
    
    Parameters:
    
    error - error or null for none
  - getExpiryTime
```
public String getExpiryTime()
```
    Backup expiration time. A UTC timestamp of when this resource expired.
    
    Returns:
    
    value or null for none
  - setExpiryTime
```
public Backup setExpiryTime(String expiryTime)
```
    Backup expiration time. A UTC timestamp of when this resource expired.
    
    Parameters:
    
    expiryTime - expiryTime or null for none
  - getInstance
```
public String getInstance()
```
    The name of the database instance.
    
    Returns:
    
    value or null for none
  - setInstance
```
public Backup setInstance(String instance)
```
    The name of the database instance.
    
    Parameters:
    
    instance - instance or null for none
  - getInstanceDeletionTime
```
public String getInstanceDeletionTime()
```
    Optional. Output only. Timestamp in UTC of when the instance associated with this backup is deleted.
    
    Returns:
    
    value or null for none
  - setInstanceDeletionTime
```
public Backup setInstanceDeletionTime(String instanceDeletionTime)
```
    Optional. Output only. Timestamp in UTC of when the instance associated with this backup is deleted.
    
    Parameters:
    
    instanceDeletionTime - instanceDeletionTime or null for none
  - getInstanceSettings
```
public DatabaseInstance getInstanceSettings()
```
    Optional. Output only. Instance setting of the source instance that's associated with this backup.
    
    Returns:
    
    value or null for none
  - setInstanceSettings
```
public Backup setInstanceSettings(DatabaseInstance instanceSettings)
```
    Optional. Output only. Instance setting of the source instance that's associated with this backup.
    
    Parameters:
    
    instanceSettings - instanceSettings or null for none
  - getKind
```
public String getKind()
```
    Output only. This is always `sql#backup`.
    
    Returns:
    
    value or null for none
  - setKind
```
public Backup setKind(String kind)
```
    Output only. This is always `sql#backup`.
    
    Parameters:
    
    kind - kind or null for none
  - getKmsKey
```
public String getKmsKey()
```
    Output only. This output contains the encryption configuration for a backup and the resource name of the KMS key for disk encryption.
    
    Returns:
    
    value or null for none
  - setKmsKey
```
public Backup setKmsKey(String kmsKey)
```
    Output only. This output contains the encryption configuration for a backup and the resource name of the KMS key for disk encryption.
    
    Parameters:
    
    kmsKey - kmsKey or null for none
  - getKmsKeyVersion
```
public String getKmsKeyVersion()
```
    Output only. This output contains the encryption status for a backup and the version of the KMS key that's used to encrypt the Cloud SQL instance.
    
    Returns:
    
    value or null for none
  - setKmsKeyVersion
```
public Backup setKmsKeyVersion(String kmsKeyVersion)
```
    Output only. This output contains the encryption status for a backup and the version of the KMS key that's used to encrypt the Cloud SQL instance.
    
    Parameters:
    
    kmsKeyVersion - kmsKeyVersion or null for none
  - getLocation
```
public String getLocation()
```
    The storage location of the backups. The location can be multi-regional.
    
    Returns:
    
    value or null for none
  - setLocation
```
public Backup setLocation(String location)
```
    The storage location of the backups. The location can be multi-regional.
    
    Parameters:
    
    location - location or null for none
  - getMaxChargeableBytes
```
public Long getMaxChargeableBytes()
```
    Output only. The maximum chargeable bytes for the backup.
    
    Returns:
    
    value or null for none
  - setMaxChargeableBytes
```
public Backup setMaxChargeableBytes(Long maxChargeableBytes)
```
    Output only. The maximum chargeable bytes for the backup.
    
    Parameters:
    
    maxChargeableBytes - maxChargeableBytes or null for none
  - getName
```
public String getName()
```
    Output only. The resource name of the backup. Format: projects/{project}/backups/{backup}.
    
    Returns:
    
    value or null for none
  - setName
```
public Backup setName(String name)
```
    Output only. The resource name of the backup. Format: projects/{project}/backups/{backup}.
    
    Parameters:
    
    name - name or null for none
  - getSatisfiesPzi
```
public Boolean getSatisfiesPzi()
```
    Output only. This status indicates whether the backup satisfies PZI. The status is reserved for future use.
    
    Returns:
    
    value or null for none
  - setSatisfiesPzi
```
public Backup setSatisfiesPzi(Boolean satisfiesPzi)
```
    Output only. This status indicates whether the backup satisfies PZI. The status is reserved for future use.
    
    Parameters:
    
    satisfiesPzi - satisfiesPzi or null for none
  - getSatisfiesPzs
```
public Boolean getSatisfiesPzs()
```
    Output only. This status indicates whether the backup satisfies PZS. The status is reserved for future use.
    
    Returns:
    
    value or null for none
  - setSatisfiesPzs
```
public Backup setSatisfiesPzs(Boolean satisfiesPzs)
```
    Output only. This status indicates whether the backup satisfies PZS. The status is reserved for future use.
    
    Parameters:
    
    satisfiesPzs - satisfiesPzs or null for none
  - getSelfLink
```
public String getSelfLink()
```
    Output only. The URI of this resource.
    
    Returns:
    
    value or null for none
  - setSelfLink
```
public Backup setSelfLink(String selfLink)
```
    Output only. The URI of this resource.
    
    Parameters:
    
    selfLink - selfLink or null for none
  - getState
```
public String getState()
```
    Output only. The state of this backup.
    
    Returns:
    
    value or null for none
  - setState
```
public Backup setState(String state)
```
    Output only. The state of this backup.
    
    Parameters:
    
    state - state or null for none
  - getTimeZone
```
public String getTimeZone()
```
    Output only. This output contains a backup time zone. If a Cloud SQL for SQL Server instance has a different time zone from the backup's time zone, then the restore to the instance doesn't happen.
    
    Returns:
    
    value or null for none
  - setTimeZone
```
public Backup setTimeZone(String timeZone)
```
    Output only. This output contains a backup time zone. If a Cloud SQL for SQL Server instance has a different time zone from the backup's time zone, then the restore to the instance doesn't happen.
    
    Parameters:
    
    timeZone - timeZone or null for none
  - getTtlDays
```
public Long getTtlDays()
```
    Input only. The time-to-live (TTL) interval for this resource (in days). For example: ttlDays:7, means 7 days from the current time. The expiration time can't exceed 365 days from the time that the backup is created.
    
    Returns:
    
    value or null for none
  - setTtlDays
```
public Backup setTtlDays(Long ttlDays)
```
    Input only. The time-to-live (TTL) interval for this resource (in days). For example: ttlDays:7, means 7 days from the current time. The expiration time can't exceed 365 days from the time that the backup is created.
    
    Parameters:
    
    ttlDays - ttlDays or null for none
  - getType
```
public String getType()
```
    Output only. The type of this backup. The type can be "AUTOMATED", "ON_DEMAND", or “FINAL”.
    
    Returns:
    
    value or null for none
  - setType
```
public Backup setType(String type)
```
    Output only. The type of this backup. The type can be "AUTOMATED", "ON_DEMAND", or “FINAL”.
    
    Parameters:
    
    type - type or null for none
  - set
```
public Backup set(String fieldName,
                  Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public Backup clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class Backup

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Backup

Method Detail

getBackupInterval

setBackupInterval

getBackupKind

setBackupKind

getBackupRun

setBackupRun

getDatabaseVersion

setDatabaseVersion

getDescription

setDescription

getError

setError

getExpiryTime

setExpiryTime

getInstance

setInstance

getInstanceDeletionTime

setInstanceDeletionTime

getInstanceSettings

setInstanceSettings

getKind

setKind

getKmsKey

setKmsKey

getKmsKeyVersion

setKmsKeyVersion

getLocation

setLocation

getMaxChargeableBytes

setMaxChargeableBytes

getName

setName

getSatisfiesPzi

setSatisfiesPzi

getSatisfiesPzs

setSatisfiesPzs

getSelfLink

setSelfLink

getState

setState

getTimeZone

setTimeZone

getTtlDays

setTtlDays

getType

setType

set

clone