dataMigration

import { dataMigration } from "https://googleapis.deno.dev/v1/datamigration:v1.ts";

Manage Cloud Database Migration Service resources on Google Cloud Platform.

class dataMigration {

constructor(client?: CredentialsClient, baseUrl?: string);

locations;

async projectsLocationsConnectionProfilesCreate(

parent: string,

req: ConnectionProfile,

opts?: ProjectsLocationsConnectionProfilesCreateOptions,

): Promise<Operation>;

async projectsLocationsConnectionProfilesDelete(name: string, opts?: ProjectsLocationsConnectionProfilesDeleteOptions): Promise<Operation>;

async projectsLocationsConnectionProfilesGet(name: string): Promise<ConnectionProfile>;

async projectsLocationsConnectionProfilesGetIamPolicy(resource: string, opts?: ProjectsLocationsConnectionProfilesGetIamPolicyOptions): Promise<Policy>;

async projectsLocationsConnectionProfilesList(parent: string, opts?: ProjectsLocationsConnectionProfilesListOptions): Promise<ListConnectionProfilesResponse>;

async projectsLocationsConnectionProfilesPatch(

req: ConnectionProfile,

opts?: ProjectsLocationsConnectionProfilesPatchOptions,

): Promise<Operation>;

async projectsLocationsConnectionProfilesSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>;

async projectsLocationsConnectionProfilesTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>;

async projectsLocationsConversionWorkspacesApply(name: string, req: ApplyConversionWorkspaceRequest): Promise<Operation>;

async projectsLocationsConversionWorkspacesCommit(name: string, req: CommitConversionWorkspaceRequest): Promise<Operation>;

async projectsLocationsConversionWorkspacesConvert(name: string, req: ConvertConversionWorkspaceRequest): Promise<Operation>;

async projectsLocationsConversionWorkspacesCreate(

parent: string,

req: ConversionWorkspace,

opts?: ProjectsLocationsConversionWorkspacesCreateOptions,

): Promise<Operation>;

async projectsLocationsConversionWorkspacesDelete(name: string, opts?: ProjectsLocationsConversionWorkspacesDeleteOptions): Promise<Operation>;

async projectsLocationsConversionWorkspacesDescribeConversionWorkspaceRevisions(conversionWorkspace: string, opts?: ProjectsLocationsConversionWorkspacesDescribeConversionWorkspaceRevisionsOptions): Promise<DescribeConversionWorkspaceRevisionsResponse>;

async projectsLocationsConversionWorkspacesDescribeDatabaseEntities(conversionWorkspace: string, opts?: ProjectsLocationsConversionWorkspacesDescribeDatabaseEntitiesOptions): Promise<DescribeDatabaseEntitiesResponse>;

async projectsLocationsConversionWorkspacesGet(name: string): Promise<ConversionWorkspace>;

async projectsLocationsConversionWorkspacesGetIamPolicy(resource: string, opts?: ProjectsLocationsConversionWorkspacesGetIamPolicyOptions): Promise<Policy>;

async projectsLocationsConversionWorkspacesList(parent: string, opts?: ProjectsLocationsConversionWorkspacesListOptions): Promise<ListConversionWorkspacesResponse>;

async projectsLocationsConversionWorkspacesMappingRulesCreate(

parent: string,

req: MappingRule,

opts?: ProjectsLocationsConversionWorkspacesMappingRulesCreateOptions,

): Promise<MappingRule>;

async projectsLocationsConversionWorkspacesMappingRulesDelete(name: string, opts?: ProjectsLocationsConversionWorkspacesMappingRulesDeleteOptions): Promise<Empty>;

async projectsLocationsConversionWorkspacesMappingRulesGet(name: string): Promise<MappingRule>;

async projectsLocationsConversionWorkspacesMappingRulesImport(parent: string, req: ImportMappingRulesRequest): Promise<Operation>;

async projectsLocationsConversionWorkspacesMappingRulesList(parent: string, opts?: ProjectsLocationsConversionWorkspacesMappingRulesListOptions): Promise<ListMappingRulesResponse>;

async projectsLocationsConversionWorkspacesPatch(

req: ConversionWorkspace,

opts?: ProjectsLocationsConversionWorkspacesPatchOptions,

): Promise<Operation>;

async projectsLocationsConversionWorkspacesRollback(name: string, req: RollbackConversionWorkspaceRequest): Promise<Operation>;

async projectsLocationsConversionWorkspacesSearchBackgroundJobs(conversionWorkspace: string, opts?: ProjectsLocationsConversionWorkspacesSearchBackgroundJobsOptions): Promise<SearchBackgroundJobsResponse>;

async projectsLocationsConversionWorkspacesSeed(name: string, req: SeedConversionWorkspaceRequest): Promise<Operation>;

async projectsLocationsConversionWorkspacesSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>;

async projectsLocationsConversionWorkspacesTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>;

async projectsLocationsFetchStaticIps(name: string, opts?: ProjectsLocationsFetchStaticIpsOptions): Promise<FetchStaticIpsResponse>;

async projectsLocationsGet(name: string): Promise<Location>;

async projectsLocationsList(name: string, opts?: ProjectsLocationsListOptions): Promise<ListLocationsResponse>;

async projectsLocationsMigrationJobsCreate(

parent: string,

req: MigrationJob,

opts?: ProjectsLocationsMigrationJobsCreateOptions,

): Promise<Operation>;

async projectsLocationsMigrationJobsDelete(name: string, opts?: ProjectsLocationsMigrationJobsDeleteOptions): Promise<Operation>;

async projectsLocationsMigrationJobsDemoteDestination(name: string, req: DemoteDestinationRequest): Promise<Operation>;

async projectsLocationsMigrationJobsGenerateSshScript(migrationJob: string, req: GenerateSshScriptRequest): Promise<SshScript>;

async projectsLocationsMigrationJobsGenerateTcpProxyScript(migrationJob: string, req: GenerateTcpProxyScriptRequest): Promise<TcpProxyScript>;

async projectsLocationsMigrationJobsGet(name: string): Promise<MigrationJob>;

async projectsLocationsMigrationJobsGetIamPolicy(resource: string, opts?: ProjectsLocationsMigrationJobsGetIamPolicyOptions): Promise<Policy>;

async projectsLocationsMigrationJobsList(parent: string, opts?: ProjectsLocationsMigrationJobsListOptions): Promise<ListMigrationJobsResponse>;

async projectsLocationsMigrationJobsObjectsGetIamPolicy(resource: string, opts?: ProjectsLocationsMigrationJobsObjectsGetIamPolicyOptions): Promise<Policy>;

async projectsLocationsMigrationJobsObjectsSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>;

async projectsLocationsMigrationJobsObjectsTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>;

async projectsLocationsMigrationJobsPatch(

req: MigrationJob,

opts?: ProjectsLocationsMigrationJobsPatchOptions,

): Promise<Operation>;

async projectsLocationsMigrationJobsPromote(name: string, req: PromoteMigrationJobRequest): Promise<Operation>;

async projectsLocationsMigrationJobsRestart(name: string, req: RestartMigrationJobRequest): Promise<Operation>;

async projectsLocationsMigrationJobsResume(name: string, req: ResumeMigrationJobRequest): Promise<Operation>;

async projectsLocationsMigrationJobsSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>;

async projectsLocationsMigrationJobsStart(name: string, req: StartMigrationJobRequest): Promise<Operation>;

async projectsLocationsMigrationJobsStop(name: string, req: StopMigrationJobRequest): Promise<Operation>;

async projectsLocationsMigrationJobsTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>;

async projectsLocationsMigrationJobsVerify(name: string, req: VerifyMigrationJobRequest): Promise<Operation>;

async projectsLocationsOperationsCancel(name: string, req: CancelOperationRequest): Promise<Empty>;

async projectsLocationsOperationsDelete(name: string): Promise<Empty>;

async projectsLocationsOperationsGet(name: string): Promise<Operation>;

async projectsLocationsOperationsList(name: string, opts?: ProjectsLocationsOperationsListOptions): Promise<ListOperationsResponse>;

async projectsLocationsPrivateConnectionsCreate(

parent: string,

req: PrivateConnection,

opts?: ProjectsLocationsPrivateConnectionsCreateOptions,

): Promise<Operation>;

async projectsLocationsPrivateConnectionsDelete(name: string, opts?: ProjectsLocationsPrivateConnectionsDeleteOptions): Promise<Operation>;

async projectsLocationsPrivateConnectionsGet(name: string): Promise<PrivateConnection>;

async projectsLocationsPrivateConnectionsGetIamPolicy(resource: string, opts?: ProjectsLocationsPrivateConnectionsGetIamPolicyOptions): Promise<Policy>;

async projectsLocationsPrivateConnectionsList(parent: string, opts?: ProjectsLocationsPrivateConnectionsListOptions): Promise<ListPrivateConnectionsResponse>;

async projectsLocationsPrivateConnectionsSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>;

async projectsLocationsPrivateConnectionsTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>;

}

§Constructors

new dataMigration(client?: CredentialsClient, baseUrl?: string)

[src]

§Properties

locations

[src]

Fetches a set of static IP addresses that need to be allowlisted by the customer when using the static-IP connectivity method.

§Methods

projectsLocationsConnectionProfilesCreate(parent: string, req: ConnectionProfile, opts?: ProjectsLocationsConnectionProfilesCreateOptions): Promise<Operation>

[src]

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

@param parent

Required. The parent which owns this collection of connection profiles.

projectsLocationsConnectionProfilesDelete(name: string, opts?: ProjectsLocationsConnectionProfilesDeleteOptions): Promise<Operation>

[src]

Deletes a single Database Migration Service connection profile. A connection profile can only be deleted if it is not in use by any active migration jobs.

@param name

Required. Name of the connection profile resource to delete.

projectsLocationsConnectionProfilesGet(name: string): Promise<ConnectionProfile>

[src]

Gets details of a single connection profile.

@param name

Required. Name of the connection profile resource to get.

projectsLocationsConnectionProfilesGetIamPolicy(resource: string, opts?: ProjectsLocationsConnectionProfilesGetIamPolicyOptions): Promise<Policy>

[src]

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

@param resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

projectsLocationsConnectionProfilesList(parent: string, opts?: ProjectsLocationsConnectionProfilesListOptions): Promise<ListConnectionProfilesResponse>

[src]

Retrieves a list of all connection profiles in a given project and location.

@param parent

Required. The parent which owns this collection of connection profiles.

projectsLocationsConnectionProfilesPatch(name: string, req: ConnectionProfile, opts?: ProjectsLocationsConnectionProfilesPatchOptions): Promise<Operation>

[src]

Update the configuration of a single connection profile.

@param name

The name of this connection profile resource in the form of projects/{project}/locations/{location}/connectionProfiles/{connectionProfile}.

projectsLocationsConnectionProfilesSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>

[src]

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

@param resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

projectsLocationsConnectionProfilesTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>

[src]

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

@param resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

projectsLocationsConversionWorkspacesApply(name: string, req: ApplyConversionWorkspaceRequest): Promise<Operation>

[src]

Applies draft tree onto a specific destination database.

@param name

Required. The name of the conversion workspace resource for which to apply the draft tree. Must be in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.

projectsLocationsConversionWorkspacesCommit(name: string, req: CommitConversionWorkspaceRequest): Promise<Operation>

[src]

Marks all the data in the conversion workspace as committed.

@param name

Required. Name of the conversion workspace resource to commit.

projectsLocationsConversionWorkspacesConvert(name: string, req: ConvertConversionWorkspaceRequest): Promise<Operation>

[src]

Creates a draft tree schema for the destination database.

@param name

Name of the conversion workspace resource to convert in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.

projectsLocationsConversionWorkspacesCreate(parent: string, req: ConversionWorkspace, opts?: ProjectsLocationsConversionWorkspacesCreateOptions): Promise<Operation>

[src]

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

@param parent

Required. The parent which owns this collection of conversion workspaces.

projectsLocationsConversionWorkspacesDelete(name: string, opts?: ProjectsLocationsConversionWorkspacesDeleteOptions): Promise<Operation>

[src]

Deletes a single conversion workspace.

@param name

Required. Name of the conversion workspace resource to delete.

projectsLocationsConversionWorkspacesDescribeConversionWorkspaceRevisions(conversionWorkspace: string, opts?: ProjectsLocationsConversionWorkspacesDescribeConversionWorkspaceRevisionsOptions): Promise<DescribeConversionWorkspaceRevisionsResponse>

[src]

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

@param conversionWorkspace

Required. Name of the conversion workspace resource whose revisions are listed. Must be in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.

projectsLocationsConversionWorkspacesDescribeDatabaseEntities(conversionWorkspace: string, opts?: ProjectsLocationsConversionWorkspacesDescribeDatabaseEntitiesOptions): Promise<DescribeDatabaseEntitiesResponse>

[src]

Describes the database entities tree for a specific conversion workspace and a specific tree type. Database entities are not resources like conversion workspaces or mapping rules, and they can't be created, updated or deleted. Instead, they are simple data objects describing the structure of the client database.

@param conversionWorkspace

Required. Name of the conversion workspace resource whose database entities are described. Must be in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.

projectsLocationsConversionWorkspacesGet(name: string): Promise<ConversionWorkspace>

[src]

Gets details of a single conversion workspace.

@param name

Required. Name of the conversion workspace resource to get.

projectsLocationsConversionWorkspacesGetIamPolicy(resource: string, opts?: ProjectsLocationsConversionWorkspacesGetIamPolicyOptions): Promise<Policy>

[src]

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

@param resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

projectsLocationsConversionWorkspacesList(parent: string, opts?: ProjectsLocationsConversionWorkspacesListOptions): Promise<ListConversionWorkspacesResponse>

[src]

Lists conversion workspaces in a given project and location.

@param parent

Required. The parent which owns this collection of conversion workspaces.

projectsLocationsConversionWorkspacesMappingRulesCreate(parent: string, req: MappingRule, opts?: ProjectsLocationsConversionWorkspacesMappingRulesCreateOptions): Promise<MappingRule>

[src]

Creates a new mapping rule for a given conversion workspace.

@param parent

Required. The parent which owns this collection of mapping rules.

projectsLocationsConversionWorkspacesMappingRulesDelete(name: string, opts?: ProjectsLocationsConversionWorkspacesMappingRulesDeleteOptions): Promise<Empty>

[src]

Deletes a single mapping rule.

@param name

Required. Name of the mapping rule resource to delete.

projectsLocationsConversionWorkspacesMappingRulesGet(name: string): Promise<MappingRule>

[src]

Gets the details of a mapping rule.

@param name

Required. Name of the mapping rule resource to get. Example: conversionWorkspaces/123/mappingRules/rule123 In order to retrieve a previous revision of the mapping rule, also provide the revision ID. Example: conversionWorkspace/123/mappingRules/rule123@c7cfa2a8c7cfa2a8c7cfa2a8c7cfa2a8

projectsLocationsConversionWorkspacesMappingRulesImport(parent: string, req: ImportMappingRulesRequest): Promise<Operation>

[src]

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

@param parent

Required. Name of the conversion workspace resource to import the rules to in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.

projectsLocationsConversionWorkspacesMappingRulesList(parent: string, opts?: ProjectsLocationsConversionWorkspacesMappingRulesListOptions): Promise<ListMappingRulesResponse>

[src]

Lists the mapping rules for a specific conversion workspace.

@param parent

Required. Name of the conversion workspace resource whose mapping rules are listed in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.

projectsLocationsConversionWorkspacesPatch(name: string, req: ConversionWorkspace, opts?: ProjectsLocationsConversionWorkspacesPatchOptions): Promise<Operation>

[src]

Updates the parameters of a single conversion workspace.

@param name

Full name of the workspace resource, in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.

projectsLocationsConversionWorkspacesRollback(name: string, req: RollbackConversionWorkspaceRequest): Promise<Operation>

[src]

Rolls back a conversion workspace to the last committed snapshot.

@param name

Required. Name of the conversion workspace resource to roll back to.

projectsLocationsConversionWorkspacesSearchBackgroundJobs(conversionWorkspace: string, opts?: ProjectsLocationsConversionWorkspacesSearchBackgroundJobsOptions): Promise<SearchBackgroundJobsResponse>

[src]

Searches/lists the background jobs for a specific conversion workspace. The background jobs are not resources like conversion workspaces or mapping rules, and they can't be created, updated or deleted. Instead, they are a way to expose the data plane jobs log.

@param conversionWorkspace

Required. Name of the conversion workspace resource whose jobs are listed, in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.

projectsLocationsConversionWorkspacesSeed(name: string, req: SeedConversionWorkspaceRequest): Promise<Operation>

[src]

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

@param name

Name of the conversion workspace resource to seed with new database structure, in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.

projectsLocationsConversionWorkspacesSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>

[src]

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

@param resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

projectsLocationsConversionWorkspacesTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>

[src]

@param resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

projectsLocationsFetchStaticIps(name: string, opts?: ProjectsLocationsFetchStaticIpsOptions): Promise<FetchStaticIpsResponse>

[src]

projectsLocationsGet(name: string): Promise<Location>

[src]

Gets information about a location.

@param name

Resource name for the location.

projectsLocationsList(name: string, opts?: ProjectsLocationsListOptions): Promise<ListLocationsResponse>

[src]

Lists information about the supported locations for this service.

@param name

The resource that owns the locations collection, if applicable.

projectsLocationsMigrationJobsCreate(parent: string, req: MigrationJob, opts?: ProjectsLocationsMigrationJobsCreateOptions): Promise<Operation>

[src]

Creates a new migration job in a given project and location.

@param parent

Required. The parent which owns this collection of migration jobs.

projectsLocationsMigrationJobsDelete(name: string, opts?: ProjectsLocationsMigrationJobsDeleteOptions): Promise<Operation>

[src]

Deletes a single migration job.

@param name

Required. Name of the migration job resource to delete.

projectsLocationsMigrationJobsDemoteDestination(name: string, req: DemoteDestinationRequest): Promise<Operation>

[src]

Demotes the destination database to become a read replica of the source. This is applicable for the following migrations: 1. MySQL to Cloud SQL for MySQL 2. PostgreSQL to Cloud SQL for PostgreSQL 3. PostgreSQL to AlloyDB for PostgreSQL.

@param name

Name of the migration job resource to demote its destination.

projectsLocationsMigrationJobsGenerateSshScript(migrationJob: string, req: GenerateSshScriptRequest): Promise<SshScript>

[src]

Generate a SSH configuration script to configure the reverse SSH connectivity.

@param migrationJob

Name of the migration job resource to generate the SSH script.

projectsLocationsMigrationJobsGenerateTcpProxyScript(migrationJob: string, req: GenerateTcpProxyScriptRequest): Promise<TcpProxyScript>

[src]

Generate a TCP Proxy configuration script to configure a cloud-hosted VM running a TCP Proxy.

@param migrationJob

Name of the migration job resource to generate the TCP Proxy script.

projectsLocationsMigrationJobsGet(name: string): Promise<MigrationJob>

[src]

Gets details of a single migration job.

@param name

Required. Name of the migration job resource to get.

projectsLocationsMigrationJobsGetIamPolicy(resource: string, opts?: ProjectsLocationsMigrationJobsGetIamPolicyOptions): Promise<Policy>

[src]

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

@param resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

projectsLocationsMigrationJobsList(parent: string, opts?: ProjectsLocationsMigrationJobsListOptions): Promise<ListMigrationJobsResponse>

[src]

Lists migration jobs in a given project and location.

@param parent

Required. The parent which owns this collection of migrationJobs.

projectsLocationsMigrationJobsObjectsGetIamPolicy(resource: string, opts?: ProjectsLocationsMigrationJobsObjectsGetIamPolicyOptions): Promise<Policy>

[src]

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

@param resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

projectsLocationsMigrationJobsObjectsSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>

[src]

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

@param resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

projectsLocationsMigrationJobsObjectsTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>

[src]

@param resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

projectsLocationsMigrationJobsPatch(name: string, req: MigrationJob, opts?: ProjectsLocationsMigrationJobsPatchOptions): Promise<Operation>

[src]

Updates the parameters of a single migration job.

@param name

The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/migrationJobs/{migrationJob}.

projectsLocationsMigrationJobsPromote(name: string, req: PromoteMigrationJobRequest): Promise<Operation>

[src]

Promote a migration job, stopping replication to the destination and promoting the destination to be a standalone database.

@param name

Name of the migration job resource to promote.

projectsLocationsMigrationJobsRestart(name: string, req: RestartMigrationJobRequest): Promise<Operation>

[src]

Restart a stopped or failed migration job, resetting the destination instance to its original state and starting the migration process from scratch.

@param name

Name of the migration job resource to restart.

projectsLocationsMigrationJobsResume(name: string, req: ResumeMigrationJobRequest): Promise<Operation>

[src]

Resume a migration job that is currently stopped and is resumable (was stopped during CDC phase).

@param name

Name of the migration job resource to resume.

projectsLocationsMigrationJobsSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>

[src]

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

@param resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

projectsLocationsMigrationJobsStart(name: string, req: StartMigrationJobRequest): Promise<Operation>

[src]

Start an already created migration job.

@param name

Name of the migration job resource to start.

projectsLocationsMigrationJobsStop(name: string, req: StopMigrationJobRequest): Promise<Operation>

[src]

Stops a running migration job.

@param name

Name of the migration job resource to stop.

projectsLocationsMigrationJobsTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>

[src]

@param resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

projectsLocationsMigrationJobsVerify(name: string, req: VerifyMigrationJobRequest): Promise<Operation>

[src]

Verify a migration job, making sure the destination can reach the source and that all configuration and prerequisites are met.

@param name

Name of the migration job resource to verify.

projectsLocationsOperationsCancel(name: string, req: CancelOperationRequest): Promise<Empty>

[src]

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

@param name

The name of the operation resource to be cancelled.

projectsLocationsOperationsDelete(name: string): Promise<Empty>

[src]

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

@param name

The name of the operation resource to be deleted.

projectsLocationsOperationsGet(name: string): Promise<Operation>

[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

projectsLocationsOperationsList(name: string, opts?: ProjectsLocationsOperationsListOptions): Promise<ListOperationsResponse>

[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

projectsLocationsPrivateConnectionsCreate(parent: string, req: PrivateConnection, opts?: ProjectsLocationsPrivateConnectionsCreateOptions): Promise<Operation>

[src]

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

@param parent

Required. The parent that owns the collection of PrivateConnections.

projectsLocationsPrivateConnectionsDelete(name: string, opts?: ProjectsLocationsPrivateConnectionsDeleteOptions): Promise<Operation>

[src]

Deletes a single Database Migration Service private connection.

@param name

Required. The name of the private connection to delete.

projectsLocationsPrivateConnectionsGet(name: string): Promise<PrivateConnection>

[src]

Gets details of a single private connection.

@param name

Required. The name of the private connection to get.

projectsLocationsPrivateConnectionsGetIamPolicy(resource: string, opts?: ProjectsLocationsPrivateConnectionsGetIamPolicyOptions): Promise<Policy>

[src]

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

@param resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

projectsLocationsPrivateConnectionsList(parent: string, opts?: ProjectsLocationsPrivateConnectionsListOptions): Promise<ListPrivateConnectionsResponse>

[src]

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

@param parent

Required. The parent that owns the collection of private connections.

projectsLocationsPrivateConnectionsSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>

[src]

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

@param resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

projectsLocationsPrivateConnectionsTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>

[src]

@param resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.