types
Alert
alertId : string
output only field.
alertTemplateId : string
template of the alert.
name : string
name of the alert.
description : string
human readable description of the alert.
notificationChannels : NotificationChannel
the notification channels of the alert.
alertParameters : AlertParameter
alert parameters to override.
alertThresholds : AlertParameter
alert paratemers to override.
AlertParameter
DoubleParameterValue
name : string
Required. Parameter name
value : double
Required. Parameter value
IntegerParameterValue
name : string
Required. Parameter name
value : int64
Required. Parameter value
TextParameterValue
name : string
Required. Parameter name
value : string
Required. Parameter value
TextListParameterValue
name : string
Required. Parameter name
values : string
Required. Parameter value
LabelListParameterValue
name : string
Required. Parameter name
values : string
Required. Parameter value
One of parameter
doubleParameterValue: DoubleParameterValue
integerParameterValue: IntegerParameterValue
textParameterValue: TextParameterValue
textListParameterValue: TextListParameterValue
labelListParameterValue: LabelListParameterValue
Backup
Status
id of backup
STATUS_UNSPECIFIEDid of backup
CREATINGid of backup
READYid of backup
ERRORid of backup
CANCELLEDid of backup
Type
TYPE_UNSPECIFIEDSYSTEMindicates that backup started by the system.
USER
id : string
name : string
human readable backup name.
folderId : string
databaseId : string
description : string
description of backup.
createdAt : google.protobuf.Timestamp
startedAt : google.protobuf.Timestamp
indicates when backup started.
completedAt : google.protobuf.Timestamp
indicates when backup completed.
status : Status
backupSettings : BackupSettings
settings used to make backup.
type : Type
size : int64
size of backup in bytes.
BackupConfig
backupSettings : BackupSettings
BackupSchedule
One of policy
dailyBackupSchedule: DailyBackupSchedule
weeklyBackupSchedule: WeeklyBackupSchedule
recurringBackupSchedule: RecurringBackupSchedule
nextExecuteTime : google.protobuf.Timestamp
output only field: when next backup will be executed using provided schedule.
BackupSettings
Type
TYPE_UNSPECIFIEDSYSTEMUSER
StorageClass
STORAGE_CLASS_UNSPECIFIEDSTANDARDREDUCED_REDUNDANCYSTANDARD_IAONEZONE_IAINTELLIGENT_TIERINGGLACIERDEEP_ARCHIVEOUTPOSTS
name : string
name of backup settings
description : string
human readable description.
backupSchedule : BackupSchedule
provide schedule. if empty, backup will be disabled.
backupTimeToLive : google.protobuf.Duration
provide time to live of backup.
sourcePaths : string
provide a list of source paths. Each path can be directory, table or even database itself. Each directory (or database) will be traversed recursively and all childs of directory will be included to backup. By default, backup will be created for full database.
sourcePathsToExclude : string
provide a list of paths to exclude from backup. Each path is a directory, table, or database. Each directory (or database) will be traversed recursively and all childs of directory will be excluded.
type : Type
storageClass : StorageClass
DailyBackupSchedule
executeTime : google.type.TimeOfDay
Database
YDB database.
Status
STATUS_UNSPECIFIEDPROVISIONINGRUNNINGUPDATINGERRORDELETINGSTARTINGSTOPPED
id : string
folderId : string
createdAt : google.protobuf.Timestamp
name : string
description : string
status : Status
endpoint : string
resourcePresetId : string
storageConfig : StorageConfig
scalePolicy : ScalePolicy
networkId : string
subnetIds : string
One of databaseType
zonalDatabase: ZonalDatabasedeprecated field
regionalDatabase: RegionalDatabasedeprecated field
dedicatedDatabase: DedicatedDatabase
serverlessDatabase: ServerlessDatabase
assignPublicIps : bool
locationId : string
labels : string
backupConfig : BackupConfig
documentApiEndpoint : string
kinesisApiEndpoint : string
kafkaApiEndpoint : string
monitoringConfig : MonitoringConfig
deletionProtection : bool
DaysOfWeekBackupSchedule
days : google.type.DayOfWeek
executeTime : google.type.TimeOfDay
DedicatedDatabase
resourcePresetId : string
storageConfig : StorageConfig
scalePolicy : ScalePolicy
networkId : string
subnetIds : string
assignPublicIps : bool
Location
id : string
description : string
MonitoringConfig
alerts : Alert
NotificationChannel
notificationChannelId : string
notifyAboutStatuses : AlertEvaluationStatus
repeateNotifyDelayMs : int64
RecurringBackupSchedule
startTime : google.protobuf.Timestamp
Timestamp of the first recurrence.
recurrence : string
An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how this backup reccurs. The FREQ values of MINUTELY, and SECONDLY are not supported.
RegionalDatabase
regionId : string
ResourcePreset
id : string
cores : int64
memory : int64
ScalePolicy
FixedScale
size : int64
One of scaleType
fixedScale: FixedScale
ServerlessDatabase
throttlingRcuLimit : int64
Let's define 1 RU - 1 request unit
Let's define 1 RCU - 1 request capacity unit, which is 1 RU per second.
If enable_throttling_rcu_limit flag is true, the database will be throttled using throttling_rcu_limit value.
Otherwise, the database is throttled using the cloud quotas.
If zero, all requests will be blocked until non zero value is set.
storageSizeLimit : int64
Specify serverless database storage size limit. If zero, default value is applied.
enableThrottlingRcuLimit : bool
If false, the database is throttled by cloud value.
provisionedRcuLimit : int64
Specify the number of provisioned RCUs to pay less if the database has predictable load. You will be charged for the provisioned capacity regularly even if this capacity is not fully consumed. You will be charged for the on-demand consumption only if provisioned capacity is consumed.
topicWriteQuota : int64
write quota for topic service, defined in bytes per second.
StorageConfig
storageOptions : StorageOption
storageSizeLimit : int64
output only field: storage size limit of dedicated database.