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

google-artifactregistry1_beta1

一个用于与 artifact registry (协议 v1beta1) 交互的完整库

12 个稳定版本 (4 个主要版本)

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日
1.0.14+20200703 2020年7月10日

#2961 in 网页编程


google-artifactregistry1_… 中使用

MIT 许可证

455KB
5.5K SLoC

google-artifactregistry1_beta1 库允许访问 Google Artifact Registry 服务中的所有功能。

本文档是从 Artifact Registry crate 版本 5.0.5+20240608 生成的,其中 20240608 是由 mako 代码生成器 v5.0.5 构建的 artifactregistry:v1beta1 架构的确切修订版。

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

功能

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

本库结构

API 被组织成以下主要项

  • 枢纽
    • 一个中心对象,用于维护状态并允许访问所有 活动
    • 创建 方法构建器,这些构建器反过来允许访问单个 调用构建器
  • 资源
    • 主要类型,可以将 活动 应用到其上
    • 属性和 部分 的集合
    • 部分
      • 属性的集合
      • 活动 中从不直接使用
  • 活动
    • 应用于 资源 的操作

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

一般来说,您可以通过以下方式调用 活动

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

或者具体来说...

let r = hub.projects().locations_operations_get(...).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_create(...).doit().await
let r = hub.projects().locations_repositories_delete(...).doit().await

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

用法

设置项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_artifactregistry1_beta1 as artifactregistry1_beta1;
use artifactregistry1_beta1::api::Repository;
use artifactregistry1_beta1::{Result, Error};
use std::default::Default;
use artifactregistry1_beta1::{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(...)方法表示,这些方法分别命名为upload(...)upload_resumable(...)

自定义和回调

您可以通过在最终调用doit()之前向Method Builder提供一个delegate来更改doit()方法的调用方式。相关方法将被调用以提供进度信息,以及确定系统在失败时是否应该重试。

delegate trait具有默认实现,允许您以最小的努力对其进行自定义。

服务器请求中的可选部分

本库提供的所有结构都是为了通过json进行编码解码而设计的。使用可选类型来表示部分请求或响应是有效的。大多数可选类型都被视为部分,可以通过名称识别,这些部分将被发送到服务器以指示请求的集合部分或响应中所需的部分。

构建器参数

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

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

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

Cargo功能

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

许可证

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

依赖关系

~12–23MB
~346K SLoC