com.softlayer.api.service.scale.group.Status Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of softlayer-api-client Show documentation
API client for accessing the SoftLayer API
There is a newer version: 0.3.4
package com.softlayer.api.service.scale.group;

import com.softlayer.api.ApiClient;
import com.softlayer.api.ResponseHandler;
import com.softlayer.api.annotation.ApiMethod;
import com.softlayer.api.annotation.ApiProperty;
import com.softlayer.api.annotation.ApiType;
import com.softlayer.api.service.Entity;
import java.util.List;
import java.util.concurrent.Future;

/**
 * The status of a scale group. This status affects what actions can occur on a group. The values can be: 

 * 

 * 

 * * ACTIVE - There are no actions execution for any members or assets of any type.

 * * BUSY - There is an action executing for one of the members or assets, but that action is not a scaling action.

 * * SCALING - At least one of the members is in the process of being created or destroyed.

 * * SUSPENDED - The group has been placed in a suspended state by a user. It may only be resumed by a user. While in a

 * suspended state, a scale group cannot have any members added or deleted, or change settings of that group that would invoke such an action. 
 *
 * @see SoftLayer_Scale_Group_Status
 */
@ApiType("SoftLayer_Scale_Group_Status")
public class Status extends Entity {

    /**
     * A status's internal identifier.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long id;

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        idSpecified = true;
        this.id = id;
    }

    protected boolean idSpecified;

    public boolean isIdSpecified() {
        return idSpecified;
    }

    public void unsetId() {
        id = null;
        idSpecified = false;
    }

    /**
     * A status's programmatic name.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String keyName;

    public String getKeyName() {
        return keyName;
    }

    public void setKeyName(String keyName) {
        keyNameSpecified = true;
        this.keyName = keyName;
    }

    protected boolean keyNameSpecified;

    public boolean isKeyNameSpecified() {
        return keyNameSpecified;
    }

    public void unsetKeyName() {
        keyName = null;
        keyNameSpecified = false;
    }

    /**
     * A status's human-friendly name.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String name;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        nameSpecified = true;
        this.name = name;
    }

    protected boolean nameSpecified;

    public boolean isNameSpecified() {
        return nameSpecified;
    }

    public void unsetName() {
        name = null;
        nameSpecified = false;
    }

    public Service asService(ApiClient client) {
        return service(client, id);
    }

    public static Service service(ApiClient client) {
        return client.createService(Service.class, null);
    }

    public static Service service(ApiClient client, Long id) {
        return client.createService(Service.class, id == null ? null : id.toString());
    }

    /**
     * The status of a scale group. This status affects what actions can occur on a group. The values can be: 

     * 

     * 

     * * ACTIVE - There are no actions execution for any members or assets of any type.

     * * BUSY - There is an action executing for one of the members or assets, but that action is not a scaling action.

     * * SCALING - At least one of the members is in the process of being created or destroyed.

     * * SUSPENDED - The group has been placed in a suspended state by a user. It may only be resumed by a user. While in a

     * suspended state, a scale group cannot have any members added or deleted, or change settings of that group that would invoke such an action. 
     *
     * @see SoftLayer_Scale_Group_Status
     */
    @com.softlayer.api.annotation.ApiService("SoftLayer_Scale_Group_Status")
    public static interface Service extends com.softlayer.api.Service {

        public ServiceAsync asAsync();
        public Mask withNewMask();
        public Mask withMask();
        public void setMask(Mask mask);

        /**
         * @see SoftLayer_Scale_Group_Status::getAllObjects
         */
        @ApiMethod
        public List getAllObjects();

        /**
         * @see SoftLayer_Scale_Group_Status::getObject
         */
        @ApiMethod(instanceRequired = true)
        public Status getObject();

    }

    public static interface ServiceAsync extends com.softlayer.api.ServiceAsync {

        public Mask withNewMask();
        public Mask withMask();
        public void setMask(Mask mask);

        /**
         * Async version of {@link Service#getAllObjects}
         */
        public Future> getAllObjects();

        public Future getAllObjects(ResponseHandler> callback);

        /**
         * Async version of {@link Service#getObject}
         */
        public Future getObject();

        public Future getObject(ResponseHandler callback);

    }

    public static class Mask extends com.softlayer.api.service.Entity.Mask {

        public Mask id() {
            withLocalProperty("id");
            return this;
        }

        public Mask keyName() {
            withLocalProperty("keyName");
            return this;
        }

        public Mask name() {
            withLocalProperty("name");
            return this;
        }

    }

}