结构体 WorkflowTemplateService (0.5.0)

为 Cloud Dataproc API 实现客户端。

示例

# tokio_test::block_on(async {
# use google_cloud_dataproc_v1::client::WorkflowTemplateService;
let client = WorkflowTemplateService::builder().build().await?;
// use `client` to make requests to the Cloud Dataproc API.
# gax::client_builder::Result::<()>::Ok(()) });

服务说明

用于在 Dataproc API 中管理工作流模板的 API 接口。

配置

如需配置 WorkflowTemplateService,请使用 [builder()][WorkflowTemplateService::builder] 返回的类型中的 with_* 方法。默认配置应该适用于大多数应用。常见的配置更改包括

  • with_endpoint():默认情况下,此客户端使用全球默认端点 (https://dataproc.googleapis.com)。使用区域端点或在受限网络(例如,配置为覆盖此默认值的网络)中运行的应用。
  • with_credentials():默认情况下,此客户端使用应用默认凭证。使用自定义身份验证的应用可能需要替换此默认值。

池化和克隆

WorkflowTemplateService 在内部保留一个连接池,建议创建一个连接池并重复使用。您无需将 WorkflowTemplateService 封装在 Rc 或 Arc 中即可重复使用它,因为它已在内部使用 Arc。

实现

构建器

 fn builder() -> super::builder::workflow_template_service::ClientBuilder

返回 [WorkflowTemplateService] 的构建器。

# tokio_test::block_on(async {
# use google_cloud_dataproc_v1::client::WorkflowTemplateService;
let client = WorkflowTemplateService::builder().build().await?;
# gax::client_builder::Result::<()>::Ok(()) });

from_stub

 fn from_stub<T>(stub: T) -> Self
where
    T: super::stub::WorkflowTemplateService + 'static,

通过提供的桩创建新客户端。

调用此函数的最常见情况是在模拟客户端行为的测试中。

create_workflow_template

 fn create_workflow_template(self: &Self) -> super::builder::workflow_template_service::CreateWorkflowTemplate

创建新的工作流模板。

get_workflow_template

 fn get_workflow_template(self: &Self) -> super::builder::workflow_template_service::GetWorkflowTemplate

检索最新的工作流模板。

可以通过指定可选版本参数来检索之前实例化的模板。

instantiate_workflow_template

 fn instantiate_workflow_template(self: &Self) -> super::builder::workflow_template_service::InstantiateWorkflowTemplate

实例化模板并开始执行。

返回的 Operation 可用于通过轮询 [operations.get][google.longrunning.Operations.GetOperation] 来跟踪工作流的执行。整个工作流完成后,操作即告完成。

可以通过 [operations.cancel][google.longrunning.Operations.CancelOperation] 取消正在运行的工作流。这将导致所有正在运行的作业被取消,并且工作流拥有的集群将被删除。

Operation.metadata 将为 WorkflowMetadata。另请参阅使用 WorkflowMetadata。

成功完成后,Operation.response 将为 Empty。

长时间运行的操作

此方法用于启动和/或轮询长时间运行的操作。用户指南中的使用长时间运行的操作一章详细介绍了这些操作。

instantiate_inline_workflow_template

 fn instantiate_inline_workflow_template(self: &Self) -> super::builder::workflow_template_service::InstantiateInlineWorkflowTemplate

实例化模板并开始执行。

此方法等效于执行序列 CreateWorkflowTemplate、InstantiateWorkflowTemplate、DeleteWorkflowTemplate。

返回的 Operation 可用于通过轮询 [operations.get][google.longrunning.Operations.GetOperation] 来跟踪工作流的执行。整个工作流完成后,操作即告完成。

可以通过 [operations.cancel][google.longrunning.Operations.CancelOperation] 取消正在运行的工作流。这将导致所有正在运行的作业被取消,并且工作流拥有的集群将被删除。

Operation.metadata 将为 WorkflowMetadata。另请参阅使用 WorkflowMetadata。

成功完成后,Operation.response 将为 Empty。

长时间运行的操作

此方法用于启动和/或轮询长时间运行的操作。用户指南中的使用长时间运行的操作一章详细介绍了这些操作。

update_workflow_template

 fn update_workflow_template(self: &Self) -> super::builder::workflow_template_service::UpdateWorkflowTemplate

更新(替换)工作流模板。更新后的模板必须包含与当前服务器版本匹配的版本。

list_workflow_templates

 fn list_workflow_templates(self: &Self) -> super::builder::workflow_template_service::ListWorkflowTemplates

列出与请求中指定的过滤条件匹配的工作流。

delete_workflow_template

 fn delete_workflow_template(self: &Self) -> super::builder::workflow_template_service::DeleteWorkflowTemplate

删除工作流模板。它不会取消正在进行的工作流。

set_iam_policy

 fn set_iam_policy(self: &Self) -> super::builder::workflow_template_service::SetIamPolicy

设置对指定资源的访问权限控制政策。替换任何现有政策。

可能返回 NOT_FOUND、INVALID_ARGUMENT、PERMISSION_DENIED 错误。

get_iam_policy

 fn get_iam_policy(self: &Self) -> super::builder::workflow_template_service::GetIamPolicy

获取资源的访问权限控制政策。如果资源存在但未设置政策,则返回空政策。

test_iam_permissions

 fn test_iam_permissions(self: &Self) -> super::builder::workflow_template_service::TestIamPermissions

返回调用者对指定资源拥有的权限。如果资源不存在,则会返回一组空权限,而不是 NOT_FOUND 错误。

注意:此操作旨在用于构建权限感知界面和命令行工具,而不是用于授权检查。此操作可能会在没有警告的情况下“应急开启”。

list_operations

 fn list_operations(self: &Self) -> super::builder::workflow_template_service::ListOperations

在此服务中提供操作服务功能。

get_operation

 fn get_operation(self: &Self) -> super::builder::workflow_template_service::GetOperation

在此服务中提供操作服务功能。

delete_operation

 fn delete_operation(self: &Self) -> super::builder::workflow_template_service::DeleteOperation

在此服务中提供操作服务功能。

cancel_operation

 fn cancel_operation(self: &Self) -> super::builder::workflow_template_service::CancelOperation

在此服务中提供操作服务功能。