GroupsApi: Groups operations
In TileDB-Inc/TileDB-Cloud-R: TileDB Cloud Platform R Client Package
GroupsApi R Documentation
Groups operations
Description
tiledbcloud.Groups
Format
An R6Class generator object
Methods
ChangeGroupContents
Changes the contents of the group by adding/removing members.
-
@param group.namespace character
-
@param group.name character
-
@param group.changes GroupChanges
status code : 204 | all changes applied successfully
response headers :
status code : 0 | error response
return type : Error
response headers :
CreateGroup
Creates a new group in the namespace.
-
@param namespace character
-
@param group.create GroupCreate
status code : 204 | group created successfully
response headers :
status code : 0 | error response
return type : Error
response headers :
DeleteGroup
Deletes the group. The assets are not deleted nor are not relocated to any other group
-
@param group.namespace character
-
@param group.name character
status code : 204 | group deleted successfully
response headers :
status code : 0 | error response
return type : Error
response headers :
GetGroup
Returns the the group
-
@param group.namespace character
-
@param group.name character
-
@returnType GroupInfo
status code : 200 | the group metadata
return type : GroupInfo
response headers :
status code : 0 | error response
return type : Error
response headers :
GetGroupContents
Returns the contents of the group
-
@param group.namespace character
-
@param group.name character
-
@param page integer
-
@param per.page integer
-
@param namespace character
-
@param search character
-
@param orderby character
-
@param tag list( character )
-
@param exclude.tag list( character )
-
@param member.type list( character )
-
@param exclude.member.type list( character )
-
@returnType GroupContents
status code : 200 | the group contents
return type : GroupContents
response headers :
status code : 0 | error response
return type : Error
response headers :
GetGroupSharingPolicies
Get all sharing details of the group
-
@param group.namespace character
-
@param group.name character
-
@returnType list( GroupSharing )
status code : 200 | List of all specific sharing policies
return type : array[GroupSharing]
response headers :
status code : 404 | Group does not exist or user does not have permissions to view group-sharing policies
response headers :
status code : 0 | error response
return type : Error
response headers :
GroupsBrowserOwnedFiltersGet
Fetch data to initialize filters for the groups browser
-
@returnType GroupBrowserFilterData
status code : 200 | Filter data
return type : GroupBrowserFilterData
response headers :
status code : 0 | error response
return type : Error
response headers :
GroupsBrowserPublicFiltersGet
Fetch data to initialize filters for the groups browser
-
@returnType GroupBrowserFilterData
status code : 200 | Filter data
return type : GroupBrowserFilterData
response headers :
status code : 0 | error response
return type : Error
response headers :
GroupsBrowserSharedFiltersGet
Fetch data to initialize filters for the groups browser
-
@returnType GroupBrowserFilterData
status code : 200 | Filter data
return type : GroupBrowserFilterData
response headers :
status code : 0 | error response
return type : Error
response headers :
GroupsGroupNamespaceGroupNameContentsFiltersGet
Fetch data to initialize filters for the group contents
-
@param group.namespace character
-
@param group.name character
-
@returnType GroupContentsFilterData
status code : 200 | Filter data
return type : GroupContentsFilterData
response headers :
status code : 0 | error response
return type : Error
response headers :
ListOwnedGroups
Returns one page of owned groups.
-
@param page integer
-
@param per.page integer
-
@param search character
-
@param namespace character
-
@param orderby character
-
@param permissions character
-
@param tag list( character )
-
@param exclude.tag list( character )
-
@param flat character
-
@param parent character
-
@returnType GroupBrowserData
status code : 200 | the group contents
return type : GroupBrowserData
response headers :
status code : 0 | error response
return type : Error
response headers :
ListPublicGroups
Returns one page of public groups.
-
@param page integer
-
@param per.page integer
-
@param search character
-
@param namespace character
-
@param orderby character
-
@param permissions character
-
@param tag list( character )
-
@param exclude.tag list( character )
-
@param flat character
-
@param parent character
-
@returnType GroupBrowserData
status code : 200 | the group contents
return type : GroupBrowserData
response headers :
status code : 0 | error response
return type : Error
response headers :
ListSharedGroups
Returns one page of shared groups.
-
@param page integer
-
@param per.page integer
-
@param search character
-
@param namespace character
-
@param orderby character
-
@param permissions character
-
@param tag list( character )
-
@param exclude.tag list( character )
-
@param flat character
-
@param parent character
-
@param shared.to list( character )
-
@returnType GroupBrowserData
status code : 200 | the group contents
return type : GroupBrowserData
response headers :
status code : 0 | error response
return type : Error
response headers :
RegisterGroup
Registers an existing group in the namespace.
-
@param namespace character
-
@param array character
-
@param group.register GroupRegister
status code : 204 | group created successfully
response headers :
status code : 0 | error response
return type : Error
response headers :
ShareGroup
Share a group with a namespace
-
@param group.namespace character
-
@param group.name character
-
@param group.sharing.request GroupSharingRequest
status code : 204 | Group shared successfully
response headers :
status code : 404 | Group does not exist or user does not have permissions to share group
response headers :
status code : 0 | error response
return type : Error
response headers :
UpdateGroup
Changes attributes of the group
-
@param group.namespace character
-
@param group.name character
-
@param group.update GroupUpdate
status code : 204 | attributes changed successfully
response headers :
status code : 0 | error response
return type : Error
response headers :
Public fields
apiClientHandles the client-server communication.
Methods
Public methods
Method new()
Usage
GroupsApi$new(apiClient)
Method ChangeGroupContents()
Usage
GroupsApi$ChangeGroupContents(
group.namespace,
group.name,
group.changes = NULL,
...
)
Method ChangeGroupContentsWithHttpInfo()
Usage
GroupsApi$ChangeGroupContentsWithHttpInfo(
group.namespace,
group.name,
group.changes = NULL,
...
)
Method CreateGroup()
Usage
GroupsApi$CreateGroup(namespace, group.create = NULL, ...)
Method CreateGroupWithHttpInfo()
Usage
GroupsApi$CreateGroupWithHttpInfo(namespace, group.create = NULL, ...)
Method DeleteGroup()
Usage
GroupsApi$DeleteGroup(group.namespace, group.name, ...)
Method DeleteGroupWithHttpInfo()
Usage
GroupsApi$DeleteGroupWithHttpInfo(group.namespace, group.name, ...)
Method GetGroup()
Usage
GroupsApi$GetGroup(group.namespace, group.name, ...)
Method GetGroupWithHttpInfo()
Usage
GroupsApi$GetGroupWithHttpInfo(group.namespace, group.name, ...)
Method GetGroupContents()
Usage
GroupsApi$GetGroupContents(
group.namespace,
group.name,
page = NULL,
per.page = NULL,
namespace = NULL,
search = NULL,
orderby = NULL,
tag = NULL,
exclude.tag = NULL,
member.type = NULL,
exclude.member.type = NULL,
...
)
Method GetGroupContentsWithHttpInfo()
Usage
GroupsApi$GetGroupContentsWithHttpInfo(
group.namespace,
group.name,
page = NULL,
per.page = NULL,
namespace = NULL,
search = NULL,
orderby = NULL,
tag = NULL,
exclude.tag = NULL,
member.type = NULL,
exclude.member.type = NULL,
...
)
Method GetGroupSharingPolicies()
Usage
GroupsApi$GetGroupSharingPolicies(group.namespace, group.name, ...)
Method GetGroupSharingPoliciesWithHttpInfo()
Usage
GroupsApi$GetGroupSharingPoliciesWithHttpInfo(group.namespace, group.name, ...)
Method GroupsBrowserOwnedFiltersGet()
Usage
GroupsApi$GroupsBrowserOwnedFiltersGet(...)
Method GroupsBrowserOwnedFiltersGetWithHttpInfo()
Usage
GroupsApi$GroupsBrowserOwnedFiltersGetWithHttpInfo(...)
Method GroupsBrowserPublicFiltersGet()
Usage
GroupsApi$GroupsBrowserPublicFiltersGet(...)
Method GroupsBrowserPublicFiltersGetWithHttpInfo()
Usage
GroupsApi$GroupsBrowserPublicFiltersGetWithHttpInfo(...)
Method GroupsBrowserSharedFiltersGet()
Usage
GroupsApi$GroupsBrowserSharedFiltersGet(...)
Method GroupsBrowserSharedFiltersGetWithHttpInfo()
Usage
GroupsApi$GroupsBrowserSharedFiltersGetWithHttpInfo(...)
Method GroupsGroupNamespaceGroupNameContentsFiltersGet()
Usage
GroupsApi$GroupsGroupNamespaceGroupNameContentsFiltersGet(
group.namespace,
group.name,
...
)
Method GroupsGroupNamespaceGroupNameContentsFiltersGetWithHttpInfo()
Usage
GroupsApi$GroupsGroupNamespaceGroupNameContentsFiltersGetWithHttpInfo(
group.namespace,
group.name,
...
)
Method ListOwnedGroups()
Usage
GroupsApi$ListOwnedGroups(
page = NULL,
per.page = NULL,
search = NULL,
namespace = NULL,
orderby = NULL,
permissions = NULL,
tag = NULL,
exclude.tag = NULL,
flat = NULL,
parent = NULL,
...
)
Method ListOwnedGroupsWithHttpInfo()
Usage
GroupsApi$ListOwnedGroupsWithHttpInfo(
page = NULL,
per.page = NULL,
search = NULL,
namespace = NULL,
orderby = NULL,
permissions = NULL,
tag = NULL,
exclude.tag = NULL,
flat = NULL,
parent = NULL,
...
)
Method ListPublicGroups()
Usage
GroupsApi$ListPublicGroups(
page = NULL,
per.page = NULL,
search = NULL,
namespace = NULL,
orderby = NULL,
permissions = NULL,
tag = NULL,
exclude.tag = NULL,
flat = NULL,
parent = NULL,
...
)
Method ListPublicGroupsWithHttpInfo()
Usage
GroupsApi$ListPublicGroupsWithHttpInfo(
page = NULL,
per.page = NULL,
search = NULL,
namespace = NULL,
orderby = NULL,
permissions = NULL,
tag = NULL,
exclude.tag = NULL,
flat = NULL,
parent = NULL,
...
)
Method ListSharedGroups()
Usage
GroupsApi$ListSharedGroups(
page = NULL,
per.page = NULL,
search = NULL,
namespace = NULL,
orderby = NULL,
permissions = NULL,
tag = NULL,
exclude.tag = NULL,
flat = NULL,
parent = NULL,
shared.to = NULL,
...
)
Method ListSharedGroupsWithHttpInfo()
Usage
GroupsApi$ListSharedGroupsWithHttpInfo(
page = NULL,
per.page = NULL,
search = NULL,
namespace = NULL,
orderby = NULL,
permissions = NULL,
tag = NULL,
exclude.tag = NULL,
flat = NULL,
parent = NULL,
shared.to = NULL,
...
)
Method RegisterGroup()
Usage
GroupsApi$RegisterGroup(namespace, array, group.register = NULL, ...)
Method RegisterGroupWithHttpInfo()
Usage
GroupsApi$RegisterGroupWithHttpInfo(
namespace,
array,
group.register = NULL,
...
)
Method ShareGroup()
Usage
GroupsApi$ShareGroup(group.namespace, group.name, group.sharing.request, ...)
Method ShareGroupWithHttpInfo()
Usage
GroupsApi$ShareGroupWithHttpInfo(
group.namespace,
group.name,
group.sharing.request,
...
)
Method UpdateGroup()
Usage
GroupsApi$UpdateGroup(group.namespace, group.name, group.update = NULL, ...)
Method UpdateGroupWithHttpInfo()
Usage
GroupsApi$UpdateGroupWithHttpInfo(
group.namespace,
group.name,
group.update = NULL,
...
)
Method clone()
The objects of this class are cloneable with this method.
Usage
GroupsApi$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
Examples
## Not run:
#################### ChangeGroupContents ####################
library(tiledbcloud)
var.group.namespace <- 'group.namespace_example' # character | The namespace of the group
var.group.name <- 'group.name_example' # character | The unique name or id of the group
var.group.changes <- GroupChanges$new() # GroupChanges |
api.instance <- GroupsApi$new()
#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>';
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';
result <- api.instance$ChangeGroupContents(var.group.namespace, var.group.name, group.changes=var.group.changes)
#################### CreateGroup ####################
library(tiledbcloud)
var.namespace <- 'namespace_example' # character | The namespace of the group
var.group.create <- GroupCreate$new() # GroupCreate |
api.instance <- GroupsApi$new()
#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>';
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';
result <- api.instance$CreateGroup(var.namespace, group.create=var.group.create)
#################### DeleteGroup ####################
library(tiledbcloud)
var.group.namespace <- 'group.namespace_example' # character | The namespace of the group
var.group.name <- 'group.name_example' # character | The unique name or id of the group
api.instance <- GroupsApi$new()
#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>';
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';
result <- api.instance$DeleteGroup(var.group.namespace, var.group.name)
#################### GetGroup ####################
library(tiledbcloud)
var.group.namespace <- 'group.namespace_example' # character | The namespace of the group
var.group.name <- 'group.name_example' # character | The unique name or id of the group
api.instance <- GroupsApi$new()
#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>';
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';
result <- api.instance$GetGroup(var.group.namespace, var.group.name)
#################### GetGroupContents ####################
library(tiledbcloud)
var.group.namespace <- 'group.namespace_example' # character | The namespace of the group
var.group.name <- 'group.name_example' # character | The unique name or id of the group
var.page <- 56 # integer | pagination offset for assets
var.per.page <- 56 # integer | pagination limit for assets
var.namespace <- 'namespace_example' # character | namespace to search for
var.search <- 'search_example' # character | search string that will look at name, namespace or description fields
var.orderby <- 'orderby_example' # character | sort by which field valid values include last_accessed, size, name
var.tag <- ['tag_example'] # array[character] | tag to search for, more than one can be included
var.exclude.tag <- ['exclude.tag_example'] # array[character] | tags to exclude matching array in results, more than one can be included
var.member.type <- ['member.type_example'] # array[character] | member type to search for, more than one can be included
var.exclude.member.type <- ['exclude.member.type_example'] # array[character] | member type to exclude matching groups in results, more than one can be included
api.instance <- GroupsApi$new()
#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>';
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';
result <- api.instance$GetGroupContents(var.group.namespace, var.group.name, page=var.page, per.page=var.per.page, namespace=var.namespace, search=var.search, orderby=var.orderby, tag=var.tag, exclude.tag=var.exclude.tag, member.type=var.member.type, exclude.member.type=var.exclude.member.type)
#################### GetGroupSharingPolicies ####################
library(tiledbcloud)
var.group.namespace <- 'group.namespace_example' # character | The namespace of the group
var.group.name <- 'group.name_example' # character | The unique name or id of the group
api.instance <- GroupsApi$new()
#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>';
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';
result <- api.instance$GetGroupSharingPolicies(var.group.namespace, var.group.name)
#################### GroupsBrowserOwnedFiltersGet ####################
library(tiledbcloud)
api.instance <- GroupsApi$new()
#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>';
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';
result <- api.instance$GroupsBrowserOwnedFiltersGet()
#################### GroupsBrowserPublicFiltersGet ####################
library(tiledbcloud)
api.instance <- GroupsApi$new()
#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>';
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';
result <- api.instance$GroupsBrowserPublicFiltersGet()
#################### GroupsBrowserSharedFiltersGet ####################
library(tiledbcloud)
api.instance <- GroupsApi$new()
#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>';
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';
result <- api.instance$GroupsBrowserSharedFiltersGet()
#################### GroupsGroupNamespaceGroupNameContentsFiltersGet ####################
library(tiledbcloud)
var.group.namespace <- 'group.namespace_example' # character | The namespace of the group
var.group.name <- 'group.name_example' # character | The unique name or id of the group
api.instance <- GroupsApi$new()
#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>';
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';
result <- api.instance$GroupsGroupNamespaceGroupNameContentsFiltersGet(var.group.namespace, var.group.name)
#################### ListOwnedGroups ####################
library(tiledbcloud)
var.page <- 56 # integer | pagination offset
var.per.page <- 56 # integer | pagination limit
var.search <- 'search_example' # character | search string that will look at name, namespace or description fields
var.namespace <- 'namespace_example' # character | namespace
var.orderby <- 'orderby_example' # character | sort by which field valid values include last_accessed, size, name
var.permissions <- 'permissions_example' # character | permissions valid values include read, read_write, write, admin
var.tag <- ['tag_example'] # array[character] | tag to search for, more than one can be included
var.exclude.tag <- ['exclude.tag_example'] # array[character] | tags to exclude matching array in results, more than one can be included
var.flat <- 'flat_example' # character | if true, ignores the nesting of groups and searches all of them
var.parent <- 'parent_example' # character | search only the children of the groups with this uuid
api.instance <- GroupsApi$new()
#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>';
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';
result <- api.instance$ListOwnedGroups(page=var.page, per.page=var.per.page, search=var.search, namespace=var.namespace, orderby=var.orderby, permissions=var.permissions, tag=var.tag, exclude.tag=var.exclude.tag, flat=var.flat, parent=var.parent)
#################### ListPublicGroups ####################
library(tiledbcloud)
var.page <- 56 # integer | pagination offset
var.per.page <- 56 # integer | pagination limit
var.search <- 'search_example' # character | search string that will look at name, namespace or description fields
var.namespace <- 'namespace_example' # character | namespace
var.orderby <- 'orderby_example' # character | sort by which field valid values include last_accessed, size, name
var.permissions <- 'permissions_example' # character | permissions valid values include read, read_write, write, admin
var.tag <- ['tag_example'] # array[character] | tag to search for, more than one can be included
var.exclude.tag <- ['exclude.tag_example'] # array[character] | tags to exclude matching array in results, more than one can be included
var.flat <- 'flat_example' # character | if true, ignores the nesting of groups and searches all of them
var.parent <- 'parent_example' # character | search only the children of the groups with this uuid
api.instance <- GroupsApi$new()
#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>';
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';
result <- api.instance$ListPublicGroups(page=var.page, per.page=var.per.page, search=var.search, namespace=var.namespace, orderby=var.orderby, permissions=var.permissions, tag=var.tag, exclude.tag=var.exclude.tag, flat=var.flat, parent=var.parent)
#################### ListSharedGroups ####################
library(tiledbcloud)
var.page <- 56 # integer | pagination offset
var.per.page <- 56 # integer | pagination limit
var.search <- 'search_example' # character | search string that will look at name, namespace or description fields
var.namespace <- 'namespace_example' # character | namespace
var.orderby <- 'orderby_example' # character | sort by which field valid values include last_accessed, size, name
var.permissions <- 'permissions_example' # character | permissions valid values include read, read_write, write, admin
var.tag <- ['tag_example'] # array[character] | tag to search for, more than one can be included
var.exclude.tag <- ['exclude.tag_example'] # array[character] | tags to exclude matching array in results, more than one can be included
var.flat <- 'flat_example' # character | if true, ignores the nesting of groups and searches all of them
var.parent <- 'parent_example' # character | search only the children of the groups with this uuid
var.shared.to <- ['shared.to_example'] # array[character] | namespaces to filter results of where there groups were shared to
api.instance <- GroupsApi$new()
#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>';
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';
result <- api.instance$ListSharedGroups(page=var.page, per.page=var.per.page, search=var.search, namespace=var.namespace, orderby=var.orderby, permissions=var.permissions, tag=var.tag, exclude.tag=var.exclude.tag, flat=var.flat, parent=var.parent, shared.to=var.shared.to)
#################### RegisterGroup ####################
library(tiledbcloud)
var.namespace <- 'namespace_example' # character | The namespace of the group
var.array <- 'array_example' # character | The unique name or id of the group
var.group.register <- GroupRegister$new() # GroupRegister |
api.instance <- GroupsApi$new()
#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>';
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';
result <- api.instance$RegisterGroup(var.namespace, var.array, group.register=var.group.register)
#################### ShareGroup ####################
library(tiledbcloud)
var.group.namespace <- 'group.namespace_example' # character | The namespace of the group
var.group.name <- 'group.name_example' # character | The unique name or id of the group
var.group.sharing.request <- GroupSharingRequest$new() # GroupSharingRequest | Namespace and list of permissions to share with. Sharing is recursive, it is applied to all reachable subgroups and arrays of the group. An empty list of permissions will remove the namespace; if permissions already exist they will be deleted then new ones added. In the event of a failure, the new policies will be rolled back to prevent partial policies, and it's likely the group will not be shared with the namespace at all.
api.instance <- GroupsApi$new()
#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>';
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';
result <- api.instance$ShareGroup(var.group.namespace, var.group.name, var.group.sharing.request)
#################### UpdateGroup ####################
library(tiledbcloud)
var.group.namespace <- 'group.namespace_example' # character | The namespace of the group
var.group.name <- 'group.name_example' # character | The unique name or id of the group
var.group.update <- GroupUpdate$new() # GroupUpdate |
api.instance <- GroupsApi$new()
#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>';
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';
result <- api.instance$UpdateGroup(var.group.namespace, var.group.name, group.update=var.group.update)
## End(Not run)
TileDB-Inc/TileDB-Cloud-R documentation built on July 18, 2024, 3:33 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| GroupsApi | R Documentation |
Groups operations
Description
tiledbcloud.Groups
Format
An R6Class generator object
Methods
ChangeGroupContents Changes the contents of the group by adding/removing members.
-
@param group.namespace character
-
@param group.name character
-
@param group.changes GroupChanges
status code : 204 | all changes applied successfully
response headers :
status code : 0 | error response
return type : Error
response headers :
CreateGroup Creates a new group in the namespace.
-
@param namespace character
-
@param group.create GroupCreate
status code : 204 | group created successfully
response headers :
status code : 0 | error response
return type : Error
response headers :
DeleteGroup Deletes the group. The assets are not deleted nor are not relocated to any other group
-
@param group.namespace character
-
@param group.name character
status code : 204 | group deleted successfully
response headers :
status code : 0 | error response
return type : Error
response headers :
GetGroup Returns the the group
-
@param group.namespace character
-
@param group.name character
-
@returnType GroupInfo
status code : 200 | the group metadata
return type : GroupInfo
response headers :
status code : 0 | error response
return type : Error
response headers :
GetGroupContents Returns the contents of the group
-
@param group.namespace character
-
@param group.name character
-
@param page integer
-
@param per.page integer
-
@param namespace character
-
@param search character
-
@param orderby character
-
@param tag list( character )
-
@param exclude.tag list( character )
-
@param member.type list( character )
-
@param exclude.member.type list( character )
-
@returnType GroupContents
status code : 200 | the group contents
return type : GroupContents
response headers :
status code : 0 | error response
return type : Error
response headers :
GetGroupSharingPolicies Get all sharing details of the group
-
@param group.namespace character
-
@param group.name character
-
@returnType list( GroupSharing )
status code : 200 | List of all specific sharing policies
return type : array[GroupSharing]
response headers :
status code : 404 | Group does not exist or user does not have permissions to view group-sharing policies
response headers :
status code : 0 | error response
return type : Error
response headers :
GroupsBrowserOwnedFiltersGet Fetch data to initialize filters for the groups browser
-
@returnType GroupBrowserFilterData
status code : 200 | Filter data
return type : GroupBrowserFilterData
response headers :
status code : 0 | error response
return type : Error
response headers :
GroupsBrowserPublicFiltersGet Fetch data to initialize filters for the groups browser
-
@returnType GroupBrowserFilterData
status code : 200 | Filter data
return type : GroupBrowserFilterData
response headers :
status code : 0 | error response
return type : Error
response headers :
GroupsBrowserSharedFiltersGet Fetch data to initialize filters for the groups browser
-
@returnType GroupBrowserFilterData
status code : 200 | Filter data
return type : GroupBrowserFilterData
response headers :
status code : 0 | error response
return type : Error
response headers :
GroupsGroupNamespaceGroupNameContentsFiltersGet Fetch data to initialize filters for the group contents
-
@param group.namespace character
-
@param group.name character
-
@returnType GroupContentsFilterData
status code : 200 | Filter data
return type : GroupContentsFilterData
response headers :
status code : 0 | error response
return type : Error
response headers :
ListOwnedGroups Returns one page of owned groups.
-
@param page integer
-
@param per.page integer
-
@param search character
-
@param namespace character
-
@param orderby character
-
@param permissions character
-
@param tag list( character )
-
@param exclude.tag list( character )
-
@param flat character
-
@param parent character
-
@returnType GroupBrowserData
status code : 200 | the group contents
return type : GroupBrowserData
response headers :
status code : 0 | error response
return type : Error
response headers :
ListPublicGroups Returns one page of public groups.
-
@param page integer
-
@param per.page integer
-
@param search character
-
@param namespace character
-
@param orderby character
-
@param permissions character
-
@param tag list( character )
-
@param exclude.tag list( character )
-
@param flat character
-
@param parent character
-
@returnType GroupBrowserData
status code : 200 | the group contents
return type : GroupBrowserData
response headers :
status code : 0 | error response
return type : Error
response headers :
ListSharedGroups Returns one page of shared groups.
-
@param page integer
-
@param per.page integer
-
@param search character
-
@param namespace character
-
@param orderby character
-
@param permissions character
-
@param tag list( character )
-
@param exclude.tag list( character )
-
@param flat character
-
@param parent character
-
@param shared.to list( character )
-
@returnType GroupBrowserData
status code : 200 | the group contents
return type : GroupBrowserData
response headers :
status code : 0 | error response
return type : Error
response headers :
RegisterGroup Registers an existing group in the namespace.
-
@param namespace character
-
@param array character
-
@param group.register GroupRegister
status code : 204 | group created successfully
response headers :
status code : 0 | error response
return type : Error
response headers :
ShareGroup Share a group with a namespace
-
@param group.namespace character
-
@param group.name character
-
@param group.sharing.request GroupSharingRequest
status code : 204 | Group shared successfully
response headers :
status code : 404 | Group does not exist or user does not have permissions to share group
response headers :
status code : 0 | error response
return type : Error
response headers :
UpdateGroup Changes attributes of the group
-
@param group.namespace character
-
@param group.name character
-
@param group.update GroupUpdate
status code : 204 | attributes changed successfully
response headers :
status code : 0 | error response
return type : Error
response headers :
Public fields
apiClientHandles the client-server communication.
Methods
Public methods
Method new()
Usage
GroupsApi$new(apiClient)
Method ChangeGroupContents()
Usage
GroupsApi$ChangeGroupContents( group.namespace, group.name, group.changes = NULL, ... )
Method ChangeGroupContentsWithHttpInfo()
Usage
GroupsApi$ChangeGroupContentsWithHttpInfo( group.namespace, group.name, group.changes = NULL, ... )
Method CreateGroup()
Usage
GroupsApi$CreateGroup(namespace, group.create = NULL, ...)
Method CreateGroupWithHttpInfo()
Usage
GroupsApi$CreateGroupWithHttpInfo(namespace, group.create = NULL, ...)
Method DeleteGroup()
Usage
GroupsApi$DeleteGroup(group.namespace, group.name, ...)
Method DeleteGroupWithHttpInfo()
Usage
GroupsApi$DeleteGroupWithHttpInfo(group.namespace, group.name, ...)
Method GetGroup()
Usage
GroupsApi$GetGroup(group.namespace, group.name, ...)
Method GetGroupWithHttpInfo()
Usage
GroupsApi$GetGroupWithHttpInfo(group.namespace, group.name, ...)
Method GetGroupContents()
Usage
GroupsApi$GetGroupContents( group.namespace, group.name, page = NULL, per.page = NULL, namespace = NULL, search = NULL, orderby = NULL, tag = NULL, exclude.tag = NULL, member.type = NULL, exclude.member.type = NULL, ... )
Method GetGroupContentsWithHttpInfo()
Usage
GroupsApi$GetGroupContentsWithHttpInfo( group.namespace, group.name, page = NULL, per.page = NULL, namespace = NULL, search = NULL, orderby = NULL, tag = NULL, exclude.tag = NULL, member.type = NULL, exclude.member.type = NULL, ... )
Method GetGroupSharingPolicies()
Usage
GroupsApi$GetGroupSharingPolicies(group.namespace, group.name, ...)
Method GetGroupSharingPoliciesWithHttpInfo()
Usage
GroupsApi$GetGroupSharingPoliciesWithHttpInfo(group.namespace, group.name, ...)
Method GroupsBrowserOwnedFiltersGet()
Usage
GroupsApi$GroupsBrowserOwnedFiltersGet(...)
Method GroupsBrowserOwnedFiltersGetWithHttpInfo()
Usage
GroupsApi$GroupsBrowserOwnedFiltersGetWithHttpInfo(...)
Method GroupsBrowserPublicFiltersGet()
Usage
GroupsApi$GroupsBrowserPublicFiltersGet(...)
Method GroupsBrowserPublicFiltersGetWithHttpInfo()
Usage
GroupsApi$GroupsBrowserPublicFiltersGetWithHttpInfo(...)
Method GroupsBrowserSharedFiltersGet()
Usage
GroupsApi$GroupsBrowserSharedFiltersGet(...)
Method GroupsBrowserSharedFiltersGetWithHttpInfo()
Usage
GroupsApi$GroupsBrowserSharedFiltersGetWithHttpInfo(...)
Method GroupsGroupNamespaceGroupNameContentsFiltersGet()
Usage
GroupsApi$GroupsGroupNamespaceGroupNameContentsFiltersGet( group.namespace, group.name, ... )
Method GroupsGroupNamespaceGroupNameContentsFiltersGetWithHttpInfo()
Usage
GroupsApi$GroupsGroupNamespaceGroupNameContentsFiltersGetWithHttpInfo( group.namespace, group.name, ... )
Method ListOwnedGroups()
Usage
GroupsApi$ListOwnedGroups( page = NULL, per.page = NULL, search = NULL, namespace = NULL, orderby = NULL, permissions = NULL, tag = NULL, exclude.tag = NULL, flat = NULL, parent = NULL, ... )
Method ListOwnedGroupsWithHttpInfo()
Usage
GroupsApi$ListOwnedGroupsWithHttpInfo( page = NULL, per.page = NULL, search = NULL, namespace = NULL, orderby = NULL, permissions = NULL, tag = NULL, exclude.tag = NULL, flat = NULL, parent = NULL, ... )
Method ListPublicGroups()
Usage
GroupsApi$ListPublicGroups( page = NULL, per.page = NULL, search = NULL, namespace = NULL, orderby = NULL, permissions = NULL, tag = NULL, exclude.tag = NULL, flat = NULL, parent = NULL, ... )
Method ListPublicGroupsWithHttpInfo()
Usage
GroupsApi$ListPublicGroupsWithHttpInfo( page = NULL, per.page = NULL, search = NULL, namespace = NULL, orderby = NULL, permissions = NULL, tag = NULL, exclude.tag = NULL, flat = NULL, parent = NULL, ... )
Method ListSharedGroups()
Usage
GroupsApi$ListSharedGroups( page = NULL, per.page = NULL, search = NULL, namespace = NULL, orderby = NULL, permissions = NULL, tag = NULL, exclude.tag = NULL, flat = NULL, parent = NULL, shared.to = NULL, ... )
Method ListSharedGroupsWithHttpInfo()
Usage
GroupsApi$ListSharedGroupsWithHttpInfo( page = NULL, per.page = NULL, search = NULL, namespace = NULL, orderby = NULL, permissions = NULL, tag = NULL, exclude.tag = NULL, flat = NULL, parent = NULL, shared.to = NULL, ... )
Method RegisterGroup()
Usage
GroupsApi$RegisterGroup(namespace, array, group.register = NULL, ...)
Method RegisterGroupWithHttpInfo()
Usage
GroupsApi$RegisterGroupWithHttpInfo( namespace, array, group.register = NULL, ... )
Method ShareGroup()
Usage
GroupsApi$ShareGroup(group.namespace, group.name, group.sharing.request, ...)
Method ShareGroupWithHttpInfo()
Usage
GroupsApi$ShareGroupWithHttpInfo( group.namespace, group.name, group.sharing.request, ... )
Method UpdateGroup()
Usage
GroupsApi$UpdateGroup(group.namespace, group.name, group.update = NULL, ...)
Method UpdateGroupWithHttpInfo()
Usage
GroupsApi$UpdateGroupWithHttpInfo( group.namespace, group.name, group.update = NULL, ... )
Method clone()
The objects of this class are cloneable with this method.
Usage
GroupsApi$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
Examples
## Not run:
#################### ChangeGroupContents ####################
library(tiledbcloud)
var.group.namespace <- 'group.namespace_example' # character | The namespace of the group
var.group.name <- 'group.name_example' # character | The unique name or id of the group
var.group.changes <- GroupChanges$new() # GroupChanges |
api.instance <- GroupsApi$new()
#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>';
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';
result <- api.instance$ChangeGroupContents(var.group.namespace, var.group.name, group.changes=var.group.changes)
#################### CreateGroup ####################
library(tiledbcloud)
var.namespace <- 'namespace_example' # character | The namespace of the group
var.group.create <- GroupCreate$new() # GroupCreate |
api.instance <- GroupsApi$new()
#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>';
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';
result <- api.instance$CreateGroup(var.namespace, group.create=var.group.create)
#################### DeleteGroup ####################
library(tiledbcloud)
var.group.namespace <- 'group.namespace_example' # character | The namespace of the group
var.group.name <- 'group.name_example' # character | The unique name or id of the group
api.instance <- GroupsApi$new()
#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>';
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';
result <- api.instance$DeleteGroup(var.group.namespace, var.group.name)
#################### GetGroup ####################
library(tiledbcloud)
var.group.namespace <- 'group.namespace_example' # character | The namespace of the group
var.group.name <- 'group.name_example' # character | The unique name or id of the group
api.instance <- GroupsApi$new()
#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>';
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';
result <- api.instance$GetGroup(var.group.namespace, var.group.name)
#################### GetGroupContents ####################
library(tiledbcloud)
var.group.namespace <- 'group.namespace_example' # character | The namespace of the group
var.group.name <- 'group.name_example' # character | The unique name or id of the group
var.page <- 56 # integer | pagination offset for assets
var.per.page <- 56 # integer | pagination limit for assets
var.namespace <- 'namespace_example' # character | namespace to search for
var.search <- 'search_example' # character | search string that will look at name, namespace or description fields
var.orderby <- 'orderby_example' # character | sort by which field valid values include last_accessed, size, name
var.tag <- ['tag_example'] # array[character] | tag to search for, more than one can be included
var.exclude.tag <- ['exclude.tag_example'] # array[character] | tags to exclude matching array in results, more than one can be included
var.member.type <- ['member.type_example'] # array[character] | member type to search for, more than one can be included
var.exclude.member.type <- ['exclude.member.type_example'] # array[character] | member type to exclude matching groups in results, more than one can be included
api.instance <- GroupsApi$new()
#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>';
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';
result <- api.instance$GetGroupContents(var.group.namespace, var.group.name, page=var.page, per.page=var.per.page, namespace=var.namespace, search=var.search, orderby=var.orderby, tag=var.tag, exclude.tag=var.exclude.tag, member.type=var.member.type, exclude.member.type=var.exclude.member.type)
#################### GetGroupSharingPolicies ####################
library(tiledbcloud)
var.group.namespace <- 'group.namespace_example' # character | The namespace of the group
var.group.name <- 'group.name_example' # character | The unique name or id of the group
api.instance <- GroupsApi$new()
#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>';
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';
result <- api.instance$GetGroupSharingPolicies(var.group.namespace, var.group.name)
#################### GroupsBrowserOwnedFiltersGet ####################
library(tiledbcloud)
api.instance <- GroupsApi$new()
#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>';
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';
result <- api.instance$GroupsBrowserOwnedFiltersGet()
#################### GroupsBrowserPublicFiltersGet ####################
library(tiledbcloud)
api.instance <- GroupsApi$new()
#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>';
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';
result <- api.instance$GroupsBrowserPublicFiltersGet()
#################### GroupsBrowserSharedFiltersGet ####################
library(tiledbcloud)
api.instance <- GroupsApi$new()
#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>';
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';
result <- api.instance$GroupsBrowserSharedFiltersGet()
#################### GroupsGroupNamespaceGroupNameContentsFiltersGet ####################
library(tiledbcloud)
var.group.namespace <- 'group.namespace_example' # character | The namespace of the group
var.group.name <- 'group.name_example' # character | The unique name or id of the group
api.instance <- GroupsApi$new()
#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>';
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';
result <- api.instance$GroupsGroupNamespaceGroupNameContentsFiltersGet(var.group.namespace, var.group.name)
#################### ListOwnedGroups ####################
library(tiledbcloud)
var.page <- 56 # integer | pagination offset
var.per.page <- 56 # integer | pagination limit
var.search <- 'search_example' # character | search string that will look at name, namespace or description fields
var.namespace <- 'namespace_example' # character | namespace
var.orderby <- 'orderby_example' # character | sort by which field valid values include last_accessed, size, name
var.permissions <- 'permissions_example' # character | permissions valid values include read, read_write, write, admin
var.tag <- ['tag_example'] # array[character] | tag to search for, more than one can be included
var.exclude.tag <- ['exclude.tag_example'] # array[character] | tags to exclude matching array in results, more than one can be included
var.flat <- 'flat_example' # character | if true, ignores the nesting of groups and searches all of them
var.parent <- 'parent_example' # character | search only the children of the groups with this uuid
api.instance <- GroupsApi$new()
#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>';
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';
result <- api.instance$ListOwnedGroups(page=var.page, per.page=var.per.page, search=var.search, namespace=var.namespace, orderby=var.orderby, permissions=var.permissions, tag=var.tag, exclude.tag=var.exclude.tag, flat=var.flat, parent=var.parent)
#################### ListPublicGroups ####################
library(tiledbcloud)
var.page <- 56 # integer | pagination offset
var.per.page <- 56 # integer | pagination limit
var.search <- 'search_example' # character | search string that will look at name, namespace or description fields
var.namespace <- 'namespace_example' # character | namespace
var.orderby <- 'orderby_example' # character | sort by which field valid values include last_accessed, size, name
var.permissions <- 'permissions_example' # character | permissions valid values include read, read_write, write, admin
var.tag <- ['tag_example'] # array[character] | tag to search for, more than one can be included
var.exclude.tag <- ['exclude.tag_example'] # array[character] | tags to exclude matching array in results, more than one can be included
var.flat <- 'flat_example' # character | if true, ignores the nesting of groups and searches all of them
var.parent <- 'parent_example' # character | search only the children of the groups with this uuid
api.instance <- GroupsApi$new()
#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>';
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';
result <- api.instance$ListPublicGroups(page=var.page, per.page=var.per.page, search=var.search, namespace=var.namespace, orderby=var.orderby, permissions=var.permissions, tag=var.tag, exclude.tag=var.exclude.tag, flat=var.flat, parent=var.parent)
#################### ListSharedGroups ####################
library(tiledbcloud)
var.page <- 56 # integer | pagination offset
var.per.page <- 56 # integer | pagination limit
var.search <- 'search_example' # character | search string that will look at name, namespace or description fields
var.namespace <- 'namespace_example' # character | namespace
var.orderby <- 'orderby_example' # character | sort by which field valid values include last_accessed, size, name
var.permissions <- 'permissions_example' # character | permissions valid values include read, read_write, write, admin
var.tag <- ['tag_example'] # array[character] | tag to search for, more than one can be included
var.exclude.tag <- ['exclude.tag_example'] # array[character] | tags to exclude matching array in results, more than one can be included
var.flat <- 'flat_example' # character | if true, ignores the nesting of groups and searches all of them
var.parent <- 'parent_example' # character | search only the children of the groups with this uuid
var.shared.to <- ['shared.to_example'] # array[character] | namespaces to filter results of where there groups were shared to
api.instance <- GroupsApi$new()
#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>';
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';
result <- api.instance$ListSharedGroups(page=var.page, per.page=var.per.page, search=var.search, namespace=var.namespace, orderby=var.orderby, permissions=var.permissions, tag=var.tag, exclude.tag=var.exclude.tag, flat=var.flat, parent=var.parent, shared.to=var.shared.to)
#################### RegisterGroup ####################
library(tiledbcloud)
var.namespace <- 'namespace_example' # character | The namespace of the group
var.array <- 'array_example' # character | The unique name or id of the group
var.group.register <- GroupRegister$new() # GroupRegister |
api.instance <- GroupsApi$new()
#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>';
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';
result <- api.instance$RegisterGroup(var.namespace, var.array, group.register=var.group.register)
#################### ShareGroup ####################
library(tiledbcloud)
var.group.namespace <- 'group.namespace_example' # character | The namespace of the group
var.group.name <- 'group.name_example' # character | The unique name or id of the group
var.group.sharing.request <- GroupSharingRequest$new() # GroupSharingRequest | Namespace and list of permissions to share with. Sharing is recursive, it is applied to all reachable subgroups and arrays of the group. An empty list of permissions will remove the namespace; if permissions already exist they will be deleted then new ones added. In the event of a failure, the new policies will be rolled back to prevent partial policies, and it's likely the group will not be shared with the namespace at all.
api.instance <- GroupsApi$new()
#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>';
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';
result <- api.instance$ShareGroup(var.group.namespace, var.group.name, var.group.sharing.request)
#################### UpdateGroup ####################
library(tiledbcloud)
var.group.namespace <- 'group.namespace_example' # character | The namespace of the group
var.group.name <- 'group.name_example' # character | The unique name or id of the group
var.group.update <- GroupUpdate$new() # GroupUpdate |
api.instance <- GroupsApi$new()
#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';
#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>';
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';
result <- api.instance$UpdateGroup(var.group.namespace, var.group.name, group.update=var.group.update)
## End(Not run)
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.