google-cloud-cloud_dms-v1 0.3.0 → 0.5.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -98,8 +98,8 @@ module Google
98
98
  # object.
99
99
  # @!attribute [rw] request_id
100
100
  # @return [::String]
101
- # A unique ID used to identify the request. If the server receives two
102
- # requests with the same ID, then the second request is ignored.
101
+ # Optional. A unique ID used to identify the request. If the server receives
102
+ # two requests with the same ID, then the second request is ignored.
103
103
  #
104
104
  # It is recommended to always set this value to a UUID.
105
105
  #
@@ -159,6 +159,10 @@ module Google
159
159
  # @!attribute [rw] name
160
160
  # @return [::String]
161
161
  # Name of the migration job resource to start.
162
+ # @!attribute [rw] skip_validation
163
+ # @return [::Boolean]
164
+ # Optional. Start the migration job without running prior configuration
165
+ # verification. Defaults to `false`.
162
166
  class StartMigrationJobRequest
163
167
  include ::Google::Protobuf::MessageExts
164
168
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -195,6 +199,14 @@ module Google
195
199
  # @!attribute [rw] name
196
200
  # @return [::String]
197
201
  # Name of the migration job resource to verify.
202
+ # @!attribute [rw] update_mask
203
+ # @return [::Google::Protobuf::FieldMask]
204
+ # Optional. Field mask is used to specify the changed fields to be verified.
205
+ # It will not update the migration job.
206
+ # @!attribute [rw] migration_job
207
+ # @return [::Google::Cloud::CloudDMS::V1::MigrationJob]
208
+ # Optional. The changed migration job parameters to verify.
209
+ # It will not update the migration job.
198
210
  class VerifyMigrationJobRequest
199
211
  include ::Google::Protobuf::MessageExts
200
212
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -204,6 +216,10 @@ module Google
204
216
  # @!attribute [rw] name
205
217
  # @return [::String]
206
218
  # Name of the migration job resource to restart.
219
+ # @!attribute [rw] skip_validation
220
+ # @return [::Boolean]
221
+ # Optional. Restart the migration job without running prior configuration
222
+ # verification. Defaults to `false`.
207
223
  class RestartMigrationJobRequest
208
224
  include ::Google::Protobuf::MessageExts
209
225
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -263,6 +279,42 @@ module Google
263
279
  extend ::Google::Protobuf::MessageExts::ClassMethods
264
280
  end
265
281
 
282
+ # Request message for 'GenerateTcpProxyScript' request.
283
+ # @!attribute [rw] migration_job
284
+ # @return [::String]
285
+ # Name of the migration job resource to generate the TCP Proxy script.
286
+ # @!attribute [rw] vm_name
287
+ # @return [::String]
288
+ # Required. The name of the Compute instance that will host the proxy.
289
+ # @!attribute [rw] vm_machine_type
290
+ # @return [::String]
291
+ # Required. The type of the Compute instance that will host the proxy.
292
+ # @!attribute [rw] vm_zone
293
+ # @return [::String]
294
+ # Optional. The Google Cloud Platform zone to create the VM in. The fully
295
+ # qualified name of the zone must be specified, including the region name,
296
+ # for example "us-central1-b". If not specified, uses the "-b" zone of the
297
+ # destination Connection Profile's region.
298
+ # @!attribute [rw] vm_subnet
299
+ # @return [::String]
300
+ # Required. The name of the subnet the Compute instance will use for private
301
+ # connectivity. Must be supplied in the form of
302
+ # projects/\\{project}/regions/\\{region}/subnetworks/\\{subnetwork}.
303
+ # Note: the region for the subnet must match the Compute instance region.
304
+ class GenerateTcpProxyScriptRequest
305
+ include ::Google::Protobuf::MessageExts
306
+ extend ::Google::Protobuf::MessageExts::ClassMethods
307
+ end
308
+
309
+ # Response message for 'GenerateTcpProxyScript' request.
310
+ # @!attribute [rw] script
311
+ # @return [::String]
312
+ # The TCP Proxy configuration script.
313
+ class TcpProxyScript
314
+ include ::Google::Protobuf::MessageExts
315
+ extend ::Google::Protobuf::MessageExts::ClassMethods
316
+ end
317
+
266
318
  # Request message for 'ListConnectionProfiles' request.
267
319
  # @!attribute [rw] parent
268
320
  # @return [::String]
@@ -664,6 +716,10 @@ module Google
664
716
  #
665
717
  # The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores
666
718
  # (_), and hyphens (-). The maximum length is 40 characters.
719
+ # @!attribute [rw] force
720
+ # @return [::Boolean]
721
+ # Force delete the conversion workspace, even if there's a running migration
722
+ # that is using the workspace.
667
723
  class DeleteConversionWorkspaceRequest
668
724
  include ::Google::Protobuf::MessageExts
669
725
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -700,14 +756,74 @@ module Google
700
756
  # @return [::String]
701
757
  # Filter which entities to apply. Leaving this field empty will apply all of
702
758
  # the entities. Supports Google AIP 160 based filtering.
759
+ # @!attribute [rw] dry_run
760
+ # @return [::Boolean]
761
+ # Optional. Only validates the apply process, but doesn't change the
762
+ # destination database. Only works for PostgreSQL destination connection
763
+ # profile.
764
+ # @!attribute [rw] auto_commit
765
+ # @return [::Boolean]
766
+ # Optional. Specifies whether the conversion workspace is to be committed
767
+ # automatically after the apply.
703
768
  # @!attribute [rw] connection_profile
704
769
  # @return [::String]
705
- # Fully qualified (Uri) name of the destination connection profile.
770
+ # Optional. Fully qualified (Uri) name of the destination connection
771
+ # profile.
706
772
  class ApplyConversionWorkspaceRequest
707
773
  include ::Google::Protobuf::MessageExts
708
774
  extend ::Google::Protobuf::MessageExts::ClassMethods
709
775
  end
710
776
 
777
+ # Retrieve a list of all mapping rules in a given conversion workspace.
778
+ # @!attribute [rw] parent
779
+ # @return [::String]
780
+ # Required. Name of the conversion workspace resource whose mapping rules are
781
+ # listed in the form of:
782
+ # projects/\\{project}/locations/\\{location}/conversionWorkspaces/\\{conversion_workspace}.
783
+ # @!attribute [rw] page_size
784
+ # @return [::Integer]
785
+ # The maximum number of rules to return. The service may return
786
+ # fewer than this value.
787
+ # @!attribute [rw] page_token
788
+ # @return [::String]
789
+ # The nextPageToken value received in the previous call to
790
+ # mappingRules.list, used in the subsequent request to retrieve the next
791
+ # page of results. On first call this should be left blank. When paginating,
792
+ # all other parameters provided to mappingRules.list must match the call
793
+ # that provided the page token.
794
+ class ListMappingRulesRequest
795
+ include ::Google::Protobuf::MessageExts
796
+ extend ::Google::Protobuf::MessageExts::ClassMethods
797
+ end
798
+
799
+ # Response message for 'ListMappingRulesRequest' request.
800
+ # @!attribute [rw] mapping_rules
801
+ # @return [::Array<::Google::Cloud::CloudDMS::V1::MappingRule>]
802
+ # The list of conversion workspace mapping rules.
803
+ # @!attribute [rw] next_page_token
804
+ # @return [::String]
805
+ # A token which can be sent as `page_token` to retrieve the next page.
806
+ # If this field is omitted, there are no subsequent pages.
807
+ class ListMappingRulesResponse
808
+ include ::Google::Protobuf::MessageExts
809
+ extend ::Google::Protobuf::MessageExts::ClassMethods
810
+ end
811
+
812
+ # Request message for 'GetMappingRule' request.
813
+ # @!attribute [rw] name
814
+ # @return [::String]
815
+ # Required. Name of the mapping rule resource to get.
816
+ # Example: conversionWorkspaces/123/mappingRules/rule123
817
+ #
818
+ # In order to retrieve a previous revision of the mapping rule, also provide
819
+ # the revision ID.
820
+ # Example:
821
+ # conversionWorkspace/123/mappingRules/rule123@c7cfa2a8c7cfa2a8c7cfa2a8c7cfa2a8
822
+ class GetMappingRuleRequest
823
+ include ::Google::Protobuf::MessageExts
824
+ extend ::Google::Protobuf::MessageExts::ClassMethods
825
+ end
826
+
711
827
  # Request message for 'SeedConversionWorkspace' request.
712
828
  # @!attribute [rw] name
713
829
  # @return [::String]
@@ -720,10 +836,11 @@ module Google
720
836
  # seed operation.
721
837
  # @!attribute [rw] source_connection_profile
722
838
  # @return [::String]
723
- # Fully qualified (Uri) name of the source connection profile.
839
+ # Optional. Fully qualified (Uri) name of the source connection profile.
724
840
  # @!attribute [rw] destination_connection_profile
725
841
  # @return [::String]
726
- # Fully qualified (Uri) name of the destination connection profile.
842
+ # Optional. Fully qualified (Uri) name of the destination connection
843
+ # profile.
727
844
  class SeedConversionWorkspaceRequest
728
845
  include ::Google::Protobuf::MessageExts
729
846
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -736,12 +853,17 @@ module Google
736
853
  # projects/\\{project}/locations/\\{location}/conversionWorkspaces/\\{conversion_workspace}.
737
854
  # @!attribute [rw] auto_commit
738
855
  # @return [::Boolean]
739
- # Specifies whether the conversion workspace is to be committed automatically
740
- # after the conversion.
856
+ # Optional. Specifies whether the conversion workspace is to be committed
857
+ # automatically after the conversion.
741
858
  # @!attribute [rw] filter
742
859
  # @return [::String]
743
- # Filter the entities to convert. Leaving this field empty will convert all
744
- # of the entities. Supports Google AIP-160 style filtering.
860
+ # Optional. Filter the entities to convert. Leaving this field empty will
861
+ # convert all of the entities. Supports Google AIP-160 style filtering.
862
+ # @!attribute [rw] convert_full_path
863
+ # @return [::Boolean]
864
+ # Optional. Automatically convert the full entity path for each entity
865
+ # specified by the filter. For example, if the filter specifies a table, that
866
+ # table schema (and database if there is one) will also be converted.
745
867
  class ConvertConversionWorkspaceRequest
746
868
  include ::Google::Protobuf::MessageExts
747
869
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -755,14 +877,14 @@ module Google
755
877
  # projects/\\{project}/locations/\\{location}/conversionWorkspaces/\\{conversion_workspace}.
756
878
  # @!attribute [rw] rules_format
757
879
  # @return [::Google::Cloud::CloudDMS::V1::ImportRulesFileFormat]
758
- # The format of the rules content file.
880
+ # Required. The format of the rules content file.
759
881
  # @!attribute [rw] rules_files
760
882
  # @return [::Array<::Google::Cloud::CloudDMS::V1::ImportMappingRulesRequest::RulesFile>]
761
- # One or more rules files.
883
+ # Required. One or more rules files.
762
884
  # @!attribute [rw] auto_commit
763
885
  # @return [::Boolean]
764
- # Should the conversion workspace be committed automatically after the
765
- # import operation.
886
+ # Required. Should the conversion workspace be committed automatically after
887
+ # the import operation.
766
888
  class ImportMappingRulesRequest
767
889
  include ::Google::Protobuf::MessageExts
768
890
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -770,12 +892,12 @@ module Google
770
892
  # Details of a single rules file.
771
893
  # @!attribute [rw] rules_source_filename
772
894
  # @return [::String]
773
- # The filename of the rules that needs to be converted. The filename is
774
- # used mainly so that future logs of the import rules job contain it, and
775
- # can therefore be searched by it.
895
+ # Required. The filename of the rules that needs to be converted. The
896
+ # filename is used mainly so that future logs of the import rules job
897
+ # contain it, and can therefore be searched by it.
776
898
  # @!attribute [rw] rules_content
777
899
  # @return [::String]
778
- # The text content of the rules that needs to be converted.
900
+ # Required. The text content of the rules that needs to be converted.
779
901
  class RulesFile
780
902
  include ::Google::Protobuf::MessageExts
781
903
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -790,11 +912,11 @@ module Google
790
912
  # projects/\\{project}/locations/\\{location}/conversionWorkspaces/\\{conversion_workspace}.
791
913
  # @!attribute [rw] page_size
792
914
  # @return [::Integer]
793
- # The maximum number of entities to return. The service may return
915
+ # Optional. The maximum number of entities to return. The service may return
794
916
  # fewer entities than the value specifies.
795
917
  # @!attribute [rw] page_token
796
918
  # @return [::String]
797
- # The nextPageToken value received in the previous call to
919
+ # Optional. The nextPageToken value received in the previous call to
798
920
  # conversionWorkspace.describeDatabaseEntities, used in the subsequent
799
921
  # request to retrieve the next page of results. On first call this should be
800
922
  # left blank. When paginating, all other parameters provided to
@@ -802,18 +924,22 @@ module Google
802
924
  # provided the page token.
803
925
  # @!attribute [rw] tree
804
926
  # @return [::Google::Cloud::CloudDMS::V1::DescribeDatabaseEntitiesRequest::DBTreeType]
805
- # The tree to fetch.
927
+ # Required. The tree to fetch.
806
928
  # @!attribute [rw] uncommitted
807
929
  # @return [::Boolean]
808
- # Whether to retrieve the latest committed version of the entities or the
809
- # latest version. This field is ignored if a specific commit_id is specified.
930
+ # Optional. Whether to retrieve the latest committed version of the entities
931
+ # or the latest version. This field is ignored if a specific commit_id is
932
+ # specified.
810
933
  # @!attribute [rw] commit_id
811
934
  # @return [::String]
812
- # Request a specific commit ID. If not specified, the entities from the
813
- # latest commit are returned.
935
+ # Optional. Request a specific commit ID. If not specified, the entities from
936
+ # the latest commit are returned.
814
937
  # @!attribute [rw] filter
815
938
  # @return [::String]
816
- # Filter the returned entities based on AIP-160 standard.
939
+ # Optional. Filter the returned entities based on AIP-160 standard.
940
+ # @!attribute [rw] view
941
+ # @return [::Google::Cloud::CloudDMS::V1::DatabaseEntityView]
942
+ # Optional. Results view based on AIP-157
817
943
  class DescribeDatabaseEntitiesRequest
818
944
  include ::Google::Protobuf::MessageExts
819
945
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -903,6 +1029,50 @@ module Google
903
1029
  extend ::Google::Protobuf::MessageExts::ClassMethods
904
1030
  end
905
1031
 
1032
+ # Request message for 'CreateMappingRule' command.
1033
+ # @!attribute [rw] parent
1034
+ # @return [::String]
1035
+ # Required. The parent which owns this collection of mapping rules.
1036
+ # @!attribute [rw] mapping_rule_id
1037
+ # @return [::String]
1038
+ # Required. The ID of the rule to create.
1039
+ # @!attribute [rw] mapping_rule
1040
+ # @return [::Google::Cloud::CloudDMS::V1::MappingRule]
1041
+ # Required. Represents a [mapping rule]
1042
+ # (https://cloud.google.com/database-migration/reference/rest/v1/projects.locations.mappingRules)
1043
+ # object.
1044
+ # @!attribute [rw] request_id
1045
+ # @return [::String]
1046
+ # A unique ID used to identify the request. If the server receives two
1047
+ # requests with the same ID, then the second request is ignored.
1048
+ #
1049
+ # It is recommended to always set this value to a UUID.
1050
+ #
1051
+ # The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores
1052
+ # (_), and hyphens (-). The maximum length is 40 characters.
1053
+ class CreateMappingRuleRequest
1054
+ include ::Google::Protobuf::MessageExts
1055
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1056
+ end
1057
+
1058
+ # Request message for 'DeleteMappingRule' request.
1059
+ # @!attribute [rw] name
1060
+ # @return [::String]
1061
+ # Required. Name of the mapping rule resource to delete.
1062
+ # @!attribute [rw] request_id
1063
+ # @return [::String]
1064
+ # Optional. A unique ID used to identify the request. If the server receives
1065
+ # two requests with the same ID, then the second request is ignored.
1066
+ #
1067
+ # It is recommended to always set this value to a UUID.
1068
+ #
1069
+ # The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores
1070
+ # (_), and hyphens (-). The maximum length is 40 characters.
1071
+ class DeleteMappingRuleRequest
1072
+ include ::Google::Protobuf::MessageExts
1073
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1074
+ end
1075
+
906
1076
  # Request message for 'FetchStaticIps' request.
907
1077
  # @!attribute [rw] name
908
1078
  # @return [::String]
@@ -931,6 +1101,25 @@ module Google
931
1101
  include ::Google::Protobuf::MessageExts
932
1102
  extend ::Google::Protobuf::MessageExts::ClassMethods
933
1103
  end
1104
+
1105
+ # AIP-157 Partial Response view for Database Entity.
1106
+ module DatabaseEntityView
1107
+ # Unspecified view. Defaults to basic view.
1108
+ DATABASE_ENTITY_VIEW_UNSPECIFIED = 0
1109
+
1110
+ # Default view. Does not return DDLs or Issues.
1111
+ DATABASE_ENTITY_VIEW_BASIC = 1
1112
+
1113
+ # Return full entity details including mappings, ddl and issues.
1114
+ DATABASE_ENTITY_VIEW_FULL = 2
1115
+
1116
+ # Top-most (Database, Schema) nodes which are returned contains summary
1117
+ # details for their decendents such as the number of entities per type and
1118
+ # issues rollups. When this view is used, only a single page of result is
1119
+ # returned and the page_size property of the request is ignored. The
1120
+ # returned page will only include the top-most node types.
1121
+ DATABASE_ENTITY_VIEW_ROOT_SUMMARY = 3
1122
+ end
934
1123
  end
935
1124
  end
936
1125
  end
@@ -161,6 +161,12 @@ module Google
161
161
  # @!attribute [rw] database_service
162
162
  # @return [::String]
163
163
  # Required. Database service for the Oracle connection.
164
+ # @!attribute [rw] ssl
165
+ # @return [::Google::Cloud::CloudDMS::V1::SslConfig]
166
+ # SSL configuration for the connection to the source Oracle database.
167
+ #
168
+ # * Only `SERVER_ONLY` configuration is supported for Oracle SSL.
169
+ # * SSL is supported for Oracle versions 12 and above.
164
170
  # @!attribute [rw] static_service_ip_connectivity
165
171
  # @return [::Google::Cloud::CloudDMS::V1::StaticServiceIpConnectivity]
166
172
  # Static Service IP connectivity.
@@ -356,6 +362,9 @@ module Google
356
362
  # zone affect data availability.
357
363
  # * `REGIONAL`: The instance can serve data from more than one zone in a
358
364
  # region (it is highly available).
365
+ # @!attribute [rw] edition
366
+ # @return [::Google::Cloud::CloudDMS::V1::CloudSqlSettings::Edition]
367
+ # Optional. The edition of the given Cloud SQL instance.
359
368
  class CloudSqlSettings
360
369
  include ::Google::Protobuf::MessageExts
361
370
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -433,6 +442,9 @@ module Google
433
442
 
434
443
  # PostgreSQL 14.
435
444
  POSTGRES_14 = 17
445
+
446
+ # PostgreSQL 15.
447
+ POSTGRES_15 = 18
436
448
  end
437
449
 
438
450
  # The availability type of the given Cloud SQL instance.
@@ -446,6 +458,19 @@ module Google
446
458
  # Regional availability instance.
447
459
  REGIONAL = 2
448
460
  end
461
+
462
+ # The edition of the given Cloud SQL instance.
463
+ # Can be ENTERPRISE or ENTERPRISE_PLUS.
464
+ module Edition
465
+ # The instance did not specify the edition.
466
+ EDITION_UNSPECIFIED = 0
467
+
468
+ # The instance is an enterprise edition.
469
+ ENTERPRISE = 2
470
+
471
+ # The instance is an enterprise plus edition.
472
+ ENTERPRISE_PLUS = 3
473
+ end
449
474
  end
450
475
 
451
476
  # Settings for creating an AlloyDB cluster.
@@ -578,8 +603,8 @@ module Google
578
603
  extend ::Google::Protobuf::MessageExts::ClassMethods
579
604
  end
580
605
 
581
- # Private Service Connect connectivity
582
- # (https://cloud.google.com/vpc/docs/private-service-connect#service-attachments)
606
+ # [Private Service Connect
607
+ # connectivity](https://cloud.google.com/vpc/docs/private-service-connect#service-attachments)
583
608
  # @!attribute [rw] service_attachment
584
609
  # @return [::String]
585
610
  # Required. A service attachment that exposes a database, and has the
@@ -775,6 +800,10 @@ module Google
775
800
  # connection profile instead).
776
801
  # Each Cloud CMEK key has the following format:
777
802
  # projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
803
+ # @!attribute [rw] performance_config
804
+ # @return [::Google::Cloud::CloudDMS::V1::MigrationJob::PerformanceConfig]
805
+ # Optional. Data dump parallelism settings used by the migration.
806
+ # Currently applicable only for MySQL to Cloud SQL for MySQL migrations only.
778
807
  class MigrationJob
779
808
  include ::Google::Protobuf::MessageExts
780
809
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -800,6 +829,30 @@ module Google
800
829
  extend ::Google::Protobuf::MessageExts::ClassMethods
801
830
  end
802
831
 
832
+ # Performance configuration definition.
833
+ # @!attribute [rw] dump_parallel_level
834
+ # @return [::Google::Cloud::CloudDMS::V1::MigrationJob::PerformanceConfig::DumpParallelLevel]
835
+ # Initial dump parallelism level.
836
+ class PerformanceConfig
837
+ include ::Google::Protobuf::MessageExts
838
+ extend ::Google::Protobuf::MessageExts::ClassMethods
839
+
840
+ # Describes the parallelism level during initial dump.
841
+ module DumpParallelLevel
842
+ # Unknown dump parallel level. Will be defaulted to OPTIMAL.
843
+ DUMP_PARALLEL_LEVEL_UNSPECIFIED = 0
844
+
845
+ # Minimal parallel level.
846
+ MIN = 1
847
+
848
+ # Optimal parallel level.
849
+ OPTIMAL = 2
850
+
851
+ # Maximum parallel level.
852
+ MAX = 3
853
+ end
854
+ end
855
+
803
856
  # @!attribute [rw] key
804
857
  # @return [::String]
805
858
  # @!attribute [rw] value
@@ -1076,6 +1129,9 @@ module Google
1076
1129
  # Migration is already running at the time of restart request.
1077
1130
  CANT_RESTART_RUNNING_MIGRATION = 21
1078
1131
 
1132
+ # The source already has a replication setup.
1133
+ SOURCE_ALREADY_SETUP = 23
1134
+
1079
1135
  # The source has tables with limited support.
1080
1136
  # E.g. PostgreSQL tables without primary keys.
1081
1137
  TABLES_WITH_LIMITED_SUPPORT = 24
@@ -1092,6 +1148,13 @@ module Google
1092
1148
  # The source DB size in Bytes exceeds a certain threshold. The migration
1093
1149
  # might require an increase of quota, or might not be supported.
1094
1150
  SOURCE_SIZE_EXCEEDS_THRESHOLD = 28
1151
+
1152
+ # The destination DB contains existing databases that are conflicting with
1153
+ # those in the source DB.
1154
+ EXISTING_CONFLICTING_DATABASES = 29
1155
+
1156
+ # Insufficient privilege to enable the parallelism configuration.
1157
+ PARALLEL_IMPORT_INSUFFICIENT_PRIVILEGE = 30
1095
1158
  end
1096
1159
  end
1097
1160