package google.events.cloud.alloydb.v1

Get desktop application:
View/edit binary Protocol Buffers messages

Message describing the user-specified automated backup policy. All fields in the automated backup policy are optional. Defaults for each field are provided if they are not set.

Used in: Cluster

• oneof schedule

  The schedule for this automated backup policy. A schedule specifies times at which to start a backup. If a backup window is also provided, the backup is guaranteed to be started and completed within the start time plus the backup window. If the backup is not completed within the backup window it is marked as failed. If not set, the schedule defaults to a weekly schedule with one backup per day and a start time chosen arbitrarily.

  • AutomatedBackupPolicy.WeeklySchedule weekly_schedule = 2

    Weekly schedule for the Backup.

• oneof retention

  The retention policy for automated backups. The retention policy for a backup is fixed at the time the backup is created. Changes to this field only apply to new backups taken with the policy; the retentions of existing backups remain unchanged. If no retention policy is set, a default of 14 days is used.

  • AutomatedBackupPolicy.TimeBasedRetention time_based_retention = 4

    Time-based Backup retention policy.

  • AutomatedBackupPolicy.QuantityBasedRetention quantity_based_retention = 5

    Quantity-based Backup retention policy to retain recent backups.

• optional bool enabled = 1

  Whether automated automated backups are enabled. If not set, defaults to true.

• optional protobuf.Duration backup_window = 3

  The length of the time window during which a backup can be taken. If a backup does not succeed within this time window, it will be canceled and considered failed. The backup window must be at least 5 minutes long. There is no upper bound on the window. If not set, it defaults to 1 hour.

• optional EncryptionConfig encryption_config = 8

  Optional. The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.

• string location = 6

  The location where the backup will be stored. Currently, the only supported option is to store the backup in the same region as the cluster. If empty, defaults to the region of the cluster.

• map<string, string> labels = 7

  Labels to apply to backups created using this configuration.

A quantity based policy specifies that a certain number of the most recent successful backups should be retained.

Used in: AutomatedBackupPolicy

• int32 count = 1

  The number of backups to retain.

A time based retention policy specifies that all backups within a certain time period should be retained.

Used in: AutomatedBackupPolicy

• optional protobuf.Duration retention_period = 1

  The retention period.

A weekly schedule starts a backup at prescribed start times within a day, for the specified days of the week. The weekly schedule message is flexible and can be used to create many types of schedules. For example, to have a daily backup that starts at 22:00, configure the `start_times` field to have one element "22:00" and the `days_of_week` field to have all seven days of the week.

Used in: AutomatedBackupPolicy

• repeated type.TimeOfDay start_times = 1

  The times during the day to start a backup. The start times are assumed to be in UTC and to be an exact hour (e.g., 04:00:00). If no start times are provided, a single fixed start time is chosen arbitrarily.

• repeated type.DayOfWeek days_of_week = 2

  The days of the week to perform a backup. If this field is left empty, the default of every day of the week is used.

Message describing Backup object

Used in: BackupEventData

• string name = 1

  Output only. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id} where the cluster and backup ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the backup resource name is the name of the parent resource: * projects/{project}/locations/{region}

• string display_name = 2

  User-settable and human-readable display name for the Backup.

• string uid = 3

  Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.

• optional protobuf.Timestamp create_time = 4

  Output only. Create time stamp

• optional protobuf.Timestamp update_time = 5

  Output only. Update time stamp

• optional protobuf.Timestamp delete_time = 15

  Output only. Delete time stamp

• map<string, string> labels = 6

  Labels as key value pairs

• Backup.State state = 7

  Output only. The current state of the backup.

• Backup.Type type = 8

  The backup type, which suggests the trigger for the backup.

• string description = 9

  User-provided description of the backup.

• string cluster_uid = 18

  Output only. The system-generated UID of the cluster which was used to create this resource.

• string cluster_name = 10

  Required. The full resource name of the backup source cluster (e.g., projects/{project}/locations/{region}/clusters/{cluster_id}).

• bool reconciling = 11

  Output only. Reconciling (https://google.aip.dev/128#reconciliation), if true, indicates that the service is actively updating the resource. This can happen due to user-triggered updates or system actions like failover or maintenance.

• optional EncryptionConfig encryption_config = 12

  Optional. The encryption config can be specified to encrypt the backup with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.

• optional EncryptionInfo encryption_info = 13

  Output only. The encryption information for the backup.

• string etag = 14

  For Resource freshness validation (https://google.aip.dev/154)

• map<string, string> annotations = 16

  Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128

• int64 size_bytes = 17

  Output only. The size of the backup in bytes.

• optional protobuf.Timestamp expiry_time = 19

  Output only. The time at which after the backup is eligible to be garbage collected. It is the duration specified by the backup's retention policy, added to the backup's create_time.

Backup State

Used in: Backup

• STATE_UNSPECIFIED = 0

  The state of the backup is unknown.

• READY = 1

  The backup is ready.

• CREATING = 2

  The backup is creating.

• FAILED = 3

  The backup failed.

• DELETING = 4

  The backup is being deleted.

Backup Type

Used in: Backup

• TYPE_UNSPECIFIED = 0

  Backup Type is unknown.

• ON_DEMAND = 1

  ON_DEMAND backups that were triggered by the customer (e.g., not AUTOMATED).

• AUTOMATED = 2

  AUTOMATED backups triggered by the automated backups scheduler pursuant to an automated backup policy.

• CONTINUOUS = 3

  CONTINUOUS backups triggered by the automated backups scheduler due to a continuous backup policy.

The CloudEvent raised when a Backup is created.

• optional BackupEventData data = 1

  The data associated with the event.

The CloudEvent raised when a Backup is deleted.

• optional BackupEventData data = 1

  The data associated with the event.

The data within all Backup events.

Used in: BackupCreatedEvent, BackupDeletedEvent, BackupUpdatedEvent

• optional Backup payload = 1

  Optional. The Backup event payload. Unset for deletion events.

Message describing a BackupSource.

Used in: Cluster

• string backup_uid = 2

  Output only. The system-generated UID of the backup which was used to create this resource. The UID is generated when the backup is created, and it is retained until the backup is deleted.

• string backup_name = 1

  Required. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id}

The CloudEvent raised when a Backup is updated.

• optional BackupEventData data = 1

  The data associated with the event.

A cluster is a collection of regional AlloyDB resources. It can include a primary instance and one or more read pool instances. All cluster resources share a storage layer, which scales as needed.

Used in: ClusterEventData

• oneof source

  In case of an imported cluster, this field contains information about the source this cluster was imported from.

  • BackupSource backup_source = 15

    Output only. Cluster created from backup.

  • MigrationSource migration_source = 16

    Output only. Cluster created via DMS migration.

• string name = 1

  Output only. The name of the cluster resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} where the cluster ID segment should satisfy the regex expression `[a-z0-9-]+`. For more details see https://google.aip.dev/122. The prefix of the cluster resource name is the name of the parent resource: * projects/{project}/locations/{region}

• string display_name = 2

  User-settable and human-readable display name for the Cluster.

• string uid = 3

  Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.

• optional protobuf.Timestamp create_time = 4

  Output only. Create time stamp

• optional protobuf.Timestamp update_time = 5

  Output only. Update time stamp

• optional protobuf.Timestamp delete_time = 6

  Output only. Delete time stamp

• map<string, string> labels = 7

  Labels as key value pairs

• Cluster.State state = 8

  Output only. The current serving state of the cluster.

• Cluster.ClusterType cluster_type = 24

  Output only. The type of the cluster. This is an output-only field and it's populated at the Cluster creation time or the Cluster promotion time. The cluster type is determined by which RPC was used to create the cluster (i.e. `CreateCluster` vs. `CreateSecondaryCluster`

• DatabaseVersion database_version = 9

  Output only. The database engine major version. This is an output-only field and it's populated at the Cluster creation time. This field cannot be changed after cluster creation.

• string network = 10

  Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: "projects/{project_number}/global/networks/{network_id}". This is required to create a cluster. It can be updated, but it cannot be removed.

• string etag = 11

  For Resource freshness validation (https://google.aip.dev/154)

• map<string, string> annotations = 12

  Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128

• bool reconciling = 13

  Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Cluster does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.

• optional AutomatedBackupPolicy automated_backup_policy = 17

  The automated backup policy for this cluster. If no policy is provided then the default policy will be used. If backups are supported for the cluster, the default policy takes one backup a day, has a backup window of 1 hour, and retains backups for 14 days. For more information on the defaults, consult the documentation for the message type.

• optional SslConfig ssl_config = 18

  SSL configuration for this AlloyDB Cluster.

• optional EncryptionConfig encryption_config = 19

  Optional. The encryption config can be specified to encrypt the data disks and other persistent data resources of a cluster with a customer-managed encryption key (CMEK). When this field is not specified, the cluster will then use default encryption scheme to protect the user data.

• optional EncryptionInfo encryption_info = 20

  Output only. The encryption information for the cluster.

• optional Cluster.SecondaryConfig secondary_config = 22

  Cross Region replication config specific to SECONDARY cluster.

• optional Cluster.PrimaryConfig primary_config = 23

  Output only. Cross Region replication config specific to PRIMARY cluster.

Type of Cluster

Used in: Cluster

• CLUSTER_TYPE_UNSPECIFIED = 0

  The type of the cluster is unknown.

• PRIMARY = 1

  Primary cluster that support read and write operations.

• SECONDARY = 2

  Secondary cluster that is replicating from another region. This only supports read.

Configuration for the primary cluster. It has the list of clusters that are replicating from this cluster. This should be set if and only if the cluster is of type PRIMARY.

Used in: Cluster

• repeated string secondary_cluster_names = 1

  Output only. Names of the clusters that are replicating from this cluster.

Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY.

Used in: Cluster

• string primary_cluster_name = 1

  The name of the primary cluster name with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}

Cluster State

Used in: Cluster

• STATE_UNSPECIFIED = 0

  The state of the cluster is unknown.

• READY = 1

  The cluster is active and running.

• STOPPED = 2

  The cluster is stopped. All instances in the cluster are stopped. Customers can start a stopped cluster at any point and all their instances will come back to life with same names and IP resources. In this state, customer pays for storage. Associated backups could also be present in a stopped cluster.

• EMPTY = 3

  The cluster is empty and has no associated resources. All instances, associated storage and backups have been deleted.

• CREATING = 4

  The cluster is being created.

• DELETING = 5

  The cluster is being deleted.

• FAILED = 6

  The creation of the cluster failed.

• BOOTSTRAPPING = 7

  The cluster is bootstrapping with data from some other source. Direct mutations to the cluster (e.g. adding read pool) are not allowed.

• MAINTENANCE = 8

  The cluster is under maintenance. AlloyDB regularly performs maintenance and upgrades on customer clusters. Updates on the cluster are not allowed while the cluster is in this state.

• PROMOTING = 9

  The cluster is being promoted.

The CloudEvent raised when a Cluster is created.

• optional ClusterEventData data = 1

  The data associated with the event.

The CloudEvent raised when a Cluster is deleted.

• optional ClusterEventData data = 1

  The data associated with the event.

The data within all Cluster events.

Used in: ClusterCreatedEvent, ClusterDeletedEvent, ClusterUpdatedEvent

• optional Cluster payload = 1

  Optional. The Cluster event payload. Unset for deletion events.

The CloudEvent raised when a Cluster is updated.

• optional ClusterEventData data = 1

  The data associated with the event.

The supported database engine versions.

Used in: Cluster

• DATABASE_VERSION_UNSPECIFIED = 0

  This is an unknown database version.

• POSTGRES_13 = 1

  DEPRECATED - The database version is Postgres 13.

• POSTGRES_14 = 2

  The database version is Postgres 14.

EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key).

Used in: AutomatedBackupPolicy, Backup, Cluster

• string kms_key_name = 1

  The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]

EncryptionInfo describes the encryption information of a cluster or a backup.

Used in: Backup, Cluster

• EncryptionInfo.Type encryption_type = 1

  Output only. Type of encryption.

• repeated string kms_key_versions = 2

  Output only. Cloud KMS key versions that are being used to protect the database or the backup.

Possible encryption types.

Used in: EncryptionInfo

• TYPE_UNSPECIFIED = 0

  Encryption type not specified. Defaults to GOOGLE_DEFAULT_ENCRYPTION.

• GOOGLE_DEFAULT_ENCRYPTION = 1

  The data is encrypted at rest with a key that is fully managed by Google. No key version will be populated. This is the default state.

• CUSTOMER_MANAGED_ENCRYPTION = 2

  The data is encrypted at rest with a key that is managed by the customer. KMS key versions will be populated.

An Instance is a computing unit that an end customer can connect to. It's the main unit of computing resources in AlloyDB.

Used in: InstanceEventData

• string name = 1

  Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id}

• string display_name = 2

  User-settable and human-readable display name for the Instance.

• string uid = 3

  Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.

• optional protobuf.Timestamp create_time = 4

  Output only. Create time stamp

• optional protobuf.Timestamp update_time = 5

  Output only. Update time stamp

• optional protobuf.Timestamp delete_time = 6

  Output only. Delete time stamp

• map<string, string> labels = 7

  Labels as key value pairs

• Instance.State state = 8

  Output only. The current serving state of the instance.

• Instance.InstanceType instance_type = 9

  Required. The type of the instance. Specified at creation time.

• optional Instance.MachineConfig machine_config = 10

  Configurations for the machines that host the underlying database engine.

• Instance.AvailabilityType availability_type = 11

  Availability type of an Instance. If empty, defaults to REGIONAL for primary instances. For read pools, availability_type is always UNSPECIFIED. Instances in the read pools are evenly distributed across available zones within the region (i.e. read pools with more than one node will have a node in at least two zones).

• string gce_zone = 12

  The Compute Engine zone that the instance should serve from, per https://cloud.google.com/compute/docs/regions-zones This can ONLY be specified for ZONAL instances. If present for a REGIONAL instance, an error will be thrown. If this is absent for a ZONAL instance, instance is created in a random zone with available capacity.

• map<string, string> database_flags = 13

  Database flags. Set at instance level. * They are copied from primary instance on read instance creation. * Read instances can set new or override existing flags that are relevant for reads, e.g. for enabling columnar cache on a read instance. Flags set on read instance may or may not be present on primary. This is a list of "key": "value" pairs. "key": The name of the flag. These flags are passed at instance setup time, so include both server options and system variables for Postgres. Flags are specified with underscores, not hyphens. "value": The value of the flag. Booleans are set to **on** for true and **off** for false. This field must be omitted if the flag doesn't take a value.

• optional Instance.Node writable_node = 19

  Output only. This is set for the read-write VM of the PRIMARY instance only.

• repeated Instance.Node nodes = 20

  Output only. List of available read-only VMs in this instance, including the standby for a PRIMARY instance.

• optional Instance.QueryInsightsInstanceConfig query_insights_config = 21

  Configuration for query insights.

• optional Instance.ReadPoolConfig read_pool_config = 14

  Read pool specific config.

• string ip_address = 15

  Output only. The IP address for the Instance. This is the connection endpoint for an end-user application.

• bool reconciling = 16

  Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Instance does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.

• string etag = 17

  For Resource freshness validation (https://google.aip.dev/154)

• map<string, string> annotations = 18

  Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128

The Availability type of an instance. Potential values: - ZONAL: The instance serves data from only one zone. Outages in that zone affect instance availability. - REGIONAL: The instance can serve data from more than one zone in a region (it is highly available).

Used in: Instance

• AVAILABILITY_TYPE_UNSPECIFIED = 0

  This is an unknown Availability type.

• ZONAL = 1

  Zonal available instance.

• REGIONAL = 2

  Regional (or Highly) available instance.

Type of an Instance

Used in: Instance

• INSTANCE_TYPE_UNSPECIFIED = 0

  The type of the instance is unknown.

• PRIMARY = 1

  PRIMARY instances support read and write operations.

• READ_POOL = 2

  READ POOL instances support read operations only. Each read pool instance consists of one or more homogeneous nodes. * Read pool of size 1 can only have zonal availability. * Read pools with node count of 2 or more can have regional availability (nodes are present in 2 or more zones in a region).

• SECONDARY = 3

  SECONDARY instances support read operations only. SECONDARY instance is a cross-region read replica

MachineConfig describes the configuration of a machine.

Used in: Instance

• int32 cpu_count = 1

  The number of CPU's in the VM instance.

Details of a single node in the instance. Nodes in an AlloyDB instance are ephemereal, they can change during update, failover, autohealing and resize operations.

Used in: Instance

• string zone_id = 1

  The Compute Engine zone of the VM e.g. "us-central1-b".

• string id = 2

  The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".

• string ip = 3

  The private IP address of the VM e.g. "10.57.0.34".

• string state = 4

  Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY.

QueryInsights Instance specific configuration.

Used in: Instance

• optional bool record_application_tags = 2

  Record application tags for an instance. This flag is turned "on" by default.

• optional bool record_client_address = 3

  Record client address for an instance. Client address is PII information. This flag is turned "on" by default.

• uint32 query_string_length = 4

  Query string length. The default value is 1024. Any integer between 256 and 4500 is considered valid.

• optional uint32 query_plans_per_minute = 5

  Number of query execution plans captured by Insights per minute for all queries combined. The default value is 5. Any integer between 0 and 20 is considered valid.

Configuration for a read pool instance.

Used in: Instance

• int32 node_count = 1

  Read capacity, i.e. number of nodes in a read pool instance.

Instance State

Used in: Instance

• STATE_UNSPECIFIED = 0

  The state of the instance is unknown.

• READY = 1

  The instance is active and running.

• STOPPED = 2

  The instance is stopped. Instance name and IP resources are preserved.

• CREATING = 3

  The instance is being created.

• DELETING = 4

  The instance is being deleted.

• MAINTENANCE = 5

  The instance is down for maintenance.

• FAILED = 6

  The creation of the instance failed or a fatal error occurred during an operation on the instance. Note: Instances in this state would tried to be auto-repaired. And Customers should be able to restart, update or delete these instances.

• BOOTSTRAPPING = 8

  Index 7 is used in the producer apis for ROLLED_BACK state. Keeping that index unused in case that state also needs to exposed via consumer apis in future. The instance has been configured to sync data from some other source.

• PROMOTING = 9

  The instance is being promoted.

The CloudEvent raised when an Instance is created.

• optional InstanceEventData data = 1

  The data associated with the event.

The CloudEvent raised when an Instance is deleted.

• optional InstanceEventData data = 1

  The data associated with the event.

The data within all Instance events.

Used in: InstanceCreatedEvent, InstanceDeletedEvent, InstanceUpdatedEvent

• optional Instance payload = 1

  Optional. The Instance event payload. Unset for deletion events.

The CloudEvent raised when an Instance is updated.

• optional InstanceEventData data = 1

  The data associated with the event.

Subset of the source instance configuration that is available when reading the cluster resource.

Used in: Cluster

• string host_port = 1

  Output only. The host and port of the on-premises instance in host:port format

• string reference_id = 2

  Output only. Place holder for the external source identifier(e.g DMS job name) that created the cluster.

• MigrationSource.MigrationSourceType source_type = 3

  Output only. Type of migration source.

Denote the type of migration source that created this cluster.

Used in: MigrationSource

• MIGRATION_SOURCE_TYPE_UNSPECIFIED = 0

  Migration source is unknown.

• DMS = 1

  DMS source means the cluster was created via DMS migration job.

SSL configuration for an AlloyDB Cluster.

Used in: Cluster

• SslConfig.SslMode ssl_mode = 1

  Optional. SSL mode. Specifies client-server SSL/TLS connection behavior.

• SslConfig.CaSource ca_source = 2

  Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value.

Certificate Authority (CA) source for SSL/TLS certificates.

Used in: SslConfig

• CA_SOURCE_UNSPECIFIED = 0

  Certificate Authority (CA) source not specified. Defaults to CA_SOURCE_MANAGED.

• CA_SOURCE_MANAGED = 1

  Certificate Authority (CA) managed by the AlloyDB Cluster.

SSL mode options.

Used in: SslConfig

• SSL_MODE_UNSPECIFIED = 0

  SSL mode not specified. Defaults to SSL_MODE_ALLOW.

• SSL_MODE_ALLOW = 1

  SSL connections are optional. CA verification not enforced.

• SSL_MODE_REQUIRE = 2

  SSL connections are required. CA verification not enforced. Clients may use locally self-signed certificates (default psql client behavior).

• SSL_MODE_VERIFY_CA = 3

  SSL connections are required. CA verification enforced. Clients must have certificates signed by a Cluster CA, e.g. via GenerateClientCertificate.

The username/password for a database user. Used for specifying initial users at cluster creation time.

• string user = 1

  The database username.

• string password = 2

  The initial password for the user.