ark-grpc 0.9.0

gRPC client for Ark server communication
Documentation 
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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208

// This file is @generated by prost-build.
/// GatewaySpec holds gRPC gateway configurations.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GatewaySpec {
    /// endpoints hold a series of endpoint binding specs.
    #[prost(message, repeated, tag = "1")]
    pub endpoints: ::prost::alloc::vec::Vec<EndpointBinding>,
}
/// EndpointBinding is a gRPC method - HTTP endpoint binding specification.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct EndpointBinding {
    /// selector is a dot-separated gRPC service method selector.
    ///
    /// If the selector begins with '~.', the current proto package will be added to the beginning
    /// of the path. For instance: `~.MyService`. Since no proto package can be deduced in the
    /// global config file, this alias cannot be used in the global config file.
    ///
    /// If the selector does not begin with '~.', it will be treated as a fully qualified method
    /// name (FQMN).
    #[prost(string, tag = "1")]
    pub selector: ::prost::alloc::string::String,
    /// body is a request message field selector that will be read via HTTP body.
    ///
    /// '\*' indicates that the entire request message gets decoded from the body.
    /// An empty string indicates that no part of the request gets decoded from the body.
    ///
    /// NOTE: Not all methods support HTTP body.
    #[prost(string, tag = "8")]
    pub body: ::prost::alloc::string::String,
    /// response_body is a response message field selector that will be written to HTTP response.
    ///
    /// '\*' or an empty string indicates that the entire response message gets encoded.
    #[prost(string, tag = "9")]
    pub response_body: ::prost::alloc::string::String,
    /// query_params are explicit query parameter bindings that can be used to rename
    /// or ignore query parameters.
    #[prost(message, repeated, tag = "10")]
    pub query_params: ::prost::alloc::vec::Vec<QueryParameterBinding>,
    /// additional_bindings holds additional bindings for the same gRPC service method.
    #[prost(message, repeated, tag = "11")]
    pub additional_bindings: ::prost::alloc::vec::Vec<AdditionalEndpointBinding>,
    /// disable_query_param_discovery can be used to avoid auto binding query parameters.
    #[prost(bool, tag = "12")]
    pub disable_query_param_discovery: bool,
    /// stream holds configurations for streaming methods.
    #[prost(message, optional, tag = "13")]
    pub stream: ::core::option::Option<StreamConfig>,
    /// pattern specifies the HTTP method for this endpoint binding.
    #[prost(oneof = "endpoint_binding::Pattern", tags = "2, 3, 4, 5, 6, 7")]
    pub pattern: ::core::option::Option<endpoint_binding::Pattern>,
}
/// Nested message and enum types in `EndpointBinding`.
pub mod endpoint_binding {
    /// pattern specifies the HTTP method for this endpoint binding.
    #[derive(Clone, PartialEq, Eq, Hash, ::prost::Oneof)]
    pub enum Pattern {
        #[prost(string, tag = "2")]
        Get(::prost::alloc::string::String),
        #[prost(string, tag = "3")]
        Put(::prost::alloc::string::String),
        #[prost(string, tag = "4")]
        Post(::prost::alloc::string::String),
        #[prost(string, tag = "5")]
        Delete(::prost::alloc::string::String),
        #[prost(string, tag = "6")]
        Patch(::prost::alloc::string::String),
        /// custom can be used for custom HTTP methods.
        ///
        /// Not all HTTP methods are supported in OpenAPI specification, however and will not be
        /// included in the generated OpenAPI document.
        #[prost(message, tag = "7")]
        Custom(super::CustomPattern),
    }
}
/// AdditionalEndpointBinding is an additional gRPC method - HTTP endpoint binding specification.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct AdditionalEndpointBinding {
    /// body is a request message field selector that will be read via HTTP body.
    ///
    /// '\*' indicates that the entire request message gets decoded from the body.
    /// An empty string indicates that no part of the request gets decoded from the body.
    ///
    /// NOTE: Not all methods support HTTP body.
    #[prost(string, tag = "8")]
    pub body: ::prost::alloc::string::String,
    /// response_body is a response message field selector that will be written to HTTP response.
    ///
    /// '\*' or an empty string indicates that the entire response message gets encoded.
    #[prost(string, tag = "9")]
    pub response_body: ::prost::alloc::string::String,
    /// query_params are explicit query parameter bindings that can be used to rename
    /// or ignore query parameters.
    #[prost(message, repeated, tag = "10")]
    pub query_params: ::prost::alloc::vec::Vec<QueryParameterBinding>,
    /// disable_query_param_discovery can be used to avoid auto binding query parameters.
    #[prost(bool, tag = "11")]
    pub disable_query_param_discovery: bool,
    /// stream holds configurations for streaming methods.
    #[prost(message, optional, tag = "12")]
    pub stream: ::core::option::Option<StreamConfig>,
    /// pattern specifies the HTTP method for this additional endpoint binding.
    #[prost(
        oneof = "additional_endpoint_binding::Pattern",
        tags = "2, 3, 4, 5, 6, 7"
    )]
    pub pattern: ::core::option::Option<additional_endpoint_binding::Pattern>,
}
/// Nested message and enum types in `AdditionalEndpointBinding`.
pub mod additional_endpoint_binding {
    /// pattern specifies the HTTP method for this additional endpoint binding.
    #[derive(Clone, PartialEq, Eq, Hash, ::prost::Oneof)]
    pub enum Pattern {
        #[prost(string, tag = "2")]
        Get(::prost::alloc::string::String),
        #[prost(string, tag = "3")]
        Put(::prost::alloc::string::String),
        #[prost(string, tag = "4")]
        Post(::prost::alloc::string::String),
        #[prost(string, tag = "5")]
        Delete(::prost::alloc::string::String),
        #[prost(string, tag = "6")]
        Patch(::prost::alloc::string::String),
        /// custom can be used for custom HTTP methods.
        ///
        /// Not all HTTP methods are supported in OpenAPI specification, however and will not be
        /// included in the generated OpenAPI document.
        #[prost(message, tag = "7")]
        Custom(super::CustomPattern),
    }
}
/// CustomPattern describes an HTTP pattern and custom method.
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct CustomPattern {
    /// method is the custom HTTP method.
    #[prost(string, tag = "1")]
    pub method: ::prost::alloc::string::String,
    /// path is the HTTP path pattern.
    #[prost(string, tag = "2")]
    pub path: ::prost::alloc::string::String,
}
/// QueryParameterBinding describes a query parameter to request message binding.
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct QueryParameterBinding {
    /// selector is a dot-separated path to the request message's field.
    #[prost(string, tag = "1")]
    pub selector: ::prost::alloc::string::String,
    /// name is the name of the HTTP query parameter that will be used.
    #[prost(string, tag = "2")]
    pub name: ::prost::alloc::string::String,
    /// ignore avoids reading this query parameter altogether (default: false).
    #[prost(bool, tag = "3")]
    pub ignore: bool,
}
/// StreamConfig sets the behavior of the HTTP server for gRPC streaming methods.
#[derive(Clone, Copy, PartialEq, Eq, Hash, ::prost::Message)]
pub struct StreamConfig {
    /// disable_websockets indicates whether or not websockets are allowed for this method.
    /// The client must still ask for a connection upgrade.
    #[prost(bool, tag = "1")]
    pub disable_websockets: bool,
    /// disable_sse indicates whether or not server-sent events are allowed.
    ///
    /// see: <https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events>
    ///
    /// SSE is only used when Accept-Type from the request includes MIME type text/event-stream.
    #[prost(bool, tag = "2")]
    pub disable_sse: bool,
    /// disable_chunked indicates whether or not chunked transfer encoding is allowed.
    ///
    /// NOTE: Chunked transfer encoding is disabled in HTTP/2 so this option will only be available
    /// if the request is HTTP/1.
    #[prost(bool, tag = "3")]
    pub disable_chunked_transfer: bool,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ProtoEndpointBinding {
    #[prost(string, tag = "8")]
    pub body: ::prost::alloc::string::String,
    #[prost(message, repeated, tag = "9")]
    pub query_params: ::prost::alloc::vec::Vec<QueryParameterBinding>,
    #[prost(message, repeated, tag = "10")]
    pub additional_bindings: ::prost::alloc::vec::Vec<AdditionalEndpointBinding>,
    #[prost(bool, tag = "11")]
    pub disable_query_param_discovery: bool,
    #[prost(message, optional, tag = "12")]
    pub stream: ::core::option::Option<StreamConfig>,
    #[prost(oneof = "proto_endpoint_binding::Pattern", tags = "2, 3, 4, 5, 6, 7")]
    pub pattern: ::core::option::Option<proto_endpoint_binding::Pattern>,
}
/// Nested message and enum types in `ProtoEndpointBinding`.
pub mod proto_endpoint_binding {
    #[derive(Clone, PartialEq, Eq, Hash, ::prost::Oneof)]
    pub enum Pattern {
        #[prost(string, tag = "2")]
        Get(::prost::alloc::string::String),
        #[prost(string, tag = "3")]
        Put(::prost::alloc::string::String),
        #[prost(string, tag = "4")]
        Post(::prost::alloc::string::String),
        #[prost(string, tag = "5")]
        Delete(::prost::alloc::string::String),
        #[prost(string, tag = "6")]
        Patch(::prost::alloc::string::String),
        /// custom can be used for custom HTTP methods.
        #[prost(message, tag = "7")]
        Custom(super::CustomPattern),
    }
}