com.iland.core.web.rest.api

Interface BackupGroupResource

@Path(value="/backup-groups")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
public interface BackupGroupResource

Backup Groups Public API.

Author:

Cory Snyder

Method Summary

Modifier and Type	Method and Description
void	deleteBackupGroup(String backupGroupUid, BackupGroupDeleteRequest deleteRequest) Delete a backup group.
BackupGroupResponse	getBackupGroup(String backupGroupUid, boolean includeSummaryStats, boolean includeLastRun, boolean includeBackupPolicy) Get details of an individual backup protection group.
BackupPolicyResponse	getBackupGroupPolicy(String backupGroupUid) Get details for the policy associated with a specified backup group.
BackupGroupRunResponse	getBackupGroupRun(String backupGroupUid, String backupRunUid) Get a specific backup group run.
BackupGroupSummaryStatsResponse	getBackupGroupSummaryStats(String backupGroupUid, GetBackupGroupSummaryStatsFilters filters) Get summary stats for an individual backup protection group.
BackupGroupStorageMetricListResponse	getBackupStorageMetrics(String backupGroupUid) Gets the list of storage metrics that are available for the backup group.
BackupGroupStorageSampleSeriesResponse	getBackupStorageSamples(String backupGroupUid, BackupGroupStorageMetric metric, GetBackupStorageSamplesFilters filters) Gets a series of backup group storage samples for a specified storage metric.
BackupGroupRunListResponse	listBackupGroupRuns(String backupGroupUid, ListBackupGroupRunsQueryParams params) List runs for the specified backup group.
BackupGroupResponse	updateBackupGroup(String backupGroupUid, BackupGroupUpdateRequest updateRequest) Update a backup group.

Method Detail

getBackupGroup

@GET
 @Path(value="/{backupGroupUid}")
BackupGroupResponse getBackupGroup(@PathParam(value="backupGroupUid")
                                                                          String backupGroupUid,
                                                                          @QueryParam(value="includeSummaryStats")
                                                                          boolean includeSummaryStats,
                                                                          @QueryParam(value="includeLastRun")
                                                                          boolean includeLastRun,
                                                                          @QueryParam(value="includeBackupPolicy")
                                                                          boolean includeBackupPolicy)

Get details of an individual backup protection group.

Parameters:

backupGroupUid - the backup group UID

includeSummaryStats - whether to include summary stats in the response

includeLastRun - whether to include last run info in the response

includeBackupPolicy - whether to include backup policy info

Returns:

BackupGroupResponse

Throws:

javax.ws.rs.NotFoundException - if the backup group is not found

getBackupGroupPolicy

@GET
 @Path(value="/{backupGroupUid}/policy")
BackupPolicyResponse getBackupGroupPolicy(@PathParam(value="backupGroupUid")
                                                                                        String backupGroupUid)

Get details for the policy associated with a specified backup group.

Parameters:

backupGroupUid - the backup group UID

Returns:

BackupGroupResponse

Throws:

javax.ws.rs.NotFoundException - if the backup group is not found

getBackupGroupRun

@GET
 @Path(value="/{backupGroupUid}/runs/{backupRunUid}")
BackupGroupRunResponse getBackupGroupRun(@PathParam(value="backupGroupUid")
                                                                                                    String backupGroupUid,
                                                                                                    @PathParam(value="backupRunUid")
                                                                                                    String backupRunUid)

Get a specific backup group run.

Parameters:

backupGroupUid - the backup group UID

backupRunUid - the run UID

Returns:

BackupGroupRunResponse

Throws:

javax.ws.rs.NotFoundException - if the backup group is not found

listBackupGroupRuns

@GET
 @Path(value="/{backupGroupUid}/backup-runs")
BackupGroupRunListResponse listBackupGroupRuns(@PathParam(value="backupGroupUid")
                                                                                                  String backupGroupUid,
                                                                                                  @BeanParam
                                                                                                  ListBackupGroupRunsQueryParams params)

List runs for the specified backup group.

Limit defaults to 10 and query time range defaults to last 24 hours.

Parameters:

backupGroupUid - the backup group UID

params - query filter params

Returns:

BackupGroupRunListResponse

Throws:

javax.ws.rs.NotFoundException - if the backup group is not found

getBackupGroupSummaryStats

@GET
 @Path(value="/{backupGroupUid}/summary-stats")
BackupGroupSummaryStatsResponse getBackupGroupSummaryStats(@PathParam(value="backupGroupUid")
                                                                                                                String backupGroupUid,
                                                                                                                @BeanParam
                                                                                                                GetBackupGroupSummaryStatsFilters filters)

Get summary stats for an individual backup protection group.

Stat time-range defaults to the past 24 hours.

Parameters:

backupGroupUid - the backup group UID

filters - optional filters that can be used to specify a custom timeframe.

Returns:

BackupGroupSummaryStatsResponse

Throws:

javax.ws.rs.NotFoundException - if the backup group is not found

updateBackupGroup

@PUT
 @Path(value="/{backupGroupUid}")
 @Consumes(value="application/json")
BackupGroupResponse updateBackupGroup(@PathParam(value="backupGroupUid")
                                                                                                                  String backupGroupUid,
                                                                                                                  BackupGroupUpdateRequest updateRequest)

Update a backup group.

Parameters:

backupGroupUid - the UID of the backup group

updateRequest - the update request body

Returns:

BackupGroupResponse

Throws:

javax.ws.rs.NotFoundException - if the backup group is not found

deleteBackupGroup

@DELETE
 @Path(value="/{backupGroupUid}")
 @Consumes(value="application/json")
void deleteBackupGroup(@PathParam(value="backupGroupUid")
                                                                                                      String backupGroupUid,
                                                                                                      BackupGroupDeleteRequest deleteRequest)

Delete a backup group.

Parameters:

backupGroupUid - the UID of the backup group

deleteRequest - the deletion request

Throws:

javax.ws.rs.NotFoundException - if the backup group is not found

getBackupStorageMetrics

@GET
 @Path(value="/{backupGroupUid}/backup-storage-metrics")
BackupGroupStorageMetricListResponse getBackupStorageMetrics(@PathParam(value="backupGroupUid")
                                                                                                                           String backupGroupUid)

Gets the list of storage metrics that are available for the backup group.

Parameters:

backupGroupUid - the UID of the backup group

Returns:

the list of storage metrics names

getBackupStorageSamples

@GET
 @Path(value="/{backupGroupUid}/backup-storage-metrics/{metric}/samples")
BackupGroupStorageSampleSeriesResponse getBackupStorageSamples(@PathParam(value="backupGroupUid")
                                                                                                                                              String backupGroupUid,
                                                                                                                                              @PathParam(value="metric")
                                                                                                                                              BackupGroupStorageMetric metric,
                                                                                                                                              @BeanParam
                                                                                                                                              GetBackupStorageSamplesFilters filters)

Gets a series of backup group storage samples for a specified storage metric.

Parameters:

backupGroupUid - the UID of the backup group

metric - the storage metric name

filters - optional filters for the start and end of the series

Returns:

the sample series