com.softlayer.api.service.workload.citrix.deployment.Resource 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.deployment;

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.billing.Item;
import com.softlayer.api.service.billing.Order;
import com.softlayer.api.service.workload.citrix.Deployment;
import com.softlayer.api.service.workload.citrix.deployment.resource.Role;
import java.util.GregorianCalendar;
import java.util.List;
import java.util.concurrent.Future;

/**
 * The SoftLayer_Workload_Citrix_Deployment_Resource type contains the information of the resource such as the Deployment ID, resource's Billing Item ID, Order ID and Role of the resource in the CVAD deployment. 
 *
 * @see SoftLayer_Workload_Citrix_Deployment_Resource
 */
@ApiType("SoftLayer_Workload_Citrix_Deployment_Resource")
public class Resource extends Entity {

    @ApiProperty
    protected Item billingItem;

    public Item getBillingItem() {
        return billingItem;
    }

    public void setBillingItem(Item billingItem) {
        this.billingItem = billingItem;
    }

    @ApiProperty
    protected Deployment deployment;

    public Deployment getDeployment() {
        return deployment;
    }

    public void setDeployment(Deployment deployment) {
        this.deployment = deployment;
    }

    @ApiProperty
    protected Order order;

    public Order getOrder() {
        return order;
    }

    public void setOrder(Order order) {
        this.order = order;
    }

    @ApiProperty
    protected Role role;

    public Role getRole() {
        return role;
    }

    public void setRole(Role role) {
        this.role = role;
    }

    /**
     * Billing item ID of the resource
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long billingItemId;

    public Long getBillingItemId() {
        return billingItemId;
    }

    public void setBillingItemId(Long billingItemId) {
        billingItemIdSpecified = true;
        this.billingItemId = billingItemId;
    }

    protected boolean billingItemIdSpecified;

    public boolean isBillingItemIdSpecified() {
        return billingItemIdSpecified;
    }

    public void unsetBillingItemId() {
        billingItemId = null;
        billingItemIdSpecified = false;
    }

    /**
     * The point in time at which the resource was ordered.
     */
    @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;
    }

    /**
     * CVAD Deployment ID of the resource
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long deploymentId;

    public Long getDeploymentId() {
        return deploymentId;
    }

    public void setDeploymentId(Long deploymentId) {
        deploymentIdSpecified = true;
        this.deploymentId = deploymentId;
    }

    protected boolean deploymentIdSpecified;

    public boolean isDeploymentIdSpecified() {
        return deploymentIdSpecified;
    }

    public void unsetDeploymentId() {
        deploymentId = null;
        deploymentIdSpecified = false;
    }

    /**
     * Unique Identifier of the CVAD Deployment Resource
     */
    @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 last time when the resource was 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;
    }

    /**
     * Billing Order ID of the resource
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long orderId;

    public Long getOrderId() {
        return orderId;
    }

    public void setOrderId(Long orderId) {
        orderIdSpecified = true;
        this.orderId = orderId;
    }

    protected boolean orderIdSpecified;

    public boolean isOrderIdSpecified() {
        return orderIdSpecified;
    }

    public void unsetOrderId() {
        orderId = null;
        orderIdSpecified = false;
    }

    /**
     * This flag indicates that whether the CVAD APIs have control over this resource. This resource can be cancelled using CVAD cancellation APIs only if this flag is true. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Boolean orderedByCvad;

    public Boolean getOrderedByCvad() {
        return orderedByCvad;
    }

    public void setOrderedByCvad(Boolean orderedByCvad) {
        orderedByCvadSpecified = true;
        this.orderedByCvad = orderedByCvad;
    }

    protected boolean orderedByCvadSpecified;

    public boolean isOrderedByCvadSpecified() {
        return orderedByCvadSpecified;
    }

    public void unsetOrderedByCvad() {
        orderedByCvad = null;
        orderedByCvadSpecified = false;
    }

    /**
     * Role of the resource within the CVAD deployment. For example, a VSI can have different roles such as Proxy Server or DHCP Server. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long roleId;

    public Long getRoleId() {
        return roleId;
    }

    public void setRoleId(Long roleId) {
        roleIdSpecified = true;
        this.roleId = roleId;
    }

    protected boolean roleIdSpecified;

    public boolean isRoleIdSpecified() {
        return roleIdSpecified;
    }

    public void unsetRoleId() {
        roleId = null;
        roleIdSpecified = 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());
    }

    /**
     * SoftLayer_Workload_Citrix_Deployment_Resource represents the resource of Citrix Virtual Apps & Desktops deployment. 
     *
     * @see SoftLayer_Workload_Citrix_Deployment_Resource
     */
    @com.softlayer.api.annotation.ApiService("SoftLayer_Workload_Citrix_Deployment_Resource")
    public static interface Service extends com.softlayer.api.Service {

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

        /**
         * This will add the resource into CVAD deployment. 
         *
         * @see SoftLayer_Workload_Citrix_Deployment_Resource::createObject
         */
        @ApiMethod
        public Resource createObject(Resource templateObject);

        /**
         * Get all the resources of Citrix Deployments. 
         *
         * @see SoftLayer_Workload_Citrix_Deployment_Resource::getAllObjects
         */
        @ApiMethod
        public List getAllObjects();

        /**
         * getObject retrieves the SoftLayer_Workload_Citrix_Deployment_Resource object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Workload_Citrix_Deployment_Resource service. You can only retrieve resources that are assigned to your portal user's account. 
         *
         * @see SoftLayer_Workload_Citrix_Deployment_Resource::getObject
         */
        @ApiMethod(instanceRequired = true)
        public Resource getObject();

        /**
         * @see SoftLayer_Workload_Citrix_Deployment_Resource::getBillingItem
         */
        @ApiMethod(instanceRequired = true)
        public Item getBillingItem();

        /**
         * @see SoftLayer_Workload_Citrix_Deployment_Resource::getDeployment
         */
        @ApiMethod(instanceRequired = true)
        public Deployment getDeployment();

        /**
         * @see SoftLayer_Workload_Citrix_Deployment_Resource::getOrder
         */
        @ApiMethod(instanceRequired = true)
        public Order getOrder();

        /**
         * @see SoftLayer_Workload_Citrix_Deployment_Resource::getRole
         */
        @ApiMethod(instanceRequired = true)
        public Role getRole();

    }

    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(Resource templateObject);

        public Future createObject(Resource templateObject, ResponseHandler callback);

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

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

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

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

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

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

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

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

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

    }

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

        public com.softlayer.api.service.billing.Item.Mask billingItem() {
            return withSubMask("billingItem", com.softlayer.api.service.billing.Item.Mask.class);
        }

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

        public com.softlayer.api.service.billing.Order.Mask order() {
            return withSubMask("order", com.softlayer.api.service.billing.Order.Mask.class);
        }

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

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

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

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

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

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

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

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

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

    }

}