com.softlayer.api.service.workload.citrix.Deployment 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
The newest version!
package com.softlayer.api.service.workload.citrix;

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.network.Vlan;
import com.softlayer.api.service.user.Customer;
import com.softlayer.api.service.workload.citrix.deployment.Resource;
import com.softlayer.api.service.workload.citrix.deployment.Response;
import com.softlayer.api.service.workload.citrix.deployment.Type;
import java.util.ArrayList;
import java.util.GregorianCalendar;
import java.util.List;
import java.util.concurrent.Future;

/**
 * The SoftLayer_Workload_Citrix_Deployment service allows viewing the resources ordered for Citrix Virtual Apps and Desktops. 

 * 

 * The deployment resources include Cloud Connectors, Active Directory domain controller, Bare Metal servers, File Storage, VLAN, Primary/Portable subnets, DHCP server, and Proxy server. 
 *
 * @see SoftLayer_Workload_Citrix_Deployment
 */
@ApiType("SoftLayer_Workload_Citrix_Deployment")
public class Deployment extends Entity {

    /**
     * The [[SoftLayer_Account]] to which the deployment belongs.
     */
    @ApiProperty
    protected Account account;

    public Account getAccount() {
        return account;
    }

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

    /**
     * It contains a collection of items under the CVAD deployment.
     */
    @ApiProperty
    protected List resources;

    public List getResources() {
        if (resources == null) {
            resources = new ArrayList();
        }
        return resources;
    }

    /**
     * It shows if the deployment is for Citrix Hypervisor or VMware.
     */
    @ApiProperty
    protected Type type;

    public Type getType() {
        return type;
    }

    public void setType(Type type) {
        this.type = type;
    }

    /**
     * It is the [[SoftLayer_User_Customer]] who placed the order for CVAD.
     */
    @ApiProperty
    protected Customer user;

    public Customer getUser() {
        return user;
    }

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

    /**
     * It is the VLAN resource for the CVAD deployment.
     */
    @ApiProperty
    protected Vlan vlan;

    public Vlan getVlan() {
        return vlan;
    }

    public void setVlan(Vlan vlan) {
        this.vlan = vlan;
    }

    /**
     * The account ID to which the deployment belongs.
     */
    @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;
    }

    /**
     * Topology used for the Citrix Virtual Apps And  Desktop deployment.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String activeDirectoryTopology;

    public String getActiveDirectoryTopology() {
        return activeDirectoryTopology;
    }

    public void setActiveDirectoryTopology(String activeDirectoryTopology) {
        activeDirectoryTopologySpecified = true;
        this.activeDirectoryTopology = activeDirectoryTopology;
    }

    protected boolean activeDirectoryTopologySpecified;

    public boolean isActiveDirectoryTopologySpecified() {
        return activeDirectoryTopologySpecified;
    }

    public void unsetActiveDirectoryTopology() {
        activeDirectoryTopology = null;
        activeDirectoryTopologySpecified = false;
    }

    /**
     * The date when this record was created.
     */
    @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;
    }

    /**
     * It is the unique identifier for the deployment.
     */
    @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;
    }

    /**
     * The date when this record was last modified.
     */
    @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;
    }

    /**
     * The [[SoftLayer_Workload_Citrix_Deployment_Type]] of the deployment.
     */
    @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;
    }

    /**
     * The identifier for the customer who placed the CVAD order.
     */
    @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;
    }

    /**
     * VLAN ID of the deployment.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long vlanId;

    public Long getVlanId() {
        return vlanId;
    }

    public void setVlanId(Long vlanId) {
        vlanIdSpecified = true;
        this.vlanId = vlanId;
    }

    protected boolean vlanIdSpecified;

    public boolean isVlanIdSpecified() {
        return vlanIdSpecified;
    }

    public void unsetVlanId() {
        vlanId = null;
        vlanIdSpecified = false;
    }

    /**
     * It is an internal identifier for the VMware solution. It gets set if the CVAD order is for VMware. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String vmwareOrderId;

    public String getVmwareOrderId() {
        return vmwareOrderId;
    }

    public void setVmwareOrderId(String vmwareOrderId) {
        vmwareOrderIdSpecified = true;
        this.vmwareOrderId = vmwareOrderId;
    }

    protected boolean vmwareOrderIdSpecified;

    public boolean isVmwareOrderIdSpecified() {
        return vmwareOrderIdSpecified;
    }

    public void unsetVmwareOrderId() {
        vmwareOrderId = null;
        vmwareOrderIdSpecified = false;
    }

    /**
     * A count of it contains a collection of items under the CVAD deployment.
     */
    @ApiProperty
    protected Long resourceCount;

    public Long getResourceCount() {
        return resourceCount;
    }

    public void setResourceCount(Long resourceCount) {
        this.resourceCount = resourceCount;
    }

    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 SoftLayer_Workload_Citrix_Deployment service allows viewing the resources ordered for Citrix Virtual Apps and Desktops. 

     * 

     * The deployment resources include Cloud Connectors, Active Directory domain controller, Bare Metal servers, File Storage, VLAN, Primary/Portable subnets, DHCP server, and Proxy server. 
     *
     * @see SoftLayer_Workload_Citrix_Deployment
     */
    @com.softlayer.api.annotation.ApiService("SoftLayer_Workload_Citrix_Deployment")
    public static interface Service extends com.softlayer.api.Service {

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

        /**
         * Creates a new Citrix Virtual Apps and Desktops deployment. 
         *
         * @see SoftLayer_Workload_Citrix_Deployment::createObject
         */
        @ApiMethod
        public Deployment createObject(Deployment templateObject);

        /**
         * Get all Citrix Virtual Apps And Desktop deployments. 
         *
         * @see SoftLayer_Workload_Citrix_Deployment::getAllObjects
         */
        @ApiMethod
        public List getAllObjects();

        /**
         * Returns a response object [[SoftLayer_Workload_Citrix_Deployment_Response]] which represents the CVAD deployment [[SoftLayer_Workload_Citrix_Deployment]] together with all the resources ordered under the CVAD order. 

         * 

         * The deployment resources are represented by object [[SoftLayer_Workload_Citrix_Deployment_Resource_Response]]. 
         *
         * @see SoftLayer_Workload_Citrix_Deployment::getDeployment
         */
        @ApiMethod
        public Response getDeployment(Long deploymentId);

        /**
         * @see SoftLayer_Workload_Citrix_Deployment::getObject
         */
        @ApiMethod(instanceRequired = true)
        public Deployment getObject();

        /**
         * The [[SoftLayer_Account]] to which the deployment belongs.
         *
         * @see SoftLayer_Workload_Citrix_Deployment::getAccount
         */
        @ApiMethod(instanceRequired = true)
        public Account getAccount();

        /**
         * It contains a collection of items under the CVAD deployment.
         *
         * @see SoftLayer_Workload_Citrix_Deployment::getResources
         */
        @ApiMethod(instanceRequired = true)
        public List getResources();

        /**
         * It shows if the deployment is for Citrix Hypervisor or VMware.
         *
         * @see SoftLayer_Workload_Citrix_Deployment::getType
         */
        @ApiMethod(instanceRequired = true)
        public Type getType();

        /**
         * It is the [[SoftLayer_User_Customer]] who placed the order for CVAD.
         *
         * @see SoftLayer_Workload_Citrix_Deployment::getUser
         */
        @ApiMethod(instanceRequired = true)
        public Customer getUser();

        /**
         * It is the VLAN resource for the CVAD deployment.
         *
         * @see SoftLayer_Workload_Citrix_Deployment::getVlan
         */
        @ApiMethod(instanceRequired = true)
        public Vlan getVlan();

    }

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

        public Future createObject(Deployment templateObject, ResponseHandler callback);

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

        public Future getAllObjects(ResponseHandler> callback);

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

        public Future getDeployment(Long deploymentId, ResponseHandler callback);

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

        public Future getObject(ResponseHandler callback);

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

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

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

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

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

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

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

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

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

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

    }

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

        public com.softlayer.api.service.Account.Mask account() {
            return withSubMask("account", com.softlayer.api.service.Account.Mask.class);
        }

        public com.softlayer.api.service.workload.citrix.deployment.Resource.Mask resources() {
            return withSubMask("resources", com.softlayer.api.service.workload.citrix.deployment.Resource.Mask.class);
        }

        public com.softlayer.api.service.workload.citrix.deployment.Type.Mask type() {
            return withSubMask("type", com.softlayer.api.service.workload.citrix.deployment.Type.Mask.class);
        }

        public com.softlayer.api.service.user.Customer.Mask user() {
            return withSubMask("user", com.softlayer.api.service.user.Customer.Mask.class);
        }

        public com.softlayer.api.service.network.Vlan.Mask vlan() {
            return withSubMask("vlan", com.softlayer.api.service.network.Vlan.Mask.class);
        }

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

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

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

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

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

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

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

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

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

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

    }

}