#google-api #transcoder #google #protocols #api #web-api #web

google-transcoder1_beta1

一个完整的库,用于与 Transcoder(协议 v1beta1)进行交互

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

5.0.5+20210323 2024 年 6 月 27 日
5.0.4+20210323 2024 年 3 月 5 日
5.0.3+20210323 2023 年 8 月 24 日
5.0.2+20210323 2023 年 3 月 16 日
2.0.4+20210323 2021 年 4 月 15 日

#1 in #transcoder

每月下载量 38
google-transcoder1_beta1-… 中使用

MIT 许可证

245KB
3K SLoC

google-transcoder1_beta1 库允许访问 Google Transcoder 服务所有功能。

本文档是根据 Transcoder 库版本 5.0.5+20210323 生成的,其中 20210323 是由 mako 代码生成器 v5.0.5 构建的 transcoder:v1beta1 架构的确切修订版。

有关 Transcoder v1_beta1 API 的其他信息,请参阅 官方文档站点

特性

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

本库的结构

API 结构如下主要项

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

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

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

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

或者具体...

let r = hub.projects().locations_jobs_create(...).doit().await
let r = hub.projects().locations_jobs_get(...).doit().await

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

用法

设置你的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_transcoder1_beta1 as transcoder1_beta1;
use transcoder1_beta1::api::Job;
use transcoder1_beta1::{Result, Error};
use std::default::Default;
use transcoder1_beta1::{Transcoder, 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 = Transcoder::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 = Job::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_jobs_create(req, "parent")
             .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规范将无效。

许可证

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

依赖关系

~12–23MB
~344K SLoC