google-apis-datamigration_v1 0.37.0 → 0.39.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -659,6 +659,9 @@ module Google
659
659
  # Deletes a single conversion workspace.
660
660
  # @param [String] name
661
661
  # Required. Name of the conversion workspace resource to delete.
662
+ # @param [Boolean] force
663
+ # Force delete the conversion workspace, even if there's a running migration
664
+ # that is using the workspace.
662
665
  # @param [String] request_id
663
666
  # A unique ID used to identify the request. If the server receives two requests
664
667
  # with the same ID, then the second request is ignored. It is recommended to
@@ -682,11 +685,12 @@ module Google
682
685
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
683
686
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
684
687
  # @raise [Google::Apis::AuthorizationError] Authorization is required
685
- def delete_project_location_conversion_workspace(name, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
688
+ def delete_project_location_conversion_workspace(name, force: nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
686
689
  command = make_simple_command(:delete, 'v1/{+name}', options)
687
690
  command.response_representation = Google::Apis::DatamigrationV1::Operation::Representation
688
691
  command.response_class = Google::Apis::DatamigrationV1::Operation
689
692
  command.params['name'] = name unless name.nil?
693
+ command.query['force'] = force unless force.nil?
690
694
  command.query['requestId'] = request_id unless request_id.nil?
691
695
  command.query['fields'] = fields unless fields.nil?
692
696
  command.query['quotaUser'] = quota_user unless quota_user.nil?
@@ -738,24 +742,26 @@ module Google
738
742
  # are described. Must be in the form of: projects/`project`/locations/`location`/
739
743
  # conversionWorkspaces/`conversion_workspace`.
740
744
  # @param [String] commit_id
741
- # Request a specific commit ID. If not specified, the entities from the latest
742
- # commit are returned.
745
+ # Optional. Request a specific commit ID. If not specified, the entities from
746
+ # the latest commit are returned.
743
747
  # @param [String] filter
744
- # Filter the returned entities based on AIP-160 standard.
748
+ # Optional. Filter the returned entities based on AIP-160 standard.
745
749
  # @param [Fixnum] page_size
746
- # The maximum number of entities to return. The service may return fewer
747
- # entities than the value specifies.
750
+ # Optional. The maximum number of entities to return. The service may return
751
+ # fewer entities than the value specifies.
748
752
  # @param [String] page_token
749
- # The nextPageToken value received in the previous call to conversionWorkspace.
750
- # describeDatabaseEntities, used in the subsequent request to retrieve the next
751
- # page of results. On first call this should be left blank. When paginating, all
752
- # other parameters provided to conversionWorkspace.describeDatabaseEntities must
753
- # match the call that provided the page token.
753
+ # Optional. The nextPageToken value received in the previous call to
754
+ # conversionWorkspace.describeDatabaseEntities, used in the subsequent request
755
+ # to retrieve the next page of results. On first call this should be left blank.
756
+ # When paginating, all other parameters provided to conversionWorkspace.
757
+ # describeDatabaseEntities must match the call that provided the page token.
754
758
  # @param [String] tree
755
- # The tree to fetch.
759
+ # Required. The tree to fetch.
756
760
  # @param [Boolean] uncommitted
757
- # Whether to retrieve the latest committed version of the entities or the latest
758
- # version. This field is ignored if a specific commit_id is specified.
761
+ # Optional. Whether to retrieve the latest committed version of the entities or
762
+ # the latest version. This field is ignored if a specific commit_id is specified.
763
+ # @param [String] view
764
+ # Optional. Results view based on AIP-157
759
765
  # @param [String] fields
760
766
  # Selector specifying which fields to include in a partial response.
761
767
  # @param [String] quota_user
@@ -773,7 +779,7 @@ module Google
773
779
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
774
780
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
775
781
  # @raise [Google::Apis::AuthorizationError] Authorization is required
776
- def describe_project_location_conversion_workspace_database_entities(conversion_workspace, commit_id: nil, filter: nil, page_size: nil, page_token: nil, tree: nil, uncommitted: nil, fields: nil, quota_user: nil, options: nil, &block)
782
+ def describe_project_location_conversion_workspace_database_entities(conversion_workspace, commit_id: nil, filter: nil, page_size: nil, page_token: nil, tree: nil, uncommitted: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
777
783
  command = make_simple_command(:get, 'v1/{+conversionWorkspace}:describeDatabaseEntities', options)
778
784
  command.response_representation = Google::Apis::DatamigrationV1::DescribeDatabaseEntitiesResponse::Representation
779
785
  command.response_class = Google::Apis::DatamigrationV1::DescribeDatabaseEntitiesResponse
@@ -784,6 +790,7 @@ module Google
784
790
  command.query['pageToken'] = page_token unless page_token.nil?
785
791
  command.query['tree'] = tree unless tree.nil?
786
792
  command.query['uncommitted'] = uncommitted unless uncommitted.nil?
793
+ command.query['view'] = view unless view.nil?
787
794
  command.query['fields'] = fields unless fields.nil?
788
795
  command.query['quotaUser'] = quota_user unless quota_user.nil?
789
796
  execute_or_queue_command(command, &block)
@@ -1151,6 +1158,119 @@ module Google
1151
1158
  execute_or_queue_command(command, &block)
1152
1159
  end
1153
1160
 
1161
+ # Creates a new mapping rule for a given conversion workspace.
1162
+ # @param [String] parent
1163
+ # Required. The parent which owns this collection of mapping rules.
1164
+ # @param [Google::Apis::DatamigrationV1::MappingRule] mapping_rule_object
1165
+ # @param [String] mapping_rule_id
1166
+ # Required. The ID of the rule to create.
1167
+ # @param [String] request_id
1168
+ # A unique ID used to identify the request. If the server receives two requests
1169
+ # with the same ID, then the second request is ignored. It is recommended to
1170
+ # always set this value to a UUID. The ID must contain only letters (a-z, A-Z),
1171
+ # numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40
1172
+ # characters.
1173
+ # @param [String] fields
1174
+ # Selector specifying which fields to include in a partial response.
1175
+ # @param [String] quota_user
1176
+ # Available to use for quota purposes for server-side applications. Can be any
1177
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1178
+ # @param [Google::Apis::RequestOptions] options
1179
+ # Request-specific options
1180
+ #
1181
+ # @yield [result, err] Result & error if block supplied
1182
+ # @yieldparam result [Google::Apis::DatamigrationV1::MappingRule] parsed result object
1183
+ # @yieldparam err [StandardError] error object if request failed
1184
+ #
1185
+ # @return [Google::Apis::DatamigrationV1::MappingRule]
1186
+ #
1187
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1188
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1189
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1190
+ def create_project_location_conversion_workspace_mapping_rule(parent, mapping_rule_object = nil, mapping_rule_id: nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
1191
+ command = make_simple_command(:post, 'v1/{+parent}/mappingRules', options)
1192
+ command.request_representation = Google::Apis::DatamigrationV1::MappingRule::Representation
1193
+ command.request_object = mapping_rule_object
1194
+ command.response_representation = Google::Apis::DatamigrationV1::MappingRule::Representation
1195
+ command.response_class = Google::Apis::DatamigrationV1::MappingRule
1196
+ command.params['parent'] = parent unless parent.nil?
1197
+ command.query['mappingRuleId'] = mapping_rule_id unless mapping_rule_id.nil?
1198
+ command.query['requestId'] = request_id unless request_id.nil?
1199
+ command.query['fields'] = fields unless fields.nil?
1200
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1201
+ execute_or_queue_command(command, &block)
1202
+ end
1203
+
1204
+ # Deletes a single mapping rule.
1205
+ # @param [String] name
1206
+ # Required. Name of the mapping rule resource to delete.
1207
+ # @param [String] request_id
1208
+ # Optional. A unique ID used to identify the request. If the server receives two
1209
+ # requests with the same ID, then the second request is ignored. It is
1210
+ # recommended to always set this value to a UUID. The ID must contain only
1211
+ # letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The
1212
+ # maximum length is 40 characters.
1213
+ # @param [String] fields
1214
+ # Selector specifying which fields to include in a partial response.
1215
+ # @param [String] quota_user
1216
+ # Available to use for quota purposes for server-side applications. Can be any
1217
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1218
+ # @param [Google::Apis::RequestOptions] options
1219
+ # Request-specific options
1220
+ #
1221
+ # @yield [result, err] Result & error if block supplied
1222
+ # @yieldparam result [Google::Apis::DatamigrationV1::Empty] parsed result object
1223
+ # @yieldparam err [StandardError] error object if request failed
1224
+ #
1225
+ # @return [Google::Apis::DatamigrationV1::Empty]
1226
+ #
1227
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1228
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1229
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1230
+ def delete_project_location_conversion_workspace_mapping_rule(name, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
1231
+ command = make_simple_command(:delete, 'v1/{+name}', options)
1232
+ command.response_representation = Google::Apis::DatamigrationV1::Empty::Representation
1233
+ command.response_class = Google::Apis::DatamigrationV1::Empty
1234
+ command.params['name'] = name unless name.nil?
1235
+ command.query['requestId'] = request_id unless request_id.nil?
1236
+ command.query['fields'] = fields unless fields.nil?
1237
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1238
+ execute_or_queue_command(command, &block)
1239
+ end
1240
+
1241
+ # Gets the details of a mapping rule.
1242
+ # @param [String] name
1243
+ # Required. Name of the mapping rule resource to get. Example:
1244
+ # conversionWorkspaces/123/mappingRules/rule123 In order to retrieve a previous
1245
+ # revision of the mapping rule, also provide the revision ID. Example:
1246
+ # conversionWorkspace/123/mappingRules/rule123@c7cfa2a8c7cfa2a8c7cfa2a8c7cfa2a8
1247
+ # @param [String] fields
1248
+ # Selector specifying which fields to include in a partial response.
1249
+ # @param [String] quota_user
1250
+ # Available to use for quota purposes for server-side applications. Can be any
1251
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1252
+ # @param [Google::Apis::RequestOptions] options
1253
+ # Request-specific options
1254
+ #
1255
+ # @yield [result, err] Result & error if block supplied
1256
+ # @yieldparam result [Google::Apis::DatamigrationV1::MappingRule] parsed result object
1257
+ # @yieldparam err [StandardError] error object if request failed
1258
+ #
1259
+ # @return [Google::Apis::DatamigrationV1::MappingRule]
1260
+ #
1261
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1262
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1263
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1264
+ def get_project_location_conversion_workspace_mapping_rule(name, fields: nil, quota_user: nil, options: nil, &block)
1265
+ command = make_simple_command(:get, 'v1/{+name}', options)
1266
+ command.response_representation = Google::Apis::DatamigrationV1::MappingRule::Representation
1267
+ command.response_class = Google::Apis::DatamigrationV1::MappingRule
1268
+ command.params['name'] = name unless name.nil?
1269
+ command.query['fields'] = fields unless fields.nil?
1270
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1271
+ execute_or_queue_command(command, &block)
1272
+ end
1273
+
1154
1274
  # Imports the mapping rules for a given conversion workspace. Supports various
1155
1275
  # formats of external rules files.
1156
1276
  # @param [String] parent
@@ -1187,6 +1307,48 @@ module Google
1187
1307
  execute_or_queue_command(command, &block)
1188
1308
  end
1189
1309
 
1310
+ # Lists the mapping rules for a specific conversion workspace.
1311
+ # @param [String] parent
1312
+ # Required. Name of the conversion workspace resource whose mapping rules are
1313
+ # listed in the form of: projects/`project`/locations/`location`/
1314
+ # conversionWorkspaces/`conversion_workspace`.
1315
+ # @param [Fixnum] page_size
1316
+ # The maximum number of rules to return. The service may return fewer than this
1317
+ # value.
1318
+ # @param [String] page_token
1319
+ # The nextPageToken value received in the previous call to mappingRules.list,
1320
+ # used in the subsequent request to retrieve the next page of results. On first
1321
+ # call this should be left blank. When paginating, all other parameters provided
1322
+ # to mappingRules.list must match the call that provided the page token.
1323
+ # @param [String] fields
1324
+ # Selector specifying which fields to include in a partial response.
1325
+ # @param [String] quota_user
1326
+ # Available to use for quota purposes for server-side applications. Can be any
1327
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1328
+ # @param [Google::Apis::RequestOptions] options
1329
+ # Request-specific options
1330
+ #
1331
+ # @yield [result, err] Result & error if block supplied
1332
+ # @yieldparam result [Google::Apis::DatamigrationV1::ListMappingRulesResponse] parsed result object
1333
+ # @yieldparam err [StandardError] error object if request failed
1334
+ #
1335
+ # @return [Google::Apis::DatamigrationV1::ListMappingRulesResponse]
1336
+ #
1337
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1338
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1339
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1340
+ def list_project_location_conversion_workspace_mapping_rules(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1341
+ command = make_simple_command(:get, 'v1/{+parent}/mappingRules', options)
1342
+ command.response_representation = Google::Apis::DatamigrationV1::ListMappingRulesResponse::Representation
1343
+ command.response_class = Google::Apis::DatamigrationV1::ListMappingRulesResponse
1344
+ command.params['parent'] = parent unless parent.nil?
1345
+ command.query['pageSize'] = page_size unless page_size.nil?
1346
+ command.query['pageToken'] = page_token unless page_token.nil?
1347
+ command.query['fields'] = fields unless fields.nil?
1348
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1349
+ execute_or_queue_command(command, &block)
1350
+ end
1351
+
1190
1352
  # Creates a new migration job in a given project and location.
1191
1353
  # @param [String] parent
1192
1354
  # Required. The parent which owns this collection of migration jobs.
@@ -1194,11 +1356,11 @@ module Google
1194
1356
  # @param [String] migration_job_id
1195
1357
  # Required. The ID of the instance to create.
1196
1358
  # @param [String] request_id
1197
- # A unique ID used to identify the request. If the server receives two requests
1198
- # with the same ID, then the second request is ignored. It is recommended to
1199
- # always set this value to a UUID. The ID must contain only letters (a-z, A-Z),
1200
- # numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40
1201
- # characters.
1359
+ # Optional. A unique ID used to identify the request. If the server receives two
1360
+ # requests with the same ID, then the second request is ignored. It is
1361
+ # recommended to always set this value to a UUID. The ID must contain only
1362
+ # letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The
1363
+ # maximum length is 40 characters.
1202
1364
  # @param [String] fields
1203
1365
  # Selector specifying which fields to include in a partial response.
1204
1366
  # @param [String] quota_user
@@ -1305,6 +1467,40 @@ module Google
1305
1467
  execute_or_queue_command(command, &block)
1306
1468
  end
1307
1469
 
1470
+ # Generate a TCP Proxy configuration script to configure a cloud-hosted VM
1471
+ # running a TCP Proxy.
1472
+ # @param [String] migration_job
1473
+ # Name of the migration job resource to generate the TCP Proxy script.
1474
+ # @param [Google::Apis::DatamigrationV1::GenerateTcpProxyScriptRequest] generate_tcp_proxy_script_request_object
1475
+ # @param [String] fields
1476
+ # Selector specifying which fields to include in a partial response.
1477
+ # @param [String] quota_user
1478
+ # Available to use for quota purposes for server-side applications. Can be any
1479
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1480
+ # @param [Google::Apis::RequestOptions] options
1481
+ # Request-specific options
1482
+ #
1483
+ # @yield [result, err] Result & error if block supplied
1484
+ # @yieldparam result [Google::Apis::DatamigrationV1::TcpProxyScript] parsed result object
1485
+ # @yieldparam err [StandardError] error object if request failed
1486
+ #
1487
+ # @return [Google::Apis::DatamigrationV1::TcpProxyScript]
1488
+ #
1489
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1490
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1491
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1492
+ def generate_migration_job_tcp_proxy_script(migration_job, generate_tcp_proxy_script_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1493
+ command = make_simple_command(:post, 'v1/{+migrationJob}:generateTcpProxyScript', options)
1494
+ command.request_representation = Google::Apis::DatamigrationV1::GenerateTcpProxyScriptRequest::Representation
1495
+ command.request_object = generate_tcp_proxy_script_request_object
1496
+ command.response_representation = Google::Apis::DatamigrationV1::TcpProxyScript::Representation
1497
+ command.response_class = Google::Apis::DatamigrationV1::TcpProxyScript
1498
+ command.params['migrationJob'] = migration_job unless migration_job.nil?
1499
+ command.query['fields'] = fields unless fields.nil?
1500
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1501
+ execute_or_queue_command(command, &block)
1502
+ end
1503
+
1308
1504
  # Gets details of a single migration job.
1309
1505
  # @param [String] name
1310
1506
  # Required. Name of the migration job resource to get.
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-datamigration_v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.37.0
4
+ version: 0.39.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-05-28 00:00:00.000000000 Z
11
+ date: 2023-07-09 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-datamigration_v1/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-datamigration_v1/v0.37.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-datamigration_v1/v0.39.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-datamigration_v1
63
63
  post_install_message:
64
64
  rdoc_options: []