Package org.jclouds.rackspace.autoscale.v1.features

Interface GroupApi

All Superinterfaces:

AutoCloseable, Closeable

@Consumes("application/json")
@Path("/groups")
public interface GroupApi
extends Closeable

The API for controlling 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	Description
Group	create(GroupConfiguration groupConfiguration, LaunchConfiguration launchConfiguration, List<CreateScalingPolicy> scalingPolicies)	Create a scaling group.
boolean	delete(String groupId)	This operation deletes the specified Autoscaling Group
Group	get(String id)	This operation gets group details for a group
GroupConfiguration	getGroupConfiguration(String id)	This operation gets the configuration for the scaling group.
LaunchConfiguration	getLaunchConfiguration(String id)	This operation gets the launch configuration for the scaling group.
GroupState	getState(String id)	This operation gets the state of the Autoscaling Group.
com.google.common.collect.FluentIterable<GroupState>	listGroupStates()	This operation lists all autoscaling groups.
boolean	pause(String groupId)	This operation pauses the specified Autoscaling Group
boolean	resume(String groupId)	This operation resumes the specified Autoscaling Group.
boolean	updateGroupConfiguration(String id, GroupConfiguration groupConfiguration)	This operation updates the configuration for the scaling group.
boolean	updateLaunchConfiguration(String id, LaunchConfiguration launchConfiguration)	This operation updates the launch configuration for the scaling group.

Methods inherited from interface java.io.Closeable

close

Method Detail

create

@Named("group:create")
@POST
@Nullable
Group create(GroupConfiguration groupConfiguration,
             LaunchConfiguration launchConfiguration,
             List<CreateScalingPolicy> scalingPolicies)

Create a scaling group.

Parameters:

groupConfiguration - The group configuration.

launchConfiguration - The launch configuration.

scalingPolicies - The list of scaling policies.

Returns:

Group The group created by this call.

See Also:

GroupConfiguration, LaunchConfiguration, CreateScalingPolicy, Group

pause

@Named("group:pause")
@POST
@Path("/{groupId}/pause")
boolean pause(@PathParam("groupId")
              String groupId)

This operation pauses the specified Autoscaling Group

Parameters:

groupId - The id for the specified Group.

Returns:

true if successful.

See Also:

resume(String)

resume

@Named("group:resume")
@POST
@Path("/{groupId}/resume")
boolean resume(@PathParam("groupId")
               String groupId)

This operation resumes the specified Autoscaling Group.

Parameters:

groupId - The id for the specified Group.

Returns:

true if successful.

See Also:

pause(String)

delete

@Named("group:delete")
@DELETE
@Path("/{id}")
boolean delete(@PathParam("id")
               String groupId)

This operation deletes the specified Autoscaling Group

Parameters:

groupId - The id for the specified Group.

Returns:

true if successful.

get

@Named("group:get")
@GET
@Path("/{id}")
@Nullable
Group get(@PathParam("id")
          String id)

This operation gets group details for a group

Parameters:

id - The unique identifier of the scaling group.

Returns:

Group Full details for the scaling group.

getState

@Named("group:getState")
@GET
@Path("/{id}/state")
@Nullable
GroupState getState(@PathParam("id")
                    String id)

This operation gets the state of the Autoscaling Group. This is a slightly different set of information than the full details for a group.

Parameters:

id - The unique identifier of the scaling group.

Returns:

The state of the Group.

See Also:

GroupState

listGroupStates

@Named("group:listGroupStates")
@GET
com.google.common.collect.FluentIterable<GroupState> listGroupStates()

This operation lists all autoscaling groups.

Returns:

A list of group states for all scaling groups.

See Also:

GroupState

getGroupConfiguration

@Named("group:getGroupConfiguration")
@GET
@Path("/{groupId}/config")
@Nullable
GroupConfiguration getGroupConfiguration(@PathParam("groupId")
                                         String id)

This operation gets the configuration for the scaling group.

Returns:

The group configuration for the scaling group.

See Also:

GroupConfiguration

updateGroupConfiguration

@Named("group:updateGroupConfiguration")
@PUT
@Path("/{groupId}/config")
boolean updateGroupConfiguration(@PathParam("groupId")
                                 String id,
                                 GroupConfiguration groupConfiguration)

This operation updates the configuration for the scaling group.

Returns:

true if successful.

See Also:

GroupConfiguration

getLaunchConfiguration

@Named("group:getLaunchConfiguration")
@GET
@Path("/{groupId}/launch")
@Nullable
LaunchConfiguration getLaunchConfiguration(@PathParam("groupId")
                                           String id)

This operation gets the launch configuration for the scaling group.

Returns:

The launch configuration for the scaling group.

See Also:

LaunchConfiguration

updateLaunchConfiguration

@Named("group:updateLaunchConfiguration")
@PUT
@Path("/{groupId}/launch")
boolean updateLaunchConfiguration(@PathParam("groupId")
                                  String id,
                                  LaunchConfiguration launchConfiguration)

This operation updates the launch configuration for the scaling group.

Returns:

true if successful.

See Also:

LaunchConfiguration