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

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;
import com.softlayer.api.service.configuration.template.section.Definition;
import com.softlayer.api.service.configuration.template.section.Profile;
import com.softlayer.api.service.configuration.template.section.Reference;
import com.softlayer.api.service.configuration.template.section.Type;
import java.util.ArrayList;
import java.util.GregorianCalendar;
import java.util.List;
import java.util.concurrent.Future;

/**
 * The SoftLayer_Configuration_Template_Section data type contains information of a configuration section. 

 * 

 * Configuration can contain sub-sections. 
 *
 * @see SoftLayer_Configuration_Template_Section
 */
@ApiType("SoftLayer_Configuration_Template_Section")
public class Section extends Entity {

    @ApiProperty
    protected List definitions;

    public List getDefinitions() {
        if (definitions == null) {
            definitions = new ArrayList();
        }
        return definitions;
    }

    @ApiProperty
    protected Boolean disallowedDeletionFlag;

    public Boolean getDisallowedDeletionFlag() {
        return disallowedDeletionFlag;
    }

    public void setDisallowedDeletionFlag(Boolean disallowedDeletionFlag) {
        this.disallowedDeletionFlag = disallowedDeletionFlag;
    }

    @ApiProperty
    protected Template linkedTemplate;

    public Template getLinkedTemplate() {
        return linkedTemplate;
    }

    public void setLinkedTemplate(Template linkedTemplate) {
        this.linkedTemplate = linkedTemplate;
    }

    @ApiProperty
    protected Reference linkedTemplateReference;

    public Reference getLinkedTemplateReference() {
        return linkedTemplateReference;
    }

    public void setLinkedTemplateReference(Reference linkedTemplateReference) {
        this.linkedTemplateReference = linkedTemplateReference;
    }

    @ApiProperty
    protected List profiles;

    public List getProfiles() {
        if (profiles == null) {
            profiles = new ArrayList();
        }
        return profiles;
    }

    @ApiProperty
    protected Type sectionType;

    public Type getSectionType() {
        return sectionType;
    }

    public void setSectionType(Type sectionType) {
        this.sectionType = sectionType;
    }

    @ApiProperty
    protected String sectionTypeName;

    public String getSectionTypeName() {
        return sectionTypeName;
    }

    public void setSectionTypeName(String sectionTypeName) {
        this.sectionTypeName = sectionTypeName;
    }

    @ApiProperty
    protected List subSections;

    public List getSubSections() {
        if (subSections == null) {
            subSections = new ArrayList();
        }
        return subSections;
    }

    @ApiProperty
    protected Template template;

    public Template getTemplate() {
        return template;
    }

    public void setTemplate(Template template) {
        this.template = template;
    }

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

    /**
     * Configuration section description
     */
    @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;
    }

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

    /**
     * Internal identifier of a sub configuration template that this section points to. Use this property if you wish to create a reference to a sub configuration template when creating a linked section. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String linkedTemplateId;

    public String getLinkedTemplateId() {
        return linkedTemplateId;
    }

    public void setLinkedTemplateId(String linkedTemplateId) {
        linkedTemplateIdSpecified = true;
        this.linkedTemplateId = linkedTemplateId;
    }

    protected boolean linkedTemplateIdSpecified;

    public boolean isLinkedTemplateIdSpecified() {
        return linkedTemplateIdSpecified;
    }

    public void unsetLinkedTemplateId() {
        linkedTemplateId = null;
        linkedTemplateIdSpecified = false;
    }

    /**
     * Last modified 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 section 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;
    }

    /**
     * Internal identifier of the parent configuration section
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long parentId;

    public Long getParentId() {
        return parentId;
    }

    public void setParentId(Long parentId) {
        parentIdSpecified = true;
        this.parentId = parentId;
    }

    protected boolean parentIdSpecified;

    public boolean isParentIdSpecified() {
        return parentIdSpecified;
    }

    public void unsetParentId() {
        parentId = null;
        parentIdSpecified = 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 template that this section belongs to
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String templateId;

    public String getTemplateId() {
        return templateId;
    }

    public void setTemplateId(String templateId) {
        templateIdSpecified = true;
        this.templateId = templateId;
    }

    protected boolean templateIdSpecified;

    public boolean isTemplateIdSpecified() {
        return templateIdSpecified;
    }

    public void unsetTemplateId() {
        templateId = null;
        templateIdSpecified = false;
    }

    /**
     * Internal identifier of the configuration section 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 definitionCount;

    public Long getDefinitionCount() {
        return definitionCount;
    }

    public void setDefinitionCount(Long definitionCount) {
        this.definitionCount = definitionCount;
    }

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

    public Long getProfileCount() {
        return profileCount;
    }

    public void setProfileCount(Long profileCount) {
        this.profileCount = profileCount;
    }

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

    public Long getSubSectionCount() {
        return subSectionCount;
    }

    public void setSubSectionCount(Long subSectionCount) {
        this.subSectionCount = subSectionCount;
    }

    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 section allow you to divide a large configuration values into a smaller pieces. 
     *
     * @see SoftLayer_Configuration_Template_Section
     */
    @com.softlayer.api.annotation.ApiService("SoftLayer_Configuration_Template_Section")
    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::getObject
         */
        @ApiMethod(instanceRequired = true)
        public Section getObject();

        /**
         * Returns true if the object has sub-sections 
         *
         * @see SoftLayer_Configuration_Template_Section::hasSubSections
         */
        @ApiMethod(instanceRequired = true)
        public Boolean hasSubSections();

        /**
         * @see SoftLayer_Configuration_Template_Section::getDefinitions
         */
        @ApiMethod(instanceRequired = true)
        public List getDefinitions();

        /**
         * @see SoftLayer_Configuration_Template_Section::getDisallowedDeletionFlag
         */
        @ApiMethod(instanceRequired = true)
        public Boolean getDisallowedDeletionFlag();

        /**
         * @see SoftLayer_Configuration_Template_Section::getLinkedTemplate
         */
        @ApiMethod(instanceRequired = true)
        public Template getLinkedTemplate();

        /**
         * @see SoftLayer_Configuration_Template_Section::getLinkedTemplateReference
         */
        @ApiMethod(instanceRequired = true)
        public Reference getLinkedTemplateReference();

        /**
         * @see SoftLayer_Configuration_Template_Section::getProfiles
         */
        @ApiMethod(instanceRequired = true)
        public List getProfiles();

        /**
         * @see SoftLayer_Configuration_Template_Section::getSectionType
         */
        @ApiMethod(instanceRequired = true)
        public Type getSectionType();

        /**
         * @see SoftLayer_Configuration_Template_Section::getSectionTypeName
         */
        @ApiMethod(instanceRequired = true)
        public String getSectionTypeName();

        /**
         * @see SoftLayer_Configuration_Template_Section::getSubSections
         */
        @ApiMethod(instanceRequired = true)
        public List getSubSections();

        /**
         * @see SoftLayer_Configuration_Template_Section::getTemplate
         */
        @ApiMethod(instanceRequired = true)
        public Template getTemplate();

    }

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

        public Future hasSubSections(ResponseHandler callback);

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

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

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

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

        /**
         * Async version of {@link Service#getLinkedTemplate}
         */
        public Future