Package com.softlayer.api.service.virtual.guest.block.device.template

Interface Group.Service

All Superinterfaces:

Maskable, ResultLimitable, Service

Enclosing class:

Group

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

The virtual guest block device template group service provides a common interface to an accounts archived image templates The interaction with various third party APIs is not needed when implementing this service to administer your guests.

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group

Method Summary

Modifier and Type	Method	Description
Boolean	addByolAttribute()	This method allows you to mark this image template as customer managed software license (BYOL)
Boolean	addCloudInitAttribute()	This method allows you to mark this image template as cloud init
Boolean	addLocations(List<Location> locations)	This method will create transaction(s) to add available locations to an archive image template.
Boolean	addSupportedBootMode(String bootMode)	This method allows you to mark this image's supported boot modes as 'HVM' or 'PV'.
Group.ServiceAsync	asAsync()	Get an async version of this service
Boolean	copyToExternalSource(Configuration configuration)	Create a transaction to export/copy a template to an external source.
Boolean	copyToIcos(Configuration configuration)	Create a transaction to export/copy a template to an ICOS.
Group	createFromExternalSource(Configuration configuration)	Create a transaction to import a disk image from an external source and create a standard image template.
Group	createFromIcos(Configuration configuration)	Create a process to import a disk image from ICOS and create a standard
Long	createPublicArchiveTransaction(String groupName, String summary, String note, List<Location> locations)	Create a transaction to copy archived block devices into public repository
Boolean	deleteByolAttribute()	This method allows you to remove BYOL attribute for a given image template.
Boolean	deleteCloudInitAttribute()	This method allows you to remove cloud init attribute for a given image template.
Transaction	deleteObject()	Deleting a block device template group is different from the deletion of other objects.
Boolean	denySharingAccess(Long accountId)	This method will deny another SoftLayer customer account's previously given access to provision CloudLayer Computing Instances from an image template group.
Boolean	editObject(Group templateObject)	Edit an image template group's associated name and note.
List<Group>	findGcImagesByCurrentUser(List<String> dataCenters, List<String> regions)	Find block device template groups containing a GC enabled cloudinit image for the current active user.
Account	getAccount()	A block device template group's [[SoftLayer_Account|account]].
List<Contact>	getAccountContacts()
List<Accounts>	getAccountReferences()	The accounts which may have read-only access to an image template group.
List<String>	getAllAvailableCompatiblePlatformNames()	Get all available compatible platform names that can be added to a template group.
List<Template>	getBlockDevices()	The block devices that are part of an image template group
BigDecimal	getBlockDevicesDiskSpaceTotal()	The total disk space of all images in a image template group.
String	getBootMode()	This method returns the boot mode, if any, set on a given image template.
Boolean	getByolFlag()	A flag indicating that customer is providing the software licenses.
List<Group>	getChildren()	The image template groups that are clones of an image template group.
List<String>	getCurrentCompatiblePlatformNames()	Get compatible platform names currently set on the template group.
Location	getDatacenter()	The location containing this image template group.
List<Location>	getDatacenters()	A collection of locations containing a copy of this image template group.
String	getDefaultBootMode()	This method returns the default boot mode set by the software description
List<String>	getEncryptionAttributes()	This method returns an array of encryption values, or empty array if none are found
Group	getFirstChild()	The first clone of the image template group
Boolean	getFlexImageFlag()	A flag indicating if this is a flex image.
String	getGlobalIdentifier()	An image template's universally unique identifier.
Type	getImageType()	The virtual disk image type of this template.
String	getImageTypeKeyName()	The virtual disk image type keyname (e.g.
Boolean	getNextGenFlag()	A flag indicating if this is a next generation image.
Group	getObject()
Group	getParent()	The image template group that another image template group was cloned from.
List<Group>	getPublicCustomerOwnedImages()	This method gets all public customer owned image templates that the user is allowed to see.
List<Group>	getPublicImages()	This method gets all public image templates that the user is allowed to see.
Resource	getRegion()
List<Resource>	getRegions()
RiasAccount	getRiasAccount(String secret)
List<Key>	getSshKeys()	The ssh keys to be implemented on the server when provisioned or reloaded from an image template group.
Status	getStatus()	A template group's status.
List<Location>	getStorageLocations()	Returns the image storage locations.
Repository	getStorageRepository()	The storage repository that an image template group resides on.
List<String>	getSupportedBootModes()	This method indicates which boot modes are supported by the image.
List<Reference>	getTagReferences()	The tags associated with this image template group.
String	getTemplateDataCenterName()	This method allows you to grab the first data center that the image(s) reside on so we can pull it from there.
Transaction	getTransaction()	A transaction that is being performed on a image template group.
List<Description>	getVhdImportSoftwareDescriptions()	Returns an array of SoftLayer_Software_Description that are supported for VHD imports.
Boolean	isByol()	This method indicates whether or not this image is a customer supplied license image.
Boolean	isByolCapableOperatingSystem()	This method indicates whether or not this image uses an operating system capable of using a customer supplied license image.
Boolean	isByolOnlyOperatingSystem()	This method indicates whether or not this image uses an operating system that requires using a customer supplied license image
Boolean	isCloudInit()	This method indicates whether or not this image is a cloud-init image.
Boolean	isCloudInitOnlyOperatingSystem()	This method indicates whether or not this image uses an operating system that requires cloud init
Boolean	isEncrypted()	This method indicates whether this image template contains an encrypted disk image.
Boolean	permitSharingAccess(Long accountId)	This method will permit another SoftLayer customer account access to provision CloudLayer Computing Instances from an image template group.
Boolean	removeCompatiblePlatforms(List<String> platformNames)	Removes compatible platforms on the template group.
Boolean	removeLocations(List<Location> locations)	This method will create transaction(s) to remove available locations from an archive image template.
Boolean	removeSupportedBootMode(String bootMode)	This method allows you to remove a supported boot mode attribute for a given image template.
Boolean	setAvailableLocations(List<Location> locations)	Create transaction(s) to set the archived block device available locations
Boolean	setBootMode(String newBootMode)	This method allows you to specify the boot mode for a given image template.
Boolean	setCompatiblePlatforms(List<String> platformNames)	Sets compatible platforms on the template group.
void	setMask(Group.Mask mask)
Boolean	setTags(String tags)	Set the tags for this template group.
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 Details

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)

addByolAttribute

@ApiMethod(instanceRequired=true)
Boolean addByolAttribute()

This method allows you to mark this image template as customer managed software license (BYOL)

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::addByolAttribute

addCloudInitAttribute

@ApiMethod(instanceRequired=true)
Boolean addCloudInitAttribute()

This method allows you to mark this image template as cloud init

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::addCloudInitAttribute

addLocations

@ApiMethod(instanceRequired=true)
Boolean addLocations(List<Location> locations)

This method will create transaction(s) to add available locations to an archive image template.

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::addLocations

addSupportedBootMode

@ApiMethod(instanceRequired=true)
Boolean addSupportedBootMode(String bootMode)

This method allows you to mark this image's supported boot modes as 'HVM' or 'PV'.

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::addSupportedBootMode

copyToExternalSource

@ApiMethod(instanceRequired=true)
Boolean copyToExternalSource(Configuration configuration)

Create a transaction to export/copy a template to an external source.

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::copyToExternalSource

copyToIcos

@ApiMethod(instanceRequired=true)
Boolean copyToIcos(Configuration configuration)

Create a transaction to export/copy a template to an ICOS.

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::copyToIcos

createFromExternalSource

@ApiMethod
Group createFromExternalSource(Configuration configuration)

Create a transaction to import a disk image from an external source and create a standard image template.

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::createFromExternalSource

createFromIcos

@ApiMethod
Group createFromIcos(Configuration configuration)

Create a process to import a disk image from ICOS and create a standard

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::createFromIcos

createPublicArchiveTransaction

@ApiMethod(instanceRequired=true)
Long createPublicArchiveTransaction(String groupName,
String summary,
String note,
List<Location> locations)

Create a transaction to copy archived block devices into public repository

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::createPublicArchiveTransaction

deleteByolAttribute

@ApiMethod(instanceRequired=true)
Boolean deleteByolAttribute()

This method allows you to remove BYOL attribute for a given image template.

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::deleteByolAttribute

deleteCloudInitAttribute

@ApiMethod(instanceRequired=true)
Boolean deleteCloudInitAttribute()

This method allows you to remove cloud init attribute for a given image template.

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::deleteCloudInitAttribute

deleteObject

@ApiMethod(instanceRequired=true)
Transaction deleteObject()

Deleting a block device template group is different from the deletion of other objects. A block device template group can contain several gigabytes of data in its disk images. This may take some time to delete and requires a transaction to be created. This method creates a transaction that will delete all resources associated with the block device template group.

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::deleteObject

denySharingAccess

@ApiMethod(instanceRequired=true)
Boolean denySharingAccess(Long accountId)

This method will deny another SoftLayer customer account's previously given access to provision CloudLayer Computing Instances from an image template group. Template access should only be removed from the parent template group object, not the child.

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::denySharingAccess

editObject

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

Edit an image template group's associated name and note. All other properties in the SoftLayer_Virtual_Guest_Block_Device_Template_Group data type are read-only.

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::editObject

findGcImagesByCurrentUser

@ApiMethod
List<Group> findGcImagesByCurrentUser(List<String> dataCenters,
List<String> regions)

Find block device template groups containing a GC enabled cloudinit image for the current active user. A sorted collection of groups is returned. The Caller can optionally specify data center or region names to retrieve GC images from only those locations.

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::findGcImagesByCurrentUser

getAllAvailableCompatiblePlatformNames

@ApiMethod
List<String> getAllAvailableCompatiblePlatformNames()

Get all available compatible platform names that can be added to a template group.

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::getAllAvailableCompatiblePlatformNames

getBootMode

@ApiMethod(instanceRequired=true)
String getBootMode()

This method returns the boot mode, if any, set on a given image template.

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::getBootMode

getCurrentCompatiblePlatformNames

@ApiMethod(instanceRequired=true)
List<String> getCurrentCompatiblePlatformNames()

Get compatible platform names currently set on the template group.

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::getCurrentCompatiblePlatformNames

getDefaultBootMode

@ApiMethod(instanceRequired=true)
String getDefaultBootMode()

This method returns the default boot mode set by the software description

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::getDefaultBootMode

getEncryptionAttributes

@ApiMethod(instanceRequired=true)
List<String> getEncryptionAttributes()

This method returns an array of encryption values, or empty array if none are found

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::getEncryptionAttributes

getObject

@ApiMethod(instanceRequired=true)
Group getObject()

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::getObject

getPublicCustomerOwnedImages

@ApiMethod
List<Group> getPublicCustomerOwnedImages()

This method gets all public customer owned image templates that the user is allowed to see.

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::getPublicCustomerOwnedImages

getPublicImages

@ApiMethod
List<Group> getPublicImages()

This method gets all public image templates that the user is allowed to see.

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::getPublicImages

getRiasAccount

@ApiMethod
RiasAccount getRiasAccount(String secret)

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::getRiasAccount

getStorageLocations

@ApiMethod(instanceRequired=true)
List<Location> getStorageLocations()

Returns the image storage locations.

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::getStorageLocations

getSupportedBootModes

@ApiMethod(instanceRequired=true)
List<String> getSupportedBootModes()

This method indicates which boot modes are supported by the image.

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::getSupportedBootModes

getTemplateDataCenterName

@ApiMethod(instanceRequired=true)
String getTemplateDataCenterName()

This method allows you to grab the first data center that the image(s) reside on so we can pull it from there.

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::getTemplateDataCenterName

getVhdImportSoftwareDescriptions

@ApiMethod
List<Description> getVhdImportSoftwareDescriptions()

Returns an array of SoftLayer_Software_Description that are supported for VHD imports.

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::getVhdImportSoftwareDescriptions

isByol

@ApiMethod(instanceRequired=true)
Boolean isByol()

This method indicates whether or not this image is a customer supplied license image.

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::isByol

isByolCapableOperatingSystem

@ApiMethod(instanceRequired=true)
Boolean isByolCapableOperatingSystem()

This method indicates whether or not this image uses an operating system capable of using a customer supplied license image.

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::isByolCapableOperatingSystem

isByolOnlyOperatingSystem

@ApiMethod(instanceRequired=true)
Boolean isByolOnlyOperatingSystem()

This method indicates whether or not this image uses an operating system that requires using a customer supplied license image

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::isByolOnlyOperatingSystem

isCloudInit

@ApiMethod(instanceRequired=true)
Boolean isCloudInit()

This method indicates whether or not this image is a cloud-init image.

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::isCloudInit

isCloudInitOnlyOperatingSystem

@ApiMethod(instanceRequired=true)
Boolean isCloudInitOnlyOperatingSystem()

This method indicates whether or not this image uses an operating system that requires cloud init

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::isCloudInitOnlyOperatingSystem

isEncrypted

@ApiMethod(instanceRequired=true)
Boolean isEncrypted()

This method indicates whether this image template contains an encrypted disk image.

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::isEncrypted

permitSharingAccess

@ApiMethod(instanceRequired=true)
Boolean permitSharingAccess(Long accountId)

This method will permit another SoftLayer customer account access to provision CloudLayer Computing Instances from an image template group. Template access should only be given to the parent template group object, not the child.

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::permitSharingAccess

removeCompatiblePlatforms

@ApiMethod(instanceRequired=true)
Boolean removeCompatiblePlatforms(List<String> platformNames)

Removes compatible platforms on the template group.

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::removeCompatiblePlatforms

removeLocations

@ApiMethod(instanceRequired=true)
Boolean removeLocations(List<Location> locations)

This method will create transaction(s) to remove available locations from an archive image template.

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::removeLocations

removeSupportedBootMode

@ApiMethod(instanceRequired=true)
Boolean removeSupportedBootMode(String bootMode)

This method allows you to remove a supported boot mode attribute for a given image template.

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::removeSupportedBootMode

setAvailableLocations

@ApiMethod(instanceRequired=true)
Boolean setAvailableLocations(List<Location> locations)

Create transaction(s) to set the archived block device available locations

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::setAvailableLocations

setBootMode

@ApiMethod(instanceRequired=true)
Boolean setBootMode(String newBootMode)

This method allows you to specify the boot mode for a given image template.

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::setBootMode

setCompatiblePlatforms

@ApiMethod(instanceRequired=true)
Boolean setCompatiblePlatforms(List<String> platformNames)

Sets compatible platforms on the template group.

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::setCompatiblePlatforms

setTags

@ApiMethod(instanceRequired=true)
Boolean setTags(String tags)

Set the tags for this template group.

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::setTags

getAccount

@ApiMethod(instanceRequired=true)
Account getAccount()

A block device template group's [[SoftLayer_Account|account]].

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::getAccount

getAccountContacts

@ApiMethod(instanceRequired=true)
List<Contact> getAccountContacts()

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::getAccountContacts

getAccountReferences

@ApiMethod(instanceRequired=true)
List<Accounts> getAccountReferences()

The accounts which may have read-only access to an image template group. Will only be populated for parent template group objects.

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::getAccountReferences

getBlockDevices

@ApiMethod(instanceRequired=true)
List<Template> getBlockDevices()

The block devices that are part of an image template group

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::getBlockDevices

getBlockDevicesDiskSpaceTotal

@ApiMethod(instanceRequired=true)
BigDecimal getBlockDevicesDiskSpaceTotal()

The total disk space of all images in a image template group.

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::getBlockDevicesDiskSpaceTotal

getByolFlag

@ApiMethod(instanceRequired=true)
Boolean getByolFlag()

A flag indicating that customer is providing the software licenses.

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::getByolFlag

getChildren

@ApiMethod(instanceRequired=true)
List<Group> getChildren()

The image template groups that are clones of an image template group.

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::getChildren

getDatacenter

@ApiMethod(instanceRequired=true)
Location getDatacenter()

The location containing this image template group. Will only be populated for child template group objects.

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::getDatacenter

getDatacenters

@ApiMethod(instanceRequired=true)
List<Location> getDatacenters()

A collection of locations containing a copy of this image template group. Will only be populated for parent template group objects.

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::getDatacenters

getFirstChild

@ApiMethod(instanceRequired=true)
Group getFirstChild()

The first clone of the image template group

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::getFirstChild

getFlexImageFlag

@ApiMethod(instanceRequired=true)
Boolean getFlexImageFlag()

A flag indicating if this is a flex image.

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::getFlexImageFlag

getGlobalIdentifier

@ApiMethod(instanceRequired=true)
String getGlobalIdentifier()

An image template's universally unique identifier.

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::getGlobalIdentifier

getImageType

@ApiMethod(instanceRequired=true)
Type getImageType()

The virtual disk image type of this template. Value will be populated on parent and child, but only supports object filtering on the parent.

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::getImageType

getImageTypeKeyName

@ApiMethod(instanceRequired=true)
String getImageTypeKeyName()

The virtual disk image type keyname (e.g. SYSTEM, DISK_CAPTURE, ISO, etc) of this template. Value will be populated on parent and child, but only supports object filtering on the parent.

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::getImageTypeKeyName

getNextGenFlag

@ApiMethod(instanceRequired=true)
Boolean getNextGenFlag()

A flag indicating if this is a next generation image.

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::getNextGenFlag

getParent

@ApiMethod(instanceRequired=true)
Group getParent()

The image template group that another image template group was cloned from.

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::getParent

getRegion

@ApiMethod(instanceRequired=true)
Resource getRegion()

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::getRegion

getRegions

@ApiMethod(instanceRequired=true)
List<Resource> getRegions()

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::getRegions

getSshKeys

@ApiMethod(instanceRequired=true)
List<Key> getSshKeys()

The ssh keys to be implemented on the server when provisioned or reloaded from an image template group.

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::getSshKeys

getStatus

@ApiMethod(instanceRequired=true)
Status getStatus()

A template group's status.

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::getStatus

getStorageRepository

@ApiMethod(instanceRequired=true)
Repository getStorageRepository()

The storage repository that an image template group resides on.

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::getStorageRepository

getTagReferences

@ApiMethod(instanceRequired=true)
List<Reference> getTagReferences()

The tags associated with this image template group.

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::getTagReferences

getTransaction

@ApiMethod(instanceRequired=true)
Transaction getTransaction()

A transaction that is being performed on a image template group.

See Also:

SoftLayer_Virtual_Guest_Block_Device_Template_Group::getTransaction