org.jclouds.rackspace.autoscale.v1.features

Interface PolicyApi

All Superinterfaces:

AutoCloseable, Closeable

@Consumes(value="application/json")
 @Path(value="/policies")
public interface PolicyApi
extends Closeable

The API for controlling the configuration of scaling groups. A scaling group is a high-level autoscaling concept that encompasses a group configuration, a launch configuration, and a set of scaling policies.

Method Summary

Modifier and Type	Method and Description
com.google.common.collect.FluentIterable<ScalingPolicy>	create(List<CreateScalingPolicy> scalingPolicies) Create a scaling policy.
boolean	delete(String scalingPolicyId) This operation deletes a specific scaling policy.
boolean	execute(String scalingPolicyId) This operation executes a specific scaling policy.
ScalingPolicy	get(String scalingPolicyId) This operation returns the details for a single scaling policy.
com.google.common.collect.FluentIterable<ScalingPolicy>	list() This operation lists all scaling policies.
boolean	update(String scalingPolicyId, CreateScalingPolicy scalingPolicy) This operation updates a specific scaling policy.

Methods inherited from interface java.io.Closeable

close

Method Detail

create

@Named(value="policy:create")
 @POST
com.google.common.collect.FluentIterable<ScalingPolicy> create(List<CreateScalingPolicy> scalingPolicies)

Create a scaling policy.

Parameters:

scalingPolicies - The list of scaling policies.

Returns:

List of the created scaling policies

See Also:

CreateScalingPolicy, ScalingPolicy

list

@Named(value="policy:list")
 @GET
com.google.common.collect.FluentIterable<ScalingPolicy> list()

This operation lists all scaling policies.

Returns:

A list of scaling policy responses.

See Also:

ScalingPolicy

get

@Named(value="policy:get")
 @GET
 @Path(value="/{scalingPolicyId}")
 @Nullable
ScalingPolicy get(@PathParam(value="scalingPolicyId")
                                                                                                 String scalingPolicyId)

This operation returns the details for a single scaling policy.

Returns:

Existing scaling policy details

See Also:

ScalingPolicy

update

@Named(value="policy:update")
 @PUT
 @Path(value="/{scalingPolicyId}")
boolean update(@PathParam(value="scalingPolicyId")
                                                                                      String scalingPolicyId,
                                                                                      CreateScalingPolicy scalingPolicy)

This operation updates a specific scaling policy.

Returns:

true if successful.

See Also:

CreateScalingPolicy

delete

@Named(value="policy:delete")
 @DELETE
 @Path(value="/{scalingPolicyId}")
boolean delete(@PathParam(value="scalingPolicyId")
                                                                                         String scalingPolicyId)

This operation deletes a specific scaling policy.

Returns:

true if successful.

See Also:

CreateScalingPolicy

execute

@Named(value="policy:execute")
 @POST
 @Path(value="/{scalingPolicyId}/execute")
boolean execute(@PathParam(value="scalingPolicyId")
                                                                                                 String scalingPolicyId)

This operation executes a specific scaling policy.

Returns:

true if successful.

See Also:

CreateScalingPolicy