DataSphere API v2, gRPC: CommunityService.List
List communities in specified organization.
gRPC request
rpc List (ListCommunitiesRequest) returns (ListCommunitiesResponse)
ListCommunitiesRequest
{
"page_size": "int64",
"page_token": "string",
"name_or_description_pattern": "string",
"owned_by_id": "string",
"list_public": "bool",
"organization_id": "string"
}
|
Field |
Description |
|
page_size |
int64 The maximum number of results per page to return. If the number of available |
|
page_token |
string Page token. To get the next page of results, set |
|
name_or_description_pattern |
string Community name or description pattern. |
|
owned_by_id |
string ID of the user. Only communities owned by specified user will be returned. |
|
list_public |
bool If set to true, only public communities will be returned. |
|
organization_id |
string Required field. ID of the organization to list communities in. |
ListCommunitiesResponse
{
"communities": [
{
"id": "string",
"created_at": "google.protobuf.Timestamp",
"name": "string",
"description": "string",
"labels": "map<string, string>",
"created_by_id": "string",
"organization_id": "string",
"zone_id": "string"
}
],
"next_page_token": "string"
}
|
Field |
Description |
|
communities[] |
List of communities matching filters in list communities request. |
|
next_page_token |
string This token allows you to get the next page of results for list requests. If the number of results |
Community
|
Field |
Description |
|
id |
string ID of the community. |
|
created_at |
Time when community was created. |
|
name |
string Name of the community. |
|
description |
string Description of the comminuty. |
|
labels |
object (map<string, string>) Labels of the community. |
|
created_by_id |
string ID of the user who created the community. |
|
organization_id |
string ID of the organization to which community belongs. |
|
zone_id |
string ID of the zone where this community was created |