This product is not supported for your selected Datadog site. ().
Cette page n'est pas encore disponible en français, sa traduction est en cours.
Si vous avez des questions ou des retours sur notre projet de traduction actuel, n'hésitez pas à nous contacter.

gcp_spanner_backup

ancestors

Type: UNORDERED_LIST_STRING

backup_schedules

Type: UNORDERED_LIST_STRING
Provider name: backupSchedules
Description: Output only. List of backup schedule URIs that are associated with creating this backup. This is only applicable for scheduled backups, and is empty for on-demand backups. To optimize for storage, whenever possible, multiple schedules are collapsed together to create one backup. In such cases, this field captures the list of all backup schedule URIs that are associated with creating this backup. If collapsing is not done, then this field captures the single backup schedule URI associated with creating this backup.

create_time

Type: TIMESTAMP
Provider name: createTime
Description: Output only. The time the CreateBackup request is received. If the request does not specify version_time, the version_time of the backup will be equivalent to the create_time.

database

Type: STRING
Provider name: database
Description: Required for the CreateBackup operation. Name of the database from which this backup was created. This needs to be in the same instance as the backup. Values are of the form projects//instances//databases/.

database_dialect

Type: STRING
Provider name: databaseDialect
Description: Output only. The database dialect information for the backup.
Possible values:

  • DATABASE_DIALECT_UNSPECIFIED - Default value. This value will create a database with the GOOGLE_STANDARD_SQL dialect.
  • GOOGLE_STANDARD_SQL - GoogleSQL supported SQL.
  • POSTGRESQL - PostgreSQL supported SQL.

encryption_info

Type: STRUCT
Provider name: encryptionInfo
Description: Output only. The encryption information for the backup.

  • encryption_status
    Type: STRUCT
    Provider name: encryptionStatus
    Description: Output only. If present, the status of a recent encrypt/decrypt call on underlying data for this database or backup. Regardless of status, data is always encrypted at rest.
    • code
      Type: INT32
      Provider name: code
      Description: The status code, which should be an enum value of google.rpc.Code.
    • message
      Type: STRING
      Provider name: message
      Description: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  • encryption_type
    Type: STRING
    Provider name: encryptionType
    Description: Output only. The type of encryption.
    Possible values:
    • TYPE_UNSPECIFIED - Encryption type was not specified, though data at rest remains encrypted.
    • GOOGLE_DEFAULT_ENCRYPTION - The data is encrypted at rest with a key that is fully managed by Google. No key version or status will be populated. This is the default state.
    • CUSTOMER_MANAGED_ENCRYPTION - The data is encrypted at rest with a key that is managed by the customer. The active version of the key. kms_key_version will be populated, and encryption_status may be populated.
  • kms_key_version
    Type: STRING
    Provider name: kmsKeyVersion
    Description: Output only. A Cloud KMS key version that is being used to protect the database or backup.

encryption_information

Type: UNORDERED_LIST_STRUCT
Provider name: encryptionInformation
Description: Output only. The encryption information for the backup, whether it is protected by one or more KMS keys. The information includes all Cloud KMS key versions used to encrypt the backup. The encryption_status field inside of each EncryptionInfo is not populated. At least one of the key versions must be available for the backup to be restored. If a key version is revoked in the middle of a restore, the restore behavior is undefined.

  • encryption_status
    Type: STRUCT
    Provider name: encryptionStatus
    Description: Output only. If present, the status of a recent encrypt/decrypt call on underlying data for this database or backup. Regardless of status, data is always encrypted at rest.
    • code
      Type: INT32
      Provider name: code
      Description: The status code, which should be an enum value of google.rpc.Code.
    • message
      Type: STRING
      Provider name: message
      Description: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  • encryption_type
    Type: STRING
    Provider name: encryptionType
    Description: Output only. The type of encryption.
    Possible values:
    • TYPE_UNSPECIFIED - Encryption type was not specified, though data at rest remains encrypted.
    • GOOGLE_DEFAULT_ENCRYPTION - The data is encrypted at rest with a key that is fully managed by Google. No key version or status will be populated. This is the default state.
    • CUSTOMER_MANAGED_ENCRYPTION - The data is encrypted at rest with a key that is managed by the customer. The active version of the key. kms_key_version will be populated, and encryption_status may be populated.
  • kms_key_version
    Type: STRING
    Provider name: kmsKeyVersion
    Description: Output only. A Cloud KMS key version that is being used to protect the database or backup.

exclusive_size_bytes

Type: INT64
Provider name: exclusiveSizeBytes
Description: Output only. For a backup in an incremental backup chain, this is the storage space needed to keep the data that has changed since the previous backup. For all other backups, this is always the size of the backup. This value may change if backups on the same chain get deleted or expired. This field can be used to calculate the total storage space used by a set of backups. For example, the total space used by all backups of a database can be computed by summing up this field.

expire_time

Type: TIMESTAMP
Provider name: expireTime
Description: Required for the CreateBackup operation. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 366 days from the time the CreateBackup request is processed. Once the expire_time has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup.

freeable_size_bytes

Type: INT64
Provider name: freeableSizeBytes
Description: Output only. The number of bytes that will be freed by deleting this backup. This value will be zero if, for example, this backup is part of an incremental backup chain and younger backups in the chain require that we keep its data. For backups not in an incremental backup chain, this is always the size of the backup. This value may change if backups on the same chain get created, deleted or expired.

incremental_backup_chain_id

Type: STRING
Provider name: incrementalBackupChainId
Description: Output only. Populated only for backups in an incremental backup chain. Backups share the same chain id if and only if they belong to the same incremental backup chain. Use this field to determine which backups are part of the same incremental backup chain. The ordering of backups in the chain can be determined by ordering the backup version_time.

instance_partitions

Type: UNORDERED_LIST_STRUCT
Provider name: instancePartitions
Description: Output only. The instance partition(s) storing the backup. This is the same as the list of the instance partition(s) that the database had footprint in at the backup’s version_time.

  • instance_partition
    Type: STRING
    Provider name: instancePartition
    Description: A unique identifier for the instance partition. Values are of the form projects//instances//instancePartitions/

labels

Type: UNORDERED_LIST_STRING

max_expire_time

Type: TIMESTAMP
Provider name: maxExpireTime
Description: Output only. The max allowed expiration time of the backup, with microseconds granularity. A backup’s expiration time can be configured in multiple APIs: CreateBackup, UpdateBackup, CopyBackup. When updating or copying an existing backup, the expiration time specified must be less than Backup.max_expire_time.

name

Type: STRING
Provider name: name
Description: Output only for the CreateBackup operation. Required for the UpdateBackup operation. A globally unique identifier for the backup which cannot be changed. Values are of the form projects//instances//backups/a-z*[a-z0-9] The final segment of the name must be between 2 and 60 characters in length. The backup is stored in the location(s) specified in the instance configuration of the instance containing the backup, identified by the prefix of the backup name of the form projects//instances/.

oldest_version_time

Type: TIMESTAMP
Provider name: oldestVersionTime
Description: Output only. Data deleted at a time older than this is guaranteed not to be retained in order to support this backup. For a backup in an incremental backup chain, this is the version time of the oldest backup that exists or ever existed in the chain. For all other backups, this is the version time of the backup. This field can be used to understand what data is being retained by the backup system.

organization_id

Type: STRING

parent

Type: STRING

project_id

Type: STRING

project_number

Type: STRING

referencing_backups

Type: UNORDERED_LIST_STRING
Provider name: referencingBackups
Description: Output only. The names of the destination backups being created by copying this source backup. The backup names are of the form projects//instances//backups/. Referencing backups may exist in different instances. The existence of any referencing backup prevents the backup from being deleted. When the copy operation is done (either successfully completed or cancelled or the destination backup is deleted), the reference to the backup is removed.

referencing_databases

Type: UNORDERED_LIST_STRING
Provider name: referencingDatabases
Description: Output only. The names of the restored databases that reference the backup. The database names are of the form projects//instances//databases/. Referencing databases may exist in different instances. The existence of any referencing database prevents the backup from being deleted. When a restored database from the backup enters the READY state, the reference to the backup is removed.

resource_name

Type: STRING

size_bytes

Type: INT64
Provider name: sizeBytes
Description: Output only. Size of the backup in bytes. For a backup in an incremental backup chain, this is the sum of the exclusive_size_bytes of itself and all older backups in the chain.

state

Type: STRING
Provider name: state
Description: Output only. The current state of the backup.
Possible values:

  • STATE_UNSPECIFIED - Not specified.
  • CREATING - The pending backup is still being created. Operations on the backup may fail with FAILED_PRECONDITION in this state.
  • READY - The backup is complete and ready for use.

tags

Type: UNORDERED_LIST_STRING

version_time

Type: TIMESTAMP
Provider name: versionTime
Description: The backup will contain an externally consistent copy of the database at the timestamp specified by version_time. If version_time is not specified, the system will set version_time to the create_time of the backup.