com.softlayer.api.service.network.subnet.ipaddress.Global 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.network.subnet.ipaddress;

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.subnet.IpAddress;
import com.softlayer.api.service.provisioning.version1.Transaction;
import java.util.concurrent.Future;

/**
 * Global IP Addresses are static IP addresses that can be routed to any server within the SoftLayer network. Global IP Addresses are not restricted to routing within the same datacenter. 
 *
 * @see SoftLayer_Network_Subnet_IpAddress_Global
 */
@ApiType("SoftLayer_Network_Subnet_IpAddress_Global")
public class Global extends Entity {

    @ApiProperty
    protected Account account;

    public Account getAccount() {
        return account;
    }

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

    /**
     * DEPRECATED
     */
    @ApiProperty
    protected Transaction activeTransaction;

    public Transaction getActiveTransaction() {
        return activeTransaction;
    }

    public void setActiveTransaction(Transaction activeTransaction) {
        this.activeTransaction = activeTransaction;
    }

    /**
     * The billing item for this Global IP.
     */
    @ApiProperty
    protected com.softlayer.api.service.billing.item.network.subnet.ipaddress.Global billingItem;

    public com.softlayer.api.service.billing.item.network.subnet.ipaddress.Global getBillingItem() {
        return billingItem;
    }

    public void setBillingItem(com.softlayer.api.service.billing.item.network.subnet.ipaddress.Global billingItem) {
        this.billingItem = billingItem;
    }

    @ApiProperty
    protected IpAddress destinationIpAddress;

    public IpAddress getDestinationIpAddress() {
        return destinationIpAddress;
    }

    public void setDestinationIpAddress(IpAddress destinationIpAddress) {
        this.destinationIpAddress = destinationIpAddress;
    }

    @ApiProperty
    protected IpAddress ipAddress;

    public IpAddress getIpAddress() {
        return ipAddress;
    }

    public void setIpAddress(IpAddress ipAddress) {
        this.ipAddress = ipAddress;
    }

    /**
     * A Global IP Address' associated description 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long description;

    public Long getDescription() {
        return description;
    }

    public void setDescription(Long description) {
        descriptionSpecified = true;
        this.description = description;
    }

    protected boolean descriptionSpecified;

    public boolean isDescriptionSpecified() {
        return descriptionSpecified;
    }

    public void unsetDescription() {
        description = null;
        descriptionSpecified = false;
    }

    /**
     * A Global IP Address' associated [[SoftLayer_Network_Subnet_IpAddress|ipAddress]] ID 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long destinationIpAddressId;

    public Long getDestinationIpAddressId() {
        return destinationIpAddressId;
    }

    public void setDestinationIpAddressId(Long destinationIpAddressId) {
        destinationIpAddressIdSpecified = true;
        this.destinationIpAddressId = destinationIpAddressId;
    }

    protected boolean destinationIpAddressIdSpecified;

    public boolean isDestinationIpAddressIdSpecified() {
        return destinationIpAddressIdSpecified;
    }

    public void unsetDestinationIpAddressId() {
        destinationIpAddressId = null;
        destinationIpAddressIdSpecified = false;
    }

    /**
     * A Global IP Address' unique 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;
    }

    /**
     * A Global IP Address' associated [[SoftLayer_Account|account]] ID 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long ipAddressId;

    public Long getIpAddressId() {
        return ipAddressId;
    }

    public void setIpAddressId(Long ipAddressId) {
        ipAddressIdSpecified = true;
        this.ipAddressId = ipAddressId;
    }

    protected boolean ipAddressIdSpecified;

    public boolean isIpAddressIdSpecified() {
        return ipAddressIdSpecified;
    }

    public void unsetIpAddressId() {
        ipAddressId = null;
        ipAddressIdSpecified = false;
    }

    /**
     * A Global IP Address' associated type [[SoftLayer_Network_Subnet_IpAddress_Global_Type|id]] ID 
     */
    @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;
    }

    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());
    }

    /**
     * Global IP Addresses are static IP addresses that can be routed to any server within the SoftLayer network. Global IP Addresses are not restricted to routing within the same datacenter. 
     *
     * @see SoftLayer_Network_Subnet_IpAddress_Global
     */
    @com.softlayer.api.annotation.ApiService("SoftLayer_Network_Subnet_IpAddress_Global")
    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_Subnet_IpAddress_Global::getObject
         */
        @ApiMethod(instanceRequired = true)
        public Global getObject();

        /**
         * 

         * ***DEPRECATED***

         * This endpoint is deprecated in favor of the more expressive and capable SoftLayer_Network_Subnet::route, to which this endpoint now proxies. Refer to it for more information. 

         * 

         * Similarly, unroute requests are proxied to SoftLayer_Network_Subnet::clearRoute. 
         *
         * @see SoftLayer_Network_Subnet_IpAddress_Global::route
         */
        @ApiMethod(instanceRequired = true)
        public Boolean route(String newEndPointIpAddress);

        /**
         * 

         * ***DEPRECATED***

         * This endpoint is deprecated in favor of SoftLayer_Network_Subnet::clearRoute, to which this endpoint now proxies. Refer to it for more information. 
         *
         * @see SoftLayer_Network_Subnet_IpAddress_Global::unroute
         */
        @ApiMethod(instanceRequired = true)
        public Boolean unroute();

        /**
         * @see SoftLayer_Network_Subnet_IpAddress_Global::getAccount
         */
        @ApiMethod(instanceRequired = true)
        public Account getAccount();

        /**
         * DEPRECATED
         *
         * @see SoftLayer_Network_Subnet_IpAddress_Global::getActiveTransaction
         */
        @ApiMethod(instanceRequired = true)
        public Transaction getActiveTransaction();

        /**
         * The billing item for this Global IP.
         *
         * @see SoftLayer_Network_Subnet_IpAddress_Global::getBillingItem
         */
        @ApiMethod(instanceRequired = true)
        public com.softlayer.api.service.billing.item.network.subnet.ipaddress.Global getBillingItem();

        /**
         * @see SoftLayer_Network_Subnet_IpAddress_Global::getDestinationIpAddress
         */
        @ApiMethod(instanceRequired = true)
        public IpAddress getDestinationIpAddress();

        /**
         * @see SoftLayer_Network_Subnet_IpAddress_Global::getIpAddress
         */
        @ApiMethod(instanceRequired = true)
        public IpAddress getIpAddress();

    }

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

        public Future route(String newEndPointIpAddress, ResponseHandler callback);

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

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

        /**
         * Async callback version of {@link Service#getActiveTransaction}
         */
        public Future getActiveTransaction(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#getDestinationIpAddress}
         */
        public Future getDestinationIpAddress();

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

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

        /**
         * Async callback version of {@link Service#getIpAddress}
         */
        public Future getIpAddress(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.provisioning.version1.Transaction.Mask activeTransaction() {
            return withSubMask("activeTransaction", com.softlayer.api.service.provisioning.version1.Transaction.Mask.class);
        }

        public com.softlayer.api.service.billing.item.network.subnet.ipaddress.Global.Mask billingItem() {
            return withSubMask("billingItem", com.softlayer.api.service.billing.item.network.subnet.ipaddress.Global.Mask.class);
        }

        public com.softlayer.api.service.network.subnet.IpAddress.Mask destinationIpAddress() {
            return withSubMask("destinationIpAddress", com.softlayer.api.service.network.subnet.IpAddress.Mask.class);
        }

        public com.softlayer.api.service.network.subnet.IpAddress.Mask ipAddress() {
            return withSubMask("ipAddress", com.softlayer.api.service.network.subnet.IpAddress.Mask.class);
        }

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

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

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

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

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

    }

}