com.iland.core.web.rest.api

Interface O365JobResource

@Path(value="/o365-jobs")
 @Consumes(value="application/json")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
public interface O365JobResource

Office 365 VBO Job Resource.

Author:

Julien Anguenot

Method Summary

Modifier and Type	Method and Description
O365JobResponse	disableJob(String uuid) Disable a backup job given its UUID.
O365JobResponse	enableJob(String uuid) Enable a backup job given its UUID.
O365JobResponse	getJobByUuid(String uuid) Get an Office 365 VBO Job.
O365JobSessionSetResponse	getJobSessions(String uuid, Integer page, Integer pageSize) Get Office 365 VBO Job Sessions given a Job UUID.
O365JobResponse	modifyJob(String uuid, O365JobRequest modifyRequest) Modify a backup job given its UUID.
O365JobResponse	modifyJobSchedulePolicy(String uuid, O365JobSchedulePolicyRequest schedulePolicyRequest) Modify a backup job given its UUID.
void	removeJob(String uuid) Remove a backup job given its UUID.
O365JobResponse	startJob(String uuid) Start a backup job given its UUID.
O365RestoreSessionResponse	startRestoreSession(String uuid, O365RestoreSessionStartRequest request) Starts a restore session for exploring and performing restore operations with backups.
O365JobResponse	stopJob(String uuid) Stop a backup job given its UUID.

Method Detail

getJobByUuid

@GET
 @Path(value="/{uuid}")
O365JobResponse getJobByUuid(@PathParam(value="uuid")
                                                          String uuid)

Get an Office 365 VBO Job.

Parameters:

uuid - The Office 365 VBO Job UUID

Returns:

a O365JobResponse instance

getJobSessions

@GET
 @Path(value="/{uuid}/job-sessions")
O365JobSessionSetResponse getJobSessions(@PathParam(value="uuid")
                                                                                   String uuid,
                                                                                   @QueryParam(value="page")
                                                                                   Integer page,
                                                                                   @QueryParam(value="pageSize")
                                                                                   Integer pageSize)

Get Office 365 VBO Job Sessions given a Job UUID.

Parameters:

uuid - The Office 365 VBO Job UUID

page - the page

pageSize - the page size

Returns:

a O365JobSessionSetResponse instance

startRestoreSession

@POST
 @Path(value="/{uuid}/actions/start-restore-session")
 @Consumes(value="application/json")
O365RestoreSessionResponse startRestoreSession(@PathParam(value="uuid")
                                                                                                                                                String uuid,
                                                                                                                                                O365RestoreSessionStartRequest request)

Starts a restore session for exploring and performing restore operations with backups.

Parameters:

uuid - The Office 365 VBO Job UUID

request - a O365RestoreSessionStartRequest

Returns:

a O365RestoreSessionResponse instance

startJob

@POST
 @Path(value="/{uuid}/actions/start-backup-job")
 @Consumes(value="application/json")
O365JobResponse startJob(@PathParam(value="uuid")
                                                                                                                     String uuid)

Start a backup job given its UUID.

Parameters:

uuid - The Office 365 VBO Job UUID

Returns:

a O365JobResponse instance

stopJob

@POST
 @Path(value="/{uuid}/actions/stop-backup-job")
 @Consumes(value="application/json")
O365JobResponse stopJob(@PathParam(value="uuid")
                                                                                                                   String uuid)

Stop a backup job given its UUID.

Parameters:

uuid - The Office 365 VBO Job UUID

Returns:

a O365JobResponse instance

enableJob

@POST
 @Path(value="/{uuid}/actions/enable")
 @Consumes(value="application/json")
O365JobResponse enableJob(@PathParam(value="uuid")
                                                                                                            String uuid)

Enable a backup job given its UUID.

Parameters:

uuid - The Office 365 VBO Job UUID

Returns:

a O365JobResponse instance

disableJob

@POST
 @Path(value="/{uuid}/actions/disable")
 @Consumes(value="application/json")
O365JobResponse disableJob(@PathParam(value="uuid")
                                                                                                              String uuid)

Disable a backup job given its UUID.

Parameters:

uuid - The Office 365 VBO Job UUID

Returns:

a O365JobResponse instance

modifyJob

@PUT
 @Path(value="/{uuid}/actions/modifyJob")
 @Consumes(value="application/json")
O365JobResponse modifyJob(@PathParam(value="uuid")
                                                                                                              String uuid,
                                                                                                              O365JobRequest modifyRequest)

Modify a backup job given its UUID.

Parameters:

uuid - The Office 365 VBO Job UUID

modifyRequest - the O365JobRequest instance

Returns:

a O365JobResponse instance

modifyJobSchedulePolicy

@PUT
 @Path(value="/{uuid}/actions/modify")
 @Consumes(value="application/json")
O365JobResponse modifyJobSchedulePolicy(@PathParam(value="uuid")
                                                                                                                         String uuid,
                                                                                                                         O365JobSchedulePolicyRequest schedulePolicyRequest)

Modify a backup job given its UUID. Currently only modification of schedule policy is supported.

Parameters:

uuid - The Office 365 VBO Job UUID

schedulePolicyRequest - the O365JobSchedulePolicyRequest instance

Returns:

a O365JobResponse instance

removeJob

@DELETE
 @Path(value="/{uuid}")
 @Consumes(value="application/json")
void removeJob(@PathParam(value="uuid")
                                                                                    String uuid)

Remove a backup job given its UUID.

Parameters:

uuid - The Office 365 VBO Job UUID