google-cloud-alloy_db-v1alpha 0.12.0 → 0.14.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.
Files changed (30) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/google/cloud/alloy_db/v1alpha/alloy_db_admin/client.rb +249 -4
  4. data/lib/google/cloud/alloy_db/v1alpha/alloy_db_admin/rest/client.rb +235 -4
  5. data/lib/google/cloud/alloy_db/v1alpha/alloy_db_admin/rest/service_stub.rb +124 -0
  6. data/lib/google/cloud/alloy_db/v1alpha/alloy_db_cloud_sql_admin/client.rb +519 -0
  7. data/lib/google/cloud/alloy_db/v1alpha/alloy_db_cloud_sql_admin/credentials.rb +47 -0
  8. data/lib/google/cloud/alloy_db/v1alpha/alloy_db_cloud_sql_admin/operations.rb +813 -0
  9. data/lib/google/cloud/alloy_db/v1alpha/alloy_db_cloud_sql_admin/paths.rb +128 -0
  10. data/lib/google/cloud/alloy_db/v1alpha/alloy_db_cloud_sql_admin/rest/client.rb +494 -0
  11. data/lib/google/cloud/alloy_db/v1alpha/alloy_db_cloud_sql_admin/rest/operations.rb +914 -0
  12. data/lib/google/cloud/alloy_db/v1alpha/alloy_db_cloud_sql_admin/rest/service_stub.rb +143 -0
  13. data/lib/google/cloud/alloy_db/v1alpha/alloy_db_cloud_sql_admin/rest.rb +54 -0
  14. data/lib/google/cloud/alloy_db/v1alpha/alloy_db_cloud_sql_admin.rb +56 -0
  15. data/lib/google/cloud/alloy_db/v1alpha/rest.rb +1 -0
  16. data/lib/google/cloud/alloy_db/v1alpha/version.rb +1 -1
  17. data/lib/google/cloud/alloy_db/v1alpha.rb +1 -0
  18. data/lib/google/cloud/alloydb/v1alpha/csql_service_pb.rb +53 -0
  19. data/lib/google/cloud/alloydb/v1alpha/csql_service_services_pb.rb +45 -0
  20. data/lib/google/cloud/alloydb/v1alpha/gemini_pb.rb +3 -1
  21. data/lib/google/cloud/alloydb/v1alpha/resources_pb.rb +9 -1
  22. data/lib/google/cloud/alloydb/v1alpha/service_pb.rb +10 -1
  23. data/lib/google/cloud/alloydb/v1alpha/service_services_pb.rb +6 -0
  24. data/proto_docs/google/cloud/alloydb/v1alpha/csql_service.rb +45 -0
  25. data/proto_docs/google/cloud/alloydb/v1alpha/gemini.rb +27 -12
  26. data/proto_docs/google/cloud/alloydb/v1alpha/resources.rb +229 -28
  27. data/proto_docs/google/cloud/alloydb/v1alpha/service.rb +186 -7
  28. data/proto_docs/google/type/date.rb +53 -0
  29. data/proto_docs/google/type/timeofday.rb +1 -1
  30. metadata +16 -3
@@ -181,8 +181,7 @@ module Google
181
181
  # @return [::Google::Cloud::AlloyDB::V1alpha::EncryptionConfig]
182
182
  # Optional. The encryption config can be specified to encrypt the
183
183
  # backups with a customer-managed encryption key (CMEK). When this field is
184
- # not specified, the backup will then use default encryption scheme to
185
- # protect the user data.
184
+ # not specified, the backup will use the cluster's encryption config.
186
185
  # @!attribute [rw] location
187
186
  # @return [::String]
188
187
  # The location where the backup will be stored. Currently, the only supported
@@ -265,8 +264,7 @@ module Google
265
264
  # @return [::Google::Cloud::AlloyDB::V1alpha::EncryptionConfig]
266
265
  # The encryption config can be specified to encrypt the
267
266
  # backups with a customer-managed encryption key (CMEK). When this field is
268
- # not specified, the backup will then use default encryption scheme to
269
- # protect the user data.
267
+ # not specified, the backup will use the cluster's encryption config.
270
268
  class ContinuousBackupConfig
271
269
  include ::Google::Protobuf::MessageExts
272
270
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -284,12 +282,19 @@ module Google
284
282
  # if ContinuousBackup is not enabled.
285
283
  # @!attribute [r] schedule
286
284
  # @return [::Array<::Google::Type::DayOfWeek>]
287
- # Output only. Days of the week on which a continuous backup is taken. Output
288
- # only field. Ignored if passed into the request.
285
+ # Output only. Days of the week on which a continuous backup is taken.
289
286
  # @!attribute [r] earliest_restorable_time
290
287
  # @return [::Google::Protobuf::Timestamp]
291
- # Output only. The earliest restorable time that can be restored to. Output
292
- # only field.
288
+ # Output only. The earliest restorable time that can be restored to. If
289
+ # continuous backups and recovery was recently enabled, the earliest
290
+ # restorable time is the creation time of the earliest eligible backup within
291
+ # this cluster's continuous backup recovery window. After a cluster has had
292
+ # continuous backups enabled for the duration of its recovery window, the
293
+ # earliest restorable time becomes "now minus the recovery window". For
294
+ # example, assuming a point in time recovery is attempted at 04/16/2025
295
+ # 3:23:00PM with a 14d recovery window, the earliest restorable time would be
296
+ # 04/02/2025 3:23:00PM. This field is only visible if the
297
+ # CLUSTER_VIEW_CONTINUOUS_BACKUP cluster view is provided.
293
298
  class ContinuousBackupInfo
294
299
  include ::Google::Protobuf::MessageExts
295
300
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -328,6 +333,9 @@ module Google
328
333
  # @!attribute [rw] maintenance_windows
329
334
  # @return [::Array<::Google::Cloud::AlloyDB::V1alpha::MaintenanceUpdatePolicy::MaintenanceWindow>]
330
335
  # Preferred windows to perform maintenance. Currently limited to 1.
336
+ # @!attribute [rw] deny_maintenance_periods
337
+ # @return [::Array<::Google::Cloud::AlloyDB::V1alpha::MaintenanceUpdatePolicy::DenyMaintenancePeriod>]
338
+ # Periods to deny maintenance. Currently limited to 1.
331
339
  class MaintenanceUpdatePolicy
332
340
  include ::Google::Protobuf::MessageExts
333
341
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -344,6 +352,32 @@ module Google
344
352
  include ::Google::Protobuf::MessageExts
345
353
  extend ::Google::Protobuf::MessageExts::ClassMethods
346
354
  end
355
+
356
+ # DenyMaintenancePeriod definition. Excepting emergencies, maintenance
357
+ # will not be scheduled to start within this deny period. The start_date must
358
+ # be less than the end_date.
359
+ # @!attribute [rw] start_date
360
+ # @return [::Google::Type::Date]
361
+ # Deny period start date.
362
+ # This can be:
363
+ # * A full date, with non-zero year, month and day values OR
364
+ # * A month and day value, with a zero year for recurring
365
+ # @!attribute [rw] end_date
366
+ # @return [::Google::Type::Date]
367
+ # Deny period end date.
368
+ # This can be:
369
+ # * A full date, with non-zero year, month and day values OR
370
+ # * A month and day value, with a zero year for recurring
371
+ # @!attribute [rw] time
372
+ # @return [::Google::Type::TimeOfDay]
373
+ # Time in UTC when the deny period starts on start_date and ends on
374
+ # end_date. This can be:
375
+ # * Full time OR
376
+ # * All zeros for 00:00:00 UTC
377
+ class DenyMaintenancePeriod
378
+ include ::Google::Protobuf::MessageExts
379
+ extend ::Google::Protobuf::MessageExts::ClassMethods
380
+ end
347
381
  end
348
382
 
349
383
  # MaintenanceSchedule stores the maintenance schedule generated from
@@ -502,9 +536,10 @@ module Google
502
536
  # Output only. The maintenance schedule for the cluster, generated for a
503
537
  # specific rollout if a maintenance window is set.
504
538
  # @!attribute [rw] gemini_config
539
+ # @deprecated This field is deprecated and may be removed in the next major version update.
505
540
  # @return [::Google::Cloud::AlloyDB::V1alpha::GeminiClusterConfig]
506
- # Optional. Configuration parameters related to the Gemini in Databases
507
- # add-on.
541
+ # Optional. Deprecated and unused. This field will be removed in the near
542
+ # future.
508
543
  # @!attribute [rw] subscription_type
509
544
  # @return [::Google::Cloud::AlloyDB::V1alpha::SubscriptionType]
510
545
  # Optional. Subscription type of the cluster.
@@ -519,6 +554,12 @@ module Google
519
554
  # "123/environment": "production",
520
555
  # "123/costCenter": "marketing"
521
556
  # ```
557
+ # @!attribute [r] service_account_email
558
+ # @return [::String]
559
+ # Output only. AlloyDB per-cluster service agent email. This service account
560
+ # is created per-cluster per-project, and is different from that of the
561
+ # primary service agent which is created per-project. The service account
562
+ # naming format is subject to change.
522
563
  class Cluster
523
564
  include ::Google::Protobuf::MessageExts
524
565
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -743,11 +784,13 @@ module Google
743
784
  # zone with available capacity.
744
785
  # @!attribute [rw] database_flags
745
786
  # @return [::Google::Protobuf::Map{::String => ::String}]
746
- # Database flags. Set at instance level.
747
- # * They are copied from primary instance on read instance creation.
748
- # * Read instances can set new or override existing flags that are relevant
749
- # for reads, e.g. for enabling columnar cache on a read instance. Flags
750
- # set on read instance may or may not be present on primary.
787
+ # Database flags. Set at the instance level.
788
+ # They are copied from the primary instance on secondary instance creation.
789
+ # Flags that have restrictions default to the value at primary
790
+ # instance on read instances during creation. Read instances can set new
791
+ # flags or override existing flags that are relevant for reads, for example,
792
+ # for enabling columnar cache on a read instance. Flags set on read instance
793
+ # might or might not be present on the primary instance.
751
794
  #
752
795
  #
753
796
  # This is a list of "key": "value" pairs.
@@ -822,12 +865,28 @@ module Google
822
865
  # @return [::Google::Cloud::AlloyDB::V1alpha::Instance::InstanceNetworkConfig]
823
866
  # Optional. Instance-level network configuration.
824
867
  # @!attribute [rw] gemini_config
868
+ # @deprecated This field is deprecated and may be removed in the next major version update.
825
869
  # @return [::Google::Cloud::AlloyDB::V1alpha::GeminiInstanceConfig]
826
- # Optional. Configuration parameters related to the Gemini in Databases
827
- # add-on.
870
+ # Optional. Deprecated and unused. This field will be removed in the near
871
+ # future.
828
872
  # @!attribute [r] outbound_public_ip_addresses
829
873
  # @return [::Array<::String>]
830
874
  # Output only. All outbound public IP addresses configured for the instance.
875
+ # @!attribute [rw] activation_policy
876
+ # @return [::Google::Cloud::AlloyDB::V1alpha::Instance::ActivationPolicy]
877
+ # Optional. Specifies whether an instance needs to spin up. Once the instance
878
+ # is active, the activation policy can be updated to the `NEVER` to stop the
879
+ # instance. Likewise, the activation policy can be updated to `ALWAYS` to
880
+ # start the instance.
881
+ # There are restrictions around when an instance can/cannot be activated (for
882
+ # example, a read pool instance should be stopped before stopping primary
883
+ # etc.). Please refer to the API documentation for more details.
884
+ # @!attribute [rw] connection_pool_config
885
+ # @return [::Google::Cloud::AlloyDB::V1alpha::Instance::ConnectionPoolConfig]
886
+ # Optional. The configuration for Managed Connection Pool (MCP).
887
+ # @!attribute [r] gca_config
888
+ # @return [::Google::Cloud::AlloyDB::V1alpha::GCAInstanceConfig]
889
+ # Output only. Configuration parameters related to Gemini Cloud Assist.
831
890
  class Instance
832
891
  include ::Google::Protobuf::MessageExts
833
892
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -836,27 +895,33 @@ module Google
836
895
  # @!attribute [rw] cpu_count
837
896
  # @return [::Integer]
838
897
  # The number of CPU's in the VM instance.
898
+ # @!attribute [rw] machine_type
899
+ # @return [::String]
900
+ # Machine type of the VM instance. E.g. "n2-highmem-4",
901
+ # "n2-highmem-8", "c4a-highmem-4-lssd".
902
+ # cpu_count must match the number of vCPUs in the machine type.
839
903
  class MachineConfig
840
904
  include ::Google::Protobuf::MessageExts
841
905
  extend ::Google::Protobuf::MessageExts::ClassMethods
842
906
  end
843
907
 
844
908
  # Details of a single node in the instance.
845
- # Nodes in an AlloyDB instance are ephemereal, they can change during
909
+ # Nodes in an AlloyDB instance are ephemeral, they can change during
846
910
  # update, failover, autohealing and resize operations.
847
- # @!attribute [rw] zone_id
911
+ # @!attribute [r] zone_id
848
912
  # @return [::String]
849
- # The Compute Engine zone of the VM e.g. "us-central1-b".
850
- # @!attribute [rw] id
913
+ # Output only. The Compute Engine zone of the VM e.g. "us-central1-b".
914
+ # @!attribute [r] id
851
915
  # @return [::String]
852
- # The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".
853
- # @!attribute [rw] ip
916
+ # Output only. The identifier of the VM e.g.
917
+ # "test-read-0601-407e52be-ms3l".
918
+ # @!attribute [r] ip
854
919
  # @return [::String]
855
- # The private IP address of the VM e.g. "10.57.0.34".
856
- # @!attribute [rw] state
920
+ # Output only. The private IP address of the VM e.g. "10.57.0.34".
921
+ # @!attribute [r] state
857
922
  # @return [::String]
858
- # Determined by state of the compute VM and postgres-service health.
859
- # Compute VM state can have values listed in
923
+ # Output only. Determined by state of the compute VM and postgres-service
924
+ # health. Compute VM state can have values listed in
860
925
  # https://cloud.google.com/compute/docs/instances/instance-life-cycle and
861
926
  # postgres-service health can have values: HEALTHY and UNHEALTHY.
862
927
  class Node
@@ -906,7 +971,7 @@ module Google
906
971
  # Output only. Track wait event types during query execution for an
907
972
  # instance. This flag is turned "on" by default but tracking is enabled
908
973
  # only after observability enabled flag is also turned on. This is
909
- # read-only flag and only modifiable by producer API.
974
+ # read-only flag and only modifiable by internal API.
910
975
  # @!attribute [rw] max_query_string_length
911
976
  # @return [::Integer]
912
977
  # Query string length. The default value is 10k.
@@ -927,6 +992,9 @@ module Google
927
992
  # @return [::Boolean]
928
993
  # Track client address for an instance.
929
994
  # If not set, default value is "off".
995
+ # @!attribute [rw] assistive_experiences_enabled
996
+ # @return [::Boolean]
997
+ # Whether assistive experiences are enabled for this AlloyDB instance.
930
998
  class ObservabilityInstanceConfig
931
999
  include ::Google::Protobuf::MessageExts
932
1000
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -989,6 +1057,56 @@ module Google
989
1057
  extend ::Google::Protobuf::MessageExts::ClassMethods
990
1058
  end
991
1059
 
1060
+ # Configuration for setting up PSC service automation. Consumer projects in
1061
+ # the configs will be allowlisted automatically for the instance.
1062
+ # @!attribute [rw] consumer_project
1063
+ # @return [::String]
1064
+ # The consumer project to which the PSC service automation endpoint will
1065
+ # be created.
1066
+ # @!attribute [rw] consumer_network
1067
+ # @return [::String]
1068
+ # The consumer network for the PSC service automation, example:
1069
+ # "projects/vpc-host-project/global/networks/default".
1070
+ # The consumer network might be hosted a different project than the
1071
+ # consumer project.
1072
+ # @!attribute [r] ip_address
1073
+ # @return [::String]
1074
+ # Output only. The IP address of the PSC service automation endpoint.
1075
+ # @!attribute [r] status
1076
+ # @return [::String]
1077
+ # Output only. The status of the PSC service automation connection.
1078
+ # Possible values:
1079
+ # "STATE_UNSPECIFIED" - An invalid state as the default case.
1080
+ # "ACTIVE" - The connection has been created successfully.
1081
+ # "FAILED" - The connection is not functional since some resources on the
1082
+ # connection fail to be created.
1083
+ # "CREATING" - The connection is being created.
1084
+ # "DELETING" - The connection is being deleted.
1085
+ # "CREATE_REPAIRING" - The connection is being repaired to complete
1086
+ # creation.
1087
+ # "DELETE_REPAIRING" - The connection is being repaired to complete
1088
+ # deletion.
1089
+ # @!attribute [r] consumer_network_status
1090
+ # @return [::String]
1091
+ # Output only. The status of the service connection policy.
1092
+ # Possible values:
1093
+ # "STATE_UNSPECIFIED" - Default state, when Connection Map is created
1094
+ # initially.
1095
+ # "VALID" - Set when policy and map configuration is valid, and their
1096
+ # matching can lead to allowing creation of PSC Connections subject to
1097
+ # other constraints like connections limit.
1098
+ # "CONNECTION_POLICY_MISSING" - No Service Connection Policy found for
1099
+ # this network and Service Class
1100
+ # "POLICY_LIMIT_REACHED" - Service Connection Policy limit reached for
1101
+ # this network and Service Class
1102
+ # "CONSUMER_INSTANCE_PROJECT_NOT_ALLOWLISTED" - The consumer instance
1103
+ # project is not in AllowedGoogleProducersResourceHierarchyLevels of the
1104
+ # matching ServiceConnectionPolicy.
1105
+ class PscAutoConnectionConfig
1106
+ include ::Google::Protobuf::MessageExts
1107
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1108
+ end
1109
+
992
1110
  # PscInstanceConfig contains PSC related configuration at an
993
1111
  # instance level.
994
1112
  # @!attribute [r] service_attachment_link
@@ -1011,6 +1129,9 @@ module Google
1011
1129
  # instance which are used for outbound connectivity. Only primary instances
1012
1130
  # can have PSC interface attached. Currently we only support 0 or 1 PSC
1013
1131
  # interface.
1132
+ # @!attribute [rw] psc_auto_connections
1133
+ # @return [::Array<::Google::Cloud::AlloyDB::V1alpha::Instance::PscAutoConnectionConfig>]
1134
+ # Optional. Configurations for setting up PSC service automation.
1014
1135
  class PscInstanceConfig
1015
1136
  include ::Google::Protobuf::MessageExts
1016
1137
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1027,6 +1148,22 @@ module Google
1027
1148
  # @return [::Boolean]
1028
1149
  # Optional. Enabling an outbound public IP address to support a database
1029
1150
  # server sending requests out into the internet.
1151
+ # @!attribute [r] network
1152
+ # @return [::String]
1153
+ # Output only. The resource link for the VPC network in which instance
1154
+ # resources are created and from which they are accessible via Private IP.
1155
+ # This will be the same value as the parent cluster's network. It is
1156
+ # specified in the form: //
1157
+ # `projects/{project_number}/global/networks/{network_id}`.
1158
+ # @!attribute [rw] allocated_ip_range_override
1159
+ # @return [::String]
1160
+ # Optional. Name of the allocated IP range for the private IP AlloyDB
1161
+ # instance, for example: "google-managed-services-default". If set, the
1162
+ # instance IPs will be created from this allocated range and will override
1163
+ # the IP range used by the parent cluster. The range name must comply with
1164
+ # [RFC 1035](http://datatracker.ietf.org/doc/html/rfc1035). Specifically,
1165
+ # the name must be 1-63 characters long and match the regular expression
1166
+ # [a-z]([-a-z0-9]*[a-z0-9])?.
1030
1167
  class InstanceNetworkConfig
1031
1168
  include ::Google::Protobuf::MessageExts
1032
1169
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1041,6 +1178,27 @@ module Google
1041
1178
  end
1042
1179
  end
1043
1180
 
1181
+ # Configuration for Managed Connection Pool (MCP).
1182
+ # @!attribute [rw] enabled
1183
+ # @return [::Boolean]
1184
+ # Optional. Whether to enable Managed Connection Pool (MCP).
1185
+ class ConnectionPoolConfig
1186
+ include ::Google::Protobuf::MessageExts
1187
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1188
+
1189
+ # The pool mode. Defaults to `POOL_MODE_TRANSACTION`.
1190
+ module PoolMode
1191
+ # The pool mode is not specified. Defaults to `POOL_MODE_TRANSACTION`.
1192
+ POOL_MODE_UNSPECIFIED = 0
1193
+
1194
+ # Server is released back to pool after a client disconnects.
1195
+ POOL_MODE_SESSION = 1
1196
+
1197
+ # Server is released back to pool after a transaction finishes.
1198
+ POOL_MODE_TRANSACTION = 2
1199
+ end
1200
+ end
1201
+
1044
1202
  # @!attribute [rw] key
1045
1203
  # @return [::String]
1046
1204
  # @!attribute [rw] value
@@ -1140,6 +1298,18 @@ module Google
1140
1298
  # Regional (or Highly) available instance.
1141
1299
  REGIONAL = 2
1142
1300
  end
1301
+
1302
+ # Specifies whether an instance needs to spin up.
1303
+ module ActivationPolicy
1304
+ # The policy is not specified.
1305
+ ACTIVATION_POLICY_UNSPECIFIED = 0
1306
+
1307
+ # The instance is running.
1308
+ ALWAYS = 1
1309
+
1310
+ # The instance is not running.
1311
+ NEVER = 2
1312
+ end
1143
1313
  end
1144
1314
 
1145
1315
  # ConnectionInfo singleton resource.
@@ -1200,9 +1370,15 @@ module Google
1200
1370
  # @!attribute [r] update_time
1201
1371
  # @return [::Google::Protobuf::Timestamp]
1202
1372
  # Output only. Update time stamp
1373
+ #
1374
+ # Users should not infer any meaning from this field. Its value is generally
1375
+ # unrelated to the timing of the backup creation operation.
1203
1376
  # @!attribute [r] delete_time
1204
1377
  # @return [::Google::Protobuf::Timestamp]
1205
1378
  # Output only. Delete time stamp
1379
+ # @!attribute [r] create_completion_time
1380
+ # @return [::Google::Protobuf::Timestamp]
1381
+ # Output only. Timestamp when the resource finished being created.
1206
1382
  # @!attribute [rw] labels
1207
1383
  # @return [::Google::Protobuf::Map{::String => ::String}]
1208
1384
  # Labels as key value pairs
@@ -1387,6 +1563,16 @@ module Google
1387
1563
  # Restriction on INTEGER type value.
1388
1564
  #
1389
1565
  # Note: The following fields are mutually exclusive: `integer_restrictions`, `string_restrictions`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1566
+ # @!attribute [rw] recommended_string_value
1567
+ # @return [::String]
1568
+ # The recommended value for a STRING flag.
1569
+ #
1570
+ # Note: The following fields are mutually exclusive: `recommended_string_value`, `recommended_integer_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1571
+ # @!attribute [rw] recommended_integer_value
1572
+ # @return [::Google::Protobuf::Int64Value]
1573
+ # The recommended value for an INTEGER flag.
1574
+ #
1575
+ # Note: The following fields are mutually exclusive: `recommended_integer_value`, `recommended_string_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1390
1576
  # @!attribute [rw] name
1391
1577
  # @return [::String]
1392
1578
  # The name of the flag resource, following Google Cloud conventions, e.g.:
@@ -1411,6 +1597,9 @@ module Google
1411
1597
  # restart. If a flag that requires database restart is set, the backend
1412
1598
  # will automatically restart the database (making sure to satisfy any
1413
1599
  # availability SLO's).
1600
+ # @!attribute [rw] scope
1601
+ # @return [::Google::Cloud::AlloyDB::V1alpha::SupportedDatabaseFlag::Scope]
1602
+ # The scope of the flag.
1414
1603
  class SupportedDatabaseFlag
1415
1604
  include ::Google::Protobuf::MessageExts
1416
1605
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1456,6 +1645,18 @@ module Google
1456
1645
  # Denotes that the flag does not accept any values.
1457
1646
  NONE = 4
1458
1647
  end
1648
+
1649
+ # The scope of the flag.
1650
+ module Scope
1651
+ # The scope of the flag is not specified. Default is DATABASE.
1652
+ SCOPE_UNSPECIFIED = 0
1653
+
1654
+ # The flag is a database flag.
1655
+ DATABASE = 1
1656
+
1657
+ # The flag is a connection pool flag.
1658
+ CONNECTION_POOL = 2
1659
+ end
1459
1660
  end
1460
1661
 
1461
1662
  # Message describing User object.
@@ -186,6 +186,179 @@ module Google
186
186
  extend ::Google::Protobuf::MessageExts::ClassMethods
187
187
  end
188
188
 
189
+ # Destination for Export. Export will be done to cloud storage.
190
+ # @!attribute [rw] uri
191
+ # @return [::String]
192
+ # Required. The path to the file in Google Cloud Storage where the export
193
+ # will be stored. The URI is in the form `gs://bucketName/fileName`.
194
+ class GcsDestination
195
+ include ::Google::Protobuf::MessageExts
196
+ extend ::Google::Protobuf::MessageExts::ClassMethods
197
+ end
198
+
199
+ # Export cluster request.
200
+ # @!attribute [rw] gcs_destination
201
+ # @return [::Google::Cloud::AlloyDB::V1alpha::GcsDestination]
202
+ # Required. Option to export data to cloud storage.
203
+ # @!attribute [rw] csv_export_options
204
+ # @return [::Google::Cloud::AlloyDB::V1alpha::ExportClusterRequest::CsvExportOptions]
205
+ # Options for exporting data in CSV format. Required field to be set for
206
+ # CSV file type.
207
+ #
208
+ # Note: The following fields are mutually exclusive: `csv_export_options`, `sql_export_options`. If a field in that set is populated, all other fields in the set will automatically be cleared.
209
+ # @!attribute [rw] sql_export_options
210
+ # @return [::Google::Cloud::AlloyDB::V1alpha::ExportClusterRequest::SqlExportOptions]
211
+ # Options for exporting data in SQL format. Required field to be set for
212
+ # SQL file type.
213
+ #
214
+ # Note: The following fields are mutually exclusive: `sql_export_options`, `csv_export_options`. If a field in that set is populated, all other fields in the set will automatically be cleared.
215
+ # @!attribute [rw] name
216
+ # @return [::String]
217
+ # Required. The resource name of the cluster.
218
+ # @!attribute [rw] database
219
+ # @return [::String]
220
+ # Required. Name of the database where the export command will be executed.
221
+ # Note - Value provided should be the same as expected from
222
+ # `SELECT current_database();` and NOT as a resource reference.
223
+ class ExportClusterRequest
224
+ include ::Google::Protobuf::MessageExts
225
+ extend ::Google::Protobuf::MessageExts::ClassMethods
226
+
227
+ # Options for exporting data in CSV format.
228
+ # @!attribute [rw] select_query
229
+ # @return [::String]
230
+ # Required. The SELECT query used to extract the data.
231
+ # @!attribute [rw] field_delimiter
232
+ # @return [::String]
233
+ # Optional. Specifies the character that separates columns within each row
234
+ # (line) of the file. The default is comma. The value of this argument has
235
+ # to be a character in Hex ASCII Code.
236
+ # @!attribute [rw] quote_character
237
+ # @return [::String]
238
+ # Optional. Specifies the quoting character to be used when a data value is
239
+ # quoted. The default is double-quote. The value of this argument has to be
240
+ # a character in Hex ASCII Code.
241
+ # @!attribute [rw] escape_character
242
+ # @return [::String]
243
+ # Optional. Specifies the character that should appear before a data
244
+ # character that needs to be escaped. The default is the same as quote
245
+ # character. The value of this argument has to be a character in Hex ASCII
246
+ # Code.
247
+ class CsvExportOptions
248
+ include ::Google::Protobuf::MessageExts
249
+ extend ::Google::Protobuf::MessageExts::ClassMethods
250
+ end
251
+
252
+ # Options for exporting data in SQL format.
253
+ # @!attribute [rw] tables
254
+ # @return [::Array<::String>]
255
+ # Optional. Tables to export from.
256
+ # @!attribute [rw] schema_only
257
+ # @return [::Boolean]
258
+ # Optional. If true, only export the schema.
259
+ # @!attribute [rw] clean_target_objects
260
+ # @return [::Boolean]
261
+ # Optional. If true, output commands to DROP all the dumped database
262
+ # objects prior to outputting the commands for creating them.
263
+ # @!attribute [rw] if_exist_target_objects
264
+ # @return [::Boolean]
265
+ # Optional. If true, use DROP ... IF EXISTS commands to check for the
266
+ # object's existence before dropping it in clean_target_objects mode.
267
+ class SqlExportOptions
268
+ include ::Google::Protobuf::MessageExts
269
+ extend ::Google::Protobuf::MessageExts::ClassMethods
270
+ end
271
+ end
272
+
273
+ # Response of export cluster rpc.
274
+ # @!attribute [rw] gcs_destination
275
+ # @return [::Google::Cloud::AlloyDB::V1alpha::GcsDestination]
276
+ # Required. Option to export data to cloud storage.
277
+ class ExportClusterResponse
278
+ include ::Google::Protobuf::MessageExts
279
+ extend ::Google::Protobuf::MessageExts::ClassMethods
280
+ end
281
+
282
+ # Import cluster request.
283
+ # @!attribute [rw] sql_import_options
284
+ # @return [::Google::Cloud::AlloyDB::V1alpha::ImportClusterRequest::SqlImportOptions]
285
+ # Options for importing data in SQL format.
286
+ #
287
+ # Note: The following fields are mutually exclusive: `sql_import_options`, `csv_import_options`. If a field in that set is populated, all other fields in the set will automatically be cleared.
288
+ # @!attribute [rw] csv_import_options
289
+ # @return [::Google::Cloud::AlloyDB::V1alpha::ImportClusterRequest::CsvImportOptions]
290
+ # Options for importing data in CSV format.
291
+ #
292
+ # Note: The following fields are mutually exclusive: `csv_import_options`, `sql_import_options`. If a field in that set is populated, all other fields in the set will automatically be cleared.
293
+ # @!attribute [rw] name
294
+ # @return [::String]
295
+ # Required. The resource name of the cluster.
296
+ # @!attribute [rw] gcs_uri
297
+ # @return [::String]
298
+ # Required. The path to the file in Google Cloud Storage where the source
299
+ # file for import will be stored. The URI is in the form
300
+ # `gs://bucketName/fileName`.
301
+ # @!attribute [rw] database
302
+ # @return [::String]
303
+ # Optional. Name of the database to which the import will be done.
304
+ # For import from SQL file, this is required only if the file does not
305
+ # specify a database.
306
+ # Note - Value provided should be the same as expected from `SELECT
307
+ # current_database();` and NOT as a resource reference.
308
+ # @!attribute [rw] user
309
+ # @return [::String]
310
+ # Optional. Database user to be used for importing the data.
311
+ # Note - Value provided should be the same as expected from
312
+ # `SELECT current_user;` and NOT as a resource reference.
313
+ class ImportClusterRequest
314
+ include ::Google::Protobuf::MessageExts
315
+ extend ::Google::Protobuf::MessageExts::ClassMethods
316
+
317
+ # Options for importing data in SQL format.
318
+ class SqlImportOptions
319
+ include ::Google::Protobuf::MessageExts
320
+ extend ::Google::Protobuf::MessageExts::ClassMethods
321
+ end
322
+
323
+ # Options for importing data in CSV format.
324
+ # @!attribute [rw] table
325
+ # @return [::String]
326
+ # Required. The database table to import CSV file into.
327
+ # @!attribute [rw] columns
328
+ # @return [::Array<::String>]
329
+ # Optional. The columns to which CSV data is imported. If not specified,
330
+ # all columns of the database table are loaded with CSV data.
331
+ # @!attribute [rw] field_delimiter
332
+ # @return [::String]
333
+ # Optional. Specifies the character that separates columns within each row
334
+ # (line) of the file. The default is comma. The value of this argument has
335
+ # to be a character in Hex ASCII Code.
336
+ # @!attribute [rw] quote_character
337
+ # @return [::String]
338
+ # Optional. Specifies the quoting character to be used when a data value is
339
+ # quoted. The default is double-quote. The value of this argument has to be
340
+ # a character in Hex ASCII Code.
341
+ # @!attribute [rw] escape_character
342
+ # @return [::String]
343
+ # Optional. Specifies the character that should appear before a data
344
+ # character that needs to be escaped. The default is same as quote
345
+ # character. The value of this argument has to be a character in Hex ASCII
346
+ # Code.
347
+ class CsvImportOptions
348
+ include ::Google::Protobuf::MessageExts
349
+ extend ::Google::Protobuf::MessageExts::ClassMethods
350
+ end
351
+ end
352
+
353
+ # Response of import rpc.
354
+ # @!attribute [rw] bytes_downloaded
355
+ # @return [::Integer]
356
+ # Required. Size of the object downloaded from Google Cloud Storage in bytes.
357
+ class ImportClusterResponse
358
+ include ::Google::Protobuf::MessageExts
359
+ extend ::Google::Protobuf::MessageExts::ClassMethods
360
+ end
361
+
189
362
  # Upgrades a cluster.
190
363
  # @!attribute [rw] name
191
364
  # @return [::String]
@@ -256,7 +429,7 @@ module Google
256
429
  extend ::Google::Protobuf::MessageExts::ClassMethods
257
430
  end
258
431
 
259
- # Details regarding the upgrade of instaces associated with a cluster.
432
+ # Details regarding the upgrade of instances associated with a cluster.
260
433
  # @!attribute [rw] name
261
434
  # @return [::String]
262
435
  # Normalized name of the instance.
@@ -457,6 +630,7 @@ module Google
457
630
 
458
631
  # Message for restoring a Cluster from a backup or another cluster at a given
459
632
  # point in time.
633
+ # NEXT_ID: 11
460
634
  # @!attribute [rw] backup_source
461
635
  # @return [::Google::Cloud::AlloyDB::V1alpha::BackupSource]
462
636
  # Backup source.
@@ -1211,6 +1385,10 @@ module Google
1211
1385
  # @!attribute [rw] page_token
1212
1386
  # @return [::String]
1213
1387
  # A token identifying a page of results the server should return.
1388
+ # @!attribute [rw] scope
1389
+ # @return [::Google::Cloud::AlloyDB::V1alpha::SupportedDatabaseFlag::Scope]
1390
+ # Optional. The scope for which supported flags are requested. If not
1391
+ # specified, default is DATABASE.
1214
1392
  class ListSupportedDatabaseFlagsRequest
1215
1393
  include ::Google::Protobuf::MessageExts
1216
1394
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1266,9 +1444,9 @@ module Google
1266
1444
  # Optional. The public key from the client.
1267
1445
  # @!attribute [rw] use_metadata_exchange
1268
1446
  # @return [::Boolean]
1269
- # Optional. An optional hint to the endpoint to generate a client
1270
- # ceritificate that can be used by AlloyDB connectors to exchange additional
1271
- # metadata with the server after TLS handshake.
1447
+ # Optional. An optional hint to the endpoint to generate a client certificate
1448
+ # that can be used by AlloyDB connectors to exchange additional metadata with
1449
+ # the server after TLS handshake.
1272
1450
  class GenerateClientCertificateRequest
1273
1451
  include ::Google::Protobuf::MessageExts
1274
1452
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1351,9 +1529,10 @@ module Google
1351
1529
  # @return [::Boolean]
1352
1530
  # Output only. Identifies whether the user has requested cancellation
1353
1531
  # of the operation. Operations that have successfully been cancelled
1354
- # have [Operation.error][] value with a
1355
- # {::Google::Rpc::Status#code google.rpc.Status.code} of 1, corresponding to
1356
- # `Code.CANCELLED`.
1532
+ # have
1533
+ # {::Google::Longrunning::Operation#error google.longrunning.Operation.error}
1534
+ # value with a {::Google::Rpc::Status#code google.rpc.Status.code} of 1,
1535
+ # corresponding to `Code.CANCELLED`.
1357
1536
  # @!attribute [r] api_version
1358
1537
  # @return [::String]
1359
1538
  # Output only. API version used to start the operation.