@maxim_mazurok/gapi.client.sqladmin-v1 0.0.20230928 → 0.0.20231011

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/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://sqladmin.googleapis.com/$discovery/rest?version=v1
12
- // Revision: 20230928
12
+ // Revision: 20231011
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -378,7 +378,7 @@ declare namespace gapi.client {
378
378
  */
379
379
  outOfDiskReport?:
380
380
  SqlOutOfDiskReport;
381
- /** Output only. The dns name of the primary instance in a replication group. */
381
+ /** Output only. DEPRECATED: please use write_endpoint instead. */
382
382
  primaryDnsName?:
383
383
  string;
384
384
  /** The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable. */
@@ -432,6 +432,9 @@ declare namespace gapi.client {
432
432
  /** If the instance state is SUSPENDED, the reason for the suspension. */
433
433
  suspensionReason?:
434
434
  string[];
435
+ /** Output only. The dns name of the primary instance in a replication group. */
436
+ writeEndpoint?:
437
+ string;
435
438
  }
436
439
  interface DatabasesListResponse {
437
440
  /** List of database resources in the instance. */
@@ -911,9 +914,24 @@ declare namespace gapi.client {
911
914
  /** PSC settings for this instance. */
912
915
  pscConfig?:
913
916
  PscConfig;
914
- /** Whether SSL connections over IP are enforced or not. */
917
+ /**
918
+ * LINT.IfChange(require_ssl_deprecate) Whether SSL/TLS connections over IP are enforced or not. If set to false, allow both non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS
919
+ * connections, the client certificate will not be verified. If set to true, only allow connections encrypted with SSL/TLS and with valid client certificates. If you want to enforce
920
+ * SSL/TLS without enforcing the requirement for valid client certificates, use the `ssl_mode` flag instead of the legacy `require_ssl` flag.
921
+ * LINT.ThenChange(//depot/google3/java/com/google/storage/speckle/boss/admin/actions/InstanceUpdateAction.java:update_api_temp_fix)
922
+ */
915
923
  requireSsl?:
916
924
  boolean;
925
+ /**
926
+ * Specify how SSL/TLS will be enforced in database connections. This flag is only supported for PostgreSQL. Use the legacy `require_ssl` flag for enforcing SSL/TLS in MySQL and SQL
927
+ * Server. But, for PostgreSQL, it is recommended to use the `ssl_mode` flag instead of the legacy `require_ssl` flag. To avoid the conflict between those flags in PostgreSQL, only the
928
+ * following value pairs are valid: ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED, require_ssl=false; ssl_mode=ENCRYPTED_ONLY, require_ssl=false;
929
+ * ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED, require_ssl=true; Note that the value of `ssl_mode` gets priority over the value of the legacy `require_ssl`. For example, for the pair
930
+ * `ssl_mode=ENCRYPTED_ONLY, require_ssl=false`, the `ssl_mode=ENCRYPTED_ONLY` means "only accepts SSL connection", while the `require_ssl=false` means "both non-SSL and SSL
931
+ * connections are allowed". The database will respect `ssl_mode` in this case and only accept SSL connections.
932
+ */
933
+ sslMode?:
934
+ string;
917
935
  }
918
936
  interface IpMapping {
919
937
  /** The IP address assigned. */
@@ -1152,6 +1170,9 @@ declare namespace gapi.client {
1152
1170
  /** The complexity of the password. */
1153
1171
  complexity?:
1154
1172
  string;
1173
+ /** Disallow credentials that have been previously compromised by a public data breach. */
1174
+ disallowCompromisedCredentials?:
1175
+ boolean;
1155
1176
  /** Disallow username as a part of the password. */
1156
1177
  disallowUsernameSubstring?:
1157
1178
  boolean;
@@ -1175,8 +1196,8 @@ declare namespace gapi.client {
1175
1196
  }
1176
1197
  interface PscConfig {
1177
1198
  /**
1178
- * List of consumer projects that are allow-listed for PSC connections to this instance. This instance can be connected to with PSC from any network in these projects. Each consumer
1179
- * project in this list may be represented by a project number (numeric) or by a project id (alphanumeric).
1199
+ * Optional. The list of consumer projects that are allow-listed for PSC connections to this instance. This instance can be connected to with PSC from any network in these projects.
1200
+ * Each consumer project in this list may be represented by a project number (numeric) or by a project id (alphanumeric).
1180
1201
  */
1181
1202
  allowedConsumerProjects?:
1182
1203
  string[];
@@ -1185,6 +1206,9 @@ declare namespace gapi.client {
1185
1206
  boolean;
1186
1207
  }
1187
1208
  interface ReplicaConfiguration {
1209
+ /** Optional. Specifies if a SQL Server replica is a cascadable replica. A cascadable replica is a SQL Server cross region replica that supports replica(s) under it. */
1210
+ cascadableReplica?:
1211
+ boolean;
1188
1212
  /**
1189
1213
  * Specifies if the replica is the failover target. If the field is set to `true`, the replica will be designated as a failover replica. In case the primary instance fails, the replica
1190
1214
  * instance will be promoted as the new primary instance. Only one replica can be specified as failover target, and the replica has to be in different zone with the primary instance.
@@ -3339,6 +3363,12 @@ declare namespace gapi.client {
3339
3363
  /** JSONP */
3340
3364
  callback?:
3341
3365
  string;
3366
+ /**
3367
+ * Set to true if the promote operation should attempt to re-add the original primary as a replica when it comes back online. Otherwise, if this value is false or not set, the
3368
+ * original primary will be a standalone instance.
3369
+ */
3370
+ failover?:
3371
+ boolean;
3342
3372
  /** Selector specifying which fields to include in a partial response. */
3343
3373
  fields?:
3344
3374
  string;
@@ -3796,6 +3826,54 @@ declare namespace gapi.client {
3796
3826
  uploadType?:
3797
3827
  string;
3798
3828
  }): Request<Operation>;
3829
+ /** Switches over from the primary instance to the replica instance. */
3830
+ switchover(request?: {
3831
+ /** V1 error format. */
3832
+ "$.xgafv"?:
3833
+ string;
3834
+ /** OAuth access token. */
3835
+ access_token?:
3836
+ string;
3837
+ /** Data format for response. */
3838
+ alt?:
3839
+ string;
3840
+ /** JSONP */
3841
+ callback?:
3842
+ string;
3843
+ /**
3844
+ * Optional. (MySQL only) Cloud SQL instance operations timeout, which is a sum of all database operations. Default value is 10 minutes and can be modified to a maximum value of 24
3845
+ * hours.
3846
+ */
3847
+ dbTimeout?:
3848
+ string;
3849
+ /** Selector specifying which fields to include in a partial response. */
3850
+ fields?:
3851
+ string;
3852
+ /** Cloud SQL read replica instance name. */
3853
+ instance:
3854
+ string;
3855
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
3856
+ key?:
3857
+ string;
3858
+ /** OAuth 2.0 token for the current user. */
3859
+ oauth_token?:
3860
+ string;
3861
+ /** Returns response with indentations and line breaks. */
3862
+ prettyPrint?:
3863
+ boolean;
3864
+ /** ID of the project that contains the replica. */
3865
+ project:
3866
+ string;
3867
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3868
+ quotaUser?:
3869
+ string;
3870
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3871
+ upload_protocol?:
3872
+ string;
3873
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3874
+ uploadType?:
3875
+ string;
3876
+ }): Request<Operation>;
3799
3877
  /** Truncate MySQL general and slow query log tables MySQL only. */
3800
3878
  truncateLog(request: {
3801
3879
  /** V1 error format. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.sqladmin-v1",
3
- "version": "0.0.20230928",
3
+ "version": "0.0.20231011",
4
4
  "description": "TypeScript typings for Cloud SQL Admin API v1",
5
5
  "license": "MIT",
6
6
  "author": {
package/readme.md CHANGED
@@ -234,6 +234,11 @@ Stops the replication in the read replica instance.
234
234
  */
235
235
  await gapi.client.sql.instances.stopReplica({ instance: "instance", project: "project", });
236
236
 
237
+ /*
238
+ Switches over from the primary instance to the replica instance.
239
+ */
240
+ await gapi.client.sql.instances.switchover({ instance: "instance", project: "project", });
241
+
237
242
  /*
238
243
  Truncate MySQL general and slow query log tables MySQL only.
239
244
  */
package/tests.ts CHANGED
@@ -3,7 +3,7 @@
3
3
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
4
4
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
5
5
 
6
- // Revision: 20230928
6
+ // Revision: 20231011
7
7
 
8
8
  gapi.load('client', async () => {
9
9
  /** now we can use gapi.client */
@@ -396,6 +396,7 @@ gapi.load('client', async () => {
396
396
  pscServiceAttachmentLink: "Test string",
397
397
  region: "Test string",
398
398
  replicaConfiguration: {
399
+ cascadableReplica: true,
399
400
  failoverTarget: true,
400
401
  kind: "Test string",
401
402
  mysqlReplicaConfiguration: {
@@ -515,6 +516,7 @@ gapi.load('client', async () => {
515
516
  pscEnabled: true,
516
517
  },
517
518
  requireSsl: true,
519
+ sslMode: "Test string",
518
520
  },
519
521
  kind: "Test string",
520
522
  locationPreference: {
@@ -531,6 +533,7 @@ gapi.load('client', async () => {
531
533
  },
532
534
  passwordValidationPolicy: {
533
535
  complexity: "Test string",
536
+ disallowCompromisedCredentials: true,
534
537
  disallowUsernameSubstring: true,
535
538
  enablePasswordPolicy: true,
536
539
  minLength: 42,
@@ -558,6 +561,7 @@ gapi.load('client', async () => {
558
561
  suspensionReason: [
559
562
  "Test string"
560
563
  ],
564
+ writeEndpoint: "Test string",
561
565
  });
562
566
  /** Lists instances under a given project. */
563
567
  await gapi.client.sql.instances.list({
@@ -641,6 +645,7 @@ gapi.load('client', async () => {
641
645
  pscServiceAttachmentLink: "Test string",
642
646
  region: "Test string",
643
647
  replicaConfiguration: {
648
+ cascadableReplica: true,
644
649
  failoverTarget: true,
645
650
  kind: "Test string",
646
651
  mysqlReplicaConfiguration: {
@@ -760,6 +765,7 @@ gapi.load('client', async () => {
760
765
  pscEnabled: true,
761
766
  },
762
767
  requireSsl: true,
768
+ sslMode: "Test string",
763
769
  },
764
770
  kind: "Test string",
765
771
  locationPreference: {
@@ -776,6 +782,7 @@ gapi.load('client', async () => {
776
782
  },
777
783
  passwordValidationPolicy: {
778
784
  complexity: "Test string",
785
+ disallowCompromisedCredentials: true,
779
786
  disallowUsernameSubstring: true,
780
787
  enablePasswordPolicy: true,
781
788
  minLength: 42,
@@ -803,9 +810,11 @@ gapi.load('client', async () => {
803
810
  suspensionReason: [
804
811
  "Test string"
805
812
  ],
813
+ writeEndpoint: "Test string",
806
814
  });
807
815
  /** Promotes the read replica instance to be a stand-alone Cloud SQL instance. Using this operation might cause your instance to restart. */
808
816
  await gapi.client.sql.instances.promoteReplica({
817
+ failover: true,
809
818
  instance: "Test string",
810
819
  project: "Test string",
811
820
  });
@@ -861,6 +870,12 @@ gapi.load('client', async () => {
861
870
  instance: "Test string",
862
871
  project: "Test string",
863
872
  });
873
+ /** Switches over from the primary instance to the replica instance. */
874
+ await gapi.client.sql.instances.switchover({
875
+ dbTimeout: "Test string",
876
+ instance: "Test string",
877
+ project: "Test string",
878
+ });
864
879
  /** Truncate MySQL general and slow query log tables MySQL only. */
865
880
  await gapi.client.sql.instances.truncateLog({
866
881
  instance: "Test string",
@@ -938,6 +953,7 @@ gapi.load('client', async () => {
938
953
  pscServiceAttachmentLink: "Test string",
939
954
  region: "Test string",
940
955
  replicaConfiguration: {
956
+ cascadableReplica: true,
941
957
  failoverTarget: true,
942
958
  kind: "Test string",
943
959
  mysqlReplicaConfiguration: {
@@ -1057,6 +1073,7 @@ gapi.load('client', async () => {
1057
1073
  pscEnabled: true,
1058
1074
  },
1059
1075
  requireSsl: true,
1076
+ sslMode: "Test string",
1060
1077
  },
1061
1078
  kind: "Test string",
1062
1079
  locationPreference: {
@@ -1073,6 +1090,7 @@ gapi.load('client', async () => {
1073
1090
  },
1074
1091
  passwordValidationPolicy: {
1075
1092
  complexity: "Test string",
1093
+ disallowCompromisedCredentials: true,
1076
1094
  disallowUsernameSubstring: true,
1077
1095
  enablePasswordPolicy: true,
1078
1096
  minLength: 42,
@@ -1100,6 +1118,7 @@ gapi.load('client', async () => {
1100
1118
  suspensionReason: [
1101
1119
  "Test string"
1102
1120
  ],
1121
+ writeEndpoint: "Test string",
1103
1122
  });
1104
1123
  /** Cancels an instance operation that has been performed on an instance. */
1105
1124
  await gapi.client.sql.operations.cancel({