com.softlayer.api.service.auxiliary.network.Status 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.auxiliary.network;

import com.softlayer.api.ApiClient;
import com.softlayer.api.ResponseHandler;
import com.softlayer.api.annotation.ApiMethod;
import com.softlayer.api.annotation.ApiType;
import com.softlayer.api.service.Entity;
import com.softlayer.api.service.container.auxiliary.network.status.Reading;
import java.util.List;
import java.util.concurrent.Future;

/**
 * This service provides a way for a SoftLayer customer to obtain current latency information from around the world to our datacenters, and segments of our network both public and private. There are a few valid targets. Currently the valid targets are as follows: 

 * * ALL

 * * NETWORK_DALLAS

 * * NETWORK_HOUSTON

 * * NETWORK_SANJOSE

 * * NETWORK_SEATTLE

 * * NETWORK_WDC

 * * NETWORK_PUBLIC

 * * NETWORK_PUBLIC_DALLAS

 * * NETWORK_PUBLIC_HOUSTON

 * * NETWORK_PUBLIC_SANJOSE

 * * NETWORK_PUBLIC_SEATTLE

 * * NETWORK_PUBLIC_WDC

 * * NETWORK_PRIVATE

 * * NETWORK_PRIVATE_DALLAS

 * * NETWORK_PRIVATE_HOUSTON

 * * NETWORK_PRIVATE_SANJOSE

 * * NETWORK_PRIVATE_SEATTLE

 * * NETWORK_PRIVATE_WDC

 * Information 
 *
 * @see SoftLayer_Auxiliary_Network_Status
 */
@ApiType("SoftLayer_Auxiliary_Network_Status")
public class Status extends Entity {

    public static Service service(ApiClient client) {
        return client.createService(Service.class, null);
    }

    /**
     * This service provides a way for a SoftLayer customer to obtain current latency information from around the world to our datacenters, and segments of our network both public and private. There are a few valid targets. Currently the valid targets are as follows: 

     * * ALL

     * * NETWORK_DALLAS

     * * NETWORK_HOUSTON

     * * NETWORK_SANJOSE

     * * NETWORK_SEATTLE

     * * NETWORK_WDC

     * * NETWORK_PUBLIC

     * * NETWORK_PUBLIC_DALLAS

     * * NETWORK_PUBLIC_HOUSTON

     * * NETWORK_PUBLIC_SANJOSE

     * * NETWORK_PUBLIC_SEATTLE

     * * NETWORK_PUBLIC_WDC

     * * NETWORK_PRIVATE

     * * NETWORK_PRIVATE_DALLAS

     * * NETWORK_PRIVATE_HOUSTON

     * * NETWORK_PRIVATE_SANJOSE

     * * NETWORK_PRIVATE_SEATTLE

     * * NETWORK_PRIVATE_WDC

     * Information 
     *
     * @see SoftLayer_Auxiliary_Network_Status
     */
    @com.softlayer.api.annotation.ApiService("SoftLayer_Auxiliary_Network_Status")
    public static interface Service extends com.softlayer.api.Service {

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

        /**
         * Return the current network status of and latency information for a given target from numerous points around the world. Valid Targets: 

         * * ALL

         * * NETWORK_DALLAS

         * * NETWORK_SEATTLE

         * * NETWORK_PUBLIC

         * * NETWORK_PUBLIC_DALLAS

         * * NETWORK_PUBLIC_SEATTLE

         * * NETWORK_PUBLIC_WDC

         * * NETWORK_PRIVATE

         * * NETWORK_PRIVATE_DALLAS

         * * NETWORK_PRIVATE_SEATTLE

         * * NETWORK_PRIVATE_WDC
         *
         * @see SoftLayer_Auxiliary_Network_Status::getNetworkStatus
         */
        @ApiMethod
        public List getNetworkStatus(String target);

    }

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

        public Future getNetworkStatus(String target, ResponseHandler> callback);

    }

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

    }

}