@googleapis/alloydb 3.0.0 → 4.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/v1alpha.ts CHANGED
@@ -124,6 +124,15 @@ export namespace alloydb_v1alpha {
124
124
  }
125
125
  }
126
126
 
127
+ /**
128
+ * AuthorizedNetwork contains metadata for an authorized network.
129
+ */
130
+ export interface Schema$AuthorizedNetwork {
131
+ /**
132
+ * CIDR range for one authorzied network of the instance.
133
+ */
134
+ cidrRange?: string | null;
135
+ }
127
136
  /**
128
137
  * 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.
129
138
  */
@@ -229,6 +238,10 @@ export namespace alloydb_v1alpha {
229
238
  * 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.
230
239
  */
231
240
  reconciling?: boolean | null;
241
+ /**
242
+ * Output only. Reserved for future use.
243
+ */
244
+ satisfiesPzi?: boolean | null;
232
245
  /**
233
246
  * Output only. Reserved for future use.
234
247
  */
@@ -386,6 +399,10 @@ export namespace alloydb_v1alpha {
386
399
  * 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.
387
400
  */
388
401
  reconciling?: boolean | null;
402
+ /**
403
+ * Output only. Reserved for future use.
404
+ */
405
+ satisfiesPzi?: boolean | null;
389
406
  /**
390
407
  * Output only. Reserved for future use.
391
408
  */
@@ -431,6 +448,10 @@ export namespace alloydb_v1alpha {
431
448
  * Output only. The pem-encoded chain that may be used to verify the X.509 certificate. Expected to be in issuer-to-root order according to RFC 5246.
432
449
  */
433
450
  pemCertificateChain?: string[] | null;
451
+ /**
452
+ * Output only. The public IP addresses for the Instance. This is available ONLY when enable_public_ip is set. This is the connection endpoint for an end-user application.
453
+ */
454
+ publicIpAddress?: string | null;
434
455
  }
435
456
  /**
436
457
  * ContinuousBackupConfig describes the continuous backups recovery configurations of a cluster.
@@ -700,10 +721,22 @@ export namespace alloydb_v1alpha {
700
721
  * 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\}
701
722
  */
702
723
  name?: string | null;
724
+ /**
725
+ * Optional. Instance level network configuration.
726
+ */
727
+ networkConfig?: Schema$InstanceNetworkConfig;
703
728
  /**
704
729
  * Output only. List of available read-only VMs in this instance, including the standby for a PRIMARY instance.
705
730
  */
706
731
  nodes?: Schema$Node[];
732
+ /**
733
+ * Optional. The configuration for Private Service Connect (PSC) for the instance.
734
+ */
735
+ pscInstanceConfig?: Schema$PscInstanceConfig;
736
+ /**
737
+ * Output only. The public IP addresses for the Instance. This is available ONLY when enable_public_ip is set. This is the connection endpoint for an end-user application.
738
+ */
739
+ publicIpAddress?: string | null;
707
740
  /**
708
741
  * Configuration for query insights.
709
742
  */
@@ -716,6 +749,10 @@ export namespace alloydb_v1alpha {
716
749
  * 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.
717
750
  */
718
751
  reconciling?: boolean | null;
752
+ /**
753
+ * Output only. Reserved for future use.
754
+ */
755
+ satisfiesPzi?: boolean | null;
719
756
  /**
720
757
  * Output only. Reserved for future use.
721
758
  */
@@ -741,6 +778,19 @@ export namespace alloydb_v1alpha {
741
778
  */
742
779
  writableNode?: Schema$Node;
743
780
  }
781
+ /**
782
+ * Metadata related to instance level network configuration.
783
+ */
784
+ export interface Schema$InstanceNetworkConfig {
785
+ /**
786
+ * Optional. A list of external network authorized to access this instance.
787
+ */
788
+ authorizedExternalNetworks?: Schema$AuthorizedNetwork[];
789
+ /**
790
+ * Optional. Enabling public ip for the instance.
791
+ */
792
+ enablePublicIp?: boolean | null;
793
+ }
744
794
  /**
745
795
  * Restrictions on INTEGER type values.
746
796
  */
@@ -993,7 +1043,7 @@ export namespace alloydb_v1alpha {
993
1043
  validateOnly?: boolean | null;
994
1044
  }
995
1045
  /**
996
- * PscConfig contains PSC related configuration at a cluster level. NEXT ID: 2
1046
+ * PscConfig contains PSC related configuration at a cluster level.
997
1047
  */
998
1048
  export interface Schema$PscConfig {
999
1049
  /**
@@ -1001,6 +1051,48 @@ export namespace alloydb_v1alpha {
1001
1051
  */
1002
1052
  pscEnabled?: boolean | null;
1003
1053
  }
1054
+ /**
1055
+ * PscInstanceConfig contains PSC related configuration at an instance level.
1056
+ */
1057
+ export interface Schema$PscInstanceConfig {
1058
+ /**
1059
+ * Optional. List of consumer networks that are allowed to create PSC endpoints to service-attachments to this instance.
1060
+ */
1061
+ allowedConsumerNetworks?: string[] | null;
1062
+ /**
1063
+ * Optional. List of consumer projects that are allowed to create PSC endpoints to service-attachments to this instance.
1064
+ */
1065
+ allowedConsumerProjects?: string[] | null;
1066
+ /**
1067
+ * Optional. List of service attachments that this instance has created endpoints to connect with. Currently, only a single outgoing service attachment is supported per instance.
1068
+ */
1069
+ outgoingServiceAttachmentLinks?: string[] | null;
1070
+ /**
1071
+ * Optional. Whether PSC connectivity is enabled for this instance. This is populated by referencing the value from the parent cluster.
1072
+ */
1073
+ pscEnabled?: boolean | null;
1074
+ /**
1075
+ * Optional. Configurations for setting up PSC interfaces attached to the instance which are used for outbound connectivity. Only primary instances can have PSC interface attached. All the VMs created for the primary instance will share the same configurations. Currently we only support 0 or 1 PSC interface.
1076
+ */
1077
+ pscInterfaceConfigs?: Schema$PscInterfaceConfig[];
1078
+ /**
1079
+ * Output only. The service attachment created when Private Service Connect (PSC) is enabled for the instance. The name of the resource will be in the format of projects//regions//serviceAttachments/
1080
+ */
1081
+ serviceAttachmentLink?: string | null;
1082
+ }
1083
+ /**
1084
+ * Configuration for setting up a PSC interface. This information needs to be provided by the customer. PSC interfaces will be created and added to VMs via SLM (adding a network interface will require recreating the VM). For HA instances this will be done via LDTM.
1085
+ */
1086
+ export interface Schema$PscInterfaceConfig {
1087
+ /**
1088
+ * A list of endpoints in the consumer VPC the interface might initiate outbound connections to. This list has to be provided when the PSC interface is created.
1089
+ */
1090
+ consumerEndpointIps?: string[] | null;
1091
+ /**
1092
+ * The NetworkAttachment resource created in the consumer VPC to which the PSC interface will be linked, in the form of: "projects/${CONSUMER_PROJECT\}/regions/${REGION\}/networkAttachments/${NETWORK_ATTACHMENT_NAME\}". NetworkAttachment has to be provided when the PSC interface is created.
1093
+ */
1094
+ networkAttachment?: string | null;
1095
+ }
1004
1096
  /**
1005
1097
  * A backup's position in a quantity-based retention queue, of backups with the same source cluster and type, with length, retention, specified by the backup's retention policy. Once the position is greater than the retention, the backup is eligible to be garbage collected. Example: 5 backups from the same source cluster and type with a quantity-based retention of 3 and denoted by backup_id (position, retention). Safe: backup_5 (1, 3), backup_4, (2, 3), backup_3 (3, 3). Awaiting garbage collection: backup_2 (4, 3), backup_1 (5, 3)
1006
1098
  */
@@ -1193,6 +1285,31 @@ export namespace alloydb_v1alpha {
1193
1285
  */
1194
1286
  version?: string | null;
1195
1287
  }
1288
+ /**
1289
+ * Any custom metadata associated with the resource. i.e. A spanner instance can have multiple databases with its own unique metadata. Information for these individual databases can be captured in custom metadata data
1290
+ */
1291
+ export interface Schema$StorageDatabasecenterPartnerapiV1mainCustomMetadataData {
1292
+ databaseMetadata?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseMetadata[];
1293
+ }
1294
+ /**
1295
+ * Metadata for individual databases created in an instance. i.e. spanner instance can have multiple databases with unique configuration settings.
1296
+ */
1297
+ export interface Schema$StorageDatabasecenterPartnerapiV1mainDatabaseMetadata {
1298
+ /**
1299
+ * Backup configuration for this database
1300
+ */
1301
+ backupConfiguration?: Schema$StorageDatabasecenterPartnerapiV1mainBackupConfiguration;
1302
+ /**
1303
+ * Information about the last backup attempt for this database
1304
+ */
1305
+ backupRun?: Schema$StorageDatabasecenterPartnerapiV1mainBackupRun;
1306
+ product?: Schema$StorageDatabasecenterProtoCommonProduct;
1307
+ resourceId?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceId;
1308
+ /**
1309
+ * Required. Database name. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel
1310
+ */
1311
+ resourceName?: string | null;
1312
+ }
1196
1313
  /**
1197
1314
  * DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform.
1198
1315
  */
@@ -1248,7 +1365,7 @@ export namespace alloydb_v1alpha {
1248
1365
  */
1249
1366
  provider?: string | null;
1250
1367
  /**
1251
- * Closest parent container of this resource. In GCP, 'container' refers to a Cloud Resource Manager project. It must be resource name of a Cloud Resource Manager project with the format of "provider//", such as "gcp/projects/123". For GCP provided resources, number should be project number.
1368
+ * Closest parent container of this resource. In GCP, 'container' refers to a Cloud Resource Manager project. It must be resource name of a Cloud Resource Manager project with the format of "provider//", such as "projects/123". For GCP provided resources, number should be project number.
1252
1369
  */
1253
1370
  resourceContainer?: string | null;
1254
1371
  /**
@@ -1315,9 +1432,9 @@ export namespace alloydb_v1alpha {
1315
1432
  */
1316
1433
  currentState?: string | null;
1317
1434
  /**
1318
- * Any custom metadata associated with the resource (a JSON field)
1435
+ * Any custom metadata associated with the resource
1319
1436
  */
1320
- customMetadata?: {[key: string]: any} | null;
1437
+ customMetadata?: Schema$StorageDatabasecenterPartnerapiV1mainCustomMetadataData;
1321
1438
  /**
1322
1439
  * The state that the instance is expected to be in. For example, an instance state can transition to UNHEALTHY due to wrong patch update, while the expected state will remain at the HEALTHY.
1323
1440
  */
@@ -1343,7 +1460,7 @@ export namespace alloydb_v1alpha {
1343
1460
  */
1344
1461
  product?: Schema$StorageDatabasecenterProtoCommonProduct;
1345
1462
  /**
1346
- * Closest parent Cloud Resource Manager container of this resource. It must be resource name of a Cloud Resource Manager project with the format of "provider//", such as "gcp/projects/123". For GCP provided resources, number should be project number.
1463
+ * Closest parent Cloud Resource Manager container of this resource. It must be resource name of a Cloud Resource Manager project with the format of "/", such as "projects/123". For GCP provided resources, number should be project number.
1347
1464
  */
1348
1465
  resourceContainer?: string | null;
1349
1466
  /**
package/v1beta.ts CHANGED
@@ -124,6 +124,15 @@ export namespace alloydb_v1beta {
124
124
  }
125
125
  }
126
126
 
127
+ /**
128
+ * AuthorizedNetwork contains metadata for an authorized network.
129
+ */
130
+ export interface Schema$AuthorizedNetwork {
131
+ /**
132
+ * CIDR range for one authorzied network of the instance.
133
+ */
134
+ cidrRange?: string | null;
135
+ }
127
136
  /**
128
137
  * 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.
129
138
  */
@@ -229,6 +238,10 @@ export namespace alloydb_v1beta {
229
238
  * 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.
230
239
  */
231
240
  reconciling?: boolean | null;
241
+ /**
242
+ * Output only. Reserved for future use.
243
+ */
244
+ satisfiesPzs?: boolean | null;
232
245
  /**
233
246
  * Output only. The size of the backup in bytes.
234
247
  */
@@ -374,6 +387,10 @@ export namespace alloydb_v1beta {
374
387
  * 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.
375
388
  */
376
389
  reconciling?: boolean | null;
390
+ /**
391
+ * Output only. Reserved for future use.
392
+ */
393
+ satisfiesPzs?: boolean | null;
377
394
  /**
378
395
  * Cross Region replication config specific to SECONDARY cluster.
379
396
  */
@@ -415,6 +432,10 @@ export namespace alloydb_v1beta {
415
432
  * Output only. The pem-encoded chain that may be used to verify the X.509 certificate. Expected to be in issuer-to-root order according to RFC 5246.
416
433
  */
417
434
  pemCertificateChain?: string[] | null;
435
+ /**
436
+ * Output only. The public IP addresses for the Instance. This is available ONLY when enable_public_ip is set. This is the connection endpoint for an end-user application.
437
+ */
438
+ publicIpAddress?: string | null;
418
439
  }
419
440
  /**
420
441
  * ContinuousBackupConfig describes the continuous backups recovery configurations of a cluster.
@@ -684,10 +705,18 @@ export namespace alloydb_v1beta {
684
705
  * 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\}
685
706
  */
686
707
  name?: string | null;
708
+ /**
709
+ * Optional. Instance level network configuration.
710
+ */
711
+ networkConfig?: Schema$InstanceNetworkConfig;
687
712
  /**
688
713
  * Output only. List of available read-only VMs in this instance, including the standby for a PRIMARY instance.
689
714
  */
690
715
  nodes?: Schema$Node[];
716
+ /**
717
+ * Output only. The public IP addresses for the Instance. This is available ONLY when enable_public_ip is set. This is the connection endpoint for an end-user application.
718
+ */
719
+ publicIpAddress?: string | null;
691
720
  /**
692
721
  * Configuration for query insights.
693
722
  */
@@ -700,6 +729,10 @@ export namespace alloydb_v1beta {
700
729
  * 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.
701
730
  */
702
731
  reconciling?: boolean | null;
732
+ /**
733
+ * Output only. Reserved for future use.
734
+ */
735
+ satisfiesPzs?: boolean | null;
703
736
  /**
704
737
  * Output only. The current serving state of the instance.
705
738
  */
@@ -721,6 +754,19 @@ export namespace alloydb_v1beta {
721
754
  */
722
755
  writableNode?: Schema$Node;
723
756
  }
757
+ /**
758
+ * Metadata related to instance level network configuration.
759
+ */
760
+ export interface Schema$InstanceNetworkConfig {
761
+ /**
762
+ * Optional. A list of external network authorized to access this instance.
763
+ */
764
+ authorizedExternalNetworks?: Schema$AuthorizedNetwork[];
765
+ /**
766
+ * Optional. Enabling public ip for the instance.
767
+ */
768
+ enablePublicIp?: boolean | null;
769
+ }
724
770
  /**
725
771
  * Restrictions on INTEGER type values.
726
772
  */
@@ -863,7 +909,7 @@ export namespace alloydb_v1beta {
863
909
  */
864
910
  allocatedIpRange?: string | null;
865
911
  /**
866
- * 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.
912
+ * Optional. 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.
867
913
  */
868
914
  network?: string | null;
869
915
  }
@@ -1164,6 +1210,31 @@ export namespace alloydb_v1beta {
1164
1210
  */
1165
1211
  version?: string | null;
1166
1212
  }
1213
+ /**
1214
+ * Any custom metadata associated with the resource. i.e. A spanner instance can have multiple databases with its own unique metadata. Information for these individual databases can be captured in custom metadata data
1215
+ */
1216
+ export interface Schema$StorageDatabasecenterPartnerapiV1mainCustomMetadataData {
1217
+ databaseMetadata?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseMetadata[];
1218
+ }
1219
+ /**
1220
+ * Metadata for individual databases created in an instance. i.e. spanner instance can have multiple databases with unique configuration settings.
1221
+ */
1222
+ export interface Schema$StorageDatabasecenterPartnerapiV1mainDatabaseMetadata {
1223
+ /**
1224
+ * Backup configuration for this database
1225
+ */
1226
+ backupConfiguration?: Schema$StorageDatabasecenterPartnerapiV1mainBackupConfiguration;
1227
+ /**
1228
+ * Information about the last backup attempt for this database
1229
+ */
1230
+ backupRun?: Schema$StorageDatabasecenterPartnerapiV1mainBackupRun;
1231
+ product?: Schema$StorageDatabasecenterProtoCommonProduct;
1232
+ resourceId?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceId;
1233
+ /**
1234
+ * Required. Database name. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel
1235
+ */
1236
+ resourceName?: string | null;
1237
+ }
1167
1238
  /**
1168
1239
  * DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform.
1169
1240
  */
@@ -1219,7 +1290,7 @@ export namespace alloydb_v1beta {
1219
1290
  */
1220
1291
  provider?: string | null;
1221
1292
  /**
1222
- * Closest parent container of this resource. In GCP, 'container' refers to a Cloud Resource Manager project. It must be resource name of a Cloud Resource Manager project with the format of "provider//", such as "gcp/projects/123". For GCP provided resources, number should be project number.
1293
+ * Closest parent container of this resource. In GCP, 'container' refers to a Cloud Resource Manager project. It must be resource name of a Cloud Resource Manager project with the format of "provider//", such as "projects/123". For GCP provided resources, number should be project number.
1223
1294
  */
1224
1295
  resourceContainer?: string | null;
1225
1296
  /**
@@ -1286,9 +1357,9 @@ export namespace alloydb_v1beta {
1286
1357
  */
1287
1358
  currentState?: string | null;
1288
1359
  /**
1289
- * Any custom metadata associated with the resource (a JSON field)
1360
+ * Any custom metadata associated with the resource
1290
1361
  */
1291
- customMetadata?: {[key: string]: any} | null;
1362
+ customMetadata?: Schema$StorageDatabasecenterPartnerapiV1mainCustomMetadataData;
1292
1363
  /**
1293
1364
  * The state that the instance is expected to be in. For example, an instance state can transition to UNHEALTHY due to wrong patch update, while the expected state will remain at the HEALTHY.
1294
1365
  */
@@ -1314,7 +1385,7 @@ export namespace alloydb_v1beta {
1314
1385
  */
1315
1386
  product?: Schema$StorageDatabasecenterProtoCommonProduct;
1316
1387
  /**
1317
- * Closest parent Cloud Resource Manager container of this resource. It must be resource name of a Cloud Resource Manager project with the format of "provider//", such as "gcp/projects/123". For GCP provided resources, number should be project number.
1388
+ * Closest parent Cloud Resource Manager container of this resource. It must be resource name of a Cloud Resource Manager project with the format of "/", such as "projects/123". For GCP provided resources, number should be project number.
1318
1389
  */
1319
1390
  resourceContainer?: string | null;
1320
1391
  /**