google-cloud-alloy_db-v1beta 0.9.0 → 0.11.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.
@@ -0,0 +1,42 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2024 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module AlloyDB
23
+ module V1beta
24
+ # The source CloudSQL backup resource.
25
+ # @!attribute [rw] project
26
+ # @return [::String]
27
+ # The project ID of the source CloudSQL instance. This should be the same as
28
+ # the AlloyDB cluster's project.
29
+ # @!attribute [rw] instance_id
30
+ # @return [::String]
31
+ # Required. The CloudSQL instance ID.
32
+ # @!attribute [rw] backup_run_id
33
+ # @return [::Integer]
34
+ # Required. The CloudSQL backup run ID.
35
+ class CloudSQLBackupRunSource
36
+ include ::Google::Protobuf::MessageExts
37
+ extend ::Google::Protobuf::MessageExts::ClassMethods
38
+ end
39
+ end
40
+ end
41
+ end
42
+ end
@@ -0,0 +1,75 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2024 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module AlloyDB
23
+ module V1beta
24
+ # SqlResult represents the result for the execution of a sql statement.
25
+ # @!attribute [rw] columns
26
+ # @return [::Array<::Google::Cloud::AlloyDB::V1beta::SqlResultColumn>]
27
+ # List of columns included in the result. This also includes the data type
28
+ # of the column.
29
+ # @!attribute [rw] rows
30
+ # @return [::Array<::Google::Cloud::AlloyDB::V1beta::SqlResultRow>]
31
+ # Rows returned by the SQL statement.
32
+ class SqlResult
33
+ include ::Google::Protobuf::MessageExts
34
+ extend ::Google::Protobuf::MessageExts::ClassMethods
35
+ end
36
+
37
+ # Contains the name and datatype of a column in a SQL Result.
38
+ # @!attribute [rw] name
39
+ # @return [::String]
40
+ # Name of the column.
41
+ # @!attribute [rw] type
42
+ # @return [::String]
43
+ # Datatype of the column as reported by the postgres driver.
44
+ # Common type names are "VARCHAR", "TEXT", "NVARCHAR", "DECIMAL", "BOOL",
45
+ # "INT", and "BIGINT".
46
+ class SqlResultColumn
47
+ include ::Google::Protobuf::MessageExts
48
+ extend ::Google::Protobuf::MessageExts::ClassMethods
49
+ end
50
+
51
+ # A single row from a sql result.
52
+ # @!attribute [rw] values
53
+ # @return [::Array<::Google::Cloud::AlloyDB::V1beta::SqlResultValue>]
54
+ # List of values in a row of sql result.
55
+ class SqlResultRow
56
+ include ::Google::Protobuf::MessageExts
57
+ extend ::Google::Protobuf::MessageExts::ClassMethods
58
+ end
59
+
60
+ # A single value in a row from a sql result.
61
+ # @!attribute [rw] value
62
+ # @return [::String]
63
+ # The cell value represented in string format.
64
+ # Timestamps are converted to string using RFC3339Nano format.
65
+ # @!attribute [rw] null_value
66
+ # @return [::Boolean]
67
+ # Set to true if cell value is null.
68
+ class SqlResultValue
69
+ include ::Google::Protobuf::MessageExts
70
+ extend ::Google::Protobuf::MessageExts::ClassMethods
71
+ end
72
+ end
73
+ end
74
+ end
75
+ end
@@ -0,0 +1,52 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2024 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module AlloyDB
23
+ module V1beta
24
+ # Cluster level configuration parameters related to the Gemini in Databases
25
+ # add-on.
26
+ # @!attribute [r] entitled
27
+ # @return [::Boolean]
28
+ # Output only. Whether the Gemini in Databases add-on is enabled for the
29
+ # cluster. It will be true only if the add-on has been enabled for the
30
+ # billing account corresponding to the cluster. Its status is toggled from
31
+ # the Admin Control Center (ACC) and cannot be toggled using AlloyDB's APIs.
32
+ class GeminiClusterConfig
33
+ include ::Google::Protobuf::MessageExts
34
+ extend ::Google::Protobuf::MessageExts::ClassMethods
35
+ end
36
+
37
+ # Instance level configuration parameters related to the Gemini in Databases
38
+ # add-on.
39
+ # @!attribute [r] entitled
40
+ # @return [::Boolean]
41
+ # Output only. Whether the Gemini in Databases add-on is enabled for the
42
+ # instance. It will be true only if the add-on has been enabled for the
43
+ # billing account corresponding to the instance. Its status is toggled from
44
+ # the Admin Control Center (ACC) and cannot be toggled using AlloyDB's APIs.
45
+ class GeminiInstanceConfig
46
+ include ::Google::Protobuf::MessageExts
47
+ extend ::Google::Protobuf::MessageExts::ClassMethods
48
+ end
49
+ end
50
+ end
51
+ end
52
+ end
@@ -114,7 +114,7 @@ module Google
114
114
 
115
115
  # SSL mode options.
116
116
  module SslMode
117
- # SSL mode not specified. Defaults to ENCRYPTED_ONLY.
117
+ # SSL mode is not specified. Defaults to ENCRYPTED_ONLY.
118
118
  SSL_MODE_UNSPECIFIED = 0
119
119
 
120
120
  # SSL connections are optional. CA verification not enforced.
@@ -126,7 +126,7 @@ module Google
126
126
  SSL_MODE_REQUIRE = 2
127
127
 
128
128
  # SSL connections are required. CA verification enforced.
129
- # Clients must have certificates signed by a Cluster CA, e.g. via
129
+ # Clients must have certificates signed by a Cluster CA, for example, using
130
130
  # GenerateClientCertificate.
131
131
  SSL_MODE_VERIFY_CA = 3
132
132
 
@@ -364,6 +364,9 @@ module Google
364
364
  # @!attribute [r] migration_source
365
365
  # @return [::Google::Cloud::AlloyDB::V1beta::MigrationSource]
366
366
  # Output only. Cluster created via DMS migration.
367
+ # @!attribute [r] cloudsql_backup_run_source
368
+ # @return [::Google::Cloud::AlloyDB::V1beta::CloudSQLBackupRunSource]
369
+ # Output only. Cluster created from CloudSQL snapshot.
367
370
  # @!attribute [r] name
368
371
  # @return [::String]
369
372
  # Output only. The name of the cluster resource with the format:
@@ -473,6 +476,10 @@ module Google
473
476
  # @!attribute [r] satisfies_pzs
474
477
  # @return [::Boolean]
475
478
  # Output only. Reserved for future use.
479
+ # @!attribute [rw] psc_config
480
+ # @return [::Google::Cloud::AlloyDB::V1beta::Cluster::PscConfig]
481
+ # Optional. The configuration for Private Service Connect (PSC) for the
482
+ # cluster.
476
483
  # @!attribute [rw] maintenance_update_policy
477
484
  # @return [::Google::Cloud::AlloyDB::V1beta::MaintenanceUpdatePolicy]
478
485
  # Optional. The maintenance update policy determines when to allow or deny
@@ -481,6 +488,24 @@ module Google
481
488
  # @return [::Google::Cloud::AlloyDB::V1beta::MaintenanceSchedule]
482
489
  # Output only. The maintenance schedule for the cluster, generated for a
483
490
  # specific rollout if a maintenance window is set.
491
+ # @!attribute [rw] gemini_config
492
+ # @return [::Google::Cloud::AlloyDB::V1beta::GeminiClusterConfig]
493
+ # Optional. Configuration parameters related to the Gemini in Databases
494
+ # add-on.
495
+ # @!attribute [rw] subscription_type
496
+ # @return [::Google::Cloud::AlloyDB::V1beta::SubscriptionType]
497
+ # Optional. Subscription type of the cluster.
498
+ # @!attribute [r] trial_metadata
499
+ # @return [::Google::Cloud::AlloyDB::V1beta::Cluster::TrialMetadata]
500
+ # Output only. Metadata for free trial clusters
501
+ # @!attribute [rw] tags
502
+ # @return [::Google::Protobuf::Map{::String => ::String}]
503
+ # Optional. Input only. Immutable. Tag keys/values directly bound to this
504
+ # resource. For example:
505
+ # ```
506
+ # "123/environment": "production",
507
+ # "123/costCenter": "marketing"
508
+ # ```
484
509
  class Cluster
485
510
  include ::Google::Protobuf::MessageExts
486
511
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -531,6 +556,34 @@ module Google
531
556
  extend ::Google::Protobuf::MessageExts::ClassMethods
532
557
  end
533
558
 
559
+ # PscConfig contains PSC related configuration at a cluster level.
560
+ # @!attribute [rw] psc_enabled
561
+ # @return [::Boolean]
562
+ # Optional. Create an instance that allows connections from Private Service
563
+ # Connect endpoints to the instance.
564
+ class PscConfig
565
+ include ::Google::Protobuf::MessageExts
566
+ extend ::Google::Protobuf::MessageExts::ClassMethods
567
+ end
568
+
569
+ # Contains information and all metadata related to TRIAL clusters.
570
+ # @!attribute [rw] start_time
571
+ # @return [::Google::Protobuf::Timestamp]
572
+ # start time of the trial cluster.
573
+ # @!attribute [rw] end_time
574
+ # @return [::Google::Protobuf::Timestamp]
575
+ # End time of the trial cluster.
576
+ # @!attribute [rw] upgrade_time
577
+ # @return [::Google::Protobuf::Timestamp]
578
+ # Upgrade time of trial cluster to Standard cluster.
579
+ # @!attribute [rw] grace_end_time
580
+ # @return [::Google::Protobuf::Timestamp]
581
+ # grace end time of the cluster.
582
+ class TrialMetadata
583
+ include ::Google::Protobuf::MessageExts
584
+ extend ::Google::Protobuf::MessageExts::ClassMethods
585
+ end
586
+
534
587
  # @!attribute [rw] key
535
588
  # @return [::String]
536
589
  # @!attribute [rw] value
@@ -549,6 +602,15 @@ module Google
549
602
  extend ::Google::Protobuf::MessageExts::ClassMethods
550
603
  end
551
604
 
605
+ # @!attribute [rw] key
606
+ # @return [::String]
607
+ # @!attribute [rw] value
608
+ # @return [::String]
609
+ class TagsEntry
610
+ include ::Google::Protobuf::MessageExts
611
+ extend ::Google::Protobuf::MessageExts::ClassMethods
612
+ end
613
+
552
614
  # Cluster State
553
615
  module State
554
616
  # The state of the cluster is unknown.
@@ -689,6 +751,9 @@ module Google
689
751
  # @!attribute [rw] query_insights_config
690
752
  # @return [::Google::Cloud::AlloyDB::V1beta::Instance::QueryInsightsInstanceConfig]
691
753
  # Configuration for query insights.
754
+ # @!attribute [rw] observability_config
755
+ # @return [::Google::Cloud::AlloyDB::V1beta::Instance::ObservabilityInstanceConfig]
756
+ # Configuration for observability.
692
757
  # @!attribute [rw] read_pool_config
693
758
  # @return [::Google::Cloud::AlloyDB::V1beta::Instance::ReadPoolConfig]
694
759
  # Read pool instance configuration.
@@ -735,7 +800,11 @@ module Google
735
800
  # instance.
736
801
  # @!attribute [rw] network_config
737
802
  # @return [::Google::Cloud::AlloyDB::V1beta::Instance::InstanceNetworkConfig]
738
- # Optional. Instance level network configuration.
803
+ # Optional. Instance-level network configuration.
804
+ # @!attribute [rw] gemini_config
805
+ # @return [::Google::Cloud::AlloyDB::V1beta::GeminiInstanceConfig]
806
+ # Optional. Configuration parameters related to the Gemini in Databases
807
+ # add-on.
739
808
  # @!attribute [r] outbound_public_ip_addresses
740
809
  # @return [::Array<::String>]
741
810
  # Output only. All outbound public IP addresses configured for the instance.
@@ -798,6 +867,51 @@ module Google
798
867
  extend ::Google::Protobuf::MessageExts::ClassMethods
799
868
  end
800
869
 
870
+ # Observability Instance specific configuration.
871
+ # @!attribute [rw] enabled
872
+ # @return [::Boolean]
873
+ # Observability feature status for an instance.
874
+ # This flag is turned "off" by default.
875
+ # @!attribute [rw] preserve_comments
876
+ # @return [::Boolean]
877
+ # Preserve comments in query string for an instance.
878
+ # This flag is turned "off" by default.
879
+ # @!attribute [rw] track_wait_events
880
+ # @return [::Boolean]
881
+ # Track wait events during query execution for an instance.
882
+ # This flag is turned "on" by default but tracking is enabled only after
883
+ # observability enabled flag is also turned on.
884
+ # @!attribute [r] track_wait_event_types
885
+ # @return [::Boolean]
886
+ # Output only. Track wait event types during query execution for an
887
+ # instance. This flag is turned "on" by default but tracking is enabled
888
+ # only after observability enabled flag is also turned on. This is
889
+ # read-only flag and only modifiable by producer API.
890
+ # @!attribute [rw] max_query_string_length
891
+ # @return [::Integer]
892
+ # Query string length. The default value is 10k.
893
+ # @!attribute [rw] record_application_tags
894
+ # @return [::Boolean]
895
+ # Record application tags for an instance.
896
+ # This flag is turned "off" by default.
897
+ # @!attribute [rw] query_plans_per_minute
898
+ # @return [::Integer]
899
+ # Number of query execution plans captured by Insights per minute
900
+ # for all queries combined. The default value is 200.
901
+ # Any integer between 0 to 200 is considered valid.
902
+ # @!attribute [rw] track_active_queries
903
+ # @return [::Boolean]
904
+ # Track actively running queries on the instance.
905
+ # If not set, this flag is "off" by default.
906
+ # @!attribute [rw] track_client_address
907
+ # @return [::Boolean]
908
+ # Track client address for an instance.
909
+ # If not set, default value is "off".
910
+ class ObservabilityInstanceConfig
911
+ include ::Google::Protobuf::MessageExts
912
+ extend ::Google::Protobuf::MessageExts::ClassMethods
913
+ end
914
+
801
915
  # Configuration for a read pool instance.
802
916
  # @!attribute [rw] node_count
803
917
  # @return [::Integer]
@@ -836,33 +950,12 @@ module Google
836
950
  # connections to the database.
837
951
  # @!attribute [rw] ssl_config
838
952
  # @return [::Google::Cloud::AlloyDB::V1beta::SslConfig]
839
- # Optional. SSL config option for this instance.
953
+ # Optional. SSL configuration option for this instance.
840
954
  class ClientConnectionConfig
841
955
  include ::Google::Protobuf::MessageExts
842
956
  extend ::Google::Protobuf::MessageExts::ClassMethods
843
957
  end
844
958
 
845
- # Configuration for setting up a PSC interface. This information needs to be
846
- # provided by the customer.
847
- # PSC interfaces will be created and added to VMs via SLM (adding a network
848
- # interface will require recreating the VM). For HA instances this will be
849
- # done via LDTM.
850
- # @!attribute [rw] consumer_endpoint_ips
851
- # @return [::Array<::String>]
852
- # A list of endpoints in the consumer VPC the interface might initiate
853
- # outbound connections to. This list has to be provided when the PSC
854
- # interface is created.
855
- # @!attribute [rw] network_attachment
856
- # @return [::String]
857
- # The NetworkAttachment resource created in the consumer VPC to which the
858
- # PSC interface will be linked, in the form of:
859
- # `projects/${CONSUMER_PROJECT}/regions/${REGION}/networkAttachments/${NETWORK_ATTACHMENT_NAME}`.
860
- # NetworkAttachment has to be provided when the PSC interface is created.
861
- class PscInterfaceConfig
862
- include ::Google::Protobuf::MessageExts
863
- extend ::Google::Protobuf::MessageExts::ClassMethods
864
- end
865
-
866
959
  # PscInstanceConfig contains PSC related configuration at an
867
960
  # instance level.
868
961
  # @!attribute [r] service_attachment_link
@@ -875,32 +968,16 @@ module Google
875
968
  # @return [::Array<::String>]
876
969
  # Optional. List of consumer projects that are allowed to create
877
970
  # PSC endpoints to service-attachments to this instance.
878
- # @!attribute [rw] allowed_consumer_networks
879
- # @return [::Array<::String>]
880
- # Optional. List of consumer networks that are allowed to create
881
- # PSC endpoints to service-attachments to this instance.
882
- # @!attribute [rw] psc_interface_configs
883
- # @return [::Array<::Google::Cloud::AlloyDB::V1beta::Instance::PscInterfaceConfig>]
884
- # Optional. Configurations for setting up PSC interfaces attached to the
885
- # instance which are used for outbound connectivity. Only primary instances
886
- # can have PSC interface attached. All the VMs created for the primary
887
- # instance will share the same configurations. Currently we only support 0
888
- # or 1 PSC interface.
889
- # @!attribute [rw] outgoing_service_attachment_links
890
- # @return [::Array<::String>]
891
- # Optional. List of service attachments that this instance has created
892
- # endpoints to connect with. Currently, only a single outgoing service
893
- # attachment is supported per instance.
894
- # @!attribute [rw] psc_enabled
895
- # @return [::Boolean]
896
- # Optional. Whether PSC connectivity is enabled for this instance.
897
- # This is populated by referencing the value from the parent cluster.
971
+ # @!attribute [r] psc_dns_name
972
+ # @return [::String]
973
+ # Output only. The DNS name of the instance for PSC connectivity.
974
+ # Name convention: <uid>.<uid>.<region>.alloydb-psc.goog
898
975
  class PscInstanceConfig
899
976
  include ::Google::Protobuf::MessageExts
900
977
  extend ::Google::Protobuf::MessageExts::ClassMethods
901
978
  end
902
979
 
903
- # Metadata related to instance level network configuration.
980
+ # Metadata related to instance-level network configuration.
904
981
  # @!attribute [rw] authorized_external_networks
905
982
  # @return [::Array<::Google::Cloud::AlloyDB::V1beta::Instance::InstanceNetworkConfig::AuthorizedNetwork>]
906
983
  # Optional. A list of external network authorized to access this instance.
@@ -1151,6 +1228,14 @@ module Google
1151
1228
  # Output only. The database engine major version of the cluster this backup
1152
1229
  # was created from. Any restored cluster created from this backup will have
1153
1230
  # the same database version.
1231
+ # @!attribute [rw] tags
1232
+ # @return [::Google::Protobuf::Map{::String => ::String}]
1233
+ # Optional. Input only. Immutable. Tag keys/values directly bound to this
1234
+ # resource. For example:
1235
+ # ```
1236
+ # "123/environment": "production",
1237
+ # "123/costCenter": "marketing"
1238
+ # ```
1154
1239
  class Backup
1155
1240
  include ::Google::Protobuf::MessageExts
1156
1241
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1199,6 +1284,15 @@ module Google
1199
1284
  extend ::Google::Protobuf::MessageExts::ClassMethods
1200
1285
  end
1201
1286
 
1287
+ # @!attribute [rw] key
1288
+ # @return [::String]
1289
+ # @!attribute [rw] value
1290
+ # @return [::String]
1291
+ class TagsEntry
1292
+ include ::Google::Protobuf::MessageExts
1293
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1294
+ end
1295
+
1202
1296
  # Backup State
1203
1297
  module State
1204
1298
  # The state of the backup is unknown.
@@ -1333,6 +1427,10 @@ module Google
1333
1427
  # @!attribute [rw] user_type
1334
1428
  # @return [::Google::Cloud::AlloyDB::V1beta::User::UserType]
1335
1429
  # Optional. Type of this user.
1430
+ # @!attribute [rw] keep_extra_roles
1431
+ # @return [::Boolean]
1432
+ # Input only. If the user already exists and it has additional roles, keep
1433
+ # them granted.
1336
1434
  class User
1337
1435
  include ::Google::Protobuf::MessageExts
1338
1436
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1417,6 +1515,24 @@ module Google
1417
1515
 
1418
1516
  # The database version is Postgres 15.
1419
1517
  POSTGRES_15 = 3
1518
+
1519
+ # The database version is Postgres 16.
1520
+ POSTGRES_16 = 4
1521
+ end
1522
+
1523
+ # Subscription_type added to distinguish between Standard and Trial
1524
+ # subscriptions. By default, a subscription type is considered STANDARD unless
1525
+ # explicitly specified.
1526
+ module SubscriptionType
1527
+ # This is an unknown subscription type. By default, the subscription type is
1528
+ # STANDARD.
1529
+ SUBSCRIPTION_TYPE_UNSPECIFIED = 0
1530
+
1531
+ # Standard subscription.
1532
+ STANDARD = 1
1533
+
1534
+ # Trial subscription.
1535
+ TRIAL = 2
1420
1536
  end
1421
1537
  end
1422
1538
  end