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 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571
// This file is @generated by prost-build.
/// Request message to get Google Workspace Add-ons authorization information.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetAuthorizationRequest {
/// Required. Name of the project for which to get the Google Workspace Add-ons
/// authorization information.
///
/// Example: `projects/my_project/authorization`.
#[prost(string, tag = "2")]
pub name: ::prost::alloc::string::String,
}
/// The authorization information used when invoking deployment endpoints.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Authorization {
/// The canonical full name of this resource.
/// Example: `projects/123/authorization`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// The email address of the service account used to authenticate requests to
/// add-on callback endpoints.
#[prost(string, tag = "2")]
pub service_account_email: ::prost::alloc::string::String,
/// The OAuth client ID used to obtain OAuth access tokens for a user on the
/// add-on's behalf.
#[prost(string, tag = "3")]
pub oauth_client_id: ::prost::alloc::string::String,
}
/// Request message to create a deployment.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateDeploymentRequest {
/// Required. Name of the project in which to create the deployment.
///
/// Example: `projects/my_project`.
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The id to use for this deployment. The full name of the created
/// resource will be `projects/<project_number>/deployments/<deployment_id>`.
#[prost(string, tag = "2")]
pub deployment_id: ::prost::alloc::string::String,
/// Required. The deployment to create (deployment.name cannot be set).
#[prost(message, optional, tag = "3")]
pub deployment: ::core::option::Option<Deployment>,
}
/// Request message to create or replace a deployment.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ReplaceDeploymentRequest {
/// Required. The deployment to create or replace.
#[prost(message, optional, tag = "2")]
pub deployment: ::core::option::Option<Deployment>,
}
/// Request message to get a deployment.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetDeploymentRequest {
/// Required. The full resource name of the deployment to get.
///
/// Example: `projects/my_project/deployments/my_deployment`.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message to list deployments for a project.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListDeploymentsRequest {
/// Required. Name of the project in which to create the deployment.
///
/// Example: `projects/my_project`.
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// The maximum number of deployments to return. The service may return fewer
/// than this value.
/// If unspecified, at most 1000 deployments will be returned.
/// The maximum value is 1000; values above 1000 will be coerced to 1000.
#[prost(int32, tag = "2")]
pub page_size: i32,
/// A page token, received from a previous `ListDeployments` call.
/// Provide this to retrieve the subsequent page.
///
/// When paginating, all other parameters provided to `ListDeployments` must
/// match the call that provided the page token.
#[prost(string, tag = "3")]
pub page_token: ::prost::alloc::string::String,
}
/// Response message to list deployments.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListDeploymentsResponse {
/// The list of deployments for the given project.
#[prost(message, repeated, tag = "1")]
pub deployments: ::prost::alloc::vec::Vec<Deployment>,
/// 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 message to delete a deployment.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteDeploymentRequest {
/// Required. The full resource name of the deployment to delete.
///
/// Example: `projects/my_project/deployments/my_deployment`.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// The etag of the deployment to delete.
/// If this is provided, it must match the server's etag.
#[prost(string, tag = "2")]
pub etag: ::prost::alloc::string::String,
}
/// Request message to install a developer mode deployment.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct InstallDeploymentRequest {
/// Required. The full resource name of the deployment to install.
///
/// Example: `projects/my_project/deployments/my_deployment`.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message to uninstall a developer mode deployment.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UninstallDeploymentRequest {
/// Required. The full resource name of the deployment to install.
///
/// Example: `projects/my_project/deployments/my_deployment`.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message to get the install status of a developer mode deployment.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetInstallStatusRequest {
/// Required. The full resource name of the deployment.
///
/// Example: `projects/my_project/deployments/my_deployment/installStatus`.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Developer mode install status of a deployment
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct InstallStatus {
/// The canonical full resource name of the deployment install status.
///
/// Example: `projects/123/deployments/my_deployment/installStatus`.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// True if the deployment is installed for the user
#[prost(message, optional, tag = "2")]
pub installed: ::core::option::Option<bool>,
}
/// A Google Workspace Add-on deployment
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Deployment {
/// The deployment resource name.
/// Example: projects/123/deployments/my_deployment.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// The list of Google OAuth scopes for which to request consent from the end
/// user before executing an add-on endpoint.
#[prost(string, repeated, tag = "2")]
pub oauth_scopes: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// The Google Workspace Add-on configuration.
#[prost(message, optional, tag = "3")]
pub add_ons: ::core::option::Option<AddOns>,
/// This value is computed by the server based on the version of the
/// deployment in storage, and may be sent on update and delete requests to
/// ensure the client has an up-to-date value before proceeding.
#[prost(string, tag = "5")]
pub etag: ::prost::alloc::string::String,
}
/// A Google Workspace Add-on configuration.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct AddOns {
/// Configuration that is common across all Google Workspace Add-ons.
#[prost(message, optional, tag = "1")]
pub common: ::core::option::Option<
super::super::super::apps::script::r#type::CommonAddOnManifest,
>,
/// Gmail add-on configuration.
#[prost(message, optional, tag = "2")]
pub gmail: ::core::option::Option<
super::super::super::apps::script::r#type::gmail::GmailAddOnManifest,
>,
/// Drive add-on configuration.
#[prost(message, optional, tag = "5")]
pub drive: ::core::option::Option<
super::super::super::apps::script::r#type::drive::DriveAddOnManifest,
>,
/// Calendar add-on configuration.
#[prost(message, optional, tag = "6")]
pub calendar: ::core::option::Option<
super::super::super::apps::script::r#type::calendar::CalendarAddOnManifest,
>,
/// Docs add-on configuration.
#[prost(message, optional, tag = "7")]
pub docs: ::core::option::Option<
super::super::super::apps::script::r#type::docs::DocsAddOnManifest,
>,
/// Sheets add-on configuration.
#[prost(message, optional, tag = "8")]
pub sheets: ::core::option::Option<
super::super::super::apps::script::r#type::sheets::SheetsAddOnManifest,
>,
/// Slides add-on configuration.
#[prost(message, optional, tag = "10")]
pub slides: ::core::option::Option<
super::super::super::apps::script::r#type::slides::SlidesAddOnManifest,
>,
/// Options for sending requests to add-on HTTP endpoints
#[prost(message, optional, tag = "15")]
pub http_options: ::core::option::Option<
super::super::super::apps::script::r#type::HttpOptions,
>,
}
/// Generated client implementations.
pub mod g_suite_add_ons_client {
#![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
use tonic::codegen::*;
use tonic::codegen::http::Uri;
/// A service for managing Google Workspace Add-ons deployments.
///
/// A Google Workspace Add-on is a third-party embedded component that can be
/// installed in Google Workspace Applications like Gmail, Calendar, Drive, and
/// the Google Docs, Sheets, and Slides editors. Google Workspace Add-ons can
/// display UI cards, receive contextual information from the host application,
/// and perform actions in the host application (See:
/// https://developers.google.com/gsuite/add-ons/overview for more information).
///
/// A Google Workspace Add-on deployment resource specifies metadata about the
/// add-on, including a specification of the entry points in the host application
/// that trigger add-on executions (see:
/// https://developers.google.com/gsuite/add-ons/concepts/gsuite-manifests).
/// Add-on deployments defined via the Google Workspace Add-ons API define their
/// entrypoints using HTTPS URLs (See:
/// https://developers.google.com/gsuite/add-ons/guides/alternate-runtimes),
///
/// A Google Workspace Add-on deployment can be installed in developer mode,
/// which allows an add-on developer to test the experience an end-user would see
/// when installing and running the add-on in their G Suite applications. When
/// running in developer mode, more detailed error messages are exposed in the
/// add-on UI to aid in debugging.
///
/// A Google Workspace Add-on deployment can be published to Google Workspace
/// Marketplace, which allows other Google Workspace users to discover and
/// install the add-on. See:
/// https://developers.google.com/gsuite/add-ons/how-tos/publish-add-on-overview
/// for details.
#[derive(Debug, Clone)]
pub struct GSuiteAddOnsClient<T> {
inner: tonic::client::Grpc<T>,
}
impl<T> GSuiteAddOnsClient<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,
) -> GSuiteAddOnsClient<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,
{
GSuiteAddOnsClient::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
}
/// Gets the authorization information for deployments in a given project.
pub async fn get_authorization(
&mut self,
request: impl tonic::IntoRequest<super::GetAuthorizationRequest>,
) -> std::result::Result<tonic::Response<super::Authorization>, 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.gsuiteaddons.v1.GSuiteAddOns/GetAuthorization",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.gsuiteaddons.v1.GSuiteAddOns",
"GetAuthorization",
),
);
self.inner.unary(req, path, codec).await
}
/// Creates a deployment with the specified name and configuration.
pub async fn create_deployment(
&mut self,
request: impl tonic::IntoRequest<super::CreateDeploymentRequest>,
) -> std::result::Result<tonic::Response<super::Deployment>, 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.gsuiteaddons.v1.GSuiteAddOns/CreateDeployment",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.gsuiteaddons.v1.GSuiteAddOns",
"CreateDeployment",
),
);
self.inner.unary(req, path, codec).await
}
/// Creates or replaces a deployment with the specified name.
pub async fn replace_deployment(
&mut self,
request: impl tonic::IntoRequest<super::ReplaceDeploymentRequest>,
) -> std::result::Result<tonic::Response<super::Deployment>, 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.gsuiteaddons.v1.GSuiteAddOns/ReplaceDeployment",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.gsuiteaddons.v1.GSuiteAddOns",
"ReplaceDeployment",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets the deployment with the specified name.
pub async fn get_deployment(
&mut self,
request: impl tonic::IntoRequest<super::GetDeploymentRequest>,
) -> std::result::Result<tonic::Response<super::Deployment>, 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.gsuiteaddons.v1.GSuiteAddOns/GetDeployment",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.gsuiteaddons.v1.GSuiteAddOns",
"GetDeployment",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists all deployments in a particular project.
pub async fn list_deployments(
&mut self,
request: impl tonic::IntoRequest<super::ListDeploymentsRequest>,
) -> std::result::Result<
tonic::Response<super::ListDeploymentsResponse>,
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.gsuiteaddons.v1.GSuiteAddOns/ListDeployments",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.gsuiteaddons.v1.GSuiteAddOns",
"ListDeployments",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes the deployment with the given name.
pub async fn delete_deployment(
&mut self,
request: impl tonic::IntoRequest<super::DeleteDeploymentRequest>,
) -> 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.cloud.gsuiteaddons.v1.GSuiteAddOns/DeleteDeployment",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.gsuiteaddons.v1.GSuiteAddOns",
"DeleteDeployment",
),
);
self.inner.unary(req, path, codec).await
}
/// Installs a deployment in developer mode.
/// See:
/// https://developers.google.com/gsuite/add-ons/how-tos/testing-gsuite-addons.
pub async fn install_deployment(
&mut self,
request: impl tonic::IntoRequest<super::InstallDeploymentRequest>,
) -> 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.cloud.gsuiteaddons.v1.GSuiteAddOns/InstallDeployment",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.gsuiteaddons.v1.GSuiteAddOns",
"InstallDeployment",
),
);
self.inner.unary(req, path, codec).await
}
/// Uninstalls a developer mode deployment.
/// See:
/// https://developers.google.com/gsuite/add-ons/how-tos/testing-gsuite-addons.
pub async fn uninstall_deployment(
&mut self,
request: impl tonic::IntoRequest<super::UninstallDeploymentRequest>,
) -> 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.cloud.gsuiteaddons.v1.GSuiteAddOns/UninstallDeployment",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.gsuiteaddons.v1.GSuiteAddOns",
"UninstallDeployment",
),
);
self.inner.unary(req, path, codec).await
}
/// Fetches the install status of a developer mode deployment.
pub async fn get_install_status(
&mut self,
request: impl tonic::IntoRequest<super::GetInstallStatusRequest>,
) -> std::result::Result<tonic::Response<super::InstallStatus>, 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.gsuiteaddons.v1.GSuiteAddOns/GetInstallStatus",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.gsuiteaddons.v1.GSuiteAddOns",
"GetInstallStatus",
),
);
self.inner.unary(req, path, codec).await
}
}
}