Package com.softlayer.api.service.monitoring.agent.configuration.template

Interface Group.Service

All Superinterfaces:

Maskable, ResultLimitable, Service

Enclosing class:

Group

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

SoftLayer offers several monitoring packages, each containing multiple monitoring agents. Monitoring packages can have a configuration template group, which consists of configuration templates for all agents in a package. The configuration template group is required when you install a SoftLayer monitoring system on your system for the first time. You will be able to configure per agent basis once your monitoring system is active. Once your monitoring system is active, please refer to [[SoftLayer_Configuration_Template|Configuration Template]].

See Also:

SoftLayer_Monitoring_Agent_Configuration_Template_Group

Method Summary

Modifier and Type	Method	Description
Group.ServiceAsync	asAsync()	Get an async version of this service
Group	createObject(Group templateObject)	This method creates a SoftLayer_Monitoring_Agent_Configuration_Template_Group using the values provided in the template object.
Boolean	deleteObject()	Deletes a customer configuration template group.
Boolean	editObject(Group templateObject)	This method edits an existing SoftLayer_Monitoring_Agent_Configuration_Template_Group using the values passed in the $object parameter.
Account	getAccount()
List<Group>	getAllObjects()
List<Group>	getConfigurationGroups(Long packageId)	This method retrieves an array of SoftLayer_Monitoring_Agent_Configuration_Template_Group objects that are available to the active user's account.
List<Reference>	getConfigurationTemplateReferences()
List<Template>	getConfigurationTemplates()
Item	getItem()
Group	getObject()	This method retrieves a monitoring agent configuration template group whose identifier corresponds to the value provided in the initialization parameter passed to the SoftLayer_Monitoring_Agent_Configuration_Template_Group service.
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)

createObject

@ApiMethod
Group createObject(Group templateObject)

This method creates a SoftLayer_Monitoring_Agent_Configuration_Template_Group using the values provided in the template object. The template objects accountId will be overridden to use the active user's accountId as it shows on their associated SoftLayer_User_Customer object.

See Also:

SoftLayer_Monitoring_Agent_Configuration_Template_Group::createObject

deleteObject

@ApiMethod(instanceRequired=true)
Boolean deleteObject()

Deletes a customer configuration template group.

See Also:

SoftLayer_Monitoring_Agent_Configuration_Template_Group::deleteObject

editObject

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

This method edits an existing SoftLayer_Monitoring_Agent_Configuration_Template_Group using the values passed in the $object parameter. The $object parameter should use the same structure as a SoftLayer_Monitoring_Agent_Configuration_Template_Group object.

See Also:

SoftLayer_Monitoring_Agent_Configuration_Template_Group::editObject

getAllObjects

@ApiMethod
List<Group> getAllObjects()

See Also:

SoftLayer_Monitoring_Agent_Configuration_Template_Group::getAllObjects

getConfigurationGroups

@ApiMethod
List<Group> getConfigurationGroups(Long packageId)

This method retrieves an array of SoftLayer_Monitoring_Agent_Configuration_Template_Group objects that are available to the active user's account. The packageId parameter is not currently used.

See Also:

SoftLayer_Monitoring_Agent_Configuration_Template_Group::getConfigurationGroups

getObject

@ApiMethod(instanceRequired=true)
Group getObject()

This method retrieves a monitoring agent configuration template group whose identifier corresponds to the value provided in the initialization parameter passed to the SoftLayer_Monitoring_Agent_Configuration_Template_Group service.

See Also:

SoftLayer_Monitoring_Agent_Configuration_Template_Group::getObject

getAccount

@ApiMethod(instanceRequired=true)
Account getAccount()

See Also:

SoftLayer_Monitoring_Agent_Configuration_Template_Group::getAccount

getConfigurationTemplateReferences

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

See Also:

SoftLayer_Monitoring_Agent_Configuration_Template_Group::getConfigurationTemplateReferences

getConfigurationTemplates

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

See Also:

SoftLayer_Monitoring_Agent_Configuration_Template_Group::getConfigurationTemplates

getItem

@ApiMethod(instanceRequired=true)
Item getItem()

See Also:

SoftLayer_Monitoring_Agent_Configuration_Template_Group::getItem