Package com.softlayer.api.service.network.storage

Interface Group.Service

All Superinterfaces:

Maskable, ResultLimitable, Service

All Known Subinterfaces:

Iscsi.Service, Nfs.Service

Enclosing class:

Group

@ApiService("SoftLayer_Network_Storage_Group")
public static interface Group.Service
extends Service

See Also:

SoftLayer_Network_Storage_Group

Method Summary

Modifier and Type	Method	Description
Boolean	addAllowedHost(Host allowedHost)	Use this method to attach a SoftLayer_Network_Storage_Allowed_Host object to this group.
Group.ServiceAsync	asAsync()	Get an async version of this service
Boolean	attachToVolume(Storage volume)	Use this method to attach a SoftLayer_Network_Storage volume to this group.
Boolean	createObject(Group templateObject)
Boolean	deleteObject()
Boolean	editObject(Group templateObject)
Account	getAccount()	The SoftLayer_Account which owns this group.
List<Group>	getAllObjects()	Use this method to retrieve all network storage groups.
List<Host>	getAllowedHosts()	The allowed hosts list for this group.
List<Storage>	getAttachedVolumes()	The network storage volumes this group is attached to.
Type	getGroupType()	The type which defines this group.
NetworkConnectionInformation	getNetworkConnectionDetails()	Use this method to retrieve network connection information for SoftLayer_Network_Storage_Allowed_Host objects within this group.
Group	getObject()
Type	getOsType()	The OS Type this group is configured for.
Resource	getServiceResource()	The network resource this group is created on.
Boolean	removeAllowedHost(Host allowedHost)	Use this method to remove a SoftLayer_Network_Storage_Allowed_Host object from this group.
Boolean	removeFromVolume(Storage volume)	Use this method to remove a SoftLayer_Network_Storage volume from this group.
void	setMask(Group.Mask mask)
Group.Mask	withMask()	Use the existing mask on this service or create it if not present
Group.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

Group.ServiceAsync asAsync()

Description copied from interface: Service

Get an async version of this service

Specified by:

asAsync in interface Service

withNewMask

Group.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

Group.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(Group.Mask mask)

addAllowedHost

@ApiMethod(instanceRequired=true)
Boolean addAllowedHost(Host allowedHost)

Use this method to attach a SoftLayer_Network_Storage_Allowed_Host object to this group. This will automatically enable access from this host to any SoftLayer_Network_Storage volumes currently attached to this group.

See Also:

SoftLayer_Network_Storage_Group::addAllowedHost

attachToVolume

@ApiMethod(instanceRequired=true)
Boolean attachToVolume(Storage volume)

Use this method to attach a SoftLayer_Network_Storage volume to this group. This will automatically enable access to this volume for any SoftLayer_Network_Storage_Allowed_Host objects currently attached to this group.

See Also:

SoftLayer_Network_Storage_Group::attachToVolume

createObject

@ApiMethod
Boolean createObject(Group templateObject)

See Also:

SoftLayer_Network_Storage_Group::createObject

deleteObject

@ApiMethod(instanceRequired=true)
Boolean deleteObject()

See Also:

SoftLayer_Network_Storage_Group::deleteObject

editObject

@ApiMethod(instanceRequired=true)
Boolean editObject(Group templateObject)

See Also:

SoftLayer_Network_Storage_Group::editObject

getAllObjects

@ApiMethod
List<Group> getAllObjects()

Use this method to retrieve all network storage groups.

See Also:

SoftLayer_Network_Storage_Group::getAllObjects

getNetworkConnectionDetails

@ApiMethod(instanceRequired=true)
NetworkConnectionInformation getNetworkConnectionDetails()

Use this method to retrieve network connection information for SoftLayer_Network_Storage_Allowed_Host objects within this group.

See Also:

SoftLayer_Network_Storage_Group::getNetworkConnectionDetails

getObject

@ApiMethod(instanceRequired=true)
Group getObject()

See Also:

SoftLayer_Network_Storage_Group::getObject

removeAllowedHost

@ApiMethod(instanceRequired=true)
Boolean removeAllowedHost(Host allowedHost)

Use this method to remove a SoftLayer_Network_Storage_Allowed_Host object from this group. This will automatically disable access from this host to any SoftLayer_Network_Storage volumes currently attached to this group.

See Also:

SoftLayer_Network_Storage_Group::removeAllowedHost

removeFromVolume

@ApiMethod(instanceRequired=true)
Boolean removeFromVolume(Storage volume)

Use this method to remove a SoftLayer_Network_Storage volume from this group. This will automatically disable access to this volume for any SoftLayer_Network_Storage_Allowed_Host objects currently attached to this group.

See Also:

SoftLayer_Network_Storage_Group::removeFromVolume

getAccount

@ApiMethod(instanceRequired=true)
Account getAccount()

The SoftLayer_Account which owns this group.

See Also:

SoftLayer_Network_Storage_Group::getAccount

getAllowedHosts

@ApiMethod(instanceRequired=true)
List<Host> getAllowedHosts()

The allowed hosts list for this group.

See Also:

SoftLayer_Network_Storage_Group::getAllowedHosts

getAttachedVolumes

@ApiMethod(instanceRequired=true)
List<Storage> getAttachedVolumes()

The network storage volumes this group is attached to.

See Also:

SoftLayer_Network_Storage_Group::getAttachedVolumes

getGroupType

@ApiMethod(instanceRequired=true)
Type getGroupType()

The type which defines this group.

See Also:

SoftLayer_Network_Storage_Group::getGroupType

getOsType

@ApiMethod(instanceRequired=true)
Type getOsType()

The OS Type this group is configured for.

See Also:

SoftLayer_Network_Storage_Group::getOsType

getServiceResource

@ApiMethod(instanceRequired=true)
Resource getServiceResource()

The network resource this group is created on.

See Also:

SoftLayer_Network_Storage_Group::getServiceResource