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 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412
// This file is @generated by prost-build.
/// A running instance of a [Workflow][google.cloud.workflows.v1beta.Workflow].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Execution {
/// Output only. The resource name of the execution.
/// Format:
/// projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Output only. Marks the beginning of execution.
#[prost(message, optional, tag = "2")]
pub start_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Marks the end of execution, successful or not.
#[prost(message, optional, tag = "3")]
pub end_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Current state of the execution.
#[prost(enumeration = "execution::State", tag = "4")]
pub state: i32,
/// Input parameters of the execution represented as a JSON string.
/// The size limit is 32KB.
#[prost(string, tag = "5")]
pub argument: ::prost::alloc::string::String,
/// Output only. Output of the execution represented as a JSON string. The
/// value can only be present if the execution's state is `SUCCEEDED`.
#[prost(string, tag = "6")]
pub result: ::prost::alloc::string::String,
/// Output only. The error which caused the execution to finish prematurely.
/// The value is only present if the execution's state is `FAILED`
/// or `CANCELLED`.
#[prost(message, optional, tag = "7")]
pub error: ::core::option::Option<execution::Error>,
/// Output only. Revision of the workflow this execution is using.
#[prost(string, tag = "8")]
pub workflow_revision_id: ::prost::alloc::string::String,
}
/// Nested message and enum types in `Execution`.
pub mod execution {
/// Error describes why the execution was abnormally terminated.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Error {
/// Error payload returned by the execution, represented as a JSON string.
#[prost(string, tag = "1")]
pub payload: ::prost::alloc::string::String,
/// Human readable error context, helpful for debugging purposes.
#[prost(string, tag = "2")]
pub context: ::prost::alloc::string::String,
}
/// Describes the current state of the execution. More states may be added
/// in the future.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum State {
/// Invalid state.
Unspecified = 0,
/// The execution is in progress.
Active = 1,
/// The execution finished successfully.
Succeeded = 2,
/// The execution failed with an error.
Failed = 3,
/// The execution was stopped intentionally.
Cancelled = 4,
}
impl State {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
State::Unspecified => "STATE_UNSPECIFIED",
State::Active => "ACTIVE",
State::Succeeded => "SUCCEEDED",
State::Failed => "FAILED",
State::Cancelled => "CANCELLED",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"STATE_UNSPECIFIED" => Some(Self::Unspecified),
"ACTIVE" => Some(Self::Active),
"SUCCEEDED" => Some(Self::Succeeded),
"FAILED" => Some(Self::Failed),
"CANCELLED" => Some(Self::Cancelled),
_ => None,
}
}
}
}
/// Request for the
/// [ListExecutions][google.cloud.workflows.executions.v1beta.Executions.ListExecutions]
/// method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListExecutionsRequest {
/// Required. Name of the workflow for which the executions should be listed.
/// Format: projects/{project}/locations/{location}/workflows/{workflow}
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Maximum number of executions to return per call.
/// Max supported value depends on the selected Execution view: it's 10000 for
/// BASIC and 100 for FULL. The default value used if the field is not
/// specified is 100, regardless of the selected view. Values greater than
/// the max value will be coerced down to it.
#[prost(int32, tag = "2")]
pub page_size: i32,
/// A page token, received from a previous `ListExecutions` call.
/// Provide this to retrieve the subsequent page.
///
/// When paginating, all other parameters provided to `ListExecutions` must
/// match the call that provided the page token.
#[prost(string, tag = "3")]
pub page_token: ::prost::alloc::string::String,
/// Optional. A view defining which fields should be filled in the returned executions.
/// The API will default to the BASIC view.
#[prost(enumeration = "ExecutionView", tag = "4")]
pub view: i32,
}
/// Response for the
/// [ListExecutions][google.cloud.workflows.executions.v1beta.Executions.ListExecutions]
/// method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListExecutionsResponse {
/// The executions which match the request.
#[prost(message, repeated, tag = "1")]
pub executions: ::prost::alloc::vec::Vec<Execution>,
/// A token, which can be sent as `page_token` to retrieve the next page.
/// If this field is omitted, there are no subsequent pages.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request for the
/// [CreateExecution][google.cloud.workflows.executions.v1beta.Executions.CreateExecution]
/// method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateExecutionRequest {
/// Required. Name of the workflow for which an execution should be created.
/// Format: projects/{project}/locations/{location}/workflows/{workflow}
/// The latest revision of the workflow will be used.
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. Execution to be created.
#[prost(message, optional, tag = "2")]
pub execution: ::core::option::Option<Execution>,
}
/// Request for the
/// [GetExecution][google.cloud.workflows.executions.v1beta.Executions.GetExecution]
/// method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetExecutionRequest {
/// Required. Name of the execution to be retrieved.
/// Format:
/// projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Optional. A view defining which fields should be filled in the returned execution.
/// The API will default to the FULL view.
#[prost(enumeration = "ExecutionView", tag = "2")]
pub view: i32,
}
/// Request for the
/// [CancelExecution][google.cloud.workflows.executions.v1beta.Executions.CancelExecution]
/// method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CancelExecutionRequest {
/// Required. Name of the execution to be cancelled.
/// Format:
/// projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Defines possible views for execution resource.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum ExecutionView {
/// The default / unset value.
Unspecified = 0,
/// Includes only basic metadata about the execution.
/// Following fields are returned: name, start_time, end_time, state
/// and workflow_revision_id.
Basic = 1,
/// Includes all data.
Full = 2,
}
impl ExecutionView {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
ExecutionView::Unspecified => "EXECUTION_VIEW_UNSPECIFIED",
ExecutionView::Basic => "BASIC",
ExecutionView::Full => "FULL",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"EXECUTION_VIEW_UNSPECIFIED" => Some(Self::Unspecified),
"BASIC" => Some(Self::Basic),
"FULL" => Some(Self::Full),
_ => None,
}
}
}
/// Generated client implementations.
pub mod executions_client {
#![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
use tonic::codegen::*;
use tonic::codegen::http::Uri;
/// Executions is used to start and manage running instances of
/// [Workflows][google.cloud.workflows.v1beta.Workflow] called executions.
#[derive(Debug, Clone)]
pub struct ExecutionsClient<T> {
inner: tonic::client::Grpc<T>,
}
impl<T> ExecutionsClient<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,
) -> ExecutionsClient<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,
{
ExecutionsClient::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
}
/// Returns a list of executions which belong to the workflow with
/// the given name. The method returns executions of all workflow
/// revisions. Returned executions are ordered by their start time (newest
/// first).
pub async fn list_executions(
&mut self,
request: impl tonic::IntoRequest<super::ListExecutionsRequest>,
) -> std::result::Result<
tonic::Response<super::ListExecutionsResponse>,
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.cloud.workflows.executions.v1beta.Executions/ListExecutions",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.workflows.executions.v1beta.Executions",
"ListExecutions",
),
);
self.inner.unary(req, path, codec).await
}
/// Creates a new execution using the latest revision of the given workflow.
pub async fn create_execution(
&mut self,
request: impl tonic::IntoRequest<super::CreateExecutionRequest>,
) -> std::result::Result<tonic::Response<super::Execution>, 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.cloud.workflows.executions.v1beta.Executions/CreateExecution",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.workflows.executions.v1beta.Executions",
"CreateExecution",
),
);
self.inner.unary(req, path, codec).await
}
/// Returns an execution of the given name.
pub async fn get_execution(
&mut self,
request: impl tonic::IntoRequest<super::GetExecutionRequest>,
) -> std::result::Result<tonic::Response<super::Execution>, 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.cloud.workflows.executions.v1beta.Executions/GetExecution",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.workflows.executions.v1beta.Executions",
"GetExecution",
),
);
self.inner.unary(req, path, codec).await
}
/// Cancels an execution of the given name.
pub async fn cancel_execution(
&mut self,
request: impl tonic::IntoRequest<super::CancelExecutionRequest>,
) -> std::result::Result<tonic::Response<super::Execution>, 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.cloud.workflows.executions.v1beta.Executions/CancelExecution",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.workflows.executions.v1beta.Executions",
"CancelExecution",
),
);
self.inner.unary(req, path, codec).await
}
}
}