DataSphere API v2, gRPC: CommunityService
A set of methods for managing Community resources.
Call | Description |
---|---|
Create | Creates community in specified organization. |
Get | Returns community. |
Update | Updates specified community. |
Delete | Deletes specified community. |
List | List communities in specified organization. |
ListAccessBindings | Lists access bindings for specified community. |
SetAccessBindings | Sets access bindings for specified community. |
UpdateAccessBindings | Updates access bindings for specified community. |
AddResource | Adds shared resource to community |
RemoveResource | Removes shared resource from community |
Calls CommunityService
Create
Creates community in specified organization.
rpc Create (CreateCommunityRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:CreateCommunityMetadata
Operation.response:Community
CreateCommunityRequest
Field | Description |
---|---|
name | string Name of the community. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9\u0401\u0451\u0410-\u044f]\\S{1,61}[a-zA-Z0-9\u0401\u0451\u0410-\u044f] . |
description | string Description of the community. |
organization_id | string Required. ID of the organization where community should be created. |
billing_account_id | string ID of the billing account for the created community. Optional, billing account could be bound to community later. |
labels | map<string,string> Labels of the community. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
CreateCommunityMetadata
Field | Description |
---|---|
community_id | string ID of the community that is being created. |
Community
Field | Description |
---|---|
id | string ID of the community. |
created_at | google.protobuf.Timestamp Time when community was created. |
name | string Name of the community. |
description | string Description of the comminuty. |
labels | 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. |
Get
Returns community.
rpc Get (GetCommunityRequest) returns (Community)
GetCommunityRequest
Field | Description |
---|---|
community_id | string Required. ID of the community. |
Community
Field | Description |
---|---|
id | string ID of the community. |
created_at | google.protobuf.Timestamp Time when community was created. |
name | string Name of the community. |
description | string Description of the comminuty. |
labels | 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. |
Update
Updates specified community.
rpc Update (UpdateCommunityRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:UpdateCommunityMetadata
Operation.response:Community
UpdateCommunityRequest
Field | Description |
---|---|
community_id | string Required. ID of the community. |
update_mask | google.protobuf.FieldMask 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 | map<string,string> Labels of the community. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
UpdateCommunityMetadata
Field | Description |
---|---|
community_id | string ID of the community that is being updated. |
Community
Field | Description |
---|---|
id | string ID of the community. |
created_at | google.protobuf.Timestamp Time when community was created. |
name | string Name of the community. |
description | string Description of the comminuty. |
labels | 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. |
Delete
Deletes specified community.
rpc Delete (DeleteCommunityRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:DeleteCommunityMetadata
Operation.response:google.protobuf.Empty
DeleteCommunityRequest
Field | Description |
---|---|
community_id | string Required. ID of the community. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
DeleteCommunityMetadata
Field | Description |
---|---|
community_id | string ID of the community that is being deleted. |
List
List communities in specified organization.
rpc List (ListCommunitiesRequest) returns (ListCommunitiesResponse)
ListCommunitiesRequest
Field | Description |
---|---|
page_size | int64 The maximum number of results per page to return. If the number of available results is larger than page_size , the service returns a ListCommunitiesResponse.next_page_token that can be used to get the next page of results in subsequent list requests. |
page_token | string Page token. To get the next page of results, set page_token to the ListCommunitiesResponse.next_page_token returned by a previous list request. |
name_or_description_pattern | string Community name or description pattern. Only communities with names or descriptions matching specified pattern will be returned. |
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. ID of the organization to list communities in. |
ListCommunitiesResponse
Field | Description |
---|---|
communities[] | Community 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 is larger than ListCommunitiesRequest.page_size, use the next_page_token as the value for the ListCommunitiesRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results. |
Community
Field | Description |
---|---|
id | string ID of the community. |
created_at | google.protobuf.Timestamp Time when community was created. |
name | string Name of the community. |
description | string Description of the comminuty. |
labels | 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. |
ListAccessBindings
Lists access bindings for specified community.
rpc ListAccessBindings (ListAccessBindingsRequest) returns (ListAccessBindingsResponse)
ListAccessBindingsRequest
Field | Description |
---|---|
resource_id | string Required. ID of the resource to list access bindings for. To get the resource ID, use a corresponding List request. For example, use the yandex.cloud.resourcemanager.v1.CloudService.List request to get the Cloud resource ID. The maximum string length in characters is 50. |
page_size | int64 The maximum number of results per page that should be returned. If the number of available results is larger than page_size , the service returns a ListAccessBindingsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Default value: 100. The maximum value is 1000. |
page_token | string Page token. Set page_token to the ListAccessBindingsResponse.next_page_token returned by a previous list request to get the next page of results. The maximum string length in characters is 100. |
ListAccessBindingsResponse
Field | Description |
---|---|
access_bindings[] | AccessBinding List of access bindings for the specified resource. |
next_page_token | string This token allows you to get the next page of results for list requests. If the number of results is larger than ListAccessBindingsRequest.page_size, use the next_page_token as the value for the ListAccessBindingsRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results. |
AccessBinding
Field | Description |
---|---|
role_id | string Required. ID of the yandex.cloud.iam.v1.Role that is assigned to the subject . The maximum string length in characters is 50. |
subject | Subject Required. Identity for which access binding is being created. It can represent an account with a unique ID or several accounts with a system identifier. |
Subject
Field | Description |
---|---|
id | string Required. ID of the subject. It can contain one of the following values:
type is system .
type is userAccount , federatedUser or serviceAccount . The maximum string length in characters is 50. |
type | string Required. Type of the subject. It can contain one of the following values:
For more information, see Subject to which the role is assigned. The maximum string length in characters is 100. |
SetAccessBindings
Sets access bindings for specified community.
rpc SetAccessBindings (SetAccessBindingsRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:SetCommunityAccessBindingsMetadata
Operation.response:google.protobuf.Empty
SetAccessBindingsRequest
Field | Description |
---|---|
resource_id | string Required. ID of the resource for which access bindings are being set. To get the resource ID, use a corresponding List request. The maximum string length in characters is 50. |
access_bindings[] | AccessBinding Required. Access bindings to be set. For more information, see Access Bindings. |
AccessBinding
Field | Description |
---|---|
role_id | string Required. ID of the yandex.cloud.iam.v1.Role that is assigned to the subject . The maximum string length in characters is 50. |
subject | Subject Required. Identity for which access binding is being created. It can represent an account with a unique ID or several accounts with a system identifier. |
Subject
Field | Description |
---|---|
id | string Required. ID of the subject. It can contain one of the following values:
type is system .
type is userAccount , federatedUser or serviceAccount . The maximum string length in characters is 50. |
type | string Required. Type of the subject. It can contain one of the following values:
For more information, see Subject to which the role is assigned. The maximum string length in characters is 100. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
SetCommunityAccessBindingsMetadata
Field | Description |
---|---|
community_id | string ID of the community which access bindings are set. |
UpdateAccessBindings
Updates access bindings for specified community.
rpc UpdateAccessBindings (UpdateAccessBindingsRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:UpdateCommunityAccessBindingsMetadata
Operation.response:google.protobuf.Empty
UpdateAccessBindingsRequest
Field | Description |
---|---|
resource_id | string Required. ID of the resource for which access bindings are being updated. The maximum string length in characters is 50. |
access_binding_deltas[] | AccessBindingDelta Required. Updates to access bindings. The number of elements must be greater than 0. |
AccessBindingDelta
Field | Description |
---|---|
action | enum AccessBindingAction Required. The action that is being performed on an access binding.
|
access_binding | AccessBinding Required. Access binding. For more information, see Access Bindings. |
AccessBinding
Field | Description |
---|---|
role_id | string Required. ID of the yandex.cloud.iam.v1.Role that is assigned to the subject . The maximum string length in characters is 50. |
subject | Subject Required. Identity for which access binding is being created. It can represent an account with a unique ID or several accounts with a system identifier. |
Subject
Field | Description |
---|---|
id | string Required. ID of the subject. It can contain one of the following values:
type is system .
type is userAccount , federatedUser or serviceAccount . The maximum string length in characters is 50. |
type | string Required. Type of the subject. It can contain one of the following values:
For more information, see Subject to which the role is assigned. The maximum string length in characters is 100. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
UpdateCommunityAccessBindingsMetadata
Field | Description |
---|---|
community_id | string ID of the community which access bindings are updated. |
AddResource
Adds shared resource to community
rpc AddResource (AddCommunityResourceRequest) returns (operation.Operation)
Response of Operation:
Operation.response:google.protobuf.Empty
AddCommunityResourceRequest
Field | Description |
---|---|
community_id | string Required. The maximum string length in characters is 50. |
resource_type | enum ResourceType Required. |
resource_id | string Required. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
RemoveResource
Removes shared resource from community
rpc RemoveResource (RemoveCommunityResourceRequest) returns (operation.Operation)
Response of Operation:
Operation.response:google.protobuf.Empty
RemoveCommunityResourceRequest
Field | Description |
---|---|
community_id | string Required. The maximum string length in characters is 50. |
resource_type | enum ResourceType Required. |
resource_id | string Required. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |