Skip to content

Latest commit

 

History

History
116 lines (88 loc) · 4 KB

removeResource.md

File metadata and controls

116 lines (88 loc) · 4 KB
editable sourcePath
false
en/_api-ref-grpc/datasphere/v2/api-ref/grpc/Community/removeResource.md

DataSphere API v2, gRPC: CommunityService.RemoveResource

Removes shared resource from community

gRPC request

rpc RemoveResource (RemoveCommunityResourceRequest) returns (operation.Operation)

RemoveCommunityResourceRequest {#yandex.cloud.datasphere.v2.RemoveCommunityResourceRequest}

{
  "community_id": "string",
  "resource_type": "ResourceType",
  "resource_id": "string"
}

#| ||Field | Description || || community_id | string

Required field. || || resource_type | enum ResourceType

Required field.

  • RESOURCE_TYPE_UNSPECIFIED
  • RESOURCE_TYPE_SECRET
  • RESOURCE_TYPE_DOCKER_IMAGE
  • RESOURCE_TYPE_DATASET
  • RESOURCE_TYPE_S3
  • RESOURCE_TYPE_NODE
  • RESOURCE_TYPE_ALIAS || || resource_id | string

Required field. || |#

operation.Operation {#yandex.cloud.operation.Operation}

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": "google.protobuf.Any",
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": "google.protobuf.Empty"
  // 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. || || 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. || || error | google.rpc.Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, 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. || || response | google.protobuf.Empty

The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, 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. || |#