com.softlayer.api.service.Network 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;

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 java.util.concurrent.Future;

/**
 * Provides services oriented to network-centric discovery and manipulation. 
 *
 * @see SoftLayer_Network
 */
@ApiType("SoftLayer_Network")
public class Network extends Entity {

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

    /**
     * Provides services oriented to network-centric discovery and manipulation. 
     *
     * @see SoftLayer_Network
     */
    @com.softlayer.api.annotation.ApiService("SoftLayer_Network")
    public static interface Service extends com.softlayer.api.Service {

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

        /**
         * Initiate the automated process to establish connectivity granting the account private back-end network access to the services available through IBM Cloud Service Endpoint. Once initiated, the configuration process occurs asynchronously in the background. 

         * 

         * 

         * 

         * Responses
 

         * 

         * True The request to connect was successfully initiated. 

         * 

         * False The account and Service Endpoint networks are already connected. 

         * 

         * 

         * 

         * Exceptions
 

         * 

         * SoftLayer_Exception_NotReady Thrown when the current network configuration will not support connection alteration. 

         * 

         * 

         * 

         *
         *
         * @see SoftLayer_Network::connectPrivateEndpointService
         */
        @ApiMethod
        public Boolean connectPrivateEndpointService();

        /**
         * Initiate the automated process to revoke mutual connectivity from the account network and IBM Cloud Service Endpoint network. Once initiated, the configuration process occurs asynchronously in the background. 

         * 

         * 

         * 

         * Responses
 

         * 

         * True The request to disconnect was successfully initiated. 

         * 

         * False The account and Service Endpoint networks are already disconnected. 

         * 

         * 

         * 

         * Exceptions
 

         * 

         * SoftLayer_Exception_NotReady Thrown when the current network configuration will not support connection alteration. 

         * 

         * 

         * 

         *
         *
         * @see SoftLayer_Network::disconnectPrivateEndpointService
         */
        @ApiMethod
        public Boolean disconnectPrivateEndpointService();

        /**
         * @see SoftLayer_Network::getObject
         */
        @ApiMethod(instanceRequired = true)
        public Network getObject();

        /**
         * Accessing select IBM Cloud services attached to the private back-end network is made possible by establishing a network relationship between an account's private network and the Service Endpoint network. 

         * 

         * 

         * 

         * Responses
 

         * 

         * True The account and Service Endpoint networks are currently connected. 

         * 

         * False The account and Service Endpoint networks are not connected; both networks are properly configured to connect. 

         * 

         * 

         * 

         * Exceptions
 

         * 

         * SoftLayer_Exception_NotReady Thrown when the current network configuration will not support connection alteration. 

         * 

         * 

         * 

         *
         *
         * @see SoftLayer_Network::isConnectedToPrivateEndpointService
         */
        @ApiMethod
        public Boolean isConnectedToPrivateEndpointService();

    }

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

        public Future connectPrivateEndpointService(ResponseHandler callback);

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

        public Future disconnectPrivateEndpointService(ResponseHandler callback);

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

        public Future getObject(ResponseHandler callback);

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

        public Future isConnectedToPrivateEndpointService(ResponseHandler callback);

    }

    public static class Mask extends Entity.Mask {

    }

}