com.softlayer.api.service.configuration.template.section.Definition 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.configuration.template.section;

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 com.softlayer.api.service.configuration.template.Section;
import com.softlayer.api.service.configuration.template.section.definition.Attribute;
import com.softlayer.api.service.configuration.template.section.definition.Group;
import com.softlayer.api.service.configuration.template.section.definition.Type;
import com.softlayer.api.service.configuration.template.section.definition.Value;
import java.util.ArrayList;
import java.util.GregorianCalendar;
import java.util.List;
import java.util.concurrent.Future;

/**
 * Configuration definition gives you details of the value that you're setting. 

 * 

 * If value type is defined as "Resource Specific Values", you will have to make an additional API call to retrieve your system specific values. 

 * 

 *
 *
 * @see SoftLayer_Configuration_Template_Section_Definition
 */
@ApiType("SoftLayer_Configuration_Template_Section_Definition")
public class Definition extends Entity {

    @ApiProperty
    protected List attributes;

    public List getAttributes() {
        if (attributes == null) {
            attributes = new ArrayList();
        }
        return attributes;
    }

    @ApiProperty
    protected Value defaultValue;

    public Value getDefaultValue() {
        return defaultValue;
    }

    public void setDefaultValue(Value defaultValue) {
        this.defaultValue = defaultValue;
    }

    @ApiProperty
    protected Group group;

    public Group getGroup() {
        return group;
    }

    public void setGroup(Group group) {
        this.group = group;
    }

    @ApiProperty
    protected Boolean monitoringDataFlag;

    public Boolean getMonitoringDataFlag() {
        return monitoringDataFlag;
    }

    public void setMonitoringDataFlag(Boolean monitoringDataFlag) {
        this.monitoringDataFlag = monitoringDataFlag;
    }

    @ApiProperty
    protected Section section;

    public Section getSection() {
        return section;
    }

    public void setSection(Section section) {
        this.section = section;
    }

    @ApiProperty
    protected Type valueType;

    public Type getValueType() {
        return valueType;
    }

    public void setValueType(Type valueType) {
        this.valueType = valueType;
    }

    /**
     * Created date
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected GregorianCalendar createDate;

    public GregorianCalendar getCreateDate() {
        return createDate;
    }

    public void setCreateDate(GregorianCalendar createDate) {
        createDateSpecified = true;
        this.createDate = createDate;
    }

    protected boolean createDateSpecified;

    public boolean isCreateDateSpecified() {
        return createDateSpecified;
    }

    public void unsetCreateDate() {
        createDate = null;
        createDateSpecified = false;
    }

    /**
     * Description of a configuration definition.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String description;

    public String getDescription() {
        return description;
    }

    public void setDescription(String description) {
        descriptionSpecified = true;
        this.description = description;
    }

    protected boolean descriptionSpecified;

    public boolean isDescriptionSpecified() {
        return descriptionSpecified;
    }

    public void unsetDescription() {
        description = null;
        descriptionSpecified = false;
    }

    /**
     * Enumeration values separated by comma.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String enumerationValues;

    public String getEnumerationValues() {
        return enumerationValues;
    }

    public void setEnumerationValues(String enumerationValues) {
        enumerationValuesSpecified = true;
        this.enumerationValues = enumerationValues;
    }

    protected boolean enumerationValuesSpecified;

    public boolean isEnumerationValuesSpecified() {
        return enumerationValuesSpecified;
    }

    public void unsetEnumerationValues() {
        enumerationValues = null;
        enumerationValuesSpecified = false;
    }

    /**
     * Definition group id.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String groupId;

    public String getGroupId() {
        return groupId;
    }

    public void setGroupId(String groupId) {
        groupIdSpecified = true;
        this.groupId = groupId;
    }

    protected boolean groupIdSpecified;

    public boolean isGroupIdSpecified() {
        return groupIdSpecified;
    }

    public void unsetGroupId() {
        groupId = null;
        groupIdSpecified = false;
    }

    /**
     * Internal identifier of a configuration definition.
     */
    @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;
    }

    /**
     * Maximum value of a configuration definition.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String maximumValue;

    public String getMaximumValue() {
        return maximumValue;
    }

    public void setMaximumValue(String maximumValue) {
        maximumValueSpecified = true;
        this.maximumValue = maximumValue;
    }

    protected boolean maximumValueSpecified;

    public boolean isMaximumValueSpecified() {
        return maximumValueSpecified;
    }

    public void unsetMaximumValue() {
        maximumValue = null;
        maximumValueSpecified = false;
    }

    /**
     * Minimum value of a configuration definition.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String minimumValue;

    public String getMinimumValue() {
        return minimumValue;
    }

    public void setMinimumValue(String minimumValue) {
        minimumValueSpecified = true;
        this.minimumValue = minimumValue;
    }

    protected boolean minimumValueSpecified;

    public boolean isMinimumValueSpecified() {
        return minimumValueSpecified;
    }

    public void unsetMinimumValue() {
        minimumValue = null;
        minimumValueSpecified = false;
    }

    /**
     * Last modify date
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected GregorianCalendar modifyDate;

    public GregorianCalendar getModifyDate() {
        return modifyDate;
    }

    public void setModifyDate(GregorianCalendar modifyDate) {
        modifyDateSpecified = true;
        this.modifyDate = modifyDate;
    }

    protected boolean modifyDateSpecified;

    public boolean isModifyDateSpecified() {
        return modifyDateSpecified;
    }

    public void unsetModifyDate() {
        modifyDate = null;
        modifyDateSpecified = false;
    }

    /**
     * Configuration definition 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;
    }

    /**
     * Definition path.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String path;

    public String getPath() {
        return path;
    }

    public void setPath(String path) {
        pathSpecified = true;
        this.path = path;
    }

    protected boolean pathSpecified;

    public boolean isPathSpecified() {
        return pathSpecified;
    }

    public void unsetPath() {
        path = null;
        pathSpecified = false;
    }

    /**
     * Indicates if a configuration value is required for this definition.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long requireValueFlag;

    public Long getRequireValueFlag() {
        return requireValueFlag;
    }

    public void setRequireValueFlag(Long requireValueFlag) {
        requireValueFlagSpecified = true;
        this.requireValueFlag = requireValueFlag;
    }

    protected boolean requireValueFlagSpecified;

    public boolean isRequireValueFlagSpecified() {
        return requireValueFlagSpecified;
    }

    public void unsetRequireValueFlag() {
        requireValueFlag = null;
        requireValueFlagSpecified = false;
    }

    /**
     * Internal identifier of a configuration section.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long sectionId;

    public Long getSectionId() {
        return sectionId;
    }

    public void setSectionId(Long sectionId) {
        sectionIdSpecified = true;
        this.sectionId = sectionId;
    }

    protected boolean sectionIdSpecified;

    public boolean isSectionIdSpecified() {
        return sectionIdSpecified;
    }

    public void unsetSectionId() {
        sectionId = null;
        sectionIdSpecified = false;
    }

    /**
     * Shortened configuration definition name.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String shortName;

    public String getShortName() {
        return shortName;
    }

    public void setShortName(String shortName) {
        shortNameSpecified = true;
        this.shortName = shortName;
    }

    protected boolean shortNameSpecified;

    public boolean isShortNameSpecified() {
        return shortNameSpecified;
    }

    public void unsetShortName() {
        shortName = null;
        shortNameSpecified = false;
    }

    /**
     * Sort order
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long sort;

    public Long getSort() {
        return sort;
    }

    public void setSort(Long sort) {
        sortSpecified = true;
        this.sort = sort;
    }

    protected boolean sortSpecified;

    public boolean isSortSpecified() {
        return sortSpecified;
    }

    public void unsetSort() {
        sort = null;
        sortSpecified = false;
    }

    /**
     * Internal identifier of a configuration definition type.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long typeId;

    public Long getTypeId() {
        return typeId;
    }

    public void setTypeId(Long typeId) {
        typeIdSpecified = true;
        this.typeId = typeId;
    }

    protected boolean typeIdSpecified;

    public boolean isTypeIdSpecified() {
        return typeIdSpecified;
    }

    public void unsetTypeId() {
        typeId = null;
        typeIdSpecified = false;
    }

    /**
     * A count of 
     */
    @ApiProperty
    protected Long attributeCount;

    public Long getAttributeCount() {
        return attributeCount;
    }

    public void setAttributeCount(Long attributeCount) {
        this.attributeCount = attributeCount;
    }

    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());
    }

    /**
     * Configuration definition gives you details of the value that you're setting. 
     *
     * @see SoftLayer_Configuration_Template_Section_Definition
     */
    @com.softlayer.api.annotation.ApiService("SoftLayer_Configuration_Template_Section_Definition")
    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_Configuration_Template_Section_Definition::getObject
         */
        @ApiMethod(instanceRequired = true)
        public Definition getObject();

        /**
         * @see SoftLayer_Configuration_Template_Section_Definition::getAttributes
         */
        @ApiMethod(instanceRequired = true)
        public List getAttributes();

        /**
         * @see SoftLayer_Configuration_Template_Section_Definition::getDefaultValue
         */
        @ApiMethod(instanceRequired = true)
        public Value getDefaultValue();

        /**
         * @see SoftLayer_Configuration_Template_Section_Definition::getGroup
         */
        @ApiMethod(instanceRequired = true)
        public Group getGroup();

        /**
         * @see SoftLayer_Configuration_Template_Section_Definition::getMonitoringDataFlag
         */
        @ApiMethod(instanceRequired = true)
        public Boolean getMonitoringDataFlag();

        /**
         * @see SoftLayer_Configuration_Template_Section_Definition::getSection
         */
        @ApiMethod(instanceRequired = true)
        public Section getSection();

        /**
         * @see SoftLayer_Configuration_Template_Section_Definition::getValueType
         */
        @ApiMethod(instanceRequired = true)
        public Type getValueType();

    }

    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#getObject}
         */
        public Future getObject();

        public Future getObject(ResponseHandler callback);

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

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

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

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

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

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

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

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

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

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

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

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

    }

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

        public com.softlayer.api.service.configuration.template.section.definition.Attribute.Mask attributes() {
            return withSubMask("attributes", com.softlayer.api.service.configuration.template.section.definition.Attribute.Mask.class);
        }

        public com.softlayer.api.service.configuration.template.section.definition.Value.Mask defaultValue() {
            return withSubMask("defaultValue", com.softlayer.api.service.configuration.template.section.definition.Value.Mask.class);
        }

        public com.softlayer.api.service.configuration.template.section.definition.Group.Mask group() {
            return withSubMask("group", com.softlayer.api.service.configuration.template.section.definition.Group.Mask.class);
        }

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

        public com.softlayer.api.service.configuration.template.Section.Mask section() {
            return withSubMask("section", com.softlayer.api.service.configuration.template.Section.Mask.class);
        }

        public com.softlayer.api.service.configuration.template.section.definition.Type.Mask valueType() {
            return withSubMask("valueType", com.softlayer.api.service.configuration.template.section.definition.Type.Mask.class);
        }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    }

}