Package com.softlayer.api.service

Interface Tag.Service

All Superinterfaces:

Maskable, ResultLimitable, Service

Enclosing class:

Tag

@ApiService("SoftLayer_Tag")
public static interface Tag.Service
extends Service

SoftLayer's tagging service gives customers the ability to tag devices with keywords that can later be used to search upon.

See Also:

SoftLayer_Tag

Method Summary

Modifier and Type	Method	Description
Tag.ServiceAsync	asAsync()	Get an async version of this service
List<Tag>	autoComplete(String tag)	This function is responsible for setting the Tags values.
Boolean	deleteTag(String tagName)	Delete a tag for an object.
Account	getAccount()	The account to which the tag is tied.
List<Type>	getAllTagTypes()	Returns all tags of a given object type.
List<Tag>	getAttachedTagsForCurrentUser()	Get all tags with at least one reference attached to it for the current account.
Tag	getObject()
List<Reference>	getReferences()	References that tie object to the tag.
List<Tag>	getTagByTagName(String tagList)	Returns the Tag object with a given name.
List<Tag>	getUnattachedTagsForCurrentUser()	Get all tags with no references attached to it for the current account.
void	setMask(Tag.Mask mask)
Boolean	setTags(String tags, String keyName, Long resourceTableId)	Tag an object by passing in one or more tags separated by a comma.
Tag.Mask	withMask()	Use the existing mask on this service or create it if not present
Tag.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

Tag.ServiceAsync asAsync()

Description copied from interface: Service

Get an async version of this service

Specified by:

asAsync in interface Service

withNewMask

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

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

autoComplete

@ApiMethod
List<Tag> autoComplete(String tag)

This function is responsible for setting the Tags values. The internal flag is set to 0 if the user is a customer, and 1 otherwise. AccountId is set to the account bound to the user, and the tags name is set to the clean version of the tag inputted by the user.

See Also:

SoftLayer_Tag::autoComplete

deleteTag

@ApiMethod
Boolean deleteTag(String tagName)

Delete a tag for an object.

See Also:

SoftLayer_Tag::deleteTag

getAllTagTypes

@ApiMethod
List<Type> getAllTagTypes()

Returns all tags of a given object type.

See Also:

SoftLayer_Tag::getAllTagTypes

getAttachedTagsForCurrentUser

@ApiMethod
List<Tag> getAttachedTagsForCurrentUser()

Get all tags with at least one reference attached to it for the current account. The total items header for this method contains the total number of attached tags even if a result limit is applied.

See Also:

SoftLayer_Tag::getAttachedTagsForCurrentUser

getObject

@ApiMethod(instanceRequired=true)
Tag getObject()

See Also:

SoftLayer_Tag::getObject

getTagByTagName

@ApiMethod
List<Tag> getTagByTagName(String tagList)

Returns the Tag object with a given name. The user types in the tag name and this method returns the tag with that name.

See Also:

SoftLayer_Tag::getTagByTagName

getUnattachedTagsForCurrentUser

@ApiMethod
List<Tag> getUnattachedTagsForCurrentUser()

Get all tags with no references attached to it for the current account. The total items header for this method contains the total number of unattached tags even if a result limit is applied.

See Also:

SoftLayer_Tag::getUnattachedTagsForCurrentUser

setTags

@ApiMethod
Boolean setTags(String tags,
                String keyName,
                Long resourceTableId)

Tag an object by passing in one or more tags separated by a comma. Tag references are cleared out every time this method is called. If your object is already tagged you will need to pass the current tags along with any new ones. To remove all tag references pass an empty string. To remove one or more tags omit them from the tag list. The characters permitted are A-Z, 0-9, whitespace, _ (underscore), - (hypen), . (period), and : (colon). All other characters will be stripped away. You must pass 3 string arguments into this method or you will receive an exception.

See Also:

SoftLayer_Tag::setTags

getAccount

@ApiMethod(instanceRequired=true)
Account getAccount()

The account to which the tag is tied.

See Also:

SoftLayer_Tag::getAccount

getReferences

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

References that tie object to the tag.

See Also:

SoftLayer_Tag::getReferences