#google #protocols #google-api #web #artifactregistry #web-api

google-artifactregistry1

与Artifact Registry(协议v1)交互的完整库

11个稳定版本 (3个主要版本)

5.0.5+20240608 2024年6月27日
5.0.4+20240213 2024年3月5日
5.0.3+20230113 2023年8月23日
5.0.2+20230113 2023年3月16日
2.0.4+20210324 2021年4月14日

#30 in #web-api


用于 google-artifactregistry1-…

MIT许可证

1MB
11K SLoC

“google-artifactregistry1”库允许访问Google Artifact Registry服务(协议v1)的所有功能。

此文档是从Artifact Registrycrate版本5.0.5+20240608生成的,其中20240608mako代码生成器v5.0.5构建的artifactregistry:v1模式的精确版本。

有关Artifact Registry v1 API的所有其他信息,请参阅官方文档网站

功能

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

支持上传...

支持下载...

本库结构

API结构如下

  • 枢纽
  • 资源
    • 你可以将其应用于活动的基本类型
    • 属性和部分的集合
    • 部分
      • 属性的集合
      • 从未在活动中直接使用
  • 活动
    • 应用于资源的操作

所有结构都标记了适用的特性和,以进一步分类它们并简化浏览。

一般来说,你可以像这样调用活动

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

或者具体...

let r = hub.projects().locations_operations_get(...).doit().await
let r = hub.projects().locations_repositories_apt_artifacts_import(...).doit().await
let r = hub.projects().locations_repositories_files_delete(...).doit().await
let r = hub.projects().locations_repositories_googet_artifacts_import(...).doit().await
let r = hub.projects().locations_repositories_packages_versions_batch_delete(...).doit().await
let r = hub.projects().locations_repositories_packages_versions_delete(...).doit().await
let r = hub.projects().locations_repositories_packages_delete(...).doit().await
let r = hub.projects().locations_repositories_yum_artifacts_import(...).doit().await
let r = hub.projects().locations_repositories_create(...).doit().await
let r = hub.projects().locations_repositories_delete(...).doit().await

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

用法

设置你的项目

要使用这个库,你需要在你的Cargo.toml文件中放入以下几行

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

一个完整的例子

extern crate hyper;
extern crate hyper_rustls;
extern crate google_artifactregistry1 as artifactregistry1;
use artifactregistry1::api::Repository;
use artifactregistry1::{Result, Error};
use std::default::Default;
use artifactregistry1::{ArtifactRegistry, 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 = ArtifactRegistry::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 = Repository::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.projects().locations_repositories_create(req, "parent")
             .repository_id("magna")
             .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 DelegateAuthenticator Delegate

当代理处理错误或中间值时,它们可能有机会指示系统重试。这使得系统可能对所有类型的错误具有弹性。

上传和下载

如果某个方法支持下载,你应该读取响应体,这是Result的一部分,以获取媒体。如果此方法也支持Response Result,则默认返回该结果。你可以将其视为实际媒体的元数据。要触发媒体下载,你需要通过此调用设置构建器:.param("alt", "media")

支持上传的方法可以使用最多2种不同的协议:简单和可恢复。每种独特性都由定制的doit方法表示,分别命名为uploadupload_resumable

定制和回调

通过在执行最终的doit调用之前向Method Builder提供一个delegate,你可以改变doit方法的调用方式。相应的函数将被调用以提供进度信息,以及确定系统在失败时应否重试。

delegate trait默认实现,允许你以最小的努力进行自定义。

服务器请求中的可选部分

本库提供的所有结构都设计为可以通过 编码解码json。可选参数用于表示部分请求或响应是有效的。大多数可选参数被认为是 Parts,可以通过名称识别,这些名称将被发送到服务器以指示请求的设置部分或响应中所需的部分。

构建器参数

通过使用 方法构建器,您可以反复调用其方法来准备一个操作调用。这些方法始终接受单个参数,以下陈述对参数是正确的。

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

参数将始终复制或克隆到构建器中,以确保它们与其原始生命周期独立。

Cargo 功能

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

许可证

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

依赖项

~12–23MB
~343K SLoC