DataSphere API v2, gRPC: CommunityService.Update
Updates specified community.
gRPC request
rpc Update (UpdateCommunityRequest) returns (operation.Operation)
UpdateCommunityRequest
{
"communityId": "string",
"updateMask": "google.protobuf.FieldMask",
"name": "string",
"description": "string",
"labels": "string"
}
Field |
Description |
communityId |
string Required field. ID of the community. |
updateMask |
Field mask that specifies which fields of the Community resource are going to be updated. |
name |
string Name of the community. |
description |
string Description of the community. |
labels |
string Labels of the community. |
operation.Operation
{
"id": "string",
"description": "string",
"createdAt": "google.protobuf.Timestamp",
"createdBy": "string",
"modifiedAt": "google.protobuf.Timestamp",
"done": "bool",
"metadata": {
"communityId": "string"
},
// Includes only one of the fields `error`, `response`
"error": "google.rpc.Status",
"response": {
"id": "string",
"createdAt": "google.protobuf.Timestamp",
"name": "string",
"description": "string",
"labels": "string",
"createdById": "string",
"organizationId": "string",
"zoneId": "string"
}
// end of the list of possible fields
}
An Operation resource. For more information, see Operation.
Field |
Description |
id |
string ID of the operation. |
description |
string Description of the operation. 0-256 characters long. |
createdAt |
Creation timestamp. |
createdBy |
string ID of the user or service account who initiated the operation. |
modifiedAt |
The time when the Operation resource was last modified. |
done |
bool If the value is |
metadata |
Service-specific metadata associated with the operation. |
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
response |
The normal response of the operation in case of success. Includes only one of the fields The operation result. |
UpdateCommunityMetadata
Field |
Description |
communityId |
string ID of the community that is being updated. |
Community
Field |
Description |
id |
string ID of the community. |
createdAt |
Time when community was created. |
name |
string Name of the community. |
description |
string Description of the comminuty. |
labels |
string Labels of the community. |
createdById |
string ID of the user who created the community. |
organizationId |
string ID of the organization to which community belongs. |
zoneId |
string ID of the zone where this community was created |