TagApi: Agave Tag API operations

Description Usage Format Details Arguments Methods See Also

Description

TagApi Class

Usage

1
tag <- TagApi$new( apiClient = ApiClient$new(), cache = AgaveCache$new() )

Format

An object of class R6ClassGenerator of length 24.

Details

Read more about the Tag API in the Agave Developer's Guide

Arguments

apiClient a rAgave::ApiClient instance preconfigured to speak to the Agave Platform.

cache an rAgave::AgaveCache instance pointing to the persistent auth cache file on disk.

responseType the default object type methods of this class should return. Valid values are:

Methods

$addTag() Creat a new tag

Usage

1
tag$addTag$listTag(body, naked, )

$addTagResource() Add resources to tag

Usage

1
tag$addTagResource$listTag(tagId, body, naked, )

$clearTagPermissions() Clear tag permissions

Usage

1
tag$clearTagPermissions$listTag(tagId, naked, )

$clearTagResources() Clear all tagged resources

Usage

1
tag$clearTagResources$listTag(tagId, naked, )

$deleteTag() Delete tag

Usage

1
tag$deleteTag$listTag(tagId, naked, )

$deleteTagPermissionForUser() Remove user tag permission

Usage

1
tag$deleteTagPermissionForUser$listTag(tagId, username, naked, )

$getTagDetails() Tag Details

Usage

1
2
tag$getTagDetails$listTag(tagId, naked, search, )
tag$getTagDetails$listTag(search=list("foo"="bar"))

$getTagPermissionForUser() List tag permissions for a user

Usage

1
tag$getTagPermissionForUser$listTag(tagId, username, naked, )

$getTaggedResource() Get tagged item details

Usage

1
tag$getTaggedResource$listTag(tagId, uuid, naked, )

$listTagHistory() Tag history

Usage

1
2
tag$listTagHistory$listTag(tagId, naked, limit, offset, search, )
tag$listTagHistory$listTag(search=list("foo"="bar"))

$listTagPermissions() List permissionss set for a given tag id

Usage

1
2
tag$listTagPermissions$listTag(tagId, naked, limit, offset, search, )
tag$listTagPermissions$listTag(search=list("foo"="bar"))

$listTagResources() Tagged items

Usage

1
2
tag$listTagResources$listTag(tagId, naked, limit, offset, search, )
tag$listTagResources$listTag(search=list("foo"="bar"))

$listTags() Available tags

Usage

1
2
tag$listTags$listTag(name, resourceType, resourceId, lastModified, created, naked, limit, offset, search, )
tag$listTags$listTag(search=list("foo"="bar"))

$removeTagResource() Remove resource from tag

Usage

1
tag$removeTagResource$listTag(tagId, uuid, naked, )

$updateTag() Update tag

Usage

1
tag$updateTag$listTag(tagId, body, naked, )

$updateTagPermission() Grant permission

Usage

1
tag$updateTagPermission$listTag(tagId, body, naked, )

$updateTagPermissionForUser() Update user permission on tag

Usage

1
tag$updateTagPermissionForUser$listTag(tagId, username, body, naked, )

$updateTagResource() Add resource to tag

Usage

1
tag$updateTagResource$listTag(tagId, uuid, body, naked, )

See Also

rAgave::ApiClient rAgave::Agave [rAgave::Permission][rAgave::Tag][rAgave::TagHistory][rAgave::TagResource][rAgave::TagSummary]


agaveplatform/r-sdk documentation built on Sept. 22, 2018, 2:14 p.m.