kikimr/yndx/api/grpc/ydb_yndx_rate_limiter_v1.proto


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

syntax = "proto3";

package Ydb.Yndx.RateLimiter.V1;

option java_package = "com.yandex.ydb.yndx.rate_limiter.v1";
option java_outer_classname = "YndxRateLimiterGrpc";
option java_multiple_files = true;

import "kikimr/yndx/api/protos/ydb_yndx_rate_limiter.proto";

// Service that implements distributed rate limiting and accounting.
//
// To use rate limiter functionality you need an existing coordination node.

service YndxRateLimiterService {
    // Control plane API

    // Create a new resource in existing coordination node.
    rpc CreateResource(CreateResourceRequest) returns (CreateResourceResponse);

    // Update a resource in coordination node.
    rpc AlterResource(AlterResourceRequest) returns (AlterResourceResponse);

    // Delete a resource from coordination node.
    rpc DropResource(DropResourceRequest) returns (DropResourceResponse);

    // List resources in given coordination node.
    rpc ListResources(ListResourcesRequest) returns (ListResourcesResponse);

    // Describe properties of resource in coordination node.
    rpc DescribeResource(DescribeResourceRequest) returns (DescribeResourceResponse);

    // Take units for usage of a resource in coordination node.
    rpc AcquireResource(AcquireResourceRequest) returns (AcquireResourceResponse);
}