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.
@@ -202,7 +202,7 @@ module Google
202
202
  credentials = @config.credentials
203
203
  # Use self-signed JWT if the endpoint is unchanged from default,
204
204
  # but only if the default endpoint does not have a region prefix.
205
- enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
205
+ enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
206
206
  !@config.endpoint.split(".").first.include?("-")
207
207
  credentials ||= Credentials.default scope: @config.scope,
208
208
  enable_self_signed_jwt: enable_self_signed_jwt
@@ -488,8 +488,8 @@ module Google
488
488
  # job](https://cloud.google.com/database-migration/docs/reference/rest/v1/projects.locations.migrationJobs)
489
489
  # object.
490
490
  # @param request_id [::String]
491
- # A unique ID used to identify the request. If the server receives two
492
- # requests with the same ID, then the second request is ignored.
491
+ # Optional. A unique ID used to identify the request. If the server receives
492
+ # two requests with the same ID, then the second request is ignored.
493
493
  #
494
494
  # It is recommended to always set this value to a UUID.
495
495
  #
@@ -790,13 +790,16 @@ module Google
790
790
  # @param options [::Gapic::CallOptions, ::Hash]
791
791
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
792
792
  #
793
- # @overload start_migration_job(name: nil)
793
+ # @overload start_migration_job(name: nil, skip_validation: nil)
794
794
  # Pass arguments to `start_migration_job` via keyword arguments. Note that at
795
795
  # least one keyword argument is required. To specify no parameters, or to keep all
796
796
  # the default parameter values, pass an empty Hash as a request object (see above).
797
797
  #
798
798
  # @param name [::String]
799
799
  # Name of the migration job resource to start.
800
+ # @param skip_validation [::Boolean]
801
+ # Optional. Start the migration job without running prior configuration
802
+ # verification. Defaults to `false`.
800
803
  #
801
804
  # @yield [response, operation] Access the result along with the RPC operation
802
805
  # @yieldparam response [::Gapic::Operation]
@@ -1165,13 +1168,19 @@ module Google
1165
1168
  # @param options [::Gapic::CallOptions, ::Hash]
1166
1169
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1167
1170
  #
1168
- # @overload verify_migration_job(name: nil)
1171
+ # @overload verify_migration_job(name: nil, update_mask: nil, migration_job: nil)
1169
1172
  # Pass arguments to `verify_migration_job` via keyword arguments. Note that at
1170
1173
  # least one keyword argument is required. To specify no parameters, or to keep all
1171
1174
  # the default parameter values, pass an empty Hash as a request object (see above).
1172
1175
  #
1173
1176
  # @param name [::String]
1174
1177
  # Name of the migration job resource to verify.
1178
+ # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
1179
+ # Optional. Field mask is used to specify the changed fields to be verified.
1180
+ # It will not update the migration job.
1181
+ # @param migration_job [::Google::Cloud::CloudDMS::V1::MigrationJob, ::Hash]
1182
+ # Optional. The changed migration job parameters to verify.
1183
+ # It will not update the migration job.
1175
1184
  #
1176
1185
  # @yield [response, operation] Access the result along with the RPC operation
1177
1186
  # @yieldparam response [::Gapic::Operation]
@@ -1260,13 +1269,16 @@ module Google
1260
1269
  # @param options [::Gapic::CallOptions, ::Hash]
1261
1270
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1262
1271
  #
1263
- # @overload restart_migration_job(name: nil)
1272
+ # @overload restart_migration_job(name: nil, skip_validation: nil)
1264
1273
  # Pass arguments to `restart_migration_job` via keyword arguments. Note that at
1265
1274
  # least one keyword argument is required. To specify no parameters, or to keep all
1266
1275
  # the default parameter values, pass an empty Hash as a request object (see above).
1267
1276
  #
1268
1277
  # @param name [::String]
1269
1278
  # Name of the migration job resource to restart.
1279
+ # @param skip_validation [::Boolean]
1280
+ # Optional. Restart the migration job without running prior configuration
1281
+ # verification. Defaults to `false`.
1270
1282
  #
1271
1283
  # @yield [response, operation] Access the result along with the RPC operation
1272
1284
  # @yieldparam response [::Gapic::Operation]
@@ -1434,6 +1446,106 @@ module Google
1434
1446
  raise ::Google::Cloud::Error.from_error(e)
1435
1447
  end
1436
1448
 
1449
+ ##
1450
+ # Generate a TCP Proxy configuration script to configure a cloud-hosted VM
1451
+ # running a TCP Proxy.
1452
+ #
1453
+ # @overload generate_tcp_proxy_script(request, options = nil)
1454
+ # Pass arguments to `generate_tcp_proxy_script` via a request object, either of type
1455
+ # {::Google::Cloud::CloudDMS::V1::GenerateTcpProxyScriptRequest} or an equivalent Hash.
1456
+ #
1457
+ # @param request [::Google::Cloud::CloudDMS::V1::GenerateTcpProxyScriptRequest, ::Hash]
1458
+ # A request object representing the call parameters. Required. To specify no
1459
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1460
+ # @param options [::Gapic::CallOptions, ::Hash]
1461
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1462
+ #
1463
+ # @overload generate_tcp_proxy_script(migration_job: nil, vm_name: nil, vm_machine_type: nil, vm_zone: nil, vm_subnet: nil)
1464
+ # Pass arguments to `generate_tcp_proxy_script` via keyword arguments. Note that at
1465
+ # least one keyword argument is required. To specify no parameters, or to keep all
1466
+ # the default parameter values, pass an empty Hash as a request object (see above).
1467
+ #
1468
+ # @param migration_job [::String]
1469
+ # Name of the migration job resource to generate the TCP Proxy script.
1470
+ # @param vm_name [::String]
1471
+ # Required. The name of the Compute instance that will host the proxy.
1472
+ # @param vm_machine_type [::String]
1473
+ # Required. The type of the Compute instance that will host the proxy.
1474
+ # @param vm_zone [::String]
1475
+ # Optional. The Google Cloud Platform zone to create the VM in. The fully
1476
+ # qualified name of the zone must be specified, including the region name,
1477
+ # for example "us-central1-b". If not specified, uses the "-b" zone of the
1478
+ # destination Connection Profile's region.
1479
+ # @param vm_subnet [::String]
1480
+ # Required. The name of the subnet the Compute instance will use for private
1481
+ # connectivity. Must be supplied in the form of
1482
+ # projects/\\{project}/regions/\\{region}/subnetworks/\\{subnetwork}.
1483
+ # Note: the region for the subnet must match the Compute instance region.
1484
+ #
1485
+ # @yield [response, operation] Access the result along with the RPC operation
1486
+ # @yieldparam response [::Google::Cloud::CloudDMS::V1::TcpProxyScript]
1487
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
1488
+ #
1489
+ # @return [::Google::Cloud::CloudDMS::V1::TcpProxyScript]
1490
+ #
1491
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
1492
+ #
1493
+ # @example Basic example
1494
+ # require "google/cloud/cloud_dms/v1"
1495
+ #
1496
+ # # Create a client object. The client can be reused for multiple calls.
1497
+ # client = Google::Cloud::CloudDMS::V1::DataMigrationService::Client.new
1498
+ #
1499
+ # # Create a request. To set request fields, pass in keyword arguments.
1500
+ # request = Google::Cloud::CloudDMS::V1::GenerateTcpProxyScriptRequest.new
1501
+ #
1502
+ # # Call the generate_tcp_proxy_script method.
1503
+ # result = client.generate_tcp_proxy_script request
1504
+ #
1505
+ # # The returned object is of type Google::Cloud::CloudDMS::V1::TcpProxyScript.
1506
+ # p result
1507
+ #
1508
+ def generate_tcp_proxy_script request, options = nil
1509
+ raise ::ArgumentError, "request must be provided" if request.nil?
1510
+
1511
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::CloudDMS::V1::GenerateTcpProxyScriptRequest
1512
+
1513
+ # Converts hash and nil to an options object
1514
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
1515
+
1516
+ # Customize the options with defaults
1517
+ metadata = @config.rpcs.generate_tcp_proxy_script.metadata.to_h
1518
+
1519
+ # Set x-goog-api-client and x-goog-user-project headers
1520
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1521
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
1522
+ gapic_version: ::Google::Cloud::CloudDMS::V1::VERSION
1523
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1524
+
1525
+ header_params = {}
1526
+ if request.migration_job
1527
+ header_params["migration_job"] = request.migration_job
1528
+ end
1529
+
1530
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
1531
+ metadata[:"x-goog-request-params"] ||= request_params_header
1532
+
1533
+ options.apply_defaults timeout: @config.rpcs.generate_tcp_proxy_script.timeout,
1534
+ metadata: metadata,
1535
+ retry_policy: @config.rpcs.generate_tcp_proxy_script.retry_policy
1536
+
1537
+ options.apply_defaults timeout: @config.timeout,
1538
+ metadata: @config.metadata,
1539
+ retry_policy: @config.retry_policy
1540
+
1541
+ @data_migration_service_stub.call_rpc :generate_tcp_proxy_script, request, options: options do |response, operation|
1542
+ yield response, operation if block_given?
1543
+ return response
1544
+ end
1545
+ rescue ::GRPC::BadStatus => e
1546
+ raise ::Google::Cloud::Error.from_error(e)
1547
+ end
1548
+
1437
1549
  ##
1438
1550
  # Retrieves a list of all connection profiles in a given project and
1439
1551
  # location.
@@ -2783,7 +2895,7 @@ module Google
2783
2895
  # @param options [::Gapic::CallOptions, ::Hash]
2784
2896
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
2785
2897
  #
2786
- # @overload delete_conversion_workspace(name: nil, request_id: nil)
2898
+ # @overload delete_conversion_workspace(name: nil, request_id: nil, force: nil)
2787
2899
  # Pass arguments to `delete_conversion_workspace` via keyword arguments. Note that at
2788
2900
  # least one keyword argument is required. To specify no parameters, or to keep all
2789
2901
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -2798,6 +2910,9 @@ module Google
2798
2910
  #
2799
2911
  # The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores
2800
2912
  # (_), and hyphens (-). The maximum length is 40 characters.
2913
+ # @param force [::Boolean]
2914
+ # Force delete the conversion workspace, even if there's a running migration
2915
+ # that is using the workspace.
2801
2916
  #
2802
2917
  # @yield [response, operation] Access the result along with the RPC operation
2803
2918
  # @yieldparam response [::Gapic::Operation]
@@ -2871,6 +2986,390 @@ module Google
2871
2986
  raise ::Google::Cloud::Error.from_error(e)
2872
2987
  end
2873
2988
 
2989
+ ##
2990
+ # Creates a new mapping rule for a given conversion workspace.
2991
+ #
2992
+ # @overload create_mapping_rule(request, options = nil)
2993
+ # Pass arguments to `create_mapping_rule` via a request object, either of type
2994
+ # {::Google::Cloud::CloudDMS::V1::CreateMappingRuleRequest} or an equivalent Hash.
2995
+ #
2996
+ # @param request [::Google::Cloud::CloudDMS::V1::CreateMappingRuleRequest, ::Hash]
2997
+ # A request object representing the call parameters. Required. To specify no
2998
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
2999
+ # @param options [::Gapic::CallOptions, ::Hash]
3000
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
3001
+ #
3002
+ # @overload create_mapping_rule(parent: nil, mapping_rule_id: nil, mapping_rule: nil, request_id: nil)
3003
+ # Pass arguments to `create_mapping_rule` via keyword arguments. Note that at
3004
+ # least one keyword argument is required. To specify no parameters, or to keep all
3005
+ # the default parameter values, pass an empty Hash as a request object (see above).
3006
+ #
3007
+ # @param parent [::String]
3008
+ # Required. The parent which owns this collection of mapping rules.
3009
+ # @param mapping_rule_id [::String]
3010
+ # Required. The ID of the rule to create.
3011
+ # @param mapping_rule [::Google::Cloud::CloudDMS::V1::MappingRule, ::Hash]
3012
+ # Required. Represents a [mapping rule]
3013
+ # (https://cloud.google.com/database-migration/reference/rest/v1/projects.locations.mappingRules)
3014
+ # object.
3015
+ # @param request_id [::String]
3016
+ # A unique ID used to identify the request. If the server receives two
3017
+ # requests with the same ID, then the second request is ignored.
3018
+ #
3019
+ # It is recommended to always set this value to a UUID.
3020
+ #
3021
+ # The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores
3022
+ # (_), and hyphens (-). The maximum length is 40 characters.
3023
+ #
3024
+ # @yield [response, operation] Access the result along with the RPC operation
3025
+ # @yieldparam response [::Google::Cloud::CloudDMS::V1::MappingRule]
3026
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
3027
+ #
3028
+ # @return [::Google::Cloud::CloudDMS::V1::MappingRule]
3029
+ #
3030
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
3031
+ #
3032
+ # @example Basic example
3033
+ # require "google/cloud/cloud_dms/v1"
3034
+ #
3035
+ # # Create a client object. The client can be reused for multiple calls.
3036
+ # client = Google::Cloud::CloudDMS::V1::DataMigrationService::Client.new
3037
+ #
3038
+ # # Create a request. To set request fields, pass in keyword arguments.
3039
+ # request = Google::Cloud::CloudDMS::V1::CreateMappingRuleRequest.new
3040
+ #
3041
+ # # Call the create_mapping_rule method.
3042
+ # result = client.create_mapping_rule request
3043
+ #
3044
+ # # The returned object is of type Google::Cloud::CloudDMS::V1::MappingRule.
3045
+ # p result
3046
+ #
3047
+ def create_mapping_rule request, options = nil
3048
+ raise ::ArgumentError, "request must be provided" if request.nil?
3049
+
3050
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::CloudDMS::V1::CreateMappingRuleRequest
3051
+
3052
+ # Converts hash and nil to an options object
3053
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
3054
+
3055
+ # Customize the options with defaults
3056
+ metadata = @config.rpcs.create_mapping_rule.metadata.to_h
3057
+
3058
+ # Set x-goog-api-client and x-goog-user-project headers
3059
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
3060
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
3061
+ gapic_version: ::Google::Cloud::CloudDMS::V1::VERSION
3062
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
3063
+
3064
+ header_params = {}
3065
+ if request.parent
3066
+ header_params["parent"] = request.parent
3067
+ end
3068
+
3069
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
3070
+ metadata[:"x-goog-request-params"] ||= request_params_header
3071
+
3072
+ options.apply_defaults timeout: @config.rpcs.create_mapping_rule.timeout,
3073
+ metadata: metadata,
3074
+ retry_policy: @config.rpcs.create_mapping_rule.retry_policy
3075
+
3076
+ options.apply_defaults timeout: @config.timeout,
3077
+ metadata: @config.metadata,
3078
+ retry_policy: @config.retry_policy
3079
+
3080
+ @data_migration_service_stub.call_rpc :create_mapping_rule, request, options: options do |response, operation|
3081
+ yield response, operation if block_given?
3082
+ return response
3083
+ end
3084
+ rescue ::GRPC::BadStatus => e
3085
+ raise ::Google::Cloud::Error.from_error(e)
3086
+ end
3087
+
3088
+ ##
3089
+ # Deletes a single mapping rule.
3090
+ #
3091
+ # @overload delete_mapping_rule(request, options = nil)
3092
+ # Pass arguments to `delete_mapping_rule` via a request object, either of type
3093
+ # {::Google::Cloud::CloudDMS::V1::DeleteMappingRuleRequest} or an equivalent Hash.
3094
+ #
3095
+ # @param request [::Google::Cloud::CloudDMS::V1::DeleteMappingRuleRequest, ::Hash]
3096
+ # A request object representing the call parameters. Required. To specify no
3097
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
3098
+ # @param options [::Gapic::CallOptions, ::Hash]
3099
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
3100
+ #
3101
+ # @overload delete_mapping_rule(name: nil, request_id: nil)
3102
+ # Pass arguments to `delete_mapping_rule` via keyword arguments. Note that at
3103
+ # least one keyword argument is required. To specify no parameters, or to keep all
3104
+ # the default parameter values, pass an empty Hash as a request object (see above).
3105
+ #
3106
+ # @param name [::String]
3107
+ # Required. Name of the mapping rule resource to delete.
3108
+ # @param request_id [::String]
3109
+ # Optional. A unique ID used to identify the request. If the server receives
3110
+ # two requests with the same ID, then the second request is ignored.
3111
+ #
3112
+ # It is recommended to always set this value to a UUID.
3113
+ #
3114
+ # The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores
3115
+ # (_), and hyphens (-). The maximum length is 40 characters.
3116
+ #
3117
+ # @yield [response, operation] Access the result along with the RPC operation
3118
+ # @yieldparam response [::Google::Protobuf::Empty]
3119
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
3120
+ #
3121
+ # @return [::Google::Protobuf::Empty]
3122
+ #
3123
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
3124
+ #
3125
+ # @example Basic example
3126
+ # require "google/cloud/cloud_dms/v1"
3127
+ #
3128
+ # # Create a client object. The client can be reused for multiple calls.
3129
+ # client = Google::Cloud::CloudDMS::V1::DataMigrationService::Client.new
3130
+ #
3131
+ # # Create a request. To set request fields, pass in keyword arguments.
3132
+ # request = Google::Cloud::CloudDMS::V1::DeleteMappingRuleRequest.new
3133
+ #
3134
+ # # Call the delete_mapping_rule method.
3135
+ # result = client.delete_mapping_rule request
3136
+ #
3137
+ # # The returned object is of type Google::Protobuf::Empty.
3138
+ # p result
3139
+ #
3140
+ def delete_mapping_rule request, options = nil
3141
+ raise ::ArgumentError, "request must be provided" if request.nil?
3142
+
3143
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::CloudDMS::V1::DeleteMappingRuleRequest
3144
+
3145
+ # Converts hash and nil to an options object
3146
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
3147
+
3148
+ # Customize the options with defaults
3149
+ metadata = @config.rpcs.delete_mapping_rule.metadata.to_h
3150
+
3151
+ # Set x-goog-api-client and x-goog-user-project headers
3152
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
3153
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
3154
+ gapic_version: ::Google::Cloud::CloudDMS::V1::VERSION
3155
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
3156
+
3157
+ header_params = {}
3158
+ if request.name
3159
+ header_params["name"] = request.name
3160
+ end
3161
+
3162
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
3163
+ metadata[:"x-goog-request-params"] ||= request_params_header
3164
+
3165
+ options.apply_defaults timeout: @config.rpcs.delete_mapping_rule.timeout,
3166
+ metadata: metadata,
3167
+ retry_policy: @config.rpcs.delete_mapping_rule.retry_policy
3168
+
3169
+ options.apply_defaults timeout: @config.timeout,
3170
+ metadata: @config.metadata,
3171
+ retry_policy: @config.retry_policy
3172
+
3173
+ @data_migration_service_stub.call_rpc :delete_mapping_rule, request, options: options do |response, operation|
3174
+ yield response, operation if block_given?
3175
+ return response
3176
+ end
3177
+ rescue ::GRPC::BadStatus => e
3178
+ raise ::Google::Cloud::Error.from_error(e)
3179
+ end
3180
+
3181
+ ##
3182
+ # Lists the mapping rules for a specific conversion workspace.
3183
+ #
3184
+ # @overload list_mapping_rules(request, options = nil)
3185
+ # Pass arguments to `list_mapping_rules` via a request object, either of type
3186
+ # {::Google::Cloud::CloudDMS::V1::ListMappingRulesRequest} or an equivalent Hash.
3187
+ #
3188
+ # @param request [::Google::Cloud::CloudDMS::V1::ListMappingRulesRequest, ::Hash]
3189
+ # A request object representing the call parameters. Required. To specify no
3190
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
3191
+ # @param options [::Gapic::CallOptions, ::Hash]
3192
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
3193
+ #
3194
+ # @overload list_mapping_rules(parent: nil, page_size: nil, page_token: nil)
3195
+ # Pass arguments to `list_mapping_rules` via keyword arguments. Note that at
3196
+ # least one keyword argument is required. To specify no parameters, or to keep all
3197
+ # the default parameter values, pass an empty Hash as a request object (see above).
3198
+ #
3199
+ # @param parent [::String]
3200
+ # Required. Name of the conversion workspace resource whose mapping rules are
3201
+ # listed in the form of:
3202
+ # projects/\\{project}/locations/\\{location}/conversionWorkspaces/\\{conversion_workspace}.
3203
+ # @param page_size [::Integer]
3204
+ # The maximum number of rules to return. The service may return
3205
+ # fewer than this value.
3206
+ # @param page_token [::String]
3207
+ # The nextPageToken value received in the previous call to
3208
+ # mappingRules.list, used in the subsequent request to retrieve the next
3209
+ # page of results. On first call this should be left blank. When paginating,
3210
+ # all other parameters provided to mappingRules.list must match the call
3211
+ # that provided the page token.
3212
+ #
3213
+ # @yield [response, operation] Access the result along with the RPC operation
3214
+ # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::CloudDMS::V1::MappingRule>]
3215
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
3216
+ #
3217
+ # @return [::Gapic::PagedEnumerable<::Google::Cloud::CloudDMS::V1::MappingRule>]
3218
+ #
3219
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
3220
+ #
3221
+ # @example Basic example
3222
+ # require "google/cloud/cloud_dms/v1"
3223
+ #
3224
+ # # Create a client object. The client can be reused for multiple calls.
3225
+ # client = Google::Cloud::CloudDMS::V1::DataMigrationService::Client.new
3226
+ #
3227
+ # # Create a request. To set request fields, pass in keyword arguments.
3228
+ # request = Google::Cloud::CloudDMS::V1::ListMappingRulesRequest.new
3229
+ #
3230
+ # # Call the list_mapping_rules method.
3231
+ # result = client.list_mapping_rules request
3232
+ #
3233
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
3234
+ # # over elements, and API calls will be issued to fetch pages as needed.
3235
+ # result.each do |item|
3236
+ # # Each element is of type ::Google::Cloud::CloudDMS::V1::MappingRule.
3237
+ # p item
3238
+ # end
3239
+ #
3240
+ def list_mapping_rules request, options = nil
3241
+ raise ::ArgumentError, "request must be provided" if request.nil?
3242
+
3243
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::CloudDMS::V1::ListMappingRulesRequest
3244
+
3245
+ # Converts hash and nil to an options object
3246
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
3247
+
3248
+ # Customize the options with defaults
3249
+ metadata = @config.rpcs.list_mapping_rules.metadata.to_h
3250
+
3251
+ # Set x-goog-api-client and x-goog-user-project headers
3252
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
3253
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
3254
+ gapic_version: ::Google::Cloud::CloudDMS::V1::VERSION
3255
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
3256
+
3257
+ header_params = {}
3258
+ if request.parent
3259
+ header_params["parent"] = request.parent
3260
+ end
3261
+
3262
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
3263
+ metadata[:"x-goog-request-params"] ||= request_params_header
3264
+
3265
+ options.apply_defaults timeout: @config.rpcs.list_mapping_rules.timeout,
3266
+ metadata: metadata,
3267
+ retry_policy: @config.rpcs.list_mapping_rules.retry_policy
3268
+
3269
+ options.apply_defaults timeout: @config.timeout,
3270
+ metadata: @config.metadata,
3271
+ retry_policy: @config.retry_policy
3272
+
3273
+ @data_migration_service_stub.call_rpc :list_mapping_rules, request, options: options do |response, operation|
3274
+ response = ::Gapic::PagedEnumerable.new @data_migration_service_stub, :list_mapping_rules, request, response, operation, options
3275
+ yield response, operation if block_given?
3276
+ return response
3277
+ end
3278
+ rescue ::GRPC::BadStatus => e
3279
+ raise ::Google::Cloud::Error.from_error(e)
3280
+ end
3281
+
3282
+ ##
3283
+ # Gets the details of a mapping rule.
3284
+ #
3285
+ # @overload get_mapping_rule(request, options = nil)
3286
+ # Pass arguments to `get_mapping_rule` via a request object, either of type
3287
+ # {::Google::Cloud::CloudDMS::V1::GetMappingRuleRequest} or an equivalent Hash.
3288
+ #
3289
+ # @param request [::Google::Cloud::CloudDMS::V1::GetMappingRuleRequest, ::Hash]
3290
+ # A request object representing the call parameters. Required. To specify no
3291
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
3292
+ # @param options [::Gapic::CallOptions, ::Hash]
3293
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
3294
+ #
3295
+ # @overload get_mapping_rule(name: nil)
3296
+ # Pass arguments to `get_mapping_rule` via keyword arguments. Note that at
3297
+ # least one keyword argument is required. To specify no parameters, or to keep all
3298
+ # the default parameter values, pass an empty Hash as a request object (see above).
3299
+ #
3300
+ # @param name [::String]
3301
+ # Required. Name of the mapping rule resource to get.
3302
+ # Example: conversionWorkspaces/123/mappingRules/rule123
3303
+ #
3304
+ # In order to retrieve a previous revision of the mapping rule, also provide
3305
+ # the revision ID.
3306
+ # Example:
3307
+ # conversionWorkspace/123/mappingRules/rule123@c7cfa2a8c7cfa2a8c7cfa2a8c7cfa2a8
3308
+ #
3309
+ # @yield [response, operation] Access the result along with the RPC operation
3310
+ # @yieldparam response [::Google::Cloud::CloudDMS::V1::MappingRule]
3311
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
3312
+ #
3313
+ # @return [::Google::Cloud::CloudDMS::V1::MappingRule]
3314
+ #
3315
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
3316
+ #
3317
+ # @example Basic example
3318
+ # require "google/cloud/cloud_dms/v1"
3319
+ #
3320
+ # # Create a client object. The client can be reused for multiple calls.
3321
+ # client = Google::Cloud::CloudDMS::V1::DataMigrationService::Client.new
3322
+ #
3323
+ # # Create a request. To set request fields, pass in keyword arguments.
3324
+ # request = Google::Cloud::CloudDMS::V1::GetMappingRuleRequest.new
3325
+ #
3326
+ # # Call the get_mapping_rule method.
3327
+ # result = client.get_mapping_rule request
3328
+ #
3329
+ # # The returned object is of type Google::Cloud::CloudDMS::V1::MappingRule.
3330
+ # p result
3331
+ #
3332
+ def get_mapping_rule request, options = nil
3333
+ raise ::ArgumentError, "request must be provided" if request.nil?
3334
+
3335
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::CloudDMS::V1::GetMappingRuleRequest
3336
+
3337
+ # Converts hash and nil to an options object
3338
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
3339
+
3340
+ # Customize the options with defaults
3341
+ metadata = @config.rpcs.get_mapping_rule.metadata.to_h
3342
+
3343
+ # Set x-goog-api-client and x-goog-user-project headers
3344
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
3345
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
3346
+ gapic_version: ::Google::Cloud::CloudDMS::V1::VERSION
3347
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
3348
+
3349
+ header_params = {}
3350
+ if request.name
3351
+ header_params["name"] = request.name
3352
+ end
3353
+
3354
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
3355
+ metadata[:"x-goog-request-params"] ||= request_params_header
3356
+
3357
+ options.apply_defaults timeout: @config.rpcs.get_mapping_rule.timeout,
3358
+ metadata: metadata,
3359
+ retry_policy: @config.rpcs.get_mapping_rule.retry_policy
3360
+
3361
+ options.apply_defaults timeout: @config.timeout,
3362
+ metadata: @config.metadata,
3363
+ retry_policy: @config.retry_policy
3364
+
3365
+ @data_migration_service_stub.call_rpc :get_mapping_rule, request, options: options do |response, operation|
3366
+ yield response, operation if block_given?
3367
+ return response
3368
+ end
3369
+ rescue ::GRPC::BadStatus => e
3370
+ raise ::Google::Cloud::Error.from_error(e)
3371
+ end
3372
+
2874
3373
  ##
2875
3374
  # Imports a snapshot of the source database into the
2876
3375
  # conversion workspace.
@@ -2898,9 +3397,10 @@ module Google
2898
3397
  # Should the conversion workspace be committed automatically after the
2899
3398
  # seed operation.
2900
3399
  # @param source_connection_profile [::String]
2901
- # Fully qualified (Uri) name of the source connection profile.
3400
+ # Optional. Fully qualified (Uri) name of the source connection profile.
2902
3401
  # @param destination_connection_profile [::String]
2903
- # Fully qualified (Uri) name of the destination connection profile.
3402
+ # Optional. Fully qualified (Uri) name of the destination connection
3403
+ # profile.
2904
3404
  #
2905
3405
  # @yield [response, operation] Access the result along with the RPC operation
2906
3406
  # @yieldparam response [::Gapic::Operation]
@@ -2998,12 +3498,12 @@ module Google
2998
3498
  # in the form of:
2999
3499
  # projects/\\{project}/locations/\\{location}/conversionWorkspaces/\\{conversion_workspace}.
3000
3500
  # @param rules_format [::Google::Cloud::CloudDMS::V1::ImportRulesFileFormat]
3001
- # The format of the rules content file.
3501
+ # Required. The format of the rules content file.
3002
3502
  # @param rules_files [::Array<::Google::Cloud::CloudDMS::V1::ImportMappingRulesRequest::RulesFile, ::Hash>]
3003
- # One or more rules files.
3503
+ # Required. One or more rules files.
3004
3504
  # @param auto_commit [::Boolean]
3005
- # Should the conversion workspace be committed automatically after the
3006
- # import operation.
3505
+ # Required. Should the conversion workspace be committed automatically after
3506
+ # the import operation.
3007
3507
  #
3008
3508
  # @yield [response, operation] Access the result along with the RPC operation
3009
3509
  # @yieldparam response [::Gapic::Operation]
@@ -3090,7 +3590,7 @@ module Google
3090
3590
  # @param options [::Gapic::CallOptions, ::Hash]
3091
3591
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
3092
3592
  #
3093
- # @overload convert_conversion_workspace(name: nil, auto_commit: nil, filter: nil)
3593
+ # @overload convert_conversion_workspace(name: nil, auto_commit: nil, filter: nil, convert_full_path: nil)
3094
3594
  # Pass arguments to `convert_conversion_workspace` via keyword arguments. Note that at
3095
3595
  # least one keyword argument is required. To specify no parameters, or to keep all
3096
3596
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -3099,11 +3599,15 @@ module Google
3099
3599
  # Name of the conversion workspace resource to convert in the form of:
3100
3600
  # projects/\\{project}/locations/\\{location}/conversionWorkspaces/\\{conversion_workspace}.
3101
3601
  # @param auto_commit [::Boolean]
3102
- # Specifies whether the conversion workspace is to be committed automatically
3103
- # after the conversion.
3602
+ # Optional. Specifies whether the conversion workspace is to be committed
3603
+ # automatically after the conversion.
3104
3604
  # @param filter [::String]
3105
- # Filter the entities to convert. Leaving this field empty will convert all
3106
- # of the entities. Supports Google AIP-160 style filtering.
3605
+ # Optional. Filter the entities to convert. Leaving this field empty will
3606
+ # convert all of the entities. Supports Google AIP-160 style filtering.
3607
+ # @param convert_full_path [::Boolean]
3608
+ # Optional. Automatically convert the full entity path for each entity
3609
+ # specified by the filter. For example, if the filter specifies a table, that
3610
+ # table schema (and database if there is one) will also be converted.
3107
3611
  #
3108
3612
  # @yield [response, operation] Access the result along with the RPC operation
3109
3613
  # @yieldparam response [::Gapic::Operation]
@@ -3378,7 +3882,7 @@ module Google
3378
3882
  # @param options [::Gapic::CallOptions, ::Hash]
3379
3883
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
3380
3884
  #
3381
- # @overload apply_conversion_workspace(name: nil, filter: nil, connection_profile: nil)
3885
+ # @overload apply_conversion_workspace(name: nil, filter: nil, dry_run: nil, auto_commit: nil, connection_profile: nil)
3382
3886
  # Pass arguments to `apply_conversion_workspace` via keyword arguments. Note that at
3383
3887
  # least one keyword argument is required. To specify no parameters, or to keep all
3384
3888
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -3390,8 +3894,16 @@ module Google
3390
3894
  # @param filter [::String]
3391
3895
  # Filter which entities to apply. Leaving this field empty will apply all of
3392
3896
  # the entities. Supports Google AIP 160 based filtering.
3897
+ # @param dry_run [::Boolean]
3898
+ # Optional. Only validates the apply process, but doesn't change the
3899
+ # destination database. Only works for PostgreSQL destination connection
3900
+ # profile.
3901
+ # @param auto_commit [::Boolean]
3902
+ # Optional. Specifies whether the conversion workspace is to be committed
3903
+ # automatically after the apply.
3393
3904
  # @param connection_profile [::String]
3394
- # Fully qualified (Uri) name of the destination connection profile.
3905
+ # Optional. Fully qualified (Uri) name of the destination connection
3906
+ # profile.
3395
3907
  #
3396
3908
  # @yield [response, operation] Access the result along with the RPC operation
3397
3909
  # @yieldparam response [::Gapic::Operation]
@@ -3483,7 +3995,7 @@ module Google
3483
3995
  # @param options [::Gapic::CallOptions, ::Hash]
3484
3996
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
3485
3997
  #
3486
- # @overload describe_database_entities(conversion_workspace: nil, page_size: nil, page_token: nil, tree: nil, uncommitted: nil, commit_id: nil, filter: nil)
3998
+ # @overload describe_database_entities(conversion_workspace: nil, page_size: nil, page_token: nil, tree: nil, uncommitted: nil, commit_id: nil, filter: nil, view: nil)
3487
3999
  # Pass arguments to `describe_database_entities` via keyword arguments. Note that at
3488
4000
  # least one keyword argument is required. To specify no parameters, or to keep all
3489
4001
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -3493,25 +4005,28 @@ module Google
3493
4005
  # are described. Must be in the form of:
3494
4006
  # projects/\\{project}/locations/\\{location}/conversionWorkspaces/\\{conversion_workspace}.
3495
4007
  # @param page_size [::Integer]
3496
- # The maximum number of entities to return. The service may return
4008
+ # Optional. The maximum number of entities to return. The service may return
3497
4009
  # fewer entities than the value specifies.
3498
4010
  # @param page_token [::String]
3499
- # The nextPageToken value received in the previous call to
4011
+ # Optional. The nextPageToken value received in the previous call to
3500
4012
  # conversionWorkspace.describeDatabaseEntities, used in the subsequent
3501
4013
  # request to retrieve the next page of results. On first call this should be
3502
4014
  # left blank. When paginating, all other parameters provided to
3503
4015
  # conversionWorkspace.describeDatabaseEntities must match the call that
3504
4016
  # provided the page token.
3505
4017
  # @param tree [::Google::Cloud::CloudDMS::V1::DescribeDatabaseEntitiesRequest::DBTreeType]
3506
- # The tree to fetch.
4018
+ # Required. The tree to fetch.
3507
4019
  # @param uncommitted [::Boolean]
3508
- # Whether to retrieve the latest committed version of the entities or the
3509
- # latest version. This field is ignored if a specific commit_id is specified.
4020
+ # Optional. Whether to retrieve the latest committed version of the entities
4021
+ # or the latest version. This field is ignored if a specific commit_id is
4022
+ # specified.
3510
4023
  # @param commit_id [::String]
3511
- # Request a specific commit ID. If not specified, the entities from the
3512
- # latest commit are returned.
4024
+ # Optional. Request a specific commit ID. If not specified, the entities from
4025
+ # the latest commit are returned.
3513
4026
  # @param filter [::String]
3514
- # Filter the returned entities based on AIP-160 standard.
4027
+ # Optional. Filter the returned entities based on AIP-160 standard.
4028
+ # @param view [::Google::Cloud::CloudDMS::V1::DatabaseEntityView]
4029
+ # Optional. Results view based on AIP-157
3515
4030
  #
3516
4031
  # @yield [response, operation] Access the result along with the RPC operation
3517
4032
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::CloudDMS::V1::DatabaseEntity>]
@@ -3947,7 +4462,9 @@ module Google
3947
4462
  class Configuration
3948
4463
  extend ::Gapic::Config
3949
4464
 
3950
- config_attr :endpoint, "datamigration.googleapis.com", ::String
4465
+ DEFAULT_ENDPOINT = "datamigration.googleapis.com"
4466
+
4467
+ config_attr :endpoint, DEFAULT_ENDPOINT, ::String
3951
4468
  config_attr :credentials, nil do |value|
3952
4469
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
3953
4470
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -4061,6 +4578,11 @@ module Google
4061
4578
  #
4062
4579
  attr_reader :generate_ssh_script
4063
4580
  ##
4581
+ # RPC-specific configuration for `generate_tcp_proxy_script`
4582
+ # @return [::Gapic::Config::Method]
4583
+ #
4584
+ attr_reader :generate_tcp_proxy_script
4585
+ ##
4064
4586
  # RPC-specific configuration for `list_connection_profiles`
4065
4587
  # @return [::Gapic::Config::Method]
4066
4588
  #
@@ -4131,6 +4653,26 @@ module Google
4131
4653
  #
4132
4654
  attr_reader :delete_conversion_workspace
4133
4655
  ##
4656
+ # RPC-specific configuration for `create_mapping_rule`
4657
+ # @return [::Gapic::Config::Method]
4658
+ #
4659
+ attr_reader :create_mapping_rule
4660
+ ##
4661
+ # RPC-specific configuration for `delete_mapping_rule`
4662
+ # @return [::Gapic::Config::Method]
4663
+ #
4664
+ attr_reader :delete_mapping_rule
4665
+ ##
4666
+ # RPC-specific configuration for `list_mapping_rules`
4667
+ # @return [::Gapic::Config::Method]
4668
+ #
4669
+ attr_reader :list_mapping_rules
4670
+ ##
4671
+ # RPC-specific configuration for `get_mapping_rule`
4672
+ # @return [::Gapic::Config::Method]
4673
+ #
4674
+ attr_reader :get_mapping_rule
4675
+ ##
4134
4676
  # RPC-specific configuration for `seed_conversion_workspace`
4135
4677
  # @return [::Gapic::Config::Method]
4136
4678
  #
@@ -4207,6 +4749,8 @@ module Google
4207
4749
  @restart_migration_job = ::Gapic::Config::Method.new restart_migration_job_config
4208
4750
  generate_ssh_script_config = parent_rpcs.generate_ssh_script if parent_rpcs.respond_to? :generate_ssh_script
4209
4751
  @generate_ssh_script = ::Gapic::Config::Method.new generate_ssh_script_config
4752
+ generate_tcp_proxy_script_config = parent_rpcs.generate_tcp_proxy_script if parent_rpcs.respond_to? :generate_tcp_proxy_script
4753
+ @generate_tcp_proxy_script = ::Gapic::Config::Method.new generate_tcp_proxy_script_config
4210
4754
  list_connection_profiles_config = parent_rpcs.list_connection_profiles if parent_rpcs.respond_to? :list_connection_profiles
4211
4755
  @list_connection_profiles = ::Gapic::Config::Method.new list_connection_profiles_config
4212
4756
  get_connection_profile_config = parent_rpcs.get_connection_profile if parent_rpcs.respond_to? :get_connection_profile
@@ -4235,6 +4779,14 @@ module Google
4235
4779
  @update_conversion_workspace = ::Gapic::Config::Method.new update_conversion_workspace_config
4236
4780
  delete_conversion_workspace_config = parent_rpcs.delete_conversion_workspace if parent_rpcs.respond_to? :delete_conversion_workspace
4237
4781
  @delete_conversion_workspace = ::Gapic::Config::Method.new delete_conversion_workspace_config
4782
+ create_mapping_rule_config = parent_rpcs.create_mapping_rule if parent_rpcs.respond_to? :create_mapping_rule
4783
+ @create_mapping_rule = ::Gapic::Config::Method.new create_mapping_rule_config
4784
+ delete_mapping_rule_config = parent_rpcs.delete_mapping_rule if parent_rpcs.respond_to? :delete_mapping_rule
4785
+ @delete_mapping_rule = ::Gapic::Config::Method.new delete_mapping_rule_config
4786
+ list_mapping_rules_config = parent_rpcs.list_mapping_rules if parent_rpcs.respond_to? :list_mapping_rules
4787
+ @list_mapping_rules = ::Gapic::Config::Method.new list_mapping_rules_config
4788
+ get_mapping_rule_config = parent_rpcs.get_mapping_rule if parent_rpcs.respond_to? :get_mapping_rule
4789
+ @get_mapping_rule = ::Gapic::Config::Method.new get_mapping_rule_config
4238
4790
  seed_conversion_workspace_config = parent_rpcs.seed_conversion_workspace if parent_rpcs.respond_to? :seed_conversion_workspace
4239
4791
  @seed_conversion_workspace = ::Gapic::Config::Method.new seed_conversion_workspace_config
4240
4792
  import_mapping_rules_config = parent_rpcs.import_mapping_rules if parent_rpcs.respond_to? :import_mapping_rules