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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
|
syntax = "proto3";
package yandex.cloud.mdb.elasticsearch.v1;
import "google/api/annotations.proto";
import "google/protobuf/field_mask.proto";
import "yandex/cloud/operation/operation.proto";
import "yandex/cloud/validation.proto";
import "yandex/cloud/mdb/elasticsearch/v1/user.proto";
import "yandex/cloud/api/operation.proto";
option go_package = "github.com/yandex-cloud/go-genproto/yandex/cloud/mdb/elasticsearch/v1;elasticsearch";
option java_package = "yandex.cloud.api.mdb.elasticsearch.v1";
// A set of methods for managing Elasticsearch users.
service UserService {
// Returns the specified Elasticsearch user.
//
// To get the list of available Elasticsearch users, make a [List] request.
rpc Get (GetUserRequest) returns (User) {
option (google.api.http) = { get: "/managed-elasticsearch/v1/clusters/{cluster_id}/users/{user_name}" };
}
// Retrieves the list of Elasticsearch users in the specified cluster.
rpc List (ListUsersRequest) returns (ListUsersResponse) {
option (google.api.http) = { get: "/managed-elasticsearch/v1/clusters/{cluster_id}/users" };
}
// Creates a user in the specified cluster.
rpc Create (CreateUserRequest) returns (operation.Operation) {
option (google.api.http) = { post: "/managed-elasticsearch/v1/clusters/{cluster_id}/users" body: "*" };
option (yandex.cloud.api.operation) = {
metadata: "CreateUserMetadata"
response: "User"
};
}
// Updates the specified user.
rpc Update (UpdateUserRequest) returns (operation.Operation) {
option (google.api.http) = { patch: "/managed-elasticsearch/v1/clusters/{cluster_id}/users/{user_name}" body: "*" };
option (yandex.cloud.api.operation) = {
metadata: "UpdateUserMetadata"
response: "User"
};
}
// Deletes the specified user.
rpc Delete (DeleteUserRequest) returns (operation.Operation) {
option (google.api.http) = { delete: "/managed-elasticsearch/v1/clusters/{cluster_id}/users/{user_name}" };
option (yandex.cloud.api.operation) = {
metadata: "DeleteUserMetadata"
response: "google.protobuf.Empty"
};
}
}
message GetUserRequest {
// ID of the Elasticsearch cluster the user belongs to.
//
// To get the cluster ID, make a [ClusterService.List] request.
string cluster_id = 1 [(required) = true, (length) = "<=50"];
// Name of the Elasticsearch user to return.
//
// To get the name of the user, make a [UserService.List] request.
string user_name = 2 [(required) = true, (length) = "<=63", (pattern) = "[a-zA-Z0-9_]*"];
}
message ListUsersRequest {
// ID of the Elasticsearch cluster to list Elasticsearch users in.
//
// To get the cluster ID, use a [ClusterService.List] request.
string cluster_id = 1 [(required) = true, (length) = "<=50"];
// The maximum number of results per page to return.
//
//If the number of available results is larger than `page_size`, the service returns a [ListUsersResponse.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 [ListUsersResponse.next_page_token] returned by the previous list request.
string page_token = 3 [(length) = "<=100"];
}
message ListUsersResponse {
// List of Elasticsearch users.
repeated User users = 1;
// This token allows you to get the next page of results for list requests.
//
// If the number of results is larger than [ListUsersRequest.page_size], use the `next_page_token` as the value for the [ListUsersRequest.page_token] 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;
}
message CreateUserRequest {
// ID of the Elasticsearch cluster to create a user in.
//
// To get the cluster ID, make a [ClusterService.List] request.
string cluster_id = 1 [(required) = true, (length) = "<=50"];
// Configuration of the user to create.
UserSpec user_spec = 2 [(required) = true];
}
message CreateUserMetadata {
// ID of the Elasticsearch cluster the user is being created in.
string cluster_id = 1;
// Name of the user that is being created.
string user_name = 2;
}
message UpdateUserRequest {
// ID of the Elasticsearch cluster the user belongs to.
//
// To get the cluster ID, make a [ClusterService.List] request.
string cluster_id = 1 [(required) = true, (length) = "<=50"];
// Name of the user to be updated.
//
// To get the name of the user, make a [UserService.List] request.
string user_name = 2 [(required) = true, (length) = "1-63", (pattern) = "[a-zA-Z0-9_]*"];
google.protobuf.FieldMask update_mask = 3;
// New password for the user.
string password = 4 [(length) = "8-128"];
}
message UpdateUserMetadata {
// ID of the Elasticsearch cluster the user belongs to.
string cluster_id = 1;
// Name of the user that is being updated.
string user_name = 2;
}
message DeleteUserRequest {
// ID of the Elasticsearch cluster the user belongs to.
//
// To get the cluster ID, make a [ClusterService.List] request.
string cluster_id = 1 [(required) = true, (length) = "<=50"];
// Name of the user to delete.
//
// To get the name of the user, make a [UserService.List] request.
string user_name = 2 [(required) = true, (length) = "1-63", (pattern) = "[a-zA-Z0-9_]*"];
}
message DeleteUserMetadata {
// ID of the Elasticsearch cluster the user belongs to.
string cluster_id = 1;
// Name of the user that is being deleted.
string user_name = 2;
}
|
