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

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.Account;
import com.softlayer.api.service.Entity;
import com.softlayer.api.service.configuration.template.Section;
import com.softlayer.api.service.configuration.template.section.Definition;
import com.softlayer.api.service.configuration.template.section.Reference;
import com.softlayer.api.service.configuration.template.section.definition.Value;
import com.softlayer.api.service.product.Item;
import com.softlayer.api.service.user.Customer;
import java.util.ArrayList;
import java.util.GregorianCalendar;
import java.util.List;
import java.util.concurrent.Future;

/**
 * The SoftLayer_Configuration_Template data type contains general information of an arbitrary resource. 
 *
 * @see SoftLayer_Configuration_Template
 */
@ApiType("SoftLayer_Configuration_Template")
public class Template extends Entity {

    @ApiProperty
    protected Account account;

    public Account getAccount() {
        return account;
    }

    public void setAccount(Account account) {
        this.account = account;
    }

    @ApiProperty
    protected List configurationSections;

    public List getConfigurationSections() {
        if (configurationSections == null) {
            configurationSections = new ArrayList();
        }
        return configurationSections;
    }

    @ApiProperty
    protected List defaultValues;

    public List getDefaultValues() {
        if (defaultValues == null) {
            defaultValues = new ArrayList();
        }
        return defaultValues;
    }

    @ApiProperty
    protected List definitions;

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

    @ApiProperty
    protected Item item;

    public Item getItem() {
        return item;
    }

    public void setItem(Item item) {
        this.item = item;
    }

    @ApiProperty
    protected Reference linkedSectionReferences;

    public Reference getLinkedSectionReferences() {
        return linkedSectionReferences;
    }

    public void setLinkedSectionReferences(Reference linkedSectionReferences) {
        this.linkedSectionReferences = linkedSectionReferences;
    }

    @ApiProperty
    protected Template parent;

    public Template getParent() {
        return parent;
    }

    public void setParent(Template parent) {
        this.parent = parent;
    }

    @ApiProperty
    protected Customer user;

    public Customer getUser() {
        return user;
    }

    public void setUser(Customer user) {
        this.user = user;
    }

    /**
     * Internal identifier of a SoftLayer account that this configuration template belongs to
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long accountId;

    public Long getAccountId() {
        return accountId;
    }

    public void setAccountId(Long accountId) {
        accountIdSpecified = true;
        this.accountId = accountId;
    }

    protected boolean accountIdSpecified;

    public boolean isAccountIdSpecified() {
        return accountIdSpecified;
    }

    public void unsetAccountId() {
        accountId = null;
        accountIdSpecified = false;
    }

    /**
     * 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 template 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 template.
     */
    @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 product item that this configuration template is associated with
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long itemId;

    public Long getItemId() {
        return itemId;
    }

    public void setItemId(Long itemId) {
        itemIdSpecified = true;
        this.itemId = itemId;
    }

    protected boolean itemIdSpecified;

    public boolean isItemIdSpecified() {
        return itemIdSpecified;
    }

    public void unsetItemId() {
        itemId = null;
        itemIdSpecified = 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 template 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 template
     */
    @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;
    }

    /**
     * Internal identifier of a user that last modified this configuration template
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long userRecordId;

    public Long getUserRecordId() {
        return userRecordId;
    }

    public void setUserRecordId(Long userRecordId) {
        userRecordIdSpecified = true;
        this.userRecordId = userRecordId;
    }

    protected boolean userRecordIdSpecified;

    public boolean isUserRecordIdSpecified() {
        return userRecordIdSpecified;
    }

    public void unsetUserRecordId() {
        userRecordId = null;
        userRecordIdSpecified = false;
    }

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

    public Long getConfigurationSectionCount() {
        return configurationSectionCount;
    }

    public void setConfigurationSectionCount(Long configurationSectionCount) {
        this.configurationSectionCount = configurationSectionCount;
    }

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

    public Long getDefaultValueCount() {
        return defaultValueCount;
    }

    public void setDefaultValueCount(Long defaultValueCount) {
        this.defaultValueCount = defaultValueCount;
    }

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

    public Long getDefinitionCount() {
        return definitionCount;
    }

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

    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 template class encapsulated an arbitrary configuration values for various resources. 
     *
     * @see SoftLayer_Configuration_Template
     */
    @com.softlayer.api.annotation.ApiService("SoftLayer_Configuration_Template")
    public static interface Service extends com.softlayer.api.Service {

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

        /**
         * Copy a configuration template and returns a newly created template copy 
         *
         * @see SoftLayer_Configuration_Template::copyTemplate
         */
        @ApiMethod(instanceRequired = true)
        public Template copyTemplate(Template templateObject);

        /**
         * Deletes a customer configuration template. 
         *
         * @see SoftLayer_Configuration_Template::deleteObject
         */
        @ApiMethod(instanceRequired = true)
        public Boolean deleteObject();

        /**
         * Edit the object by passing in a modified instance of the object. Use this method to modify configuration template name or description. 
         *
         * @see SoftLayer_Configuration_Template::editObject
         */
        @ApiMethod(instanceRequired = true)
        public Boolean editObject(Template templateObject);

        /**
         * Retrieves all available configuration templates 
         *
         * @see SoftLayer_Configuration_Template::getAllObjects
         */
        @ApiMethod
        public List