Package com.softlayer.api.service.software

Interface Component.Service

All Superinterfaces:

Maskable, ResultLimitable, Service

All Known Subinterfaces:

AntivirusSpyware.Service, HostIps.Service

Enclosing class:

Component

@ApiService("SoftLayer_Software_Component")
public static interface Component.Service
extends Service

Every installed piece of software is represented in the API as a "Software Component." This is the base class for software components, exposing basic functionality for software components. From any Software Component, through this service, you can get the hardware a component is installed upon, the license that this component is governed by, the current access passwords for a component, and the history of previous passwords for a component.

See Also:

SoftLayer_Software_Component

Method Summary

Modifier and Type	Method	Description
Component.ServiceAsync	asAsync()	Get an async version of this service
Long	getAverageInstallationDuration()	The average amount of time that a software component takes to install.
Item	getBillingItem()	The billing item for a software component.
Hardware	getHardware()	The hardware this Software Component is installed upon.
String	getLicenseFile()	Attempt to retrieve the file associated with a software component.
Component	getObject()	getObject retrieves the SoftLayer_Software_Component object whose ID corresponds to the ID number of the init parameter passed to the SoftLayer_Software_Component service.
List<History>	getPasswordHistory()	History Records for Software Passwords.
List<Password>	getPasswords()	Username/Password pairs used for access to this Software Installation.
Description	getSoftwareDescription()	The Software Description of this Software Component.
License	getSoftwareLicense()	The License this Software Component uses.
String	getVendorSetUpConfiguration()
Guest	getVirtualGuest()	The virtual guest this software component is installed upon.
void	setMask(Component.Mask mask)
Component.Mask	withMask()	Use the existing mask on this service or create it if not present
Component.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

Component.ServiceAsync asAsync()

Description copied from interface: Service

Get an async version of this service

Specified by:

asAsync in interface Service

withNewMask

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

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

getLicenseFile

@ApiMethod(instanceRequired=true)
String getLicenseFile()

Attempt to retrieve the file associated with a software component. If the software component does not support downloading license files an exception will be thrown.

See Also:

SoftLayer_Software_Component::getLicenseFile

getObject

@ApiMethod(instanceRequired=true)
Component getObject()

getObject retrieves the SoftLayer_Software_Component object whose ID corresponds to the ID number of the init parameter passed to the SoftLayer_Software_Component service.

The best way to get software components is through getSoftwareComponents from the Hardware service.

See Also:

SoftLayer_Software_Component::getObject

getVendorSetUpConfiguration

@ApiMethod(instanceRequired=true)
String getVendorSetUpConfiguration()

See Also:

SoftLayer_Software_Component::getVendorSetUpConfiguration

getAverageInstallationDuration

@ApiMethod(instanceRequired=true)
Long getAverageInstallationDuration()

The average amount of time that a software component takes to install.

See Also:

SoftLayer_Software_Component::getAverageInstallationDuration

getBillingItem

@ApiMethod(instanceRequired=true)
Item getBillingItem()

The billing item for a software component.

See Also:

SoftLayer_Software_Component::getBillingItem

getHardware

@ApiMethod(instanceRequired=true)
Hardware getHardware()

The hardware this Software Component is installed upon.

See Also:

SoftLayer_Software_Component::getHardware

getPasswordHistory

@ApiMethod(instanceRequired=true)
List<History> getPasswordHistory()

History Records for Software Passwords.

See Also:

SoftLayer_Software_Component::getPasswordHistory

getPasswords

@ApiMethod(instanceRequired=true)
List<Password> getPasswords()

Username/Password pairs used for access to this Software Installation.

See Also:

SoftLayer_Software_Component::getPasswords

getSoftwareDescription

@ApiMethod(instanceRequired=true)
Description getSoftwareDescription()

The Software Description of this Software Component.

See Also:

SoftLayer_Software_Component::getSoftwareDescription

getSoftwareLicense

@ApiMethod(instanceRequired=true)
License getSoftwareLicense()

The License this Software Component uses.

See Also:

SoftLayer_Software_Component::getSoftwareLicense

getVirtualGuest

@ApiMethod(instanceRequired=true)
Guest getVirtualGuest()

The virtual guest this software component is installed upon.

See Also:

SoftLayer_Software_Component::getVirtualGuest