Package com.softlayer.api.service

Interface Network.Service

All Superinterfaces:

Maskable, ResultLimitable, Service

Enclosing class:

Network

@ApiService("SoftLayer_Network")
public static interface Network.Service
extends Service

Provides services oriented to network-centric discovery and manipulation.

See Also:

SoftLayer_Network

Method Summary

Modifier and Type	Method	Description
Network.ServiceAsync	asAsync()	Get an async version of this service
Boolean	connectPrivateEndpointService()	Initiate the automated process to establish connectivity granting the account private back-end network access to the services available through IBM Cloud Service Endpoint.
Boolean	disconnectPrivateEndpointService()	Initiate the automated process to revoke mutual connectivity from the account network and IBM Cloud Service Endpoint network.
Network	getObject()
Boolean	isConnectedToPrivateEndpointService()	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.
void	setMask(Network.Mask mask)
Network.Mask	withMask()	Use the existing mask on this service or create it if not present
Network.Mask	withNewMask()	Overwrite the existing mask on this service with a new one and return it

Methods inherited from interface com.softlayer.api.Maskable

clearMask, setMask, setMask

Methods inherited from interface com.softlayer.api.ResultLimitable

getLastResponseTotalItemCount, getResultLimit, setResultLimit

Method Detail

asAsync

Network.ServiceAsync asAsync()

Description copied from interface: Service

Get an async version of this service

Specified by:

asAsync in interface Service

withNewMask

Network.Mask withNewMask()

Description copied from interface: Maskable

Overwrite the existing mask on this service with a new one and return it

Specified by:

withNewMask in interface Maskable

withMask

Network.Mask withMask()

Description copied from interface: Maskable

Use the existing mask on this service or create it if not present

Specified by:

withMask in interface Maskable

setMask

void setMask(Network.Mask mask)

connectPrivateEndpointService

@ApiMethod
Boolean connectPrivateEndpointService()

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 Also:

SoftLayer_Network::connectPrivateEndpointService

disconnectPrivateEndpointService

@ApiMethod
Boolean disconnectPrivateEndpointService()

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 Also:

SoftLayer_Network::disconnectPrivateEndpointService

getObject

@ApiMethod(instanceRequired=true)
Network getObject()

See Also:

SoftLayer_Network::getObject

isConnectedToPrivateEndpointService

@ApiMethod
Boolean isConnectedToPrivateEndpointService()

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 Also:

SoftLayer_Network::isConnectedToPrivateEndpointService