com.atlassian.bitbucket.migration

Interface MigrationService

public interface MigrationService

Since:

5.13

Method Summary

Modifier and Type	Method and Description
Optional<Job>	cancelExport(long jobId) Cancels the export job.
Optional<Job>	cancelImport(long jobId) Cancels the import job.
Optional<Job>	getExportJob(long jobId) Retrieves the export job.
Optional<Job>	getImportJob(long jobId) Retrieves the import job.
Stream<Scope>	previewExport(ExportRequest request) Resolves export items without triggering an export.
Page<JobMessage>	searchExportJobMessages(MigrationJobMessageSearchRequest request, PageRequest pageRequest) Finds all job messages matching the supplied request object for an export job.
Page<JobMessage>	searchImportJobMessages(MigrationJobMessageSearchRequest request, PageRequest pageRequest) Finds all job messages matching the supplied request object for an import job.
Job	startExport(ExportRequest request) Export the repositories specified in the export request.
Job	startImport(ImportRequest request) Import the data contained in the archive specified in the import request.

Method Detail

cancelExport

@Nonnull
Optional<Job> cancelExport(long jobId)

Cancels the export job. This happens immediately and the resulting archive is not usable.

Parameters:

jobId - the ID of the export job

Returns:

export job or Optional.empty() if the export job doesn't exist

Throws:

IllegalStateException - if the job has been canceled already, or if it had ended

See Also:

Job

cancelImport

@Nonnull
Optional<Job> cancelImport(long jobId)

Cancels the import job. The currently importing repository will finish importing and then the import will be canceled.

Parameters:

jobId - the ID of the import job

Returns:

import job or Optional.empty() if the import job doesn't exist

Throws:

IllegalStateException - if the job has been canceled already, or if it had ended

See Also:

Job

getExportJob

@Nonnull
Optional<Job> getExportJob(long jobId)

Retrieves the export job.

Parameters:

jobId - the ID of the export job

Returns:

export job

See Also:

Job

getImportJob

@Nonnull
Optional<Job> getImportJob(long jobId)

Retrieves the import job.

Parameters:

jobId - the ID of the import job

Returns:

import job

See Also:

Job

previewExport

@Nonnull
Stream<Scope> previewExport(@Nonnull
                                     ExportRequest request)

Resolves export items without triggering an export.

Parameters:

request - a request object describing the repositories to be exported

Returns:

the items to be exported if an export job with the given request were triggered

searchExportJobMessages

@Nonnull
Page<JobMessage> searchExportJobMessages(@Nonnull
                                                  MigrationJobMessageSearchRequest request,
                                                  @Nonnull
                                                  PageRequest pageRequest)

Finds all job messages matching the supplied request object for an export job.

Parameters:

request - the request

pageRequest - the page request

Returns:

the page of matching job messages

Throws:

IllegalArgumentException - if the job ID on the request is not an export job ID

searchImportJobMessages

@Nonnull
Page<JobMessage> searchImportJobMessages(@Nonnull
                                                  MigrationJobMessageSearchRequest request,
                                                  @Nonnull
                                                  PageRequest pageRequest)

Finds all job messages matching the supplied request object for an import job.

Parameters:

request - the request

pageRequest - the page request

Returns:

the page of matching job messages

Throws:

IllegalArgumentException - if the job ID on the request is not an import job ID

startExport

@Nonnull
Job startExport(@Nonnull
                         ExportRequest request)

Export the repositories specified in the export request.

Parameters:

request - a request object describing the repositories to be exported

Returns:

the export job, the export job contains an export ID which could be used to retrieve the job status

Throws:

MaxConcurrentMigrationJobsException - if the maximum number of concurrent migration jobs are already running on this node

See Also:

ExportRequest

startImport

@Nonnull
Job startImport(@Nonnull
                         ImportRequest request)

Import the data contained in the archive specified in the import request.

Parameters:

request - a request object specifying the archive to import

Returns:

the import job, the import job contains an import ID which could be used to retrieve the job status

Throws:

MaxConcurrentMigrationJobsException - if the maximum number of concurrent migration jobs are already running on this node

See Also:

ImportRequest