Interface PolicyApi

  • All Superinterfaces:
    AutoCloseable, Closeable

    @Consumes("application/json")
    @Path("/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 Detail

      • list

        @Named("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("policy:get")
        @GET
        @Path("/{scalingPolicyId}")
        @Nullable
        ScalingPolicy get​(@PathParam("scalingPolicyId")
                          String scalingPolicyId)
        This operation returns the details for a single scaling policy.
        Returns:
        Existing scaling policy details
        See Also:
        ScalingPolicy
      • update

        @Named("policy:update")
        @PUT
        @Path("/{scalingPolicyId}")
        boolean update​(@PathParam("scalingPolicyId")
                       String scalingPolicyId,
                       CreateScalingPolicy scalingPolicy)
        This operation updates a specific scaling policy.
        Returns:
        true if successful.
        See Also:
        CreateScalingPolicy
      • delete

        @Named("policy:delete")
        @DELETE
        @Path("/{scalingPolicyId}")
        boolean delete​(@PathParam("scalingPolicyId")
                       String scalingPolicyId)
        This operation deletes a specific scaling policy.
        Returns:
        true if successful.
        See Also:
        CreateScalingPolicy
      • execute

        @Named("policy:execute")
        @POST
        @Path("/{scalingPolicyId}/execute")
        boolean execute​(@PathParam("scalingPolicyId")
                        String scalingPolicyId)
        This operation executes a specific scaling policy.
        Returns:
        true if successful.
        See Also:
        CreateScalingPolicy