com.softlayer.api.service.network.interconnect.Tenant 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.interconnect;

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.network.Interconnect;
import java.util.GregorianCalendar;
import java.util.List;
import java.util.concurrent.Future;

/**
 * A network interconnect tenant defines an IP routing path through a network interconnect. Each network interconnect requires a single primary tenant, indicated by the primaryFlag 
 *
 * @see SoftLayer_Network_Interconnect_Tenant
 */
@ApiType("SoftLayer_Network_Interconnect_Tenant")
public class Tenant extends Entity {

    /**
     * The billing item for a network interconnect.
     */
    @ApiProperty
    protected Interconnect billingItem;

    public Interconnect getBillingItem() {
        return billingItem;
    }

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

    @ApiProperty
    protected String datacenterName;

    public String getDatacenterName() {
        return datacenterName;
    }

    public void setDatacenterName(String datacenterName) {
        this.datacenterName = datacenterName;
    }

    @ApiProperty
    protected String vendorName;

    public String getVendorName() {
        return vendorName;
    }

    public void setVendorName(String vendorName) {
        this.vendorName = vendorName;
    }

    @ApiProperty
    protected String zoneName;

    public String getZoneName() {
        return zoneName;
    }

    public void setZoneName(String zoneName) {
        this.zoneName = zoneName;
    }

    /**
     * Specifies ASN used for BGP.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long bgpAsn;

    public Long getBgpAsn() {
        return bgpAsn;
    }

    public void setBgpAsn(Long bgpAsn) {
        bgpAsnSpecified = true;
        this.bgpAsn = bgpAsn;
    }

    protected boolean bgpAsnSpecified;

    public boolean isBgpAsnSpecified() {
        return bgpAsnSpecified;
    }

    public void unsetBgpAsn() {
        bgpAsn = null;
        bgpAsnSpecified = false;
    }

    @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;
    }

    @ApiProperty(canBeNullOrNotSet = true)
    protected String errorMessage;

    public String getErrorMessage() {
        return errorMessage;
    }

    public void setErrorMessage(String errorMessage) {
        errorMessageSpecified = true;
        this.errorMessage = errorMessage;
    }

    protected boolean errorMessageSpecified;

    public boolean isErrorMessageSpecified() {
        return errorMessageSpecified;
    }

    public void unsetErrorMessage() {
        errorMessage = null;
        errorMessageSpecified = false;
    }

    /**
     * The Direct Link connectivity to all SoftLayer data centers if globalRoutingFlag = 1 and local connectivity if globalRoutingFlag = 0. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Boolean globalRoutingFlag;

    public Boolean getGlobalRoutingFlag() {
        return globalRoutingFlag;
    }

    public void setGlobalRoutingFlag(Boolean globalRoutingFlag) {
        globalRoutingFlagSpecified = true;
        this.globalRoutingFlag = globalRoutingFlag;
    }

    protected boolean globalRoutingFlagSpecified;

    public boolean isGlobalRoutingFlagSpecified() {
        return globalRoutingFlagSpecified;
    }

    public void unsetGlobalRoutingFlag() {
        globalRoutingFlag = null;
        globalRoutingFlagSpecified = false;
    }

    @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;
    }

    /**
     * Link speed of a Direct Link connection.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long linkSpeed;

    public Long getLinkSpeed() {
        return linkSpeed;
    }

    public void setLinkSpeed(Long linkSpeed) {
        linkSpeedSpecified = true;
        this.linkSpeed = linkSpeed;
    }

    protected boolean linkSpeedSpecified;

    public boolean isLinkSpeedSpecified() {
        return linkSpeedSpecified;
    }

    public void unsetLinkSpeed() {
        linkSpeed = null;
        linkSpeedSpecified = false;
    }

    /**
     * IP address (v4 or v6) of "near" router serial interface. No check/update of IP Address table. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String localIpAddress;

    public String getLocalIpAddress() {
        return localIpAddress;
    }

    public void setLocalIpAddress(String localIpAddress) {
        localIpAddressSpecified = true;
        this.localIpAddress = localIpAddress;
    }

    protected boolean localIpAddressSpecified;

    public boolean isLocalIpAddressSpecified() {
        return localIpAddressSpecified;
    }

    public void unsetLocalIpAddress() {
        localIpAddress = null;
        localIpAddressSpecified = false;
    }

    @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;
    }

    /**
     * Specifies the Interconnect connection 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;
    }

    /**
     * This field will have the ticket id if the tenant workflow fails 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String note;

    public String getNote() {
        return note;
    }

    public void setNote(String note) {
        noteSpecified = true;
        this.note = note;
    }

    protected boolean noteSpecified;

    public boolean isNoteSpecified() {
        return noteSpecified;
    }

    public void unsetNote() {
        note = null;
        noteSpecified = false;
    }

    /**
     * Link speed of a Direct Link connection on Equinix Side.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long peerLinkSpeed;

    public Long getPeerLinkSpeed() {
        return peerLinkSpeed;
    }

    public void setPeerLinkSpeed(Long peerLinkSpeed) {
        peerLinkSpeedSpecified = true;
        this.peerLinkSpeed = peerLinkSpeed;
    }

    protected boolean peerLinkSpeedSpecified;

    public boolean isPeerLinkSpeedSpecified() {
        return peerLinkSpeedSpecified;
    }

    public void unsetPeerLinkSpeed() {
        peerLinkSpeed = null;
        peerLinkSpeedSpecified = false;
    }

    /**
     * Specifies redundant connection is available if 1.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Boolean redundancyFlag;

    public Boolean getRedundancyFlag() {
        return redundancyFlag;
    }

    public void setRedundancyFlag(Boolean redundancyFlag) {
        redundancyFlagSpecified = true;
        this.redundancyFlag = redundancyFlag;
    }

    protected boolean redundancyFlagSpecified;

    public boolean isRedundancyFlagSpecified() {
        return redundancyFlagSpecified;
    }

    public void unsetRedundancyFlag() {
        redundancyFlag = null;
        redundancyFlagSpecified = false;
    }

    @ApiProperty(canBeNullOrNotSet = true)
    protected String remoteIpAddress;

    public String getRemoteIpAddress() {
        return remoteIpAddress;
    }

    public void setRemoteIpAddress(String remoteIpAddress) {
        remoteIpAddressSpecified = true;
        this.remoteIpAddress = remoteIpAddress;
    }

    protected boolean remoteIpAddressSpecified;

    public boolean isRemoteIpAddressSpecified() {
        return remoteIpAddressSpecified;
    }

    public void unsetRemoteIpAddress() {
        remoteIpAddress = null;
        remoteIpAddressSpecified = false;
    }

    /**
     * Service key for Interconnect connection.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String serviceKey;

    public String getServiceKey() {
        return serviceKey;
    }

    public void setServiceKey(String serviceKey) {
        serviceKeySpecified = true;
        this.serviceKey = serviceKey;
    }

    protected boolean serviceKeySpecified;

    public boolean isServiceKeySpecified() {
        return serviceKeySpecified;
    }

    public void unsetServiceKey() {
        serviceKey = null;
        serviceKeySpecified = false;
    }

    /**
     * The direct link connection status. IN_PROGRESS, PROVISIONING, CONNECTION_UP, CONNECTION_DOWN 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String status;

    public String getStatus() {
        return status;
    }

    public void setStatus(String status) {
        statusSpecified = true;
        this.status = status;
    }

    protected boolean statusSpecified;

    public boolean isStatusSpecified() {
        return statusSpecified;
    }

    public void unsetStatus() {
        status = null;
        statusSpecified = false;
    }

    @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;
    }

    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 network interconnect tenant defines an IP routing path through a network interconnect. Each network interconnect requires a single primary tenant, indicated by the primaryFlag 
     *
     * @see SoftLayer_Network_Interconnect_Tenant
     */
    @com.softlayer.api.annotation.ApiService("SoftLayer_Network_Interconnect_Tenant")
    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_Interconnect_Tenant::getAllObjects
         */
        @ApiMethod
        public List getAllObjects();

        /**
         * @see SoftLayer_Network_Interconnect_Tenant::getDirectLinkSpeeds
         */
        @ApiMethod
        public String getDirectLinkSpeeds(String offeringType);

        /**
         * @see SoftLayer_Network_Interconnect_Tenant::getNetworkZones
         */
        @ApiMethod
        public List getNetworkZones();

        /**
         * @see SoftLayer_Network_Interconnect_Tenant::getObject
         */
        @ApiMethod(instanceRequired = true)
        public Tenant getObject();

        /**
         * @see SoftLayer_Network_Interconnect_Tenant::isAdnAccount
         */
        @ApiMethod
        public Boolean isAdnAccount();

        /**
         * The billing item for a network interconnect.
         *
         * @see SoftLayer_Network_Interconnect_Tenant::getBillingItem
         */
        @ApiMethod(instanceRequired = true)
        public Interconnect getBillingItem();

        /**
         * @see SoftLayer_Network_Interconnect_Tenant::getDatacenterName
         */
        @ApiMethod(instanceRequired = true)
        public String getDatacenterName();

        /**
         * @see SoftLayer_Network_Interconnect_Tenant::getVendorName
         */
        @ApiMethod(instanceRequired = true)
        public String getVendorName();

        /**
         * @see SoftLayer_Network_Interconnect_Tenant::getZoneName
         */
        @ApiMethod(instanceRequired = true)
        public String getZoneName();

    }

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

        public Future getAllObjects(ResponseHandler> callback);

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

        public Future getDirectLinkSpeeds(String offeringType, ResponseHandler callback);

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

        public Future getNetworkZones(ResponseHandler> callback);

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

        public Future getObject(ResponseHandler callback);

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

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

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

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

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

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

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

    }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    }

}