Groups operations

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

apiClient

Handles the client-server communication.

Methods

Public methods

• GroupsApi$new()

• GroupsApi$ChangeGroupContents()

• GroupsApi$ChangeGroupContentsWithHttpInfo()

• GroupsApi$CreateGroup()

• GroupsApi$CreateGroupWithHttpInfo()

• GroupsApi$DeleteGroup()

• GroupsApi$DeleteGroupWithHttpInfo()

• GroupsApi$GetGroup()

• GroupsApi$GetGroupWithHttpInfo()

• GroupsApi$GetGroupContents()

• GroupsApi$GetGroupContentsWithHttpInfo()

• GroupsApi$GetGroupSharingPolicies()

• GroupsApi$GetGroupSharingPoliciesWithHttpInfo()

• GroupsApi$GroupsBrowserOwnedFiltersGet()

• GroupsApi$GroupsBrowserOwnedFiltersGetWithHttpInfo()

• GroupsApi$GroupsBrowserPublicFiltersGet()

• GroupsApi$GroupsBrowserPublicFiltersGetWithHttpInfo()

• GroupsApi$GroupsBrowserSharedFiltersGet()

• GroupsApi$GroupsBrowserSharedFiltersGetWithHttpInfo()

• GroupsApi$GroupsGroupNamespaceGroupNameContentsFiltersGet()

• GroupsApi$GroupsGroupNamespaceGroupNameContentsFiltersGetWithHttpInfo()

• GroupsApi$ListOwnedGroups()

• GroupsApi$ListOwnedGroupsWithHttpInfo()

• GroupsApi$ListPublicGroups()

• GroupsApi$ListPublicGroupsWithHttpInfo()

• GroupsApi$ListSharedGroups()

• GroupsApi$ListSharedGroupsWithHttpInfo()

• GroupsApi$RegisterGroup()

• GroupsApi$RegisterGroupWithHttpInfo()

• GroupsApi$ShareGroup()

• GroupsApi$ShareGroupWithHttpInfo()

• GroupsApi$UpdateGroup()

• GroupsApi$UpdateGroupWithHttpInfo()

• GroupsApi$clone()

---

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

deep

Whether to make a deep clone.

Examples