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 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385
// This file is @generated by prost-build.
/// This resource represents a long-running operation that is the result of a
/// network API call.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Operation {
/// The server-assigned name, which is only unique within the same service that
/// originally returns it. If you use the default HTTP mapping, the
/// `name` should be a resource name ending with `operations/{unique_id}`.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Service-specific metadata associated with the operation. It typically
/// contains progress information and common metadata such as create time.
/// Some services might not provide such metadata. Any method that returns a
/// long-running operation should document the metadata type, if any.
#[prost(message, optional, tag = "2")]
pub metadata: ::core::option::Option<::prost_types::Any>,
/// 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.
#[prost(bool, tag = "3")]
pub done: bool,
/// The operation result, which can be either an `error` or a valid `response`.
/// If `done` == `false`, neither `error` nor `response` is set.
/// If `done` == `true`, exactly one of `error` or `response` is set.
#[prost(oneof = "operation::Result", tags = "4, 5")]
pub result: ::core::option::Option<operation::Result>,
}
/// Nested message and enum types in `Operation`.
pub mod operation {
/// The operation result, which can be either an `error` or a valid `response`.
/// If `done` == `false`, neither `error` nor `response` is set.
/// If `done` == `true`, exactly one of `error` or `response` is set.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Result {
/// The error result of the operation in case of failure or cancellation.
#[prost(message, tag = "4")]
Error(super::super::rpc::Status),
/// 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 standard
/// `Get`/`Create`/`Update`, the response should be the resource. For other
/// methods, the response should have the type `XxxResponse`, where `Xxx`
/// is the original method name. For example, if the original method name
/// is `TakeSnapshot()`, the inferred response type is
/// `TakeSnapshotResponse`.
#[prost(message, tag = "5")]
Response(::prost_types::Any),
}
}
/// The request message for [Operations.GetOperation][google.longrunning.Operations.GetOperation].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetOperationRequest {
/// The name of the operation resource.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// The request message for [Operations.ListOperations][google.longrunning.Operations.ListOperations].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListOperationsRequest {
/// The name of the operation's parent resource.
#[prost(string, tag = "4")]
pub name: ::prost::alloc::string::String,
/// The standard list filter.
#[prost(string, tag = "1")]
pub filter: ::prost::alloc::string::String,
/// The standard list page size.
#[prost(int32, tag = "2")]
pub page_size: i32,
/// The standard list page token.
#[prost(string, tag = "3")]
pub page_token: ::prost::alloc::string::String,
}
/// The response message for [Operations.ListOperations][google.longrunning.Operations.ListOperations].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListOperationsResponse {
/// A list of operations that matches the specified filter in the request.
#[prost(message, repeated, tag = "1")]
pub operations: ::prost::alloc::vec::Vec<Operation>,
/// The standard List next-page token.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// The request message for [Operations.CancelOperation][google.longrunning.Operations.CancelOperation].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CancelOperationRequest {
/// The name of the operation resource to be cancelled.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// The request message for [Operations.DeleteOperation][google.longrunning.Operations.DeleteOperation].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteOperationRequest {
/// The name of the operation resource to be deleted.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// The request message for [Operations.WaitOperation][google.longrunning.Operations.WaitOperation].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct WaitOperationRequest {
/// The name of the operation resource to wait on.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// The maximum duration to wait before timing out. If left blank, the wait
/// will be at most the time permitted by the underlying HTTP/RPC protocol.
/// If RPC context deadline is also specified, the shorter one will be used.
#[prost(message, optional, tag = "2")]
pub timeout: ::core::option::Option<::prost_types::Duration>,
}
/// A message representing the message types used by a long-running operation.
///
/// Example:
///
/// rpc LongRunningRecognize(LongRunningRecognizeRequest)
/// returns (google.longrunning.Operation) {
/// option (google.longrunning.operation_info) = {
/// response_type: "LongRunningRecognizeResponse"
/// metadata_type: "LongRunningRecognizeMetadata"
/// };
/// }
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct OperationInfo {
/// Required. The message name of the primary return type for this
/// long-running operation.
/// This type will be used to deserialize the LRO's response.
///
/// If the response is in a different package from the rpc, a fully-qualified
/// message name must be used (e.g. `google.protobuf.Struct`).
///
/// Note: Altering this value constitutes a breaking change.
#[prost(string, tag = "1")]
pub response_type: ::prost::alloc::string::String,
/// Required. The message name of the metadata type for this long-running
/// operation.
///
/// If the response is in a different package from the rpc, a fully-qualified
/// message name must be used (e.g. `google.protobuf.Struct`).
///
/// Note: Altering this value constitutes a breaking change.
#[prost(string, tag = "2")]
pub metadata_type: ::prost::alloc::string::String,
}
/// Generated client implementations.
pub mod operations_client {
#![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
use tonic::codegen::*;
use tonic::codegen::http::Uri;
/// Manages long-running operations with an API service.
///
/// When an API method normally takes long time to complete, it can be designed
/// to return [Operation][google.longrunning.Operation] to the client, and the client can use this
/// interface to receive the real response asynchronously by polling the
/// operation resource, or pass the operation resource to another API (such as
/// Google Cloud Pub/Sub API) to receive the response. Any API service that
/// returns long-running operations should implement the `Operations` interface
/// so developers can have a consistent client experience.
#[derive(Debug, Clone)]
pub struct OperationsClient<T> {
inner: tonic::client::Grpc<T>,
}
impl<T> OperationsClient<T>
where
T: tonic::client::GrpcService<tonic::body::BoxBody>,
T::Error: Into<StdError>,
T::ResponseBody: Body<Data = Bytes> + std::marker::Send + 'static,
<T::ResponseBody as Body>::Error: Into<StdError> + std::marker::Send,
{
pub fn new(inner: T) -> Self {
let inner = tonic::client::Grpc::new(inner);
Self { inner }
}
pub fn with_origin(inner: T, origin: Uri) -> Self {
let inner = tonic::client::Grpc::with_origin(inner, origin);
Self { inner }
}
pub fn with_interceptor<F>(
inner: T,
interceptor: F,
) -> OperationsClient<InterceptedService<T, F>>
where
F: tonic::service::Interceptor,
T::ResponseBody: Default,
T: tonic::codegen::Service<
http::Request<tonic::body::BoxBody>,
Response = http::Response<
<T as tonic::client::GrpcService<tonic::body::BoxBody>>::ResponseBody,
>,
>,
<T as tonic::codegen::Service<
http::Request<tonic::body::BoxBody>,
>>::Error: Into<StdError> + std::marker::Send + std::marker::Sync,
{
OperationsClient::new(InterceptedService::new(inner, interceptor))
}
/// Compress requests with the given encoding.
///
/// This requires the server to support it otherwise it might respond with an
/// error.
#[must_use]
pub fn send_compressed(mut self, encoding: CompressionEncoding) -> Self {
self.inner = self.inner.send_compressed(encoding);
self
}
/// Enable decompressing responses.
#[must_use]
pub fn accept_compressed(mut self, encoding: CompressionEncoding) -> Self {
self.inner = self.inner.accept_compressed(encoding);
self
}
/// Limits the maximum size of a decoded message.
///
/// Default: `4MB`
#[must_use]
pub fn max_decoding_message_size(mut self, limit: usize) -> Self {
self.inner = self.inner.max_decoding_message_size(limit);
self
}
/// Limits the maximum size of an encoded message.
///
/// Default: `usize::MAX`
#[must_use]
pub fn max_encoding_message_size(mut self, limit: usize) -> Self {
self.inner = self.inner.max_encoding_message_size(limit);
self
}
/// Lists operations that match the specified filter in the request. If the
/// server doesn't support this method, it returns `UNIMPLEMENTED`.
///
/// NOTE: the `name` binding allows API services to override the binding
/// to use different resource name schemes, such as `users/*/operations`. To
/// override the binding, API services can add a binding such as
/// `"/v1/{name=users/*}/operations"` to their service configuration.
/// For backwards compatibility, the default name includes the operations
/// collection id, however overriding users must ensure the name binding
/// is the parent resource, without the operations collection id.
pub async fn list_operations(
&mut self,
request: impl tonic::IntoRequest<super::ListOperationsRequest>,
) -> std::result::Result<
tonic::Response<super::ListOperationsResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.longrunning.Operations/ListOperations",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new("google.longrunning.Operations", "ListOperations"),
);
self.inner.unary(req, path, codec).await
}
/// Gets the latest state of a long-running operation. Clients can use this
/// method to poll the operation result at intervals as recommended by the API
/// service.
pub async fn get_operation(
&mut self,
request: impl tonic::IntoRequest<super::GetOperationRequest>,
) -> std::result::Result<tonic::Response<super::Operation>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.longrunning.Operations/GetOperation",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new("google.longrunning.Operations", "GetOperation"),
);
self.inner.unary(req, path, codec).await
}
/// Deletes a long-running operation. This method indicates that the client is
/// no longer interested in the operation result. It does not cancel the
/// operation. If the server doesn't support this method, it returns
/// `google.rpc.Code.UNIMPLEMENTED`.
pub async fn delete_operation(
&mut self,
request: impl tonic::IntoRequest<super::DeleteOperationRequest>,
) -> std::result::Result<tonic::Response<()>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.longrunning.Operations/DeleteOperation",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new("google.longrunning.Operations", "DeleteOperation"),
);
self.inner.unary(req, path, codec).await
}
/// Starts asynchronous cancellation on a long-running operation. The server
/// makes a best effort to cancel the operation, but success is not
/// guaranteed. If the server doesn't support this method, it returns
/// `google.rpc.Code.UNIMPLEMENTED`. Clients can use
/// [Operations.GetOperation][google.longrunning.Operations.GetOperation] or
/// other methods to check whether the cancellation succeeded or whether the
/// operation completed despite cancellation. On successful cancellation,
/// the operation is not deleted; instead, it becomes an operation with
/// an [Operation.error][google.longrunning.Operation.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1,
/// corresponding to `Code.CANCELLED`.
pub async fn cancel_operation(
&mut self,
request: impl tonic::IntoRequest<super::CancelOperationRequest>,
) -> std::result::Result<tonic::Response<()>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.longrunning.Operations/CancelOperation",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new("google.longrunning.Operations", "CancelOperation"),
);
self.inner.unary(req, path, codec).await
}
/// Waits until the specified long-running operation is done or reaches at most
/// a specified timeout, returning the latest state. If the operation is
/// already done, the latest state is immediately returned. If the timeout
/// specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
/// timeout is used. If the server does not support this method, it returns
/// `google.rpc.Code.UNIMPLEMENTED`.
/// Note that this method is on a best-effort basis. It may return the latest
/// state before the specified timeout (including immediately), meaning even an
/// immediate response is no guarantee that the operation is done.
pub async fn wait_operation(
&mut self,
request: impl tonic::IntoRequest<super::WaitOperationRequest>,
) -> std::result::Result<tonic::Response<super::Operation>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.longrunning.Operations/WaitOperation",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new("google.longrunning.Operations", "WaitOperation"),
);
self.inner.unary(req, path, codec).await
}
}
}