From 12effe4a38299bb6f1fc61afeb1359200e9eff0b Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 20 Dec 2022 07:08:00 +0000 Subject: [PATCH] feat(datamigration): update the api #### datamigration:v1 The following keys were added: - resources.projects.resources.locations.resources.connectionProfiles.methods.create.parameters.skipValidation (Total Keys: 2) - resources.projects.resources.locations.resources.connectionProfiles.methods.create.parameters.validateOnly (Total Keys: 2) - resources.projects.resources.locations.resources.connectionProfiles.methods.patch.parameters.skipValidation (Total Keys: 2) - resources.projects.resources.locations.resources.connectionProfiles.methods.patch.parameters.validateOnly (Total Keys: 2) - resources.projects.resources.locations.resources.conversionWorkspaces.methods.apply (Total Keys: 12) - resources.projects.resources.locations.resources.conversionWorkspaces.methods.commit (Total Keys: 12) - resources.projects.resources.locations.resources.conversionWorkspaces.methods.convert (Total Keys: 12) - resources.projects.resources.locations.resources.conversionWorkspaces.methods.create (Total Keys: 16) - resources.projects.resources.locations.resources.conversionWorkspaces.methods.delete (Total Keys: 13) - resources.projects.resources.locations.resources.conversionWorkspaces.methods.describeDatabaseEntities (Total Keys: 24) - resources.projects.resources.locations.resources.conversionWorkspaces.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.conversionWorkspaces.methods.list (Total Keys: 18) - resources.projects.resources.locations.resources.conversionWorkspaces.methods.patch (Total Keys: 17) - resources.projects.resources.locations.resources.conversionWorkspaces.methods.rollback (Total Keys: 12) - resources.projects.resources.locations.resources.conversionWorkspaces.methods.searchBackgroundJobs (Total Keys: 19) - resources.projects.resources.locations.resources.conversionWorkspaces.methods.seed (Total Keys: 12) - resources.projects.resources.locations.resources.conversionWorkspaces.resources.mappingRules.methods.import (Total Keys: 12) - resources.projects.resources.locations.resources.privateConnections.methods.create (Total Keys: 16) - resources.projects.resources.locations.resources.privateConnections.methods.delete (Total Keys: 13) - resources.projects.resources.locations.resources.privateConnections.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.privateConnections.methods.list (Total Keys: 20) - schemas.ApplyConversionWorkspaceRequest (Total Keys: 4) - schemas.BackgroundJobLogEntry (Total Keys: 13) - schemas.ColumnEntity (Total Keys: 28) - schemas.CommitConversionWorkspaceRequest (Total Keys: 3) - schemas.ConnectionProfile.properties.oracle.$ref (Total Keys: 1) - schemas.ConstraintEntity (Total Keys: 12) - schemas.ConversionWorkspace (Total Keys: 25) - schemas.ConvertConversionWorkspaceRequest (Total Keys: 4) - schemas.DatabaseEngineInfo (Total Keys: 4) - schemas.DatabaseEntity (Total Keys: 16) - schemas.DescribeDatabaseEntitiesResponse (Total Keys: 5) - schemas.EntityMapping (Total Keys: 10) - schemas.ForwardSshTunnelConnectivity (Total Keys: 8) - schemas.FunctionEntity (Total Keys: 5) - schemas.ImportMappingRulesRequest (Total Keys: 6) - schemas.ImportRulesJobDetails (Total Keys: 5) - schemas.IndexEntity (Total Keys: 9) - schemas.ListConversionWorkspacesResponse (Total Keys: 7) - schemas.ListPrivateConnectionsResponse (Total Keys: 7) - schemas.MigrationJob.properties.conversionWorkspace.$ref (Total Keys: 1) - schemas.MigrationJob.properties.filter.type (Total Keys: 1) - schemas.OracleConnectionProfile (Total Keys: 13) - schemas.PackageEntity (Total Keys: 6) - schemas.PostgreSqlConnectionProfile.properties.privateServiceConnectConnectivity.$ref (Total Keys: 1) - schemas.PostgreSqlConnectionProfile.properties.staticIpConnectivity.$ref (Total Keys: 1) - schemas.PrivateConnection (Total Keys: 17) - schemas.PrivateConnectivity (Total Keys: 3) - schemas.PrivateServiceConnectConnectivity (Total Keys: 3) - schemas.RollbackConversionWorkspaceRequest (Total Keys: 2) - schemas.RulesFile (Total Keys: 4) - schemas.SchemaEntity (Total Keys: 4) - schemas.SearchBackgroundJobsResponse (Total Keys: 4) - schemas.SeedConversionWorkspaceRequest (Total Keys: 5) - schemas.SeedJobDetails (Total Keys: 3) - schemas.SequenceEntity (Total Keys: 15) - schemas.StaticServiceIpConnectivity (Total Keys: 2) - schemas.StoredProcedureEntity (Total Keys: 5) - schemas.SynonymEntity (Total Keys: 6) - schemas.TableEntity (Total Keys: 13) - schemas.TriggerEntity (Total Keys: 9) - schemas.ViewEntity (Total Keys: 7) - schemas.VpcPeeringConfig (Total Keys: 4) --- ...projects.locations.connectionProfiles.html | 112 +- ...ojects.locations.conversionWorkspaces.html | 891 +++++++ ...ons.conversionWorkspaces.mappingRules.html | 138 + .../datamigration_v1.projects.locations.html | 10 + ...n_v1.projects.locations.migrationJobs.html | 20 + ...projects.locations.privateConnections.html | 305 +++ .../documents/datamigration.v1.json | 2221 +++++++++++++++-- .../documents/datamigration.v1beta1.json | 2 +- 8 files changed, 3521 insertions(+), 178 deletions(-) create mode 100644 docs/dyn/datamigration_v1.projects.locations.conversionWorkspaces.html create mode 100644 docs/dyn/datamigration_v1.projects.locations.conversionWorkspaces.mappingRules.html create mode 100644 docs/dyn/datamigration_v1.projects.locations.privateConnections.html diff --git a/docs/dyn/datamigration_v1.projects.locations.connectionProfiles.html b/docs/dyn/datamigration_v1.projects.locations.connectionProfiles.html index e904048fdc0..cc693d6c2ce 100644 --- a/docs/dyn/datamigration_v1.projects.locations.connectionProfiles.html +++ b/docs/dyn/datamigration_v1.projects.locations.connectionProfiles.html @@ -78,7 +78,7 @@

Instance Methods

close()

Close httplib2 connections.

- create(parent, body=None, connectionProfileId=None, requestId=None, x__xgafv=None)

+ create(parent, body=None, connectionProfileId=None, requestId=None, skipValidation=None, validateOnly=None, x__xgafv=None)

Creates a new connection profile in a given project and location.

delete(name, force=None, requestId=None, x__xgafv=None)

@@ -96,7 +96,7 @@

Instance Methods

list_next()

Retrieves the next page of results.

- patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)

+ patch(name, body=None, requestId=None, skipValidation=None, updateMask=None, validateOnly=None, x__xgafv=None)

Update the configuration of a single connection profile.

setIamPolicy(resource, body=None, x__xgafv=None)

@@ -111,7 +111,7 @@

Method Details

- create(parent, body=None, connectionProfileId=None, requestId=None, x__xgafv=None) + create(parent, body=None, connectionProfileId=None, requestId=None, skipValidation=None, validateOnly=None, x__xgafv=None)
Creates a new connection profile in a given project and location.
 
 Args:
@@ -218,6 +218,26 @@ 

Method Details

"username": "A String", # Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service. }, "name": "A String", # The name of this connection profile resource in the form of projects/{project}/locations/{location}/connectionProfiles/{connectionProfile}. + "oracle": { # Specifies connection parameters required specifically for Oracle databases. # An Oracle database connection profile. + "databaseService": "A String", # Required. Database service for the Oracle connection. + "forwardSshConnectivity": { # Forward SSH Tunnel connectivity. # Forward SSH tunnel connectivity. + "hostname": "A String", # Required. Hostname for the SSH tunnel. + "password": "A String", # Input only. SSH password. + "port": 42, # Port for the SSH tunnel, default value is 22. + "privateKey": "A String", # Input only. SSH private key. + "username": "A String", # Required. Username for the SSH tunnel. + }, + "host": "A String", # Required. The IP or hostname of the source Oracle database. + "password": "A String", # Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service. + "passwordSet": True or False, # Output only. Indicates whether a new password is included in the request. + "port": 42, # Required. The network port of the source Oracle database. + "privateConnectivity": { # Private Connectivity. # Private connectivity. + "privateConnection": "A String", # Required. The resource name (URI) of the private connection. + }, + "staticServiceIpConnectivity": { # Static IP address connectivity configured on service project. # Static Service IP connectivity. + }, + "username": "A String", # Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service. + }, "postgresql": { # Specifies connection parameters required specifically for PostgreSQL databases. # A PostgreSQL database connection profile. "cloudSqlId": "A String", # If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source. "host": "A String", # Required. The IP or hostname of the source PostgreSQL database. @@ -225,12 +245,17 @@

Method Details

"password": "A String", # Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service. "passwordSet": True or False, # Output only. Indicates If this connection profile password is stored. "port": 42, # Required. The network port of the source PostgreSQL database. + "privateServiceConnectConnectivity": { # Private Service Connect connectivity (https://cloud.google.com/vpc/docs/private-service-connect#benefits-services) # Private service connect connectivity. + "serviceAttachment": "A String", # Required. A service attachment that exposes a database, and has the following format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment_name} + }, "ssl": { # SSL configuration information. # SSL configuration for the destination to connect to the source database. "caCertificate": "A String", # Required. Input only. The x509 PEM-encoded certificate of the CA that signed the source database server's certificate. The replica will use this certificate to verify it's connecting to the right host. "clientCertificate": "A String", # Input only. The x509 PEM-encoded certificate that will be used by the replica to authenticate against the source database server.If this field is used then the 'client_key' field is mandatory. "clientKey": "A String", # Input only. The unencrypted PKCS#1 or PKCS#8 PEM-encoded private key associated with the Client Certificate. If this field is used then the 'client_certificate' field is mandatory. "type": "A String", # Output only. The ssl config type according to 'client_key', 'client_certificate' and 'ca_certificate'. }, + "staticIpConnectivity": { # The source database will allow incoming connections from the destination database's public IP. You can retrieve the Cloud SQL instance's public IP from the Cloud SQL console or using Cloud SQL APIs. No additional configuration is required. # Static ip connectivity data (default, no additional details needed). + }, "username": "A String", # Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service. }, "provider": "A String", # The database provider. @@ -240,6 +265,8 @@

Method Details

connectionProfileId: string, Required. The connection profile identifier. requestId: string, A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be 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. + skipValidation: boolean, Optional. Create the connection profile without validating it. The default is false. Only supported for Oracle connection profiles. + validateOnly: boolean, Optional. Only validate the connection profile, but don't create any resources. The default is false. Only supported for Oracle connection profiles. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -419,6 +446,26 @@

Method Details

"username": "A String", # Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service. }, "name": "A String", # The name of this connection profile resource in the form of projects/{project}/locations/{location}/connectionProfiles/{connectionProfile}. + "oracle": { # Specifies connection parameters required specifically for Oracle databases. # An Oracle database connection profile. + "databaseService": "A String", # Required. Database service for the Oracle connection. + "forwardSshConnectivity": { # Forward SSH Tunnel connectivity. # Forward SSH tunnel connectivity. + "hostname": "A String", # Required. Hostname for the SSH tunnel. + "password": "A String", # Input only. SSH password. + "port": 42, # Port for the SSH tunnel, default value is 22. + "privateKey": "A String", # Input only. SSH private key. + "username": "A String", # Required. Username for the SSH tunnel. + }, + "host": "A String", # Required. The IP or hostname of the source Oracle database. + "password": "A String", # Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service. + "passwordSet": True or False, # Output only. Indicates whether a new password is included in the request. + "port": 42, # Required. The network port of the source Oracle database. + "privateConnectivity": { # Private Connectivity. # Private connectivity. + "privateConnection": "A String", # Required. The resource name (URI) of the private connection. + }, + "staticServiceIpConnectivity": { # Static IP address connectivity configured on service project. # Static Service IP connectivity. + }, + "username": "A String", # Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service. + }, "postgresql": { # Specifies connection parameters required specifically for PostgreSQL databases. # A PostgreSQL database connection profile. "cloudSqlId": "A String", # If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source. "host": "A String", # Required. The IP or hostname of the source PostgreSQL database. @@ -426,12 +473,17 @@

Method Details

"password": "A String", # Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service. "passwordSet": True or False, # Output only. Indicates If this connection profile password is stored. "port": 42, # Required. The network port of the source PostgreSQL database. + "privateServiceConnectConnectivity": { # Private Service Connect connectivity (https://cloud.google.com/vpc/docs/private-service-connect#benefits-services) # Private service connect connectivity. + "serviceAttachment": "A String", # Required. A service attachment that exposes a database, and has the following format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment_name} + }, "ssl": { # SSL configuration information. # SSL configuration for the destination to connect to the source database. "caCertificate": "A String", # Required. Input only. The x509 PEM-encoded certificate of the CA that signed the source database server's certificate. The replica will use this certificate to verify it's connecting to the right host. "clientCertificate": "A String", # Input only. The x509 PEM-encoded certificate that will be used by the replica to authenticate against the source database server.If this field is used then the 'client_key' field is mandatory. "clientKey": "A String", # Input only. The unencrypted PKCS#1 or PKCS#8 PEM-encoded private key associated with the Client Certificate. If this field is used then the 'client_certificate' field is mandatory. "type": "A String", # Output only. The ssl config type according to 'client_key', 'client_certificate' and 'ca_certificate'. }, + "staticIpConnectivity": { # The source database will allow incoming connections from the destination database's public IP. You can retrieve the Cloud SQL instance's public IP from the Cloud SQL console or using Cloud SQL APIs. No additional configuration is required. # Static ip connectivity data (default, no additional details needed). + }, "username": "A String", # Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service. }, "provider": "A String", # The database provider. @@ -607,6 +659,26 @@

Method Details

"username": "A String", # Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service. }, "name": "A String", # The name of this connection profile resource in the form of projects/{project}/locations/{location}/connectionProfiles/{connectionProfile}. + "oracle": { # Specifies connection parameters required specifically for Oracle databases. # An Oracle database connection profile. + "databaseService": "A String", # Required. Database service for the Oracle connection. + "forwardSshConnectivity": { # Forward SSH Tunnel connectivity. # Forward SSH tunnel connectivity. + "hostname": "A String", # Required. Hostname for the SSH tunnel. + "password": "A String", # Input only. SSH password. + "port": 42, # Port for the SSH tunnel, default value is 22. + "privateKey": "A String", # Input only. SSH private key. + "username": "A String", # Required. Username for the SSH tunnel. + }, + "host": "A String", # Required. The IP or hostname of the source Oracle database. + "password": "A String", # Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service. + "passwordSet": True or False, # Output only. Indicates whether a new password is included in the request. + "port": 42, # Required. The network port of the source Oracle database. + "privateConnectivity": { # Private Connectivity. # Private connectivity. + "privateConnection": "A String", # Required. The resource name (URI) of the private connection. + }, + "staticServiceIpConnectivity": { # Static IP address connectivity configured on service project. # Static Service IP connectivity. + }, + "username": "A String", # Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service. + }, "postgresql": { # Specifies connection parameters required specifically for PostgreSQL databases. # A PostgreSQL database connection profile. "cloudSqlId": "A String", # If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source. "host": "A String", # Required. The IP or hostname of the source PostgreSQL database. @@ -614,12 +686,17 @@

Method Details

"password": "A String", # Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service. "passwordSet": True or False, # Output only. Indicates If this connection profile password is stored. "port": 42, # Required. The network port of the source PostgreSQL database. + "privateServiceConnectConnectivity": { # Private Service Connect connectivity (https://cloud.google.com/vpc/docs/private-service-connect#benefits-services) # Private service connect connectivity. + "serviceAttachment": "A String", # Required. A service attachment that exposes a database, and has the following format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment_name} + }, "ssl": { # SSL configuration information. # SSL configuration for the destination to connect to the source database. "caCertificate": "A String", # Required. Input only. The x509 PEM-encoded certificate of the CA that signed the source database server's certificate. The replica will use this certificate to verify it's connecting to the right host. "clientCertificate": "A String", # Input only. The x509 PEM-encoded certificate that will be used by the replica to authenticate against the source database server.If this field is used then the 'client_key' field is mandatory. "clientKey": "A String", # Input only. The unencrypted PKCS#1 or PKCS#8 PEM-encoded private key associated with the Client Certificate. If this field is used then the 'client_certificate' field is mandatory. "type": "A String", # Output only. The ssl config type according to 'client_key', 'client_certificate' and 'ca_certificate'. }, + "staticIpConnectivity": { # The source database will allow incoming connections from the destination database's public IP. You can retrieve the Cloud SQL instance's public IP from the Cloud SQL console or using Cloud SQL APIs. No additional configuration is required. # Static ip connectivity data (default, no additional details needed). + }, "username": "A String", # Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service. }, "provider": "A String", # The database provider. @@ -649,7 +726,7 @@

Method Details

- patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None) + patch(name, body=None, requestId=None, skipValidation=None, updateMask=None, validateOnly=None, x__xgafv=None)
Update the configuration of a single connection profile.
 
 Args:
@@ -756,6 +833,26 @@ 

Method Details

"username": "A String", # Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service. }, "name": "A String", # The name of this connection profile resource in the form of projects/{project}/locations/{location}/connectionProfiles/{connectionProfile}. + "oracle": { # Specifies connection parameters required specifically for Oracle databases. # An Oracle database connection profile. + "databaseService": "A String", # Required. Database service for the Oracle connection. + "forwardSshConnectivity": { # Forward SSH Tunnel connectivity. # Forward SSH tunnel connectivity. + "hostname": "A String", # Required. Hostname for the SSH tunnel. + "password": "A String", # Input only. SSH password. + "port": 42, # Port for the SSH tunnel, default value is 22. + "privateKey": "A String", # Input only. SSH private key. + "username": "A String", # Required. Username for the SSH tunnel. + }, + "host": "A String", # Required. The IP or hostname of the source Oracle database. + "password": "A String", # Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service. + "passwordSet": True or False, # Output only. Indicates whether a new password is included in the request. + "port": 42, # Required. The network port of the source Oracle database. + "privateConnectivity": { # Private Connectivity. # Private connectivity. + "privateConnection": "A String", # Required. The resource name (URI) of the private connection. + }, + "staticServiceIpConnectivity": { # Static IP address connectivity configured on service project. # Static Service IP connectivity. + }, + "username": "A String", # Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service. + }, "postgresql": { # Specifies connection parameters required specifically for PostgreSQL databases. # A PostgreSQL database connection profile. "cloudSqlId": "A String", # If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source. "host": "A String", # Required. The IP or hostname of the source PostgreSQL database. @@ -763,12 +860,17 @@

Method Details

"password": "A String", # Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service. "passwordSet": True or False, # Output only. Indicates If this connection profile password is stored. "port": 42, # Required. The network port of the source PostgreSQL database. + "privateServiceConnectConnectivity": { # Private Service Connect connectivity (https://cloud.google.com/vpc/docs/private-service-connect#benefits-services) # Private service connect connectivity. + "serviceAttachment": "A String", # Required. A service attachment that exposes a database, and has the following format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment_name} + }, "ssl": { # SSL configuration information. # SSL configuration for the destination to connect to the source database. "caCertificate": "A String", # Required. Input only. The x509 PEM-encoded certificate of the CA that signed the source database server's certificate. The replica will use this certificate to verify it's connecting to the right host. "clientCertificate": "A String", # Input only. The x509 PEM-encoded certificate that will be used by the replica to authenticate against the source database server.If this field is used then the 'client_key' field is mandatory. "clientKey": "A String", # Input only. The unencrypted PKCS#1 or PKCS#8 PEM-encoded private key associated with the Client Certificate. If this field is used then the 'client_certificate' field is mandatory. "type": "A String", # Output only. The ssl config type according to 'client_key', 'client_certificate' and 'ca_certificate'. }, + "staticIpConnectivity": { # The source database will allow incoming connections from the destination database's public IP. You can retrieve the Cloud SQL instance's public IP from the Cloud SQL console or using Cloud SQL APIs. No additional configuration is required. # Static ip connectivity data (default, no additional details needed). + }, "username": "A String", # Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service. }, "provider": "A String", # The database provider. @@ -777,7 +879,9 @@

Method Details

} requestId: string, A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be 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. + skipValidation: boolean, Optional. Update the connection profile without validating it. The default is false. Only supported for Oracle connection profiles. updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the connection profile resource by the update. + validateOnly: boolean, Optional. Only validate the connection profile, but don't update any resources. The default is false. Only supported for Oracle connection profiles. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/datamigration_v1.projects.locations.conversionWorkspaces.html b/docs/dyn/datamigration_v1.projects.locations.conversionWorkspaces.html new file mode 100644 index 00000000000..95dc8014bfa --- /dev/null +++ b/docs/dyn/datamigration_v1.projects.locations.conversionWorkspaces.html @@ -0,0 +1,891 @@ + + + +

Database Migration API . projects . locations . conversionWorkspaces

+

Instance Methods

+

+ mappingRules() +

+

Returns the mappingRules Resource.

+ +

+ apply(name, body=None, x__xgafv=None)

+

Apply draft tree onto a specific destination database

+

+ close()

+

Close httplib2 connections.

+

+ commit(name, body=None, x__xgafv=None)

+

Marks all the data in the conversion workspace as committed.

+

+ convert(name, body=None, x__xgafv=None)

+

Creates a draft tree schema for the destination database.

+

+ create(parent, body=None, conversionWorkspaceId=None, requestId=None, x__xgafv=None)

+

Creates a new conversion workspace in a given project and location.

+

+ delete(name, requestId=None, x__xgafv=None)

+

Deletes a single conversion workspace.

+

+ describeConversionWorkspaceRevisions(conversionWorkspace, commitId=None, x__xgafv=None)

+

Retrieves a list of committed revisions of a specific conversion workspace.

+

+ describeDatabaseEntities(conversionWorkspace, commitId=None, filter=None, pageSize=None, pageToken=None, tree=None, uncommitted=None, x__xgafv=None)

+

Use this method to describe the database entities tree for a specific conversion workspace and a specific tree type. The DB Entities are not a resource like conversion workspace or mapping rule, and they can not be created, updated or deleted like one. Instead they are simple data objects describing the structure of the client database.

+

+ describeDatabaseEntities_next()

+

Retrieves the next page of results.

+

+ get(name, x__xgafv=None)

+

Gets details of a single conversion workspace.

+

+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists conversion workspaces in a given project and location.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)

+

Updates the parameters of a single conversion workspace.

+

+ rollback(name, body=None, x__xgafv=None)

+

Rollbacks a conversion workspace to the last committed spanshot.

+

+ searchBackgroundJobs(conversionWorkspace, completedUntilTime=None, maxSize=None, returnMostRecentPerJobType=None, x__xgafv=None)

+

Use this method to search/list the background jobs for a specific conversion workspace. The background jobs are not a resource like conversion workspace or mapping rule, and they can not be created, updated or deleted like one. Instead they are a way to expose the data plane jobs log.

+

+ seed(name, body=None, x__xgafv=None)

+

Imports a snapshot of the source database into the conversion workspace.

+

Method Details

+
+ apply(name, body=None, x__xgafv=None) +
Apply draft tree onto a specific destination database
+
+Args:
+  name: string, Required. Name of the conversion workspace resource to apply draft to destination for. in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for 'ApplyConversionWorkspace' request.
+  "connectionProfile": "A String", # Fully qualified (Uri) name of the destination connection profile.
+  "filter": "A String", # Filter which entities to apply. Leaving this field empty will apply all of the entities. Supports Google AIP 160 based filtering.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ commit(name, body=None, x__xgafv=None) +
Marks all the data in the conversion workspace as committed.
+
+Args:
+  name: string, Required. Name of the conversion workspace resource to commit. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for 'CommitConversionWorkspace' request.
+  "commitName": "A String", # Optional name of the commit.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ convert(name, body=None, x__xgafv=None) +
Creates a draft tree schema for the destination database.
+
+Args:
+  name: string, Name of the conversion workspace resource to convert in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for 'ConvertConversionWorkspace' request.
+  "autoCommit": True or False, # Should the conversion workspace be committed automatically after the conversion.
+  "filter": "A String", # Filter the entities to convert. Leaving this field empty will convert all of the entities. Supports Google AIP-160 style filtering.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ create(parent, body=None, conversionWorkspaceId=None, requestId=None, x__xgafv=None) +
Creates a new conversion workspace in a given project and location.
+
+Args:
+  parent: string, Required. The parent, which owns this collection of conversion workspaces. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The main conversion workspace resource entity.
+  "createTime": "A String", # Output only. The timestamp when the workspace resource was created.
+  "destination": { # The type and version of a source or destination DB. # Required. The destination engine details.
+    "engine": "A String", # Required. Engine Type.
+    "version": "A String", # Required. Engine named version, for e.g. 12.c.1
+  },
+  "displayName": "A String", # The display name for the workspace
+  "globalSettings": { # A generic list of settings for the workspace. The settings are database pair dependant and can indicate default behavior for the mapping rules engine or turn on or off specific features. Such examples can be: convert_foreign_key_to_interleave=true, skip_triggers=false, ignore_non_table_synonyms=true
+    "a_key": "A String",
+  },
+  "hasUncommittedChanges": True or False, # Output only. Whether the workspace has uncommitted changes (changes which were made after the workspace was committed)
+  "latestCommitId": "A String", # Output only. The latest commit id
+  "latestCommitTime": "A String", # Output only. The timestamp when the workspace was committed.
+  "name": "A String", # Full name of the workspace resource, in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
+  "source": { # The type and version of a source or destination DB. # Required. The source engine details.
+    "engine": "A String", # Required. Engine Type.
+    "version": "A String", # Required. Engine named version, for e.g. 12.c.1
+  },
+  "updateTime": "A String", # Output only. The timestamp when the workspace resource was last updated.
+}
+
+  conversionWorkspaceId: string, Required. The ID of the conversion workspace to create.
+  requestId: string, A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be 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.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ delete(name, requestId=None, x__xgafv=None) +
Deletes a single conversion workspace.
+
+Args:
+  name: string, Required. Name of the conversion workspace resource to delete. (required)
+  requestId: string, A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be 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.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ describeConversionWorkspaceRevisions(conversionWorkspace, commitId=None, x__xgafv=None) +
Retrieves a list of committed revisions of a specific conversion workspace.
+
+Args:
+  conversionWorkspace: string, Required. Name of the conversion workspace resource whose revisions are listed. in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}. (required)
+  commitId: string, Optional filter to request a specific commit id
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for 'DescribeConversionWorkspaceRevisions' request.
+  "revisions": [ # The list of conversion workspace revisions.
+    { # The main conversion workspace resource entity.
+      "createTime": "A String", # Output only. The timestamp when the workspace resource was created.
+      "destination": { # The type and version of a source or destination DB. # Required. The destination engine details.
+        "engine": "A String", # Required. Engine Type.
+        "version": "A String", # Required. Engine named version, for e.g. 12.c.1
+      },
+      "displayName": "A String", # The display name for the workspace
+      "globalSettings": { # A generic list of settings for the workspace. The settings are database pair dependant and can indicate default behavior for the mapping rules engine or turn on or off specific features. Such examples can be: convert_foreign_key_to_interleave=true, skip_triggers=false, ignore_non_table_synonyms=true
+        "a_key": "A String",
+      },
+      "hasUncommittedChanges": True or False, # Output only. Whether the workspace has uncommitted changes (changes which were made after the workspace was committed)
+      "latestCommitId": "A String", # Output only. The latest commit id
+      "latestCommitTime": "A String", # Output only. The timestamp when the workspace was committed.
+      "name": "A String", # Full name of the workspace resource, in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
+      "source": { # The type and version of a source or destination DB. # Required. The source engine details.
+        "engine": "A String", # Required. Engine Type.
+        "version": "A String", # Required. Engine named version, for e.g. 12.c.1
+      },
+      "updateTime": "A String", # Output only. The timestamp when the workspace resource was last updated.
+    },
+  ],
+}
+
+ +
+ describeDatabaseEntities(conversionWorkspace, commitId=None, filter=None, pageSize=None, pageToken=None, tree=None, uncommitted=None, x__xgafv=None) +
Use this method to describe the database entities tree for a specific conversion workspace and a specific tree type. The DB Entities are not a resource like conversion workspace or mapping rule, and they can not be created, updated or deleted like one. Instead they are simple data objects describing the structure of the client database.
+
+Args:
+  conversionWorkspace: string, Required. Name of the conversion workspace resource whose DB entities are described in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}. (required)
+  commitId: string, Request a specific commit id. If not specified, the entities from the latest commit are returned.
+  filter: string, Filter the returned entities based on AIP-160 standard
+  pageSize: integer, The maximum number of entities to return. The service may return fewer than this value.
+  pageToken: string, The nextPageToken value received in the previous call to conversionWorkspace.describeDatabaseEntities, used in the subsequent request to retrieve the next page of results. On first call this should be left blank. When paginating, all other parameters provided to conversionWorkspace.describeDatabaseEntities must match the call that provided the page token.
+  tree: string, The tree to fetch
+    Allowed values
+      DB_TREE_TYPE_UNSPECIFIED - Unspecified tree type
+      SOURCE_TREE - The source database tree
+      DRAFT_TREE - The draft database tree
+      DESTINATION_TREE - The destination database tree
+  uncommitted: boolean, Whether to retrieve the latest committed version of the entities or the latest version. This field is ignored if a specific commit_id is specified.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for 'DescribeDatabaseEntities' request.
+  "databaseEntities": [ # The list of database entities for the conversion workspace.
+    { # The base entity type for all the database related entities The message contains the entity name, the name of its parent, its type and the specific details per its type
+      "databaseFunction": { # Function's parent is a schema. # Function
+        "customFeatures": { # Custom engine specific features
+          "a_key": "", # Properties of the object.
+        },
+        "sqlCode": "A String", # The SQL code which creates the function
+      },
+      "databasePackage": { # Package's parent is a schema. # Package
+        "customFeatures": { # Custom engine specific features
+          "a_key": "", # Properties of the object.
+        },
+        "packageBody": "A String", # The SQL code which creates the package body. If the package specification has cursors or subprograms, then the package body is mandatory.
+        "packageSqlCode": "A String", # The SQL code which creates the package
+      },
+      "entityType": "A String", # The type of the database entity (table, view, index, ...).
+      "mappings": [ # Details about entity mappings. For source tree entities, this holds the draft entities which were generated by the mapping rules. For draft tree entities, this holds the source entities which were converted to form the draft entity. Destination entities will have no mapping details.
+        { # Details of the mappings of a database entity.
+          "draftEntity": "A String", # Target entity full name. The draft entity can also include a column, index or constraint using the same naming notation schema.table.column
+          "mappingLog": [ # Entity mapping log entries. Multiple rules can be effective and contribute changes to a converted entity such as, a rule can handle the entity name, another rule can handle an entity type. In addition, rules which did not change the entity are also logged along the with the reason preventing them to do so.
+            { # A single record of a rule which was used for a mapping.
+              "mappingComment": "A String", # Comment.
+              "ruleId": "A String", # Which rule caused it.
+              "ruleRevisionId": "A String", # Rule revision id
+            },
+          ],
+          "sourceEntity": "A String", # Source entity full name. The source entity can also be a column, index or constraint using the same naming notation schema.table.column
+        },
+      ],
+      "parentEntity": "A String", # The full name of the parent entity (e.g. schema name).
+      "schema": { # Schema typically has no parent entity, but can have a parent entity DatabaseInstance (for database engines which supports it). For some database engines the term schema and user can be used interchangeably when they refer to a namespace or a collection of other database entities. Can store additional information which is schema specific. # Schema.
+        "customFeatures": { # Custom engine specific features
+          "a_key": "", # Properties of the object.
+        },
+      },
+      "sequence": { # Sequence's parent is a schema. # Sequence
+        "cache": "A String", # Indicates number of entries to cache / precreate
+        "customFeatures": { # Custom engine specific features
+          "a_key": "", # Properties of the object.
+        },
+        "cycle": True or False, # Indicates whether the sequence value should cycle through
+        "increment": "A String", # Increment value for the sequence
+        "maxValue": "A String", # Maximum number for the sequence represented as bytes to accommodate large numbers
+        "minValue": "A String", # Minimum number for the sequence represented as bytes to accommodate large numbers
+        "startValue": "A String", # Start number for the sequence represented as bytes to accommodate large numbers
+      },
+      "shortName": "A String", # The short name (e.g. table name) of the entity.
+      "storedProcedure": { # Stored procedure's parent is a schema. # Stored Procedure
+        "customFeatures": { # Custom engine specific features
+          "a_key": "", # Properties of the object.
+        },
+        "sqlCode": "A String", # The SQL code which creates the stored procedure
+      },
+      "synonym": { # Synonym's parent is a schema. # Synonym
+        "customFeatures": { # Custom engine specific features
+          "a_key": "", # Properties of the object.
+        },
+        "sourceEntity": "A String", # The name of the entity for which the synonym is being created (the source)
+        "sourceType": "A String", # The type of the entity for which the synonym is being created (usually a table or a sequence)
+      },
+      "table": { # Table's parent is a schema. # Table.
+        "columns": [ # Table Columns.
+          { # Column is not used as an independent entity, it is retrieved as part of a Table entity.
+            "array": True or False, # Is the column of array type
+            "arrayLength": 42, # If the column is array, of which length
+            "autoGenerated": True or False, # Is the column auto-generated/identity
+            "charset": "A String", # Charset override - instead of table level charset
+            "collation": "A String", # Collation override - instead of table level collation
+            "comment": "A String", # Comment associated with the column
+            "customFeatures": { # Custom engine specific features
+              "a_key": "", # Properties of the object.
+            },
+            "dataType": "A String", # Column data type
+            "defaultValue": "A String", # Default value of the column
+            "fractionalSecondsPrecision": 42, # Column fractional second precision - used for timestamp based datatypes
+            "length": "A String", # Column length - e.g. varchar (50)
+            "name": "A String", # Column name
+            "nullable": True or False, # Is the column nullable
+            "ordinalPosition": 42, # Column order in the table
+            "precision": 42, # Column precision - when relevant
+            "scale": 42, # Column scale - when relevant
+            "setValues": [ # Specifies the list of values allowed in the column. List is empty if set values is not required
+              "A String",
+            ],
+            "udt": True or False, # Is the column a UDT
+          },
+        ],
+        "comment": "A String", # Comment associated with the table
+        "constraints": [ # Table Constraints.
+          { # Constraint is not used as an independent entity, it is retrieved as part of another entity such as Table or View.
+            "customFeatures": { # Custom engine specific features
+              "a_key": "", # Properties of the object.
+            },
+            "name": "A String", # The name of the table constraint
+            "referenceColumns": [ # Reference Columns which may be associated with the constraint. eg: if the constraint is a FOREIGN_KEY, this represents the list of full names of referenced columns by the foreign key.
+              "A String",
+            ],
+            "referenceTable": "A String", # Reference table which may be associated with the constraint. eg: if the constraint is a FOREIGN_KEY, this represents the list of full name of the referenced table by the foreign key.
+            "tableColumns": [ # Table columns used as part of the Constraint for e.g. primary key constraint should list the columns which constitutes the key
+              "A String",
+            ],
+            "tableName": "A String", # Table which is associated with the constraint. In case the constraint is defined on a table, this field is left empty as this information is stored in parent_name. However, if constraint is defined on a view, this field stores the table name on which the view is defined.
+            "type": "A String", # Type of constraint - e.g. unique, primary key, foreign key (currently only primary key is supported)
+          },
+        ],
+        "customFeatures": { # Custom engine specific features
+          "a_key": "", # Properties of the object.
+        },
+        "indices": [ # Table Indices.
+          { # Index is not used as an independent entity, it is retrieved as part of a Table entity.
+            "customFeatures": { # Custom engine specific features
+              "a_key": "", # Properties of the object.
+            },
+            "name": "A String", # The name of the index
+            "tableColumns": [ # Table columns used as part of the Index for e.g. B-TREE index should list the columns which constitutes the index.
+              "A String",
+            ],
+            "type": "A String", # Type of index - e.g. B-TREE
+            "unique": True or False, # boolean value indicating whether the index is unique
+          },
+        ],
+        "triggers": [ # Table triggers.
+          { # Trigger is not used as an independent entity, it is retrieved as part of a Table entity.
+            "customFeatures": { # Custom engine specific features
+              "a_key": "", # Properties of the object.
+            },
+            "name": "A String", # The name of the trigger
+            "sqlCode": "A String", # The SQL code which creates the trigger
+            "triggerType": "A String", # Indicates when the trigger fires, e.g. BEFORE STATEMENT, AFTER EACH ROW
+            "triggeringEvents": [ # The DML, DDL, or database events that fires the trigger, e.g. INSERT, UPDATE
+              "A String",
+            ],
+          },
+        ],
+      },
+      "tree": "A String", # The type of tree the entity belongs to.
+      "view": { # View's parent is a schema. # View
+        "constraints": [ # View Constraints.
+          { # Constraint is not used as an independent entity, it is retrieved as part of another entity such as Table or View.
+            "customFeatures": { # Custom engine specific features
+              "a_key": "", # Properties of the object.
+            },
+            "name": "A String", # The name of the table constraint
+            "referenceColumns": [ # Reference Columns which may be associated with the constraint. eg: if the constraint is a FOREIGN_KEY, this represents the list of full names of referenced columns by the foreign key.
+              "A String",
+            ],
+            "referenceTable": "A String", # Reference table which may be associated with the constraint. eg: if the constraint is a FOREIGN_KEY, this represents the list of full name of the referenced table by the foreign key.
+            "tableColumns": [ # Table columns used as part of the Constraint for e.g. primary key constraint should list the columns which constitutes the key
+              "A String",
+            ],
+            "tableName": "A String", # Table which is associated with the constraint. In case the constraint is defined on a table, this field is left empty as this information is stored in parent_name. However, if constraint is defined on a view, this field stores the table name on which the view is defined.
+            "type": "A String", # Type of constraint - e.g. unique, primary key, foreign key (currently only primary key is supported)
+          },
+        ],
+        "customFeatures": { # Custom engine specific features
+          "a_key": "", # Properties of the object.
+        },
+        "sqlCode": "A String", # The SQL code which creates the view.
+      },
+    },
+  ],
+  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+
+ +
+ describeDatabaseEntities_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ get(name, x__xgafv=None) +
Gets details of a single conversion workspace.
+
+Args:
+  name: string, Required. Name of the conversion workspace resource to get. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The main conversion workspace resource entity.
+  "createTime": "A String", # Output only. The timestamp when the workspace resource was created.
+  "destination": { # The type and version of a source or destination DB. # Required. The destination engine details.
+    "engine": "A String", # Required. Engine Type.
+    "version": "A String", # Required. Engine named version, for e.g. 12.c.1
+  },
+  "displayName": "A String", # The display name for the workspace
+  "globalSettings": { # A generic list of settings for the workspace. The settings are database pair dependant and can indicate default behavior for the mapping rules engine or turn on or off specific features. Such examples can be: convert_foreign_key_to_interleave=true, skip_triggers=false, ignore_non_table_synonyms=true
+    "a_key": "A String",
+  },
+  "hasUncommittedChanges": True or False, # Output only. Whether the workspace has uncommitted changes (changes which were made after the workspace was committed)
+  "latestCommitId": "A String", # Output only. The latest commit id
+  "latestCommitTime": "A String", # Output only. The timestamp when the workspace was committed.
+  "name": "A String", # Full name of the workspace resource, in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
+  "source": { # The type and version of a source or destination DB. # Required. The source engine details.
+    "engine": "A String", # Required. Engine Type.
+    "version": "A String", # Required. Engine named version, for e.g. 12.c.1
+  },
+  "updateTime": "A String", # Output only. The timestamp when the workspace resource was last updated.
+}
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists conversion workspaces in a given project and location.
+
+Args:
+  parent: string, Required. The parent, which owns this collection of conversion workspaces. (required)
+  filter: string, A filter expression that filters conversion workspaces listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, list conversion workspaces created this year by specifying **createTime %gt; 2020-01-01T00:00:00.000000000Z.** You can also filter nested fields. For example, you could specify **source.version = "12.c.1"** to select all conversion workspaces with source database version equal to 12.c.1
+  pageSize: integer, The maximum number of conversion workspaces to return. The service may return fewer than this value. If unspecified, at most 50 sets will be returned.
+  pageToken: string, The nextPageToken value received in the previous call to conversionWorkspaces.list, used in the subsequent request to retrieve the next page of results. On first call this should be left blank. When paginating, all other parameters provided to conversionWorkspaces.list must match the call that provided the page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for 'ListConversionWorkspaces' request.
+  "conversionWorkspaces": [ # The list of conversion workspace objects.
+    { # The main conversion workspace resource entity.
+      "createTime": "A String", # Output only. The timestamp when the workspace resource was created.
+      "destination": { # The type and version of a source or destination DB. # Required. The destination engine details.
+        "engine": "A String", # Required. Engine Type.
+        "version": "A String", # Required. Engine named version, for e.g. 12.c.1
+      },
+      "displayName": "A String", # The display name for the workspace
+      "globalSettings": { # A generic list of settings for the workspace. The settings are database pair dependant and can indicate default behavior for the mapping rules engine or turn on or off specific features. Such examples can be: convert_foreign_key_to_interleave=true, skip_triggers=false, ignore_non_table_synonyms=true
+        "a_key": "A String",
+      },
+      "hasUncommittedChanges": True or False, # Output only. Whether the workspace has uncommitted changes (changes which were made after the workspace was committed)
+      "latestCommitId": "A String", # Output only. The latest commit id
+      "latestCommitTime": "A String", # Output only. The timestamp when the workspace was committed.
+      "name": "A String", # Full name of the workspace resource, in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
+      "source": { # The type and version of a source or destination DB. # Required. The source engine details.
+        "engine": "A String", # Required. Engine Type.
+        "version": "A String", # Required. Engine named version, for e.g. 12.c.1
+      },
+      "updateTime": "A String", # Output only. The timestamp when the workspace resource was last updated.
+    },
+  ],
+  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+  "unreachable": [ # Locations that could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None) +
Updates the parameters of a single conversion workspace.
+
+Args:
+  name: string, Full name of the workspace resource, in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The main conversion workspace resource entity.
+  "createTime": "A String", # Output only. The timestamp when the workspace resource was created.
+  "destination": { # The type and version of a source or destination DB. # Required. The destination engine details.
+    "engine": "A String", # Required. Engine Type.
+    "version": "A String", # Required. Engine named version, for e.g. 12.c.1
+  },
+  "displayName": "A String", # The display name for the workspace
+  "globalSettings": { # A generic list of settings for the workspace. The settings are database pair dependant and can indicate default behavior for the mapping rules engine or turn on or off specific features. Such examples can be: convert_foreign_key_to_interleave=true, skip_triggers=false, ignore_non_table_synonyms=true
+    "a_key": "A String",
+  },
+  "hasUncommittedChanges": True or False, # Output only. Whether the workspace has uncommitted changes (changes which were made after the workspace was committed)
+  "latestCommitId": "A String", # Output only. The latest commit id
+  "latestCommitTime": "A String", # Output only. The timestamp when the workspace was committed.
+  "name": "A String", # Full name of the workspace resource, in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
+  "source": { # The type and version of a source or destination DB. # Required. The source engine details.
+    "engine": "A String", # Required. Engine Type.
+    "version": "A String", # Required. Engine named version, for e.g. 12.c.1
+  },
+  "updateTime": "A String", # Output only. The timestamp when the workspace resource was last updated.
+}
+
+  requestId: string, A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be 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.
+  updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the conversion workspace resource by the update.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ rollback(name, body=None, x__xgafv=None) +
Rollbacks a conversion workspace to the last committed spanshot.
+
+Args:
+  name: string, Required. Name of the conversion workspace resource to rollback to. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for 'RollbackConversionWorkspace' request.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ searchBackgroundJobs(conversionWorkspace, completedUntilTime=None, maxSize=None, returnMostRecentPerJobType=None, x__xgafv=None) +
Use this method to search/list the background jobs for a specific conversion workspace. The background jobs are not a resource like conversion workspace or mapping rule, and they can not be created, updated or deleted like one. Instead they are a way to expose the data plane jobs log.
+
+Args:
+  conversionWorkspace: string, Required. Name of the conversion workspace resource whos jobs are listed. in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}. (required)
+  completedUntilTime: string, Optional. If supplied, will only return jobs that completed until (not including) the given timestamp.
+  maxSize: integer, Optional. The maximum number of jobs to return. The service may return fewer than this value. If unspecified, at most 100 jobs will be returned. The maximum value is 100; values above 100 will be coerced to 100.
+  returnMostRecentPerJobType: boolean, Optional. Whether or not to return just the most recent job per job type
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for 'SearchBackgroundJobs' request.
+  "jobs": [ # The list of conversion workspace mapping rules.
+    { # Execution log of a background job.
+      "completionComment": "A String", # Job completion comment, such as how many entities were seeded, how many warnings were found during conversion and similar information.
+      "completionState": "A String", # Job completion state, i.e. the final state after the job completed.
+      "finishTime": "A String", # The timestamp when the background job was finished.
+      "id": "A String", # The background job log entry id
+      "importRulesJobDetails": { # Details regarding an Import Rules background job # Import rules job details
+        "fileFormat": "A String", # The requested file format
+        "files": [ # File names used for the import rules job
+          "A String",
+        ],
+      },
+      "jobType": "A String", # The type of job that was executed.
+      "requestAutocommit": True or False, # Whether the client requested the conversion workspace to be committed after a successful completion of the job.
+      "seedJobDetails": { # Details regarding a Seed background job # Seed job details
+        "connectionProfile": "A String", # The connection profile which was used for the seed job
+      },
+      "startTime": "A String", # The timestamp when the background job was started.
+    },
+  ],
+}
+
+ +
+ seed(name, body=None, x__xgafv=None) +
Imports a snapshot of the source database into the conversion workspace.
+
+Args:
+  name: string, Name of the conversion workspace resource to seed with new database structure. in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for 'SeedConversionWorkspace' request.
+  "autoCommit": True or False, # Should the conversion workspace be committed automatically after the seed operation.
+  "destinationConnectionProfile": "A String", # Fully qualified (Uri) name of the destination connection profile.
+  "sourceConnectionProfile": "A String", # Fully qualified (Uri) name of the source connection profile.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/datamigration_v1.projects.locations.conversionWorkspaces.mappingRules.html b/docs/dyn/datamigration_v1.projects.locations.conversionWorkspaces.mappingRules.html new file mode 100644 index 00000000000..cd2b6bbbfa9 --- /dev/null +++ b/docs/dyn/datamigration_v1.projects.locations.conversionWorkspaces.mappingRules.html @@ -0,0 +1,138 @@ + + + +

Database Migration API . projects . locations . conversionWorkspaces . mappingRules

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ import_(parent, body=None, x__xgafv=None)

+

Imports the mapping rules for a given conversion workspace. Supports various formats of external rules files.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ import_(parent, body=None, x__xgafv=None) +
Imports the mapping rules for a given conversion workspace. Supports various formats of external rules files.
+
+Args:
+  parent: string, Required. Name of the conversion workspace resource to import the rules to in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for 'ImportMappingRules' request.
+  "autoCommit": True or False, # Should the conversion workspace be committed automatically after the import operation.
+  "rulesFiles": [ # One or more rules files
+    { # Details of a single rules file
+      "rulesContent": "A String", # The text content of the rules that needs to be converted
+      "rulesSourceFilename": "A String", # The filename of the rules that needs to be converted. This is used mainly so future logs of the import rules job will contain this detail and can therefore be searched by it later
+    },
+  ],
+  "rulesFormat": "A String", # The format of the rules content file.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/datamigration_v1.projects.locations.html b/docs/dyn/datamigration_v1.projects.locations.html index 0090ff55123..b8784b63bca 100644 --- a/docs/dyn/datamigration_v1.projects.locations.html +++ b/docs/dyn/datamigration_v1.projects.locations.html @@ -79,6 +79,11 @@

Instance Methods

Returns the connectionProfiles Resource.

+

+ conversionWorkspaces() +

+

Returns the conversionWorkspaces Resource.

+

migrationJobs()

@@ -89,6 +94,11 @@

Instance Methods

Returns the operations Resource.

+

+ privateConnections() +

+

Returns the privateConnections Resource.

+

close()

Close httplib2 connections.

diff --git a/docs/dyn/datamigration_v1.projects.locations.migrationJobs.html b/docs/dyn/datamigration_v1.projects.locations.migrationJobs.html index f046fe69d6d..cff4f328961 100644 --- a/docs/dyn/datamigration_v1.projects.locations.migrationJobs.html +++ b/docs/dyn/datamigration_v1.projects.locations.migrationJobs.html @@ -141,6 +141,10 @@

Method Details

The object takes the form of: { # Represents a Database Migration Service migration job object. + "conversionWorkspace": { # A conversion workspace's version. # The conversion workspace used by the migration. + "commitId": "A String", # The commit ID of the conversion workspace. + "name": "A String", # The resource name (URI) of the conversion workspace. + }, "createTime": "A String", # Output only. The timestamp when the migration job resource was created. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z". "destination": "A String", # Required. The resource name (URI) of the destination connection profile. "destinationDatabase": { # A message defining the database engine and provider. # The database engine type and provider of the destination. @@ -168,6 +172,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, + "filter": "A String", # This field can be used to select the entities to migrate as part of the migration job. It uses AIP-160 notation to select a subset of the entities configured on the associated conversion-workspace. This field should not be set on migration-jobs that are not associated with a conversion workspace. "labels": { # The resource labels for migration job to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`. "a_key": "A String", }, @@ -312,6 +317,10 @@

Method Details

An object of the form: { # Represents a Database Migration Service migration job object. + "conversionWorkspace": { # A conversion workspace's version. # The conversion workspace used by the migration. + "commitId": "A String", # The commit ID of the conversion workspace. + "name": "A String", # The resource name (URI) of the conversion workspace. + }, "createTime": "A String", # Output only. The timestamp when the migration job resource was created. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z". "destination": "A String", # Required. The resource name (URI) of the destination connection profile. "destinationDatabase": { # A message defining the database engine and provider. # The database engine type and provider of the destination. @@ -339,6 +348,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, + "filter": "A String", # This field can be used to select the entities to migrate as part of the migration job. It uses AIP-160 notation to select a subset of the entities configured on the associated conversion-workspace. This field should not be set on migration-jobs that are not associated with a conversion workspace. "labels": { # The resource labels for migration job to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`. "a_key": "A String", }, @@ -435,6 +445,10 @@

Method Details

{ # Response message for 'ListMigrationJobs' request. "migrationJobs": [ # The list of migration jobs objects. { # Represents a Database Migration Service migration job object. + "conversionWorkspace": { # A conversion workspace's version. # The conversion workspace used by the migration. + "commitId": "A String", # The commit ID of the conversion workspace. + "name": "A String", # The resource name (URI) of the conversion workspace. + }, "createTime": "A String", # Output only. The timestamp when the migration job resource was created. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z". "destination": "A String", # Required. The resource name (URI) of the destination connection profile. "destinationDatabase": { # A message defining the database engine and provider. # The database engine type and provider of the destination. @@ -462,6 +476,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, + "filter": "A String", # This field can be used to select the entities to migrate as part of the migration job. It uses AIP-160 notation to select a subset of the entities configured on the associated conversion-workspace. This field should not be set on migration-jobs that are not associated with a conversion workspace. "labels": { # The resource labels for migration job to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`. "a_key": "A String", }, @@ -519,6 +534,10 @@

Method Details

The object takes the form of: { # Represents a Database Migration Service migration job object. + "conversionWorkspace": { # A conversion workspace's version. # The conversion workspace used by the migration. + "commitId": "A String", # The commit ID of the conversion workspace. + "name": "A String", # The resource name (URI) of the conversion workspace. + }, "createTime": "A String", # Output only. The timestamp when the migration job resource was created. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z". "destination": "A String", # Required. The resource name (URI) of the destination connection profile. "destinationDatabase": { # A message defining the database engine and provider. # The database engine type and provider of the destination. @@ -546,6 +565,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, + "filter": "A String", # This field can be used to select the entities to migrate as part of the migration job. It uses AIP-160 notation to select a subset of the entities configured on the associated conversion-workspace. This field should not be set on migration-jobs that are not associated with a conversion workspace. "labels": { # The resource labels for migration job to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`. "a_key": "A String", }, diff --git a/docs/dyn/datamigration_v1.projects.locations.privateConnections.html b/docs/dyn/datamigration_v1.projects.locations.privateConnections.html new file mode 100644 index 00000000000..b7cdd9dc560 --- /dev/null +++ b/docs/dyn/datamigration_v1.projects.locations.privateConnections.html @@ -0,0 +1,305 @@ + + + +

Database Migration API . projects . locations . privateConnections

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, privateConnectionId=None, requestId=None, x__xgafv=None)

+

Creates a new private connection in a given project and location.

+

+ delete(name, requestId=None, x__xgafv=None)

+

Deletes a single Database Migration Service private connection.

+

+ get(name, x__xgafv=None)

+

Gets details of a single private connection.

+

+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Retrieves a list of private connections in a given project and location.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, privateConnectionId=None, requestId=None, x__xgafv=None) +
Creates a new private connection in a given project and location.
+
+Args:
+  parent: string, Required. The parent that owns the collection of PrivateConnections. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The PrivateConnection resource is used to establish private connectivity with the customer's network.
+  "createTime": "A String", # Output only. The create time of the resource.
+  "displayName": "A String", # The private connection display name.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error details in case of state FAILED.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "labels": { # The resource labels for private connections to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`.
+    "a_key": "A String",
+  },
+  "name": "A String", # The resource's name.
+  "state": "A String", # Output only. The state of the Private Connection.
+  "updateTime": "A String", # Output only. The last update time of the resource.
+  "vpcPeeringConfig": { # The VPC Peering configuration is used to create VPC peering with the consumer's VPC. # VPC Peering Config.
+    "subnet": "A String", # Required. A free subnet for peering. (CIDR of /29)
+    "vpcName": "A String", # Required. Fully qualified name of the VPC DMS will peer to.
+  },
+}
+
+  privateConnectionId: string, Required. The private connection identifier.
+  requestId: string, Optional. A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be 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.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ delete(name, requestId=None, x__xgafv=None) +
Deletes a single Database Migration Service private connection.
+
+Args:
+  name: string, Required. The name of the private connection to delete. (required)
+  requestId: string, Optional. A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be 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.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets details of a single private connection.
+
+Args:
+  name: string, Required. The name of the private connection to get. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The PrivateConnection resource is used to establish private connectivity with the customer's network.
+  "createTime": "A String", # Output only. The create time of the resource.
+  "displayName": "A String", # The private connection display name.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error details in case of state FAILED.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "labels": { # The resource labels for private connections to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`.
+    "a_key": "A String",
+  },
+  "name": "A String", # The resource's name.
+  "state": "A String", # Output only. The state of the Private Connection.
+  "updateTime": "A String", # Output only. The last update time of the resource.
+  "vpcPeeringConfig": { # The VPC Peering configuration is used to create VPC peering with the consumer's VPC. # VPC Peering Config.
+    "subnet": "A String", # Required. A free subnet for peering. (CIDR of /29)
+    "vpcName": "A String", # Required. Fully qualified name of the VPC DMS will peer to.
+  },
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Retrieves a list of private connections in a given project and location.
+
+Args:
+  parent: string, Required. The parent that owns the collection of private connections. (required)
+  filter: string, A filter expression that filters private connections listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, list private connections created this year by specifying **createTime %gt; 2021-01-01T00:00:00.000000000Z**.
+  orderBy: string, Order by fields for the result.
+  pageSize: integer, Maximum number of private connections to return. If unspecified, at most 50 private connections that will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
+  pageToken: string, Page token received from a previous `ListPrivateConnections` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPrivateConnections` must match the call that provided the page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for 'ListPrivateConnections' request.
+  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+  "privateConnections": [ # List of private connections.
+    { # The PrivateConnection resource is used to establish private connectivity with the customer's network.
+      "createTime": "A String", # Output only. The create time of the resource.
+      "displayName": "A String", # The private connection display name.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error details in case of state FAILED.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "labels": { # The resource labels for private connections to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`.
+        "a_key": "A String",
+      },
+      "name": "A String", # The resource's name.
+      "state": "A String", # Output only. The state of the Private Connection.
+      "updateTime": "A String", # Output only. The last update time of the resource.
+      "vpcPeeringConfig": { # The VPC Peering configuration is used to create VPC peering with the consumer's VPC. # VPC Peering Config.
+        "subnet": "A String", # Required. A free subnet for peering. (CIDR of /29)
+        "vpcName": "A String", # Required. Fully qualified name of the VPC DMS will peer to.
+      },
+    },
+  ],
+  "unreachable": [ # Locations that could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/datamigration.v1.json b/googleapiclient/discovery_cache/documents/datamigration.v1.json index 5aefcf52caf..d23596c5265 100644 --- a/googleapiclient/discovery_cache/documents/datamigration.v1.json +++ b/googleapiclient/discovery_cache/documents/datamigration.v1.json @@ -204,6 +204,16 @@ "description": "A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be 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.", "location": "query", "type": "string" + }, + "skipValidation": { + "description": "Optional. Create the connection profile without validating it. The default is false. Only supported for Oracle connection profiles.", + "location": "query", + "type": "boolean" + }, + "validateOnly": { + "description": "Optional. Only validate the connection profile, but don't create any resources. The default is false. Only supported for Oracle connection profiles.", + "location": "query", + "type": "boolean" } }, "path": "v1/{+parent}/connectionProfiles", @@ -375,11 +385,21 @@ "location": "query", "type": "string" }, + "skipValidation": { + "description": "Optional. Update the connection profile without validating it. The default is false. Only supported for Oracle connection profiles.", + "location": "query", + "type": "boolean" + }, "updateMask": { "description": "Required. Field mask is used to specify the fields to be overwritten in the connection profile resource by the update.", "format": "google-fieldmask", "location": "query", "type": "string" + }, + "validateOnly": { + "description": "Optional. Only validate the connection profile, but don't update any resources. The default is false. Only supported for Oracle connection profiles.", + "location": "query", + "type": "boolean" } }, "path": "v1/{+name}", @@ -451,24 +471,108 @@ } } }, - "migrationJobs": { + "conversionWorkspaces": { "methods": { + "apply": { + "description": "Apply draft tree onto a specific destination database", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}:apply", + "httpMethod": "POST", + "id": "datamigration.projects.locations.conversionWorkspaces.apply", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the conversion workspace resource to apply draft to destination for. in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/conversionWorkspaces/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:apply", + "request": { + "$ref": "ApplyConversionWorkspaceRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "commit": { + "description": "Marks all the data in the conversion workspace as committed.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}:commit", + "httpMethod": "POST", + "id": "datamigration.projects.locations.conversionWorkspaces.commit", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the conversion workspace resource to commit.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/conversionWorkspaces/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:commit", + "request": { + "$ref": "CommitConversionWorkspaceRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "convert": { + "description": "Creates a draft tree schema for the destination database.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}:convert", + "httpMethod": "POST", + "id": "datamigration.projects.locations.conversionWorkspaces.convert", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Name of the conversion workspace resource to convert in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/conversionWorkspaces/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:convert", + "request": { + "$ref": "ConvertConversionWorkspaceRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "create": { - "description": "Creates a new migration job in a given project and location.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/migrationJobs", + "description": "Creates a new conversion workspace in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces", "httpMethod": "POST", - "id": "datamigration.projects.locations.migrationJobs.create", + "id": "datamigration.projects.locations.conversionWorkspaces.create", "parameterOrder": [ "parent" ], "parameters": { - "migrationJobId": { - "description": "Required. The ID of the instance to create.", + "conversionWorkspaceId": { + "description": "Required. The ID of the conversion workspace to create.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The parent, which owns this collection of migration jobs.", + "description": "Required. The parent, which owns this collection of conversion workspaces.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -480,9 +584,9 @@ "type": "string" } }, - "path": "v1/{+parent}/migrationJobs", + "path": "v1/{+parent}/conversionWorkspaces", "request": { - "$ref": "MigrationJob" + "$ref": "ConversionWorkspace" }, "response": { "$ref": "Operation" @@ -492,23 +596,18 @@ ] }, "delete": { - "description": "Deletes a single migration job.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}", + "description": "Deletes a single conversion workspace.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}", "httpMethod": "DELETE", - "id": "datamigration.projects.locations.migrationJobs.delete", + "id": "datamigration.projects.locations.conversionWorkspaces.delete", "parameterOrder": [ "name" ], "parameters": { - "force": { - "description": "The destination CloudSQL connection profile is always deleted with the migration job. In case of force delete, the destination CloudSQL replica database is also deleted.", - "location": "query", - "type": "boolean" - }, "name": { - "description": "Required. Name of the migration job resource to delete.", + "description": "Required. Name of the conversion workspace resource to delete.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/migrationJobs/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/conversionWorkspaces/[^/]+$", "required": true, "type": "string" }, @@ -526,149 +625,183 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "generateSshScript": { - "description": "Generate a SSH configuration script to configure the reverse SSH connectivity.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}:generateSshScript", - "httpMethod": "POST", - "id": "datamigration.projects.locations.migrationJobs.generateSshScript", + "describeConversionWorkspaceRevisions": { + "description": "Retrieves a list of committed revisions of a specific conversion workspace.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}:describeConversionWorkspaceRevisions", + "httpMethod": "GET", + "id": "datamigration.projects.locations.conversionWorkspaces.describeConversionWorkspaceRevisions", "parameterOrder": [ - "migrationJob" + "conversionWorkspace" ], "parameters": { - "migrationJob": { - "description": "Name of the migration job resource to generate the SSH script.", + "commitId": { + "description": "Optional filter to request a specific commit id", + "location": "query", + "type": "string" + }, + "conversionWorkspace": { + "description": "Required. Name of the conversion workspace resource whose revisions are listed. in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/migrationJobs/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/conversionWorkspaces/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+migrationJob}:generateSshScript", - "request": { - "$ref": "GenerateSshScriptRequest" - }, + "path": "v1/{+conversionWorkspace}:describeConversionWorkspaceRevisions", "response": { - "$ref": "SshScript" + "$ref": "DescribeConversionWorkspaceRevisionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "get": { - "description": "Gets details of a single migration job.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}", + "describeDatabaseEntities": { + "description": "Use this method to describe the database entities tree for a specific conversion workspace and a specific tree type. The DB Entities are not a resource like conversion workspace or mapping rule, and they can not be created, updated or deleted like one. Instead they are simple data objects describing the structure of the client database.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}:describeDatabaseEntities", "httpMethod": "GET", - "id": "datamigration.projects.locations.migrationJobs.get", + "id": "datamigration.projects.locations.conversionWorkspaces.describeDatabaseEntities", "parameterOrder": [ - "name" + "conversionWorkspace" ], "parameters": { - "name": { - "description": "Required. Name of the migration job resource to get.", + "commitId": { + "description": "Request a specific commit id. If not specified, the entities from the latest commit are returned.", + "location": "query", + "type": "string" + }, + "conversionWorkspace": { + "description": "Required. Name of the conversion workspace resource whose DB entities are described in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/migrationJobs/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/conversionWorkspaces/[^/]+$", "required": true, "type": "string" + }, + "filter": { + "description": "Filter the returned entities based on AIP-160 standard", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of entities to return. The service may return fewer than this value.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The nextPageToken value received in the previous call to conversionWorkspace.describeDatabaseEntities, used in the subsequent request to retrieve the next page of results. On first call this should be left blank. When paginating, all other parameters provided to conversionWorkspace.describeDatabaseEntities must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "tree": { + "description": "The tree to fetch", + "enum": [ + "DB_TREE_TYPE_UNSPECIFIED", + "SOURCE_TREE", + "DRAFT_TREE", + "DESTINATION_TREE" + ], + "enumDescriptions": [ + "Unspecified tree type", + "The source database tree", + "The draft database tree", + "The destination database tree" + ], + "location": "query", + "type": "string" + }, + "uncommitted": { + "description": "Whether to retrieve the latest committed version of the entities or the latest version. This field is ignored if a specific commit_id is specified.", + "location": "query", + "type": "boolean" } }, - "path": "v1/{+name}", + "path": "v1/{+conversionWorkspace}:describeDatabaseEntities", "response": { - "$ref": "MigrationJob" + "$ref": "DescribeDatabaseEntitiesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "getIamPolicy": { - "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}:getIamPolicy", + "get": { + "description": "Gets details of a single conversion workspace.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}", "httpMethod": "GET", - "id": "datamigration.projects.locations.migrationJobs.getIamPolicy", + "id": "datamigration.projects.locations.conversionWorkspaces.get", "parameterOrder": [ - "resource" + "name" ], "parameters": { - "options.requestedPolicyVersion": { - "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", - "format": "int32", - "location": "query", - "type": "integer" - }, - "resource": { - "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "name": { + "description": "Required. Name of the conversion workspace resource to get.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/migrationJobs/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/conversionWorkspaces/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+resource}:getIamPolicy", + "path": "v1/{+name}", "response": { - "$ref": "Policy" + "$ref": "ConversionWorkspace" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { - "description": "Lists migration jobs in a given project and location.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/migrationJobs", + "description": "Lists conversion workspaces in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces", "httpMethod": "GET", - "id": "datamigration.projects.locations.migrationJobs.list", + "id": "datamigration.projects.locations.conversionWorkspaces.list", "parameterOrder": [ "parent" ], "parameters": { "filter": { - "description": "A filter expression that filters migration jobs listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, list migration jobs created this year by specifying **createTime %gt; 2020-01-01T00:00:00.000000000Z.** You can also filter nested fields. For example, you could specify **reverseSshConnectivity.vmIp = \"1.2.3.4\"** to select all migration jobs connecting through the specific SSH tunnel bastion.", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "Sort the results based on the migration job name. Valid values are: \"name\", \"name asc\", and \"name desc\".", + "description": "A filter expression that filters conversion workspaces listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, list conversion workspaces created this year by specifying **createTime %gt; 2020-01-01T00:00:00.000000000Z.** You can also filter nested fields. For example, you could specify **source.version = \"12.c.1\"** to select all conversion workspaces with source database version equal to 12.c.1", "location": "query", "type": "string" }, "pageSize": { - "description": "The maximum number of migration jobs to return. The service may return fewer than this value. If unspecified, at most 50 migration jobs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "description": "The maximum number of conversion workspaces to return. The service may return fewer than this value. If unspecified, at most 50 sets will be returned.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "The nextPageToken value received in the previous call to migrationJobs.list, used in the subsequent request to retrieve the next page of results. On first call this should be left blank. When paginating, all other parameters provided to migrationJobs.list must match the call that provided the page token.", + "description": "The nextPageToken value received in the previous call to conversionWorkspaces.list, used in the subsequent request to retrieve the next page of results. On first call this should be left blank. When paginating, all other parameters provided to conversionWorkspaces.list must match the call that provided the page token.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The parent, which owns this collection of migrationJobs.", + "description": "Required. The parent, which owns this collection of conversion workspaces.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+parent}/migrationJobs", + "path": "v1/{+parent}/conversionWorkspaces", "response": { - "$ref": "ListMigrationJobsResponse" + "$ref": "ListConversionWorkspacesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { - "description": "Updates the parameters of a single migration job.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}", + "description": "Updates the parameters of a single conversion workspace.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}", "httpMethod": "PATCH", - "id": "datamigration.projects.locations.migrationJobs.patch", + "id": "datamigration.projects.locations.conversionWorkspaces.patch", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/migrationJobs/{migrationJob}.", + "description": "Full name of the workspace resource, in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/migrationJobs/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/conversionWorkspaces/[^/]+$", "required": true, "type": "string" }, @@ -678,7 +811,7 @@ "type": "string" }, "updateMask": { - "description": "Required. Field mask is used to specify the fields to be overwritten in the migration job resource by the update.", + "description": "Required. Field mask is used to specify the fields to be overwritten in the conversion workspace resource by the update.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -686,7 +819,7 @@ }, "path": "v1/{+name}", "request": { - "$ref": "MigrationJob" + "$ref": "ConversionWorkspace" }, "response": { "$ref": "Operation" @@ -695,26 +828,26 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "promote": { - "description": "Promote a migration job, stopping replication to the destination and promoting the destination to be a standalone database.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}:promote", + "rollback": { + "description": "Rollbacks a conversion workspace to the last committed spanshot.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}:rollback", "httpMethod": "POST", - "id": "datamigration.projects.locations.migrationJobs.promote", + "id": "datamigration.projects.locations.conversionWorkspaces.rollback", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Name of the migration job resource to promote.", + "description": "Required. Name of the conversion workspace resource to rollback to.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/migrationJobs/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/conversionWorkspaces/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+name}:promote", + "path": "v1/{+name}:rollback", "request": { - "$ref": "PromoteMigrationJobRequest" + "$ref": "RollbackConversionWorkspaceRequest" }, "response": { "$ref": "Operation" @@ -723,54 +856,68 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "restart": { - "description": "Restart a stopped or failed migration job, resetting the destination instance to its original state and starting the migration process from scratch.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}:restart", - "httpMethod": "POST", - "id": "datamigration.projects.locations.migrationJobs.restart", + "searchBackgroundJobs": { + "description": "Use this method to search/list the background jobs for a specific conversion workspace. The background jobs are not a resource like conversion workspace or mapping rule, and they can not be created, updated or deleted like one. Instead they are a way to expose the data plane jobs log.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}:searchBackgroundJobs", + "httpMethod": "GET", + "id": "datamigration.projects.locations.conversionWorkspaces.searchBackgroundJobs", "parameterOrder": [ - "name" + "conversionWorkspace" ], "parameters": { - "name": { - "description": "Name of the migration job resource to restart.", + "completedUntilTime": { + "description": "Optional. If supplied, will only return jobs that completed until (not including) the given timestamp.", + "format": "google-datetime", + "location": "query", + "type": "string" + }, + "conversionWorkspace": { + "description": "Required. Name of the conversion workspace resource whos jobs are listed. in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/migrationJobs/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/conversionWorkspaces/[^/]+$", "required": true, "type": "string" + }, + "maxSize": { + "description": "Optional. The maximum number of jobs to return. The service may return fewer than this value. If unspecified, at most 100 jobs will be returned. The maximum value is 100; values above 100 will be coerced to 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "returnMostRecentPerJobType": { + "description": "Optional. Whether or not to return just the most recent job per job type", + "location": "query", + "type": "boolean" } }, - "path": "v1/{+name}:restart", - "request": { - "$ref": "RestartMigrationJobRequest" - }, + "path": "v1/{+conversionWorkspace}:searchBackgroundJobs", "response": { - "$ref": "Operation" + "$ref": "SearchBackgroundJobsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "resume": { - "description": "Resume a migration job that is currently stopped and is resumable (was stopped during CDC phase).", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}:resume", + "seed": { + "description": "Imports a snapshot of the source database into the conversion workspace.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}:seed", "httpMethod": "POST", - "id": "datamigration.projects.locations.migrationJobs.resume", + "id": "datamigration.projects.locations.conversionWorkspaces.seed", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Name of the migration job resource to resume.", + "description": "Name of the conversion workspace resource to seed with new database structure. in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/migrationJobs/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/conversionWorkspaces/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+name}:resume", + "path": "v1/{+name}:seed", "request": { - "$ref": "ResumeMigrationJobRequest" + "$ref": "SeedConversionWorkspaceRequest" }, "response": { "$ref": "Operation" @@ -778,25 +925,389 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] - }, - "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}:setIamPolicy", + } + }, + "resources": { + "mappingRules": { + "methods": { + "import": { + "description": "Imports the mapping rules for a given conversion workspace. Supports various formats of external rules files.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}/mappingRules:import", + "httpMethod": "POST", + "id": "datamigration.projects.locations.conversionWorkspaces.mappingRules.import", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Name of the conversion workspace resource to import the rules to in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/conversionWorkspaces/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/mappingRules:import", + "request": { + "$ref": "ImportMappingRulesRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "migrationJobs": { + "methods": { + "create": { + "description": "Creates a new migration job in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/migrationJobs", "httpMethod": "POST", - "id": "datamigration.projects.locations.migrationJobs.setIamPolicy", + "id": "datamigration.projects.locations.migrationJobs.create", "parameterOrder": [ - "resource" + "parent" ], "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "migrationJobId": { + "description": "Required. The ID of the instance to create.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent, which owns this collection of migration jobs.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/migrationJobs/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" - } - }, - "path": "v1/{+resource}:setIamPolicy", + }, + "requestId": { + "description": "A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be 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.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/migrationJobs", + "request": { + "$ref": "MigrationJob" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single migration job.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}", + "httpMethod": "DELETE", + "id": "datamigration.projects.locations.migrationJobs.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "force": { + "description": "The destination CloudSQL connection profile is always deleted with the migration job. In case of force delete, the destination CloudSQL replica database is also deleted.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. Name of the migration job resource to delete.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/migrationJobs/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be 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.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "generateSshScript": { + "description": "Generate a SSH configuration script to configure the reverse SSH connectivity.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}:generateSshScript", + "httpMethod": "POST", + "id": "datamigration.projects.locations.migrationJobs.generateSshScript", + "parameterOrder": [ + "migrationJob" + ], + "parameters": { + "migrationJob": { + "description": "Name of the migration job resource to generate the SSH script.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/migrationJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+migrationJob}:generateSshScript", + "request": { + "$ref": "GenerateSshScriptRequest" + }, + "response": { + "$ref": "SshScript" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single migration job.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}", + "httpMethod": "GET", + "id": "datamigration.projects.locations.migrationJobs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the migration job resource to get.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/migrationJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "MigrationJob" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getIamPolicy": { + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}:getIamPolicy", + "httpMethod": "GET", + "id": "datamigration.projects.locations.migrationJobs.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/migrationJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:getIamPolicy", + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists migration jobs in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/migrationJobs", + "httpMethod": "GET", + "id": "datamigration.projects.locations.migrationJobs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "A filter expression that filters migration jobs listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, list migration jobs created this year by specifying **createTime %gt; 2020-01-01T00:00:00.000000000Z.** You can also filter nested fields. For example, you could specify **reverseSshConnectivity.vmIp = \"1.2.3.4\"** to select all migration jobs connecting through the specific SSH tunnel bastion.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Sort the results based on the migration job name. Valid values are: \"name\", \"name asc\", and \"name desc\".", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of migration jobs to return. The service may return fewer than this value. If unspecified, at most 50 migration jobs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The nextPageToken value received in the previous call to migrationJobs.list, used in the subsequent request to retrieve the next page of results. On first call this should be left blank. When paginating, all other parameters provided to migrationJobs.list must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent, which owns this collection of migrationJobs.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/migrationJobs", + "response": { + "$ref": "ListMigrationJobsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single migration job.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}", + "httpMethod": "PATCH", + "id": "datamigration.projects.locations.migrationJobs.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/migrationJobs/{migrationJob}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/migrationJobs/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be 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.", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "Required. Field mask is used to specify the fields to be overwritten in the migration job resource by the update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "MigrationJob" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "promote": { + "description": "Promote a migration job, stopping replication to the destination and promoting the destination to be a standalone database.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}:promote", + "httpMethod": "POST", + "id": "datamigration.projects.locations.migrationJobs.promote", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Name of the migration job resource to promote.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/migrationJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:promote", + "request": { + "$ref": "PromoteMigrationJobRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "restart": { + "description": "Restart a stopped or failed migration job, resetting the destination instance to its original state and starting the migration process from scratch.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}:restart", + "httpMethod": "POST", + "id": "datamigration.projects.locations.migrationJobs.restart", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Name of the migration job resource to restart.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/migrationJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:restart", + "request": { + "$ref": "RestartMigrationJobRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "resume": { + "description": "Resume a migration job that is currently stopped and is resumable (was stopped during CDC phase).", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}:resume", + "httpMethod": "POST", + "id": "datamigration.projects.locations.migrationJobs.resume", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Name of the migration job resource to resume.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/migrationJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:resume", + "request": { + "$ref": "ResumeMigrationJobRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}:setIamPolicy", + "httpMethod": "POST", + "id": "datamigration.projects.locations.migrationJobs.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/migrationJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:setIamPolicy", "request": { "$ref": "SetIamPolicyRequest" }, @@ -1043,13 +1554,156 @@ ] } } + }, + "privateConnections": { + "methods": { + "create": { + "description": "Creates a new private connection in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateConnections", + "httpMethod": "POST", + "id": "datamigration.projects.locations.privateConnections.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent that owns the collection of PrivateConnections.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "privateConnectionId": { + "description": "Required. The private connection identifier.", + "location": "query", + "type": "string" + }, + "requestId": { + "description": "Optional. A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be 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.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/privateConnections", + "request": { + "$ref": "PrivateConnection" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single Database Migration Service private connection.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateConnections/{privateConnectionsId}", + "httpMethod": "DELETE", + "id": "datamigration.projects.locations.privateConnections.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the private connection to delete.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/privateConnections/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be 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.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single private connection.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateConnections/{privateConnectionsId}", + "httpMethod": "GET", + "id": "datamigration.projects.locations.privateConnections.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the private connection to get.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/privateConnections/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "PrivateConnection" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Retrieves a list of private connections in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateConnections", + "httpMethod": "GET", + "id": "datamigration.projects.locations.privateConnections.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "A filter expression that filters private connections listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, list private connections created this year by specifying **createTime %gt; 2021-01-01T00:00:00.000000000Z**.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Order by fields for the result.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Maximum number of private connections to return. If unspecified, at most 50 private connections that will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Page token received from a previous `ListPrivateConnections` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPrivateConnections` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent that owns the collection of private connections.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/privateConnections", + "response": { + "$ref": "ListPrivateConnectionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } } } } } } }, - "revision": "20221201", + "revision": "20221211", "rootUrl": "https://datamigration.googleapis.com/", "schemas": { "AlloyDbConnectionProfile": { @@ -1085,8 +1739,23 @@ "primaryInstanceSettings": { "$ref": "PrimaryInstanceSettings" }, - "vpcNetwork": { - "description": "Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: \"projects/{project_number}/global/networks/{network_id}\". This is required to create a cluster.", + "vpcNetwork": { + "description": "Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: \"projects/{project_number}/global/networks/{network_id}\". This is required to create a cluster.", + "type": "string" + } + }, + "type": "object" + }, + "ApplyConversionWorkspaceRequest": { + "description": "Request message for 'ApplyConversionWorkspace' request.", + "id": "ApplyConversionWorkspaceRequest", + "properties": { + "connectionProfile": { + "description": "Fully qualified (Uri) name of the destination connection profile.", + "type": "string" + }, + "filter": { + "description": "Filter which entities to apply. Leaving this field empty will apply all of the entities. Supports Google AIP 160 based filtering.", "type": "string" } }, @@ -1140,6 +1809,75 @@ }, "type": "object" }, + "BackgroundJobLogEntry": { + "description": "Execution log of a background job.", + "id": "BackgroundJobLogEntry", + "properties": { + "completionComment": { + "description": "Job completion comment, such as how many entities were seeded, how many warnings were found during conversion and similar information.", + "type": "string" + }, + "completionState": { + "description": "Job completion state, i.e. the final state after the job completed.", + "enum": [ + "JOB_COMPLETION_STATE_UNSPECIFIED", + "SUCCEEDED", + "FAILED" + ], + "enumDescriptions": [ + "The status is not specified. This state will be used when job is not yet finished.", + "Success.", + "Error." + ], + "type": "string" + }, + "finishTime": { + "description": "The timestamp when the background job was finished.", + "format": "google-datetime", + "type": "string" + }, + "id": { + "description": "The background job log entry id", + "type": "string" + }, + "importRulesJobDetails": { + "$ref": "ImportRulesJobDetails", + "description": "Import rules job details" + }, + "jobType": { + "description": "The type of job that was executed.", + "enum": [ + "BACKGROUND_JOB_TYPE_UNSPECIFIED", + "BACKGROUND_JOB_TYPE_SOURCE_SEED", + "BACKGROUND_JOB_TYPE_CONVERT", + "BACKGROUND_JOB_TYPE_APPLY_DESTINATION", + "BACKGROUND_JOB_TYPE_IMPORT_RULES_FILE" + ], + "enumDescriptions": [ + "Unspecified background job type", + "Job to seed from the source database", + "Job to convert the source database into a draft of the destination database", + "Job to apply the draft tree onto the destination", + "Job to import and convert mapping rules from an external source such as an ora2pg config file" + ], + "type": "string" + }, + "requestAutocommit": { + "description": "Whether the client requested the conversion workspace to be committed after a successful completion of the job.", + "type": "boolean" + }, + "seedJobDetails": { + "$ref": "SeedJobDetails", + "description": "Seed job details" + }, + "startTime": { + "description": "The timestamp when the background job was started.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "Binding": { "description": "Associates `members`, or principals, with a `role`.", "id": "Binding", @@ -1341,6 +2079,109 @@ }, "type": "object" }, + "ColumnEntity": { + "description": "Column is not used as an independent entity, it is retrieved as part of a Table entity.", + "id": "ColumnEntity", + "properties": { + "array": { + "description": "Is the column of array type", + "type": "boolean" + }, + "arrayLength": { + "description": "If the column is array, of which length", + "format": "int32", + "type": "integer" + }, + "autoGenerated": { + "description": "Is the column auto-generated/identity", + "type": "boolean" + }, + "charset": { + "description": "Charset override - instead of table level charset", + "type": "string" + }, + "collation": { + "description": "Collation override - instead of table level collation", + "type": "string" + }, + "comment": { + "description": "Comment associated with the column", + "type": "string" + }, + "customFeatures": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Custom engine specific features", + "type": "object" + }, + "dataType": { + "description": "Column data type", + "type": "string" + }, + "defaultValue": { + "description": "Default value of the column", + "type": "string" + }, + "fractionalSecondsPrecision": { + "description": "Column fractional second precision - used for timestamp based datatypes", + "format": "int32", + "type": "integer" + }, + "length": { + "description": "Column length - e.g. varchar (50)", + "format": "int64", + "type": "string" + }, + "name": { + "description": "Column name", + "type": "string" + }, + "nullable": { + "description": "Is the column nullable", + "type": "boolean" + }, + "ordinalPosition": { + "description": "Column order in the table", + "format": "int32", + "type": "integer" + }, + "precision": { + "description": "Column precision - when relevant", + "format": "int32", + "type": "integer" + }, + "scale": { + "description": "Column scale - when relevant", + "format": "int32", + "type": "integer" + }, + "setValues": { + "description": "Specifies the list of values allowed in the column. List is empty if set values is not required", + "items": { + "type": "string" + }, + "type": "array" + }, + "udt": { + "description": "Is the column a UDT", + "type": "boolean" + } + }, + "type": "object" + }, + "CommitConversionWorkspaceRequest": { + "description": "Request message for 'CommitConversionWorkspace' request.", + "id": "CommitConversionWorkspaceRequest", + "properties": { + "commitName": { + "description": "Optional name of the commit.", + "type": "string" + } + }, + "type": "object" + }, "ConnectionProfile": { "description": "A connection profile definition.", "id": "ConnectionProfile", @@ -1383,57 +2224,327 @@ "description": "The name of this connection profile resource in the form of projects/{project}/locations/{location}/connectionProfiles/{connectionProfile}.", "type": "string" }, + "oracle": { + "$ref": "OracleConnectionProfile", + "description": "An Oracle database connection profile." + }, "postgresql": { "$ref": "PostgreSqlConnectionProfile", "description": "A PostgreSQL database connection profile." }, - "provider": { - "description": "The database provider.", + "provider": { + "description": "The database provider.", + "enum": [ + "DATABASE_PROVIDER_UNSPECIFIED", + "CLOUDSQL", + "RDS", + "AURORA", + "ALLOYDB" + ], + "enumDescriptions": [ + "The database provider is unknown.", + "CloudSQL runs the database.", + "RDS runs the database.", + "Amazon Aurora.", + "AlloyDB." + ], + "type": "string" + }, + "state": { + "description": "The current connection profile state (e.g. DRAFT, READY, or FAILED).", + "enum": [ + "STATE_UNSPECIFIED", + "DRAFT", + "CREATING", + "READY", + "UPDATING", + "DELETING", + "DELETED", + "FAILED" + ], + "enumDescriptions": [ + "The state of the connection profile is unknown.", + "The connection profile is in draft mode and fully editable.", + "The connection profile is being created.", + "The connection profile is ready.", + "The connection profile is being updated.", + "The connection profile is being deleted.", + "The connection profile has been deleted.", + "The last action on the connection profile failed." + ], + "type": "string" + }, + "updateTime": { + "description": "Output only. The timestamp when the resource was last updated. A timestamp in RFC3339 UTC \"Zulu\" format, accurate to nanoseconds. Example: \"2014-10-02T15:01:23.045123456Z\".", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "ConstraintEntity": { + "description": "Constraint is not used as an independent entity, it is retrieved as part of another entity such as Table or View.", + "id": "ConstraintEntity", + "properties": { + "customFeatures": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Custom engine specific features", + "type": "object" + }, + "name": { + "description": "The name of the table constraint", + "type": "string" + }, + "referenceColumns": { + "description": "Reference Columns which may be associated with the constraint. eg: if the constraint is a FOREIGN_KEY, this represents the list of full names of referenced columns by the foreign key.", + "items": { + "type": "string" + }, + "type": "array" + }, + "referenceTable": { + "description": "Reference table which may be associated with the constraint. eg: if the constraint is a FOREIGN_KEY, this represents the list of full name of the referenced table by the foreign key.", + "type": "string" + }, + "tableColumns": { + "description": "Table columns used as part of the Constraint for e.g. primary key constraint should list the columns which constitutes the key", + "items": { + "type": "string" + }, + "type": "array" + }, + "tableName": { + "description": "Table which is associated with the constraint. In case the constraint is defined on a table, this field is left empty as this information is stored in parent_name. However, if constraint is defined on a view, this field stores the table name on which the view is defined.", + "type": "string" + }, + "type": { + "description": "Type of constraint - e.g. unique, primary key, foreign key (currently only primary key is supported)", + "type": "string" + } + }, + "type": "object" + }, + "ConversionWorkspace": { + "description": "The main conversion workspace resource entity.", + "id": "ConversionWorkspace", + "properties": { + "createTime": { + "description": "Output only. The timestamp when the workspace resource was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "destination": { + "$ref": "DatabaseEngineInfo", + "description": "Required. The destination engine details." + }, + "displayName": { + "description": "The display name for the workspace", + "type": "string" + }, + "globalSettings": { + "additionalProperties": { + "type": "string" + }, + "description": "A generic list of settings for the workspace. The settings are database pair dependant and can indicate default behavior for the mapping rules engine or turn on or off specific features. Such examples can be: convert_foreign_key_to_interleave=true, skip_triggers=false, ignore_non_table_synonyms=true", + "type": "object" + }, + "hasUncommittedChanges": { + "description": "Output only. Whether the workspace has uncommitted changes (changes which were made after the workspace was committed)", + "readOnly": true, + "type": "boolean" + }, + "latestCommitId": { + "description": "Output only. The latest commit id", + "readOnly": true, + "type": "string" + }, + "latestCommitTime": { + "description": "Output only. The timestamp when the workspace was committed.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Full name of the workspace resource, in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.", + "type": "string" + }, + "source": { + "$ref": "DatabaseEngineInfo", + "description": "Required. The source engine details." + }, + "updateTime": { + "description": "Output only. The timestamp when the workspace resource was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "ConversionWorkspaceInfo": { + "description": "A conversion workspace's version.", + "id": "ConversionWorkspaceInfo", + "properties": { + "commitId": { + "description": "The commit ID of the conversion workspace.", + "type": "string" + }, + "name": { + "description": "The resource name (URI) of the conversion workspace.", + "type": "string" + } + }, + "type": "object" + }, + "ConvertConversionWorkspaceRequest": { + "description": "Request message for 'ConvertConversionWorkspace' request.", + "id": "ConvertConversionWorkspaceRequest", + "properties": { + "autoCommit": { + "description": "Should the conversion workspace be committed automatically after the conversion.", + "type": "boolean" + }, + "filter": { + "description": "Filter the entities to convert. Leaving this field empty will convert all of the entities. Supports Google AIP-160 style filtering.", + "type": "string" + } + }, + "type": "object" + }, + "DatabaseEngineInfo": { + "description": "The type and version of a source or destination DB.", + "id": "DatabaseEngineInfo", + "properties": { + "engine": { + "description": "Required. Engine Type.", + "enum": [ + "DATABASE_ENGINE_UNSPECIFIED", + "MYSQL", + "POSTGRESQL", + "ORACLE" + ], + "enumDescriptions": [ + "The source database engine of the migration job is unknown.", + "The source engine is MySQL.", + "The source engine is PostgreSQL.", + "The source engine is Oracle" + ], + "type": "string" + }, + "version": { + "description": "Required. Engine named version, for e.g. 12.c.1", + "type": "string" + } + }, + "type": "object" + }, + "DatabaseEntity": { + "description": "The base entity type for all the database related entities The message contains the entity name, the name of its parent, its type and the specific details per its type", + "id": "DatabaseEntity", + "properties": { + "databaseFunction": { + "$ref": "FunctionEntity", + "description": "Function" + }, + "databasePackage": { + "$ref": "PackageEntity", + "description": "Package" + }, + "entityType": { + "description": "The type of the database entity (table, view, index, ...).", "enum": [ - "DATABASE_PROVIDER_UNSPECIFIED", - "CLOUDSQL", - "RDS", - "AURORA", - "ALLOYDB" + "DATABASE_ENTITY_TYPE_UNSPECIFIED", + "DATABASE_ENTITY_TYPE_SCHEMA", + "DATABASE_ENTITY_TYPE_TABLE", + "DATABASE_ENTITY_TYPE_COLUMN", + "DATABASE_ENTITY_TYPE_CONSTRAINT", + "DATABASE_ENTITY_TYPE_INDEX", + "DATABASE_ENTITY_TYPE_TRIGGER", + "DATABASE_ENTITY_TYPE_VIEW", + "DATABASE_ENTITY_TYPE_SEQUENCE", + "DATABASE_ENTITY_TYPE_STORED_PROCEDURE", + "DATABASE_ENTITY_TYPE_FUNCTION", + "DATABASE_ENTITY_TYPE_SYNONYM", + "DATABASE_ENTITY_TYPE_DATABASE_PACKAGE", + "DATABASE_ENTITY_TYPE_UDT" ], "enumDescriptions": [ - "The database provider is unknown.", - "CloudSQL runs the database.", - "RDS runs the database.", - "Amazon Aurora.", - "AlloyDB." + "Unspecified database entity type", + "Schema", + "Table", + "Column", + "Constraint", + "Index", + "Trigger", + "View", + "Sequence", + "Stored Procedure", + "Function", + "Synonym", + "Package", + "UDT" ], "type": "string" }, - "state": { - "description": "The current connection profile state (e.g. DRAFT, READY, or FAILED).", + "mappings": { + "description": "Details about entity mappings. For source tree entities, this holds the draft entities which were generated by the mapping rules. For draft tree entities, this holds the source entities which were converted to form the draft entity. Destination entities will have no mapping details.", + "items": { + "$ref": "EntityMapping" + }, + "type": "array" + }, + "parentEntity": { + "description": "The full name of the parent entity (e.g. schema name).", + "type": "string" + }, + "schema": { + "$ref": "SchemaEntity", + "description": "Schema." + }, + "sequence": { + "$ref": "SequenceEntity", + "description": "Sequence" + }, + "shortName": { + "description": "The short name (e.g. table name) of the entity.", + "type": "string" + }, + "storedProcedure": { + "$ref": "StoredProcedureEntity", + "description": "Stored Procedure" + }, + "synonym": { + "$ref": "SynonymEntity", + "description": "Synonym" + }, + "table": { + "$ref": "TableEntity", + "description": "Table." + }, + "tree": { + "description": "The type of tree the entity belongs to.", "enum": [ - "STATE_UNSPECIFIED", + "TREE_TYPE_UNSPECIFIED", + "SOURCE", "DRAFT", - "CREATING", - "READY", - "UPDATING", - "DELETING", - "DELETED", - "FAILED" + "DESTINATION" ], "enumDescriptions": [ - "The state of the connection profile is unknown.", - "The connection profile is in draft mode and fully editable.", - "The connection profile is being created.", - "The connection profile is ready.", - "The connection profile is being updated.", - "The connection profile is being deleted.", - "The connection profile has been deleted.", - "The last action on the connection profile failed." + "Tree Type Unspecified.", + "Tree of entities loaded from a source database.", + "Tree of entities converted from the source tree using the mapping rules.", + "Tree of entities observed on the destination database." ], "type": "string" }, - "updateTime": { - "description": "Output only. The timestamp when the resource was last updated. A timestamp in RFC3339 UTC \"Zulu\" format, accurate to nanoseconds. Example: \"2014-10-02T15:01:23.045123456Z\".", - "format": "google-datetime", - "readOnly": true, - "type": "string" + "view": { + "$ref": "ViewEntity", + "description": "View" } }, "type": "object" @@ -1447,12 +2558,14 @@ "enum": [ "DATABASE_ENGINE_UNSPECIFIED", "MYSQL", - "POSTGRESQL" + "POSTGRESQL", + "ORACLE" ], "enumDescriptions": [ "The source database engine of the migration job is unknown.", "The source engine is MySQL.", - "The source engine is PostgreSQL." + "The source engine is PostgreSQL.", + "The source engine is Oracle" ], "type": "string" }, @@ -1477,6 +2590,38 @@ }, "type": "object" }, + "DescribeConversionWorkspaceRevisionsResponse": { + "description": "Response message for 'DescribeConversionWorkspaceRevisions' request.", + "id": "DescribeConversionWorkspaceRevisionsResponse", + "properties": { + "revisions": { + "description": "The list of conversion workspace revisions.", + "items": { + "$ref": "ConversionWorkspace" + }, + "type": "array" + } + }, + "type": "object" + }, + "DescribeDatabaseEntitiesResponse": { + "description": "Response message for 'DescribeDatabaseEntities' request.", + "id": "DescribeDatabaseEntitiesResponse", + "properties": { + "databaseEntities": { + "description": "The list of database entities for the conversion workspace.", + "items": { + "$ref": "DatabaseEntity" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + } + }, + "type": "object" + }, "DumpFlag": { "description": "Dump flag definition.", "id": "DumpFlag", @@ -1512,6 +2657,47 @@ "properties": {}, "type": "object" }, + "EntityMapping": { + "description": "Details of the mappings of a database entity.", + "id": "EntityMapping", + "properties": { + "draftEntity": { + "description": "Target entity full name. The draft entity can also include a column, index or constraint using the same naming notation schema.table.column", + "type": "string" + }, + "mappingLog": { + "description": "Entity mapping log entries. Multiple rules can be effective and contribute changes to a converted entity such as, a rule can handle the entity name, another rule can handle an entity type. In addition, rules which did not change the entity are also logged along the with the reason preventing them to do so.", + "items": { + "$ref": "EntityMappingLogEntry" + }, + "type": "array" + }, + "sourceEntity": { + "description": "Source entity full name. The source entity can also be a column, index or constraint using the same naming notation schema.table.column", + "type": "string" + } + }, + "type": "object" + }, + "EntityMappingLogEntry": { + "description": "A single record of a rule which was used for a mapping.", + "id": "EntityMappingLogEntry", + "properties": { + "mappingComment": { + "description": "Comment.", + "type": "string" + }, + "ruleId": { + "description": "Which rule caused it.", + "type": "string" + }, + "ruleRevisionId": { + "description": "Rule revision id", + "type": "string" + } + }, + "type": "object" + }, "Expr": { "description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.", "id": "Expr", @@ -1535,6 +2721,53 @@ }, "type": "object" }, + "ForwardSshTunnelConnectivity": { + "description": "Forward SSH Tunnel connectivity.", + "id": "ForwardSshTunnelConnectivity", + "properties": { + "hostname": { + "description": "Required. Hostname for the SSH tunnel.", + "type": "string" + }, + "password": { + "description": "Input only. SSH password.", + "type": "string" + }, + "port": { + "description": "Port for the SSH tunnel, default value is 22.", + "format": "int32", + "type": "integer" + }, + "privateKey": { + "description": "Input only. SSH private key.", + "type": "string" + }, + "username": { + "description": "Required. Username for the SSH tunnel.", + "type": "string" + } + }, + "type": "object" + }, + "FunctionEntity": { + "description": "Function's parent is a schema.", + "id": "FunctionEntity", + "properties": { + "customFeatures": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Custom engine specific features", + "type": "object" + }, + "sqlCode": { + "description": "The SQL code which creates the function", + "type": "string" + } + }, + "type": "object" + }, "GenerateSshScriptRequest": { "description": "Request message for 'GenerateSshScript' request.", "id": "GenerateSshScriptRequest", @@ -1603,6 +2836,100 @@ }, "type": "object" }, + "ImportMappingRulesRequest": { + "description": "Request message for 'ImportMappingRules' request.", + "id": "ImportMappingRulesRequest", + "properties": { + "autoCommit": { + "description": "Should the conversion workspace be committed automatically after the import operation.", + "type": "boolean" + }, + "rulesFiles": { + "description": "One or more rules files", + "items": { + "$ref": "RulesFile" + }, + "type": "array" + }, + "rulesFormat": { + "description": "The format of the rules content file.", + "enum": [ + "IMPORT_RULES_FILE_FORMAT_UNSPECIFIED", + "IMPORT_RULES_FILE_FORMAT_HARBOUR_BRIDGE_SESSION_FILE", + "IMPORT_RULES_FILE_FORMAT_ORATOPG_CONFIG_FILE" + ], + "enumDescriptions": [ + "Unspecified Rules Format", + "Harbour Bridge Session file", + "ORA2PG config file" + ], + "type": "string" + } + }, + "type": "object" + }, + "ImportRulesJobDetails": { + "description": "Details regarding an Import Rules background job", + "id": "ImportRulesJobDetails", + "properties": { + "fileFormat": { + "description": "The requested file format", + "enum": [ + "IMPORT_RULES_FILE_FORMAT_UNSPECIFIED", + "IMPORT_RULES_FILE_FORMAT_HARBOUR_BRIDGE_SESSION_FILE", + "IMPORT_RULES_FILE_FORMAT_ORATOPG_CONFIG_FILE" + ], + "enumDescriptions": [ + "Unspecified Rules Format", + "Harbour Bridge Session file", + "ORA2PG config file" + ], + "type": "string" + }, + "files": { + "description": "File names used for the import rules job", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "IndexEntity": { + "description": "Index is not used as an independent entity, it is retrieved as part of a Table entity.", + "id": "IndexEntity", + "properties": { + "customFeatures": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Custom engine specific features", + "type": "object" + }, + "name": { + "description": "The name of the index", + "type": "string" + }, + "tableColumns": { + "description": "Table columns used as part of the Index for e.g. B-TREE index should list the columns which constitutes the index.", + "items": { + "type": "string" + }, + "type": "array" + }, + "type": { + "description": "Type of index - e.g. B-TREE", + "type": "string" + }, + "unique": { + "description": "boolean value indicating whether the index is unique", + "type": "boolean" + } + }, + "type": "object" + }, "ListConnectionProfilesResponse": { "description": "Response message for 'ListConnectionProfiles' request.", "id": "ListConnectionProfilesResponse", @@ -1628,6 +2955,31 @@ }, "type": "object" }, + "ListConversionWorkspacesResponse": { + "description": "Response message for 'ListConversionWorkspaces' request.", + "id": "ListConversionWorkspacesResponse", + "properties": { + "conversionWorkspaces": { + "description": "The list of conversion workspace objects.", + "items": { + "$ref": "ConversionWorkspace" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "ListLocationsResponse": { "description": "The response message for Locations.ListLocations.", "id": "ListLocationsResponse", @@ -1689,6 +3041,31 @@ }, "type": "object" }, + "ListPrivateConnectionsResponse": { + "description": "Response message for 'ListPrivateConnections' request.", + "id": "ListPrivateConnectionsResponse", + "properties": { + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + }, + "privateConnections": { + "description": "List of private connections.", + "items": { + "$ref": "PrivateConnection" + }, + "type": "array" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "Location": { "description": "A resource that represents Google Cloud Platform location.", "id": "Location", @@ -1739,6 +3116,10 @@ "description": "Represents a Database Migration Service migration job object.", "id": "MigrationJob", "properties": { + "conversionWorkspace": { + "$ref": "ConversionWorkspaceInfo", + "description": "The conversion workspace used by the migration." + }, "createTime": { "description": "Output only. The timestamp when the migration job resource was created. A timestamp in RFC3339 UTC \"Zulu\" format, accurate to nanoseconds. Example: \"2014-10-02T15:01:23.045123456Z\".", "format": "google-datetime", @@ -1782,6 +3163,10 @@ "description": "Output only. The error details in case of state FAILED.", "readOnly": true }, + "filter": { + "description": "This field can be used to select the entities to migrate as part of the migration job. It uses AIP-160 notation to select a subset of the entities configured on the associated conversion-workspace. This field should not be set on migration-jobs that are not associated with a conversion workspace.", + "type": "string" + }, "labels": { "additionalProperties": { "type": "string" @@ -2014,25 +3399,93 @@ "$ref": "Status", "description": "The error result of the operation in case of failure or cancellation." }, - "metadata": { + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", + "type": "object" + }, + "name": { + "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", + "type": "string" + }, + "response": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", + "type": "object" + } + }, + "type": "object" + }, + "OracleConnectionProfile": { + "description": "Specifies connection parameters required specifically for Oracle databases.", + "id": "OracleConnectionProfile", + "properties": { + "databaseService": { + "description": "Required. Database service for the Oracle connection.", + "type": "string" + }, + "forwardSshConnectivity": { + "$ref": "ForwardSshTunnelConnectivity", + "description": "Forward SSH tunnel connectivity." + }, + "host": { + "description": "Required. The IP or hostname of the source Oracle database.", + "type": "string" + }, + "password": { + "description": "Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service.", + "type": "string" + }, + "passwordSet": { + "description": "Output only. Indicates whether a new password is included in the request.", + "readOnly": true, + "type": "boolean" + }, + "port": { + "description": "Required. The network port of the source Oracle database.", + "format": "int32", + "type": "integer" + }, + "privateConnectivity": { + "$ref": "PrivateConnectivity", + "description": "Private connectivity." + }, + "staticServiceIpConnectivity": { + "$ref": "StaticServiceIpConnectivity", + "description": "Static Service IP connectivity." + }, + "username": { + "description": "Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service.", + "type": "string" + } + }, + "type": "object" + }, + "PackageEntity": { + "description": "Package's parent is a schema.", + "id": "PackageEntity", + "properties": { + "customFeatures": { "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", + "description": "Properties of the object.", "type": "any" }, - "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", + "description": "Custom engine specific features", "type": "object" }, - "name": { - "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", + "packageBody": { + "description": "The SQL code which creates the package body. If the package specification has cursors or subprograms, then the package body is mandatory.", "type": "string" }, - "response": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", - "type": "object" + "packageSqlCode": { + "description": "The SQL code which creates the package", + "type": "string" } }, "type": "object" @@ -2109,10 +3562,18 @@ "format": "int32", "type": "integer" }, + "privateServiceConnectConnectivity": { + "$ref": "PrivateServiceConnectConnectivity", + "description": "Private service connect connectivity." + }, "ssl": { "$ref": "SslConfig", "description": "SSL configuration for the destination to connect to the source database." }, + "staticIpConnectivity": { + "$ref": "StaticIpConnectivity", + "description": "Static ip connectivity data (default, no additional details needed)." + }, "username": { "description": "Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service.", "type": "string" @@ -2154,6 +3615,94 @@ }, "type": "object" }, + "PrivateConnection": { + "description": "The PrivateConnection resource is used to establish private connectivity with the customer's network.", + "id": "PrivateConnection", + "properties": { + "createTime": { + "description": "Output only. The create time of the resource.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "The private connection display name.", + "type": "string" + }, + "error": { + "$ref": "Status", + "description": "Output only. The error details in case of state FAILED.", + "readOnly": true + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "The resource labels for private connections to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of \"key\": \"value\" pairs. Example: `{ \"name\": \"wrench\", \"mass\": \"1.3kg\", \"count\": \"3\" }`.", + "type": "object" + }, + "name": { + "description": "The resource's name.", + "type": "string" + }, + "state": { + "description": "Output only. The state of the Private Connection.", + "enum": [ + "STATE_UNSPECIFIED", + "CREATING", + "CREATED", + "FAILED", + "DELETING", + "FAILED_TO_DELETE", + "DELETED" + ], + "enumDescriptions": [ + "", + "The private connection is in creation state - creating resources.", + "The private connection has been created with all of its resources.", + "The private connection creation has failed.", + "The private connection is being deleted.", + "Delete request has failed, resource is in invalid state.", + "The private connection has been deleted." + ], + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. The last update time of the resource.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "vpcPeeringConfig": { + "$ref": "VpcPeeringConfig", + "description": "VPC Peering Config." + } + }, + "type": "object" + }, + "PrivateConnectivity": { + "description": "Private Connectivity.", + "id": "PrivateConnectivity", + "properties": { + "privateConnection": { + "description": "Required. The resource name (URI) of the private connection.", + "type": "string" + } + }, + "type": "object" + }, + "PrivateServiceConnectConnectivity": { + "description": "Private Service Connect connectivity (https://cloud.google.com/vpc/docs/private-service-connect#benefits-services)", + "id": "PrivateServiceConnectConnectivity", + "properties": { + "serviceAttachment": { + "description": "Required. A service attachment that exposes a database, and has the following format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment_name}", + "type": "string" + } + }, + "type": "object" + }, "PromoteMigrationJobRequest": { "description": "Request message for 'PromoteMigrationJob' request.", "id": "PromoteMigrationJobRequest", @@ -2196,6 +3745,130 @@ }, "type": "object" }, + "RollbackConversionWorkspaceRequest": { + "description": "Request message for 'RollbackConversionWorkspace' request.", + "id": "RollbackConversionWorkspaceRequest", + "properties": {}, + "type": "object" + }, + "RulesFile": { + "description": "Details of a single rules file", + "id": "RulesFile", + "properties": { + "rulesContent": { + "description": "The text content of the rules that needs to be converted", + "type": "string" + }, + "rulesSourceFilename": { + "description": "The filename of the rules that needs to be converted. This is used mainly so future logs of the import rules job will contain this detail and can therefore be searched by it later", + "type": "string" + } + }, + "type": "object" + }, + "SchemaEntity": { + "description": "Schema typically has no parent entity, but can have a parent entity DatabaseInstance (for database engines which supports it). For some database engines the term schema and user can be used interchangeably when they refer to a namespace or a collection of other database entities. Can store additional information which is schema specific.", + "id": "SchemaEntity", + "properties": { + "customFeatures": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Custom engine specific features", + "type": "object" + } + }, + "type": "object" + }, + "SearchBackgroundJobsResponse": { + "description": "Response message for 'SearchBackgroundJobs' request.", + "id": "SearchBackgroundJobsResponse", + "properties": { + "jobs": { + "description": "The list of conversion workspace mapping rules.", + "items": { + "$ref": "BackgroundJobLogEntry" + }, + "type": "array" + } + }, + "type": "object" + }, + "SeedConversionWorkspaceRequest": { + "description": "Request message for 'SeedConversionWorkspace' request.", + "id": "SeedConversionWorkspaceRequest", + "properties": { + "autoCommit": { + "description": "Should the conversion workspace be committed automatically after the seed operation.", + "type": "boolean" + }, + "destinationConnectionProfile": { + "description": "Fully qualified (Uri) name of the destination connection profile.", + "type": "string" + }, + "sourceConnectionProfile": { + "description": "Fully qualified (Uri) name of the source connection profile.", + "type": "string" + } + }, + "type": "object" + }, + "SeedJobDetails": { + "description": "Details regarding a Seed background job", + "id": "SeedJobDetails", + "properties": { + "connectionProfile": { + "description": "The connection profile which was used for the seed job", + "type": "string" + } + }, + "type": "object" + }, + "SequenceEntity": { + "description": "Sequence's parent is a schema.", + "id": "SequenceEntity", + "properties": { + "cache": { + "description": "Indicates number of entries to cache / precreate", + "format": "int64", + "type": "string" + }, + "customFeatures": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Custom engine specific features", + "type": "object" + }, + "cycle": { + "description": "Indicates whether the sequence value should cycle through", + "type": "boolean" + }, + "increment": { + "description": "Increment value for the sequence", + "format": "int64", + "type": "string" + }, + "maxValue": { + "description": "Maximum number for the sequence represented as bytes to accommodate large numbers", + "format": "byte", + "type": "string" + }, + "minValue": { + "description": "Minimum number for the sequence represented as bytes to accommodate large numbers", + "format": "byte", + "type": "string" + }, + "startValue": { + "description": "Start number for the sequence represented as bytes to accommodate large numbers", + "format": "byte", + "type": "string" + } + }, + "type": "object" + }, "SetIamPolicyRequest": { "description": "Request message for `SetIamPolicy` method.", "id": "SetIamPolicyRequest", @@ -2320,6 +3993,12 @@ "properties": {}, "type": "object" }, + "StaticServiceIpConnectivity": { + "description": "Static IP address connectivity configured on service project.", + "id": "StaticServiceIpConnectivity", + "properties": {}, + "type": "object" + }, "Status": { "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "id": "Status", @@ -2353,6 +4032,127 @@ "properties": {}, "type": "object" }, + "StoredProcedureEntity": { + "description": "Stored procedure's parent is a schema.", + "id": "StoredProcedureEntity", + "properties": { + "customFeatures": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Custom engine specific features", + "type": "object" + }, + "sqlCode": { + "description": "The SQL code which creates the stored procedure", + "type": "string" + } + }, + "type": "object" + }, + "SynonymEntity": { + "description": "Synonym's parent is a schema.", + "id": "SynonymEntity", + "properties": { + "customFeatures": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Custom engine specific features", + "type": "object" + }, + "sourceEntity": { + "description": "The name of the entity for which the synonym is being created (the source)", + "type": "string" + }, + "sourceType": { + "description": "The type of the entity for which the synonym is being created (usually a table or a sequence)", + "enum": [ + "DATABASE_ENTITY_TYPE_UNSPECIFIED", + "DATABASE_ENTITY_TYPE_SCHEMA", + "DATABASE_ENTITY_TYPE_TABLE", + "DATABASE_ENTITY_TYPE_COLUMN", + "DATABASE_ENTITY_TYPE_CONSTRAINT", + "DATABASE_ENTITY_TYPE_INDEX", + "DATABASE_ENTITY_TYPE_TRIGGER", + "DATABASE_ENTITY_TYPE_VIEW", + "DATABASE_ENTITY_TYPE_SEQUENCE", + "DATABASE_ENTITY_TYPE_STORED_PROCEDURE", + "DATABASE_ENTITY_TYPE_FUNCTION", + "DATABASE_ENTITY_TYPE_SYNONYM", + "DATABASE_ENTITY_TYPE_DATABASE_PACKAGE", + "DATABASE_ENTITY_TYPE_UDT" + ], + "enumDescriptions": [ + "Unspecified database entity type", + "Schema", + "Table", + "Column", + "Constraint", + "Index", + "Trigger", + "View", + "Sequence", + "Stored Procedure", + "Function", + "Synonym", + "Package", + "UDT" + ], + "type": "string" + } + }, + "type": "object" + }, + "TableEntity": { + "description": "Table's parent is a schema.", + "id": "TableEntity", + "properties": { + "columns": { + "description": "Table Columns.", + "items": { + "$ref": "ColumnEntity" + }, + "type": "array" + }, + "comment": { + "description": "Comment associated with the table", + "type": "string" + }, + "constraints": { + "description": "Table Constraints.", + "items": { + "$ref": "ConstraintEntity" + }, + "type": "array" + }, + "customFeatures": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Custom engine specific features", + "type": "object" + }, + "indices": { + "description": "Table Indices.", + "items": { + "$ref": "IndexEntity" + }, + "type": "array" + }, + "triggers": { + "description": "Table triggers.", + "items": { + "$ref": "TriggerEntity" + }, + "type": "array" + } + }, + "type": "object" + }, "TestIamPermissionsRequest": { "description": "Request message for `TestIamPermissions` method.", "id": "TestIamPermissionsRequest", @@ -2381,6 +4181,40 @@ }, "type": "object" }, + "TriggerEntity": { + "description": "Trigger is not used as an independent entity, it is retrieved as part of a Table entity.", + "id": "TriggerEntity", + "properties": { + "customFeatures": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Custom engine specific features", + "type": "object" + }, + "name": { + "description": "The name of the trigger", + "type": "string" + }, + "sqlCode": { + "description": "The SQL code which creates the trigger", + "type": "string" + }, + "triggerType": { + "description": "Indicates when the trigger fires, e.g. BEFORE STATEMENT, AFTER EACH ROW", + "type": "string" + }, + "triggeringEvents": { + "description": "The DML, DDL, or database events that fires the trigger, e.g. INSERT, UPDATE", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "UserPassword": { "description": "The username/password for a database user. Used for specifying initial users at cluster creation time.", "id": "UserPassword", @@ -2407,6 +4241,32 @@ "properties": {}, "type": "object" }, + "ViewEntity": { + "description": "View's parent is a schema.", + "id": "ViewEntity", + "properties": { + "constraints": { + "description": "View Constraints.", + "items": { + "$ref": "ConstraintEntity" + }, + "type": "array" + }, + "customFeatures": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Custom engine specific features", + "type": "object" + }, + "sqlCode": { + "description": "The SQL code which creates the view.", + "type": "string" + } + }, + "type": "object" + }, "VmCreationConfig": { "description": "VM creation configuration message", "id": "VmCreationConfig", @@ -2437,6 +4297,21 @@ }, "type": "object" }, + "VpcPeeringConfig": { + "description": "The VPC Peering configuration is used to create VPC peering with the consumer's VPC.", + "id": "VpcPeeringConfig", + "properties": { + "subnet": { + "description": "Required. A free subnet for peering. (CIDR of /29)", + "type": "string" + }, + "vpcName": { + "description": "Required. Fully qualified name of the VPC DMS will peer to.", + "type": "string" + } + }, + "type": "object" + }, "VpcPeeringConnectivity": { "description": "The details of the VPC where the source database is located in Google Cloud. We will use this information to set up the VPC peering connection between Cloud SQL and this VPC.", "id": "VpcPeeringConnectivity", diff --git a/googleapiclient/discovery_cache/documents/datamigration.v1beta1.json b/googleapiclient/discovery_cache/documents/datamigration.v1beta1.json index 9a3d2d4dc3c..7b12783a1ae 100644 --- a/googleapiclient/discovery_cache/documents/datamigration.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/datamigration.v1beta1.json @@ -1049,7 +1049,7 @@ } } }, - "revision": "20221201", + "revision": "20221211", "rootUrl": "https://datamigration.googleapis.com/", "schemas": { "AuditConfig": {