aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/libs/yandex-cloud-api-protos/yandex/cloud/billing/v1/service_service.proto
blob: bd6f54a67bc7a017b16c10321aed9e5bd379cdef (plain) (blame)
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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
syntax = "proto3";

package yandex.cloud.billing.v1;

import "google/api/annotations.proto";

import "yandex/cloud/billing/v1/service.proto";
import "yandex/cloud/validation.proto";

option go_package = "github.com/yandex-cloud/go-genproto/yandex/cloud/billing/v1;billing";
option java_package = "yandex.cloud.api.billing.v1";


// A set of methods for managing Service resources.
service ServiceService {

    // Returns the specified service.
    rpc Get(GetServiceRequest) returns (Service) {
        option (google.api.http) = { get: "/billing/v1/services/{id}" };
    };

    // Retrieves the list of services.
    rpc List(ListServicesRequest) returns (ListServicesResponse){
        option (google.api.http) = { get: "/billing/v1/services" };
    };

}

message GetServiceRequest {
    // ID of the service to return.
    // To get the service ID, use [ServiceService.List] request.
    string id = 1 [(required) = true, (length) = "<=50"];
}

message ListServicesRequest {

    // A filter expression that filters resources listed in the response.
    // The expression must specify:
    // 1. The field name. Currently you can use filtering only on the [yandex.cloud.billing.v1.Service.id] field.
    // 2. An `=` operator.
    // 3. The value in double quotes (`"`). Must be 3-63 characters long and match the regular expression `[a-z][-a-z0-9]{1,61}[a-z0-9]`.
    string filter = 1 [(length) = "<=1000"];

    // The maximum number of results per page to return. If the number of available
    // results is larger than [page_size],
    // the service returns a [ListServicesResponse.next_page_token]
    // that can be used to get the next page of results in subsequent list requests.
    int64 page_size = 2 [(value) = "<=1000"];

    // Page token. To get the next page of results,
    // set [page_token] to the [ListServicesResponse.next_page_token]
    // returned by a previous list request.
    string page_token = 3 [(length) = "<=100"];
}

message ListServicesResponse {

    // List of services.
    repeated Service services = 1;

    // This token allows you to get the next page of results for list requests. If the number of results
    // is larger than [ListServicesRequest.page_size], use
    // [next_page_token] as the value
    // for the [ListServicesRequest.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.
    string next_page_token = 2;
}