com.cloudera.api.v6

Interface SnapshotsResource

public interface SnapshotsResource

Available since API v6. Only available with Cloudera Manager Enterprise Edition.

Method Summary

Methods

Modifier and Type	Method and Description
ApiSnapshotPolicyList	createPolicies(ApiSnapshotPolicyList policies) Creates one or more snapshot policies.
ApiSnapshotPolicy	deletePolicy(String policyName) Deletes an existing snapshot policy.
ApiSnapshotCommandList	readHistory(String policyName, int limit, int offset, DataView dataView) Returns a list of commands triggered by a snapshot policy.
ApiSnapshotPolicyList	readPolicies(DataView view) Returns information for all snapshot policies.
ApiSnapshotPolicy	readPolicy(String policyName, DataView view) Returns information for a specific snapshot policy.
ApiSnapshotPolicy	updatePolicy(String policyName, ApiSnapshotPolicy policy) Updates an existing snapshot policy.

Method Detail

createPolicies

@Path(value="/policies")
ApiSnapshotPolicyList createPolicies(ApiSnapshotPolicyList policies)

Creates one or more snapshot policies.

Parameters:

policies - List of the snapshot policies to create.

Returns:

List of newly added policies.

readPolicies

@Path(value="/policies")
ApiSnapshotPolicyList readPolicies(DataView view)

Returns information for all snapshot policies.

Parameters:

view - The view to materialize.

Returns:

List of snapshot policies.

readPolicy

@Path(value="/policies/{policyName}")
ApiSnapshotPolicy readPolicy(String policyName,
                                DataView view)

Returns information for a specific snapshot policy.

Parameters:

policyName - Name of an existing snapshot policy.

view - The view to materialize.

Returns:

Snapshot policy.

updatePolicy

@Path(value="/policies/{policyName}")
ApiSnapshotPolicy updatePolicy(String policyName,
                                  ApiSnapshotPolicy policy)

Updates an existing snapshot policy.

Parameters:

policyName - Name of an existing snapshot policy.

policy - Modified policy.

Returns:

The snapshot policy after the update.

deletePolicy

@Path(value="/policies/{policyName}")
ApiSnapshotPolicy deletePolicy(String policyName)

Deletes an existing snapshot policy.

Parameters:

policyName - Name of an existing snapshot policy.

Returns:

The deleted snapshot policy.

readHistory

@Path(value="/policies/{policyName}/history")
ApiSnapshotCommandList readHistory(String policyName,
                                      int limit,
                                      int offset,
                                      DataView dataView)

Returns a list of commands triggered by a snapshot policy.

Parameters:

policyName - Name of an existing snapshot policy.

limit - Maximum number of commands to retrieve.

offset - Index of first command to retrieve.

dataView - The view to materialize.

Returns:

List of commands for the policy.