Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 25da371

Browse files
committedJun 27, 2023
feat(datamigration): update the api
#### datamigration:v1 The following keys were added: - resources.projects.resources.locations.resources.conversionWorkspaces.methods.delete.parameters.force (Total Keys: 2) - resources.projects.resources.locations.resources.migrationJobs.methods.generateTcpProxyScript (Total Keys: 12) - schemas.CloudSqlSettings.properties.edition.type (Total Keys: 1) - schemas.GenerateTcpProxyScriptRequest (Total Keys: 6) - schemas.TcpProxyScript (Total Keys: 3)
1 parent ae8443d commit 25da371

5 files changed

+122
-4
lines changed
 

‎docs/dyn/datamigration_v1.projects.locations.connectionProfiles.html

+4
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,7 @@ <h3>Method Details</h3>
167167
&quot;a_key&quot;: &quot;A String&quot;,
168168
},
169169
&quot;databaseVersion&quot;: &quot;A String&quot;, # The database engine type and version.
170+
&quot;edition&quot;: &quot;A String&quot;, # Optional. The edition of the given Cloud SQL instance.
170171
&quot;ipConfig&quot;: { # IP Management configuration. # The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled.
171172
&quot;allocatedIpRange&quot;: &quot;A String&quot;, # Optional. The name of the allocated IP address range for the private IP Cloud SQL instance. This name refers to an already allocated IP range address. If set, the instance IP address will be created in the allocated range. Note that this IP address range can&#x27;t be modified after the instance is created. If you change the VPC when configuring connectivity settings for the migration job, this field is not relevant.
172173
&quot;authorizedNetworks&quot;: [ # The list of external networks that are allowed to connect to the instance using the IP. See https://en.wikipedia.org/wiki/CIDR_notation#CIDR_notation, also known as &#x27;slash&#x27; notation (e.g. `192.168.100.0/24`).
@@ -405,6 +406,7 @@ <h3>Method Details</h3>
405406
&quot;a_key&quot;: &quot;A String&quot;,
406407
},
407408
&quot;databaseVersion&quot;: &quot;A String&quot;, # The database engine type and version.
409+
&quot;edition&quot;: &quot;A String&quot;, # Optional. The edition of the given Cloud SQL instance.
408410
&quot;ipConfig&quot;: { # IP Management configuration. # The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled.
409411
&quot;allocatedIpRange&quot;: &quot;A String&quot;, # Optional. The name of the allocated IP address range for the private IP Cloud SQL instance. This name refers to an already allocated IP range address. If set, the instance IP address will be created in the allocated range. Note that this IP address range can&#x27;t be modified after the instance is created. If you change the VPC when configuring connectivity settings for the migration job, this field is not relevant.
410412
&quot;authorizedNetworks&quot;: [ # The list of external networks that are allowed to connect to the instance using the IP. See https://en.wikipedia.org/wiki/CIDR_notation#CIDR_notation, also known as &#x27;slash&#x27; notation (e.g. `192.168.100.0/24`).
@@ -628,6 +630,7 @@ <h3>Method Details</h3>
628630
&quot;a_key&quot;: &quot;A String&quot;,
629631
},
630632
&quot;databaseVersion&quot;: &quot;A String&quot;, # The database engine type and version.
633+
&quot;edition&quot;: &quot;A String&quot;, # Optional. The edition of the given Cloud SQL instance.
631634
&quot;ipConfig&quot;: { # IP Management configuration. # The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled.
632635
&quot;allocatedIpRange&quot;: &quot;A String&quot;, # Optional. The name of the allocated IP address range for the private IP Cloud SQL instance. This name refers to an already allocated IP range address. If set, the instance IP address will be created in the allocated range. Note that this IP address range can&#x27;t be modified after the instance is created. If you change the VPC when configuring connectivity settings for the migration job, this field is not relevant.
633636
&quot;authorizedNetworks&quot;: [ # The list of external networks that are allowed to connect to the instance using the IP. See https://en.wikipedia.org/wiki/CIDR_notation#CIDR_notation, also known as &#x27;slash&#x27; notation (e.g. `192.168.100.0/24`).
@@ -812,6 +815,7 @@ <h3>Method Details</h3>
812815
&quot;a_key&quot;: &quot;A String&quot;,
813816
},
814817
&quot;databaseVersion&quot;: &quot;A String&quot;, # The database engine type and version.
818+
&quot;edition&quot;: &quot;A String&quot;, # Optional. The edition of the given Cloud SQL instance.
815819
&quot;ipConfig&quot;: { # IP Management configuration. # The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled.
816820
&quot;allocatedIpRange&quot;: &quot;A String&quot;, # Optional. The name of the allocated IP address range for the private IP Cloud SQL instance. This name refers to an already allocated IP range address. If set, the instance IP address will be created in the allocated range. Note that this IP address range can&#x27;t be modified after the instance is created. If you change the VPC when configuring connectivity settings for the migration job, this field is not relevant.
817821
&quot;authorizedNetworks&quot;: [ # The list of external networks that are allowed to connect to the instance using the IP. See https://en.wikipedia.org/wiki/CIDR_notation#CIDR_notation, also known as &#x27;slash&#x27; notation (e.g. `192.168.100.0/24`).

‎docs/dyn/datamigration_v1.projects.locations.conversionWorkspaces.html

+3-2
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ <h2>Instance Methods</h2>
9595
<code><a href="#create">create(parent, body=None, conversionWorkspaceId=None, requestId=None, x__xgafv=None)</a></code></p>
9696
<p class="firstline">Creates a new conversion workspace in a given project and location.</p>
9797
<p class="toc_element">
98-
<code><a href="#delete">delete(name, requestId=None, x__xgafv=None)</a></code></p>
98+
<code><a href="#delete">delete(name, force=None, requestId=None, x__xgafv=None)</a></code></p>
9999
<p class="firstline">Deletes a single conversion workspace.</p>
100100
<p class="toc_element">
101101
<code><a href="#describeConversionWorkspaceRevisions">describeConversionWorkspaceRevisions(conversionWorkspace, commitId=None, x__xgafv=None)</a></code></p>
@@ -332,11 +332,12 @@ <h3>Method Details</h3>
332332
</div>
333333

334334
<div class="method">
335-
<code class="details" id="delete">delete(name, requestId=None, x__xgafv=None)</code>
335+
<code class="details" id="delete">delete(name, force=None, requestId=None, x__xgafv=None)</code>
336336
<pre>Deletes a single conversion workspace.
337337

338338
Args:
339339
name: string, Required. Name of the conversion workspace resource to delete. (required)
340+
force: boolean, Force delete the conversion workspace, even if there&#x27;s a running migration that is using the workspace.
340341
requestId: string, A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is ignored. It is recommended to always set this value to a UUID. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
341342
x__xgafv: string, V1 error format.
342343
Allowed values

‎docs/dyn/datamigration_v1.projects.locations.migrationJobs.html

+32
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,9 @@ <h2>Instance Methods</h2>
8686
<p class="toc_element">
8787
<code><a href="#generateSshScript">generateSshScript(migrationJob, body=None, x__xgafv=None)</a></code></p>
8888
<p class="firstline">Generate a SSH configuration script to configure the reverse SSH connectivity.</p>
89+
<p class="toc_element">
90+
<code><a href="#generateTcpProxyScript">generateTcpProxyScript(migrationJob, body=None, x__xgafv=None)</a></code></p>
91+
<p class="firstline">Generate a TCP Proxy configuration script to configure a cloud-hosted VM running a TCP Proxy.</p>
8992
<p class="toc_element">
9093
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
9194
<p class="firstline">Gets details of a single migration job.</p>
@@ -303,6 +306,35 @@ <h3>Method Details</h3>
303306
}</pre>
304307
</div>
305308

309+
<div class="method">
310+
<code class="details" id="generateTcpProxyScript">generateTcpProxyScript(migrationJob, body=None, x__xgafv=None)</code>
311+
<pre>Generate a TCP Proxy configuration script to configure a cloud-hosted VM running a TCP Proxy.
312+
313+
Args:
314+
migrationJob: string, Name of the migration job resource to generate the TCP Proxy script. (required)
315+
body: object, The request body.
316+
The object takes the form of:
317+
318+
{ # Request message for &#x27;GenerateTcpProxyScript&#x27; request.
319+
&quot;vmMachineType&quot;: &quot;A String&quot;, # Required. The type of the Compute instance that will host the proxy.
320+
&quot;vmName&quot;: &quot;A String&quot;, # Required. The name of the Compute instance that will host the proxy.
321+
&quot;vmSubnet&quot;: &quot;A String&quot;, # Required. The name of the subnet the Compute instance will use for private connectivity. Must be supplied in the form of projects/{project}/regions/{region}/subnetworks/{subnetwork}. Note: the region for the subnet must match the Compute instance region.
322+
&quot;vmZone&quot;: &quot;A String&quot;, # Optional. The Google Cloud Platform zone to create the VM in. The fully qualified name of the zone must be specified, including the region name, for example &quot;us-central1-b&quot;. If not specified, uses the &quot;-b&quot; zone of the destination Connection Profile&#x27;s region.
323+
}
324+
325+
x__xgafv: string, V1 error format.
326+
Allowed values
327+
1 - v1 error format
328+
2 - v2 error format
329+
330+
Returns:
331+
An object of the form:
332+
333+
{ # Response message for &#x27;GenerateTcpProxyScript&#x27; request.
334+
&quot;script&quot;: &quot;A String&quot;, # The TCP Proxy configuration script.
335+
}</pre>
336+
</div>
337+
306338
<div class="method">
307339
<code class="details" id="get">get(name, x__xgafv=None)</code>
308340
<pre>Gets details of a single migration job.

‎googleapiclient/discovery_cache/documents/datamigration.v1.json

+82-1
Original file line numberDiff line numberDiff line change
@@ -640,6 +640,11 @@
640640
"name"
641641
],
642642
"parameters": {
643+
"force": {
644+
"description": "Force delete the conversion workspace, even if there's a running migration that is using the workspace.",
645+
"location": "query",
646+
"type": "boolean"
647+
},
643648
"name": {
644649
"description": "Required. Name of the conversion workspace resource to delete.",
645650
"location": "path",
@@ -1188,6 +1193,34 @@
11881193
"https://www.googleapis.com/auth/cloud-platform"
11891194
]
11901195
},
1196+
"generateTcpProxyScript": {
1197+
"description": "Generate a TCP Proxy configuration script to configure a cloud-hosted VM running a TCP Proxy.",
1198+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}:generateTcpProxyScript",
1199+
"httpMethod": "POST",
1200+
"id": "datamigration.projects.locations.migrationJobs.generateTcpProxyScript",
1201+
"parameterOrder": [
1202+
"migrationJob"
1203+
],
1204+
"parameters": {
1205+
"migrationJob": {
1206+
"description": "Name of the migration job resource to generate the TCP Proxy script.",
1207+
"location": "path",
1208+
"pattern": "^projects/[^/]+/locations/[^/]+/migrationJobs/[^/]+$",
1209+
"required": true,
1210+
"type": "string"
1211+
}
1212+
},
1213+
"path": "v1/{+migrationJob}:generateTcpProxyScript",
1214+
"request": {
1215+
"$ref": "GenerateTcpProxyScriptRequest"
1216+
},
1217+
"response": {
1218+
"$ref": "TcpProxyScript"
1219+
},
1220+
"scopes": [
1221+
"https://www.googleapis.com/auth/cloud-platform"
1222+
]
1223+
},
11911224
"get": {
11921225
"description": "Gets details of a single migration job.",
11931226
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}",
@@ -1918,7 +1951,7 @@
19181951
}
19191952
}
19201953
},
1921-
"revision": "20230610",
1954+
"revision": "20230622",
19221955
"rootUrl": "https://datamigration.googleapis.com/",
19231956
"schemas": {
19241957
"AlloyDbConnectionProfile": {
@@ -2279,6 +2312,20 @@
22792312
],
22802313
"type": "string"
22812314
},
2315+
"edition": {
2316+
"description": "Optional. The edition of the given Cloud SQL instance.",
2317+
"enum": [
2318+
"EDITION_UNSPECIFIED",
2319+
"ENTERPRISE",
2320+
"ENTERPRISE_PLUS"
2321+
],
2322+
"enumDescriptions": [
2323+
"The instance did not specify the edition.",
2324+
"The instance is an enterprise edition.",
2325+
"The instance is an enterprise plus edition."
2326+
],
2327+
"type": "string"
2328+
},
22822329
"ipConfig": {
22832330
"$ref": "SqlIpConfig",
22842331
"description": "The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled."
@@ -3160,6 +3207,29 @@
31603207
},
31613208
"type": "object"
31623209
},
3210+
"GenerateTcpProxyScriptRequest": {
3211+
"description": "Request message for 'GenerateTcpProxyScript' request.",
3212+
"id": "GenerateTcpProxyScriptRequest",
3213+
"properties": {
3214+
"vmMachineType": {
3215+
"description": "Required. The type of the Compute instance that will host the proxy.",
3216+
"type": "string"
3217+
},
3218+
"vmName": {
3219+
"description": "Required. The name of the Compute instance that will host the proxy.",
3220+
"type": "string"
3221+
},
3222+
"vmSubnet": {
3223+
"description": "Required. The name of the subnet the Compute instance will use for private connectivity. Must be supplied in the form of projects/{project}/regions/{region}/subnetworks/{subnetwork}. Note: the region for the subnet must match the Compute instance region.",
3224+
"type": "string"
3225+
},
3226+
"vmZone": {
3227+
"description": "Optional. The Google Cloud Platform zone to create the VM in. The fully qualified name of the zone must be specified, including the region name, for example \"us-central1-b\". If not specified, uses the \"-b\" zone of the destination Connection Profile's region.",
3228+
"type": "string"
3229+
}
3230+
},
3231+
"type": "object"
3232+
},
31633233
"GoogleCloudClouddmsV1OperationMetadata": {
31643234
"description": "Represents the metadata of the long-running operation.",
31653235
"id": "GoogleCloudClouddmsV1OperationMetadata",
@@ -4545,6 +4615,17 @@
45454615
},
45464616
"type": "object"
45474617
},
4618+
"TcpProxyScript": {
4619+
"description": "Response message for 'GenerateTcpProxyScript' request.",
4620+
"id": "TcpProxyScript",
4621+
"properties": {
4622+
"script": {
4623+
"description": "The TCP Proxy configuration script.",
4624+
"type": "string"
4625+
}
4626+
},
4627+
"type": "object"
4628+
},
45484629
"TestIamPermissionsRequest": {
45494630
"description": "Request message for `TestIamPermissions` method.",
45504631
"id": "TestIamPermissionsRequest",

‎googleapiclient/discovery_cache/documents/datamigration.v1beta1.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1049,7 +1049,7 @@
10491049
}
10501050
}
10511051
},
1052-
"revision": "20230610",
1052+
"revision": "20230622",
10531053
"rootUrl": "https://datamigration.googleapis.com/",
10541054
"schemas": {
10551055
"AuditConfig": {

0 commit comments

Comments
 (0)
Please sign in to comment.