com.softlayer.api.service.network.gateway.VersionUpgrade 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.network.gateway;

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.product.pkg.item.Prices;
import java.util.List;
import java.util.concurrent.Future;

/**
 * A gateway software version upgrade reference provides pairing for possible upgrades from a given versin. 
 *
 * @see SoftLayer_Network_Gateway_VersionUpgrade
 */
@ApiType("SoftLayer_Network_Gateway_VersionUpgrade")
public class VersionUpgrade extends Entity {

    /**
     * Gateway version being upgraded from. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String fromVersion;

    public String getFromVersion() {
        return fromVersion;
    }

    public void setFromVersion(String fromVersion) {
        fromVersionSpecified = true;
        this.fromVersion = fromVersion;
    }

    protected boolean fromVersionSpecified;

    public boolean isFromVersionSpecified() {
        return fromVersionSpecified;
    }

    public void unsetFromVersion() {
        fromVersion = null;
        fromVersionSpecified = false;
    }

    /**
     * A gateway status's internal identifier. 
     */
    @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;
    }

    /**
     * Is OS Reload required after version upgrade?. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long osReloadRequired;

    public Long getOsReloadRequired() {
        return osReloadRequired;
    }

    public void setOsReloadRequired(Long osReloadRequired) {
        osReloadRequiredSpecified = true;
        this.osReloadRequired = osReloadRequired;
    }

    protected boolean osReloadRequiredSpecified;

    public boolean isOsReloadRequiredSpecified() {
        return osReloadRequiredSpecified;
    }

    public void unsetOsReloadRequired() {
        osReloadRequired = null;
        osReloadRequiredSpecified = false;
    }

    /**
     * Gateway version available for upgrade. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String toVersion;

    public String getToVersion() {
        return toVersion;
    }

    public void setToVersion(String toVersion) {
        toVersionSpecified = true;
        this.toVersion = toVersion;
    }

    protected boolean toVersionSpecified;

    public boolean isToVersionSpecified() {
        return toVersionSpecified;
    }

    public void unsetToVersion() {
        toVersion = null;
        toVersionSpecified = 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());
    }

    /**
     * A gateway software version upgrade reference provides pairing for possible upgrades from a given versin. 
     *
     * @see SoftLayer_Network_Gateway_VersionUpgrade
     */
    @com.softlayer.api.annotation.ApiService("SoftLayer_Network_Gateway_VersionUpgrade")
    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_Network_Gateway_VersionUpgrade::getAllByUpgradePkgUrlId
         */
        @ApiMethod
        public List getAllByUpgradePkgUrlId(Long upgradePkgUrlId);

        /**
         * @see SoftLayer_Network_Gateway_VersionUpgrade::getAllUpgradesByGatewayId
         */
        @ApiMethod
        public List getAllUpgradesByGatewayId(Long gatewayId);

        /**
         * @see SoftLayer_Network_Gateway_VersionUpgrade::getObject
         */
        @ApiMethod(instanceRequired = true)
        public VersionUpgrade getObject();

        /**
         * Used to get a list per package of prices ids for allowed vSRX OS-es for new orders 

         * 

         *
         *
         * @see SoftLayer_Network_Gateway_VersionUpgrade::getVsrxOrdersAllowedOS
         */
        @ApiMethod
        public List getVsrxOrdersAllowedOS(Long accountId);

        /**
         * @see SoftLayer_Network_Gateway_VersionUpgrade::validateVersionChange
         */
        @ApiMethod(instanceRequired = true)
        public Boolean validateVersionChange(Long gatewayId, Long versionUpgradeId);

    }

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

        public Future getAllByUpgradePkgUrlId(Long upgradePkgUrlId, ResponseHandler> callback);

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

        public Future getAllUpgradesByGatewayId(Long gatewayId, ResponseHandler> callback);

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

        public Future getObject(ResponseHandler callback);

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

        public Future getVsrxOrdersAllowedOS(Long accountId, ResponseHandler> callback);

        /**
         * Async version of {@link Service#validateVersionChange}
         */
        public Future validateVersionChange(Long gatewayId, Long versionUpgradeId);

        public Future validateVersionChange(Long gatewayId, Long versionUpgradeId, ResponseHandler callback);

    }

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

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

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

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

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

    }

}