“google-firebasehosting1”库允许访问 Google Firebase Hosting 服务（协议版本 v1）的所有功能。

此文档是从 Firebase Hosting 库版本 5.0.5+20240625 生成的，其中 20240625 是由 mako 代码生成器 v5.0.5 构建的 firebasehosting:v1 模式的确切版本。

有关 Firebase Hosting v1 API 的其他所有信息，请参阅 官方文档站点。

功能

轻松从中心 枢纽 处处理以下 资源 ...

• 操作
• 取消，删除 和 列表
• 项目
• 网站自定义域名操作取消 和 网站自定义域名操作删除

本库结构

API 结构如下几个主要项

• 枢纽
  • 一个中心对象，用于维护状态并允许访问所有 活动
  • 创建 方法构建器，进而允许访问单个 调用构建器
• 资源
  • 你可以应用 活动 的主要类型
  • 一组属性和 部分
  • 部分
    • 一组属性
    • 在 活动 中永远不会直接使用
• 活动
  • 对 资源 应用操作

所有 结构 都带有适用的特性，以便进一步分类它们并简化浏览。

一般来说，您可以像这样调用 活动

let r = hub.resource().activity(...).doit().await

或者具体地说...

let r = hub.operations().cancel(...).doit().await
let r = hub.operations().delete(...).doit().await
let r = hub.projects().sites_custom_domains_operations_cancel(...).doit().await
let r = hub.projects().sites_custom_domains_operations_delete(...).doit().await

resource() 和 activity(...) 调用创建 构建器。第二个调用处理 Activities，支持各种方法来配置即将进行的操作（此处未显示）。它是这样设计的，即所有必需的参数必须立即指定（即 (...)），而所有可选参数则可以按需 构建。doit() 方法执行与服务器的实际通信并返回相应的结果。

用法

设置您的项目

要使用此库，您需要将以下行放入您的 Cargo.toml 文件中

[dependencies]
google-firebasehosting1 = "*"
serde = "^1.0"
serde_json = "^1.0"

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_firebasehosting1 as firebasehosting1;
use firebasehosting1::api::CancelOperationRequest;
use firebasehosting1::{Result, Error};
use std::default::Default;
use firebasehosting1::{FirebaseHosting, oauth2, hyper, hyper_rustls, chrono, FieldMask};

// Get an ApplicationSecret instance by some means. It contains the `client_id` and 
// `client_secret`, among other things.
let secret: oauth2::ApplicationSecret = Default::default();
// Instantiate the authenticator. It will choose a suitable authentication flow for you, 
// unless you replace  `None` with the desired Flow.
// Provide your own `AuthenticatorDelegate` to adjust the way it operates and get feedback about 
// what's going on. You probably want to bring in your own `TokenStorage` to persist tokens and
// retrieve them from storage.
let auth = oauth2::InstalledFlowAuthenticator::builder(
        secret,
        oauth2::InstalledFlowReturnMethod::HTTPRedirect,
    ).build().await.unwrap();
let mut hub = FirebaseHosting::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().unwrap().https_or_http().enable_http1().build()), auth);
// As the method needs a request, you would usually fill it with the desired information
// into the respective structure. Some of the parts shown here might not be applicable !
// Values shown here are possibly random and not representative !
let mut req = CancelOperationRequest::default();

// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `doit()`.
// Values shown here are possibly random and not representative !
let result = hub.operations().cancel(req, "name")
             .doit().await;

match result {
    Err(e) => match e {
        // The Error enum provides details about what exactly happened.
        // You can also just use its `Debug`, `Display` or `Error` traits
         Error::HttpError(_)
        |Error::Io(_)
        |Error::MissingAPIKey
        |Error::MissingToken(_)
        |Error::Cancelled
        |Error::UploadSizeLimitExceeded(_, _)
        |Error::Failure(_)
        |Error::BadRequest(_)
        |Error::FieldClash(_)
        |Error::JsonDecodeError(_, _) => println!("{}", e),
    },
    Ok(res) => println!("Success: {:?}", res),
}

处理错误

系统产生的所有错误都作为 Result 枚举提供，作为 doit() 方法的返回值，或者作为可能的中间结果传递给 Hub Delegate 或 Authenticator Delegate。

当代理处理错误或中间值时，它们有机会指示系统重试。这使得系统可能对各种错误都有弹性。

上传和下载

如果方法支持下载，则应读取响应体（它是 Result 的一部分），以获取媒体。如果此方法还支持 Response Result，则默认返回该值。您可以将它视为实际媒体的元数据。要触发媒体下载，您必须通过此调用设置构建器：.param("alt", "media")。

支持上传的方法可以使用多达 2 种不同的协议进行操作：简单 和 可恢复。每种协议的独特性由定制的 doit(...) 方法表示，分别命名为 upload(...) 和 upload_resumable(...)。

自定义和回调

您可以通过向 方法构建器 提供一个 代理 来更改 doit() 方法的调用方式，在执行最终的 doit() 调用之前。相应的函数将被调用以提供进度信息，以及确定系统在失败时是否应该重试。

代理特质 默认实现，允许您以最小的努力进行自定义。

服务器请求中的可选部分

此库提供的所有结构都旨在通过 json 进行 编码 和 解码。可选部分用于表示部分请求或响应是有效的。大多数可选部分都是 部分，可按名称识别，这些部分将被发送到服务器以指示请求的设置部分或响应中希望获得的部分。

构建器参数

通过 方法构建器，您可以通过重复调用其方法来准备动作调用。这些方法始终接受单个参数，以下陈述对参数有效。

• POD 通过复制传递
• 字符串作为 &str 传递
• 请求值 被移动

参数将始终被复制或克隆到构建器中，以便它们独立于其原始生命周期。

Cargo 功能

• utoipa - 添加对 utoipa 的支持并从所有类型中推导出 utoipa::ToSchema。您必须在 #[openapi(schemas(...))] 中导入和注册所需类型，否则生成的 openapi 规范将无效。

许可证

firebasehosting1 库由 Sebastian Thiel 生成，并置于 MIT 许可证下。您可以在存储库的 许可证文件 中阅读全文。