此页面由 Cloud Translation API 翻译。

Package google.cloud.managedflink.v1alpha

索引

ManagedFlink（接口）
AutotuningConfig（消息）
AutotuningConfig.Elastic（消息）
AutotuningConfig.Fixed（消息）
CreateDeploymentRequest（消息）
CreateJobRequest（消息）
CreateSessionRequest（消息）
DeleteDeploymentRequest（消息）
DeleteJobRequest（消息）
DeleteSessionRequest（消息）
Deployment（消息）
Deployment.State（枚举）
DeploymentSpec（消息）
DisplayGraph（消息）
DisplayGraph.State（枚举）
GetDeploymentRequest（消息）
GetJobRequest（消息）
GetSessionRequest（消息）
Job（消息）
Job.State（枚举）
JobSpec（消息）
Limits（消息）
ListDeploymentsRequest（消息）
ListDeploymentsResponse（消息）
ListJobsRequest（消息）
ListJobsResponse（消息）
ListSessionsRequest（消息）
ListSessionsResponse（消息）
ManagedKafkaConfig（消息）
NetworkConfig（消息）
OperationMetadata（消息）
Session（消息）
StagingLocation（消息）
UpdateDeploymentRequest（消息）
UpdateJobRequest（消息）
UpdateSessionRequest（消息）

ManagedFlink

用于描述资源处理程序的服务

CreateDeployment

CreateDeployment
`rpc CreateDeployment(CreateDeploymentRequest) returns (Operation)` 在指定的项目和位置中创建新的部署。授权范围需要以下 OAuth 范围： `https://www.googleapis.com/auth/cloud-platform` 如需了解详情，请参阅身份验证概览。 IAM 权限需要拥有 `parent` 资源的以下 IAM 权限： `managedflink.deployments.create` 如需了解详情，请参阅 IAM 文档。

rpc CreateDeployment(CreateDeploymentRequest) returns (Operation)

在指定的项目和位置中创建新的部署。

授权范围

需要以下 OAuth 范围：

https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅身份验证概览。

IAM 权限

需要拥有 parent 资源的以下 IAM 权限：

managedflink.deployments.create

如需了解详情，请参阅 IAM 文档。

CreateJob

CreateJob
`rpc CreateJob(CreateJobRequest) returns (Operation)` 在指定的项目和位置中创建新作业。授权范围需要以下 OAuth 范围： `https://www.googleapis.com/auth/cloud-platform` 如需了解详情，请参阅身份验证概览。 IAM 权限需要拥有 `parent` 资源的以下 IAM 权限： `managedflink.jobs.create` 如需了解详情，请参阅 IAM 文档。

rpc CreateJob(CreateJobRequest) returns (Operation)

在指定的项目和位置中创建新作业。

授权范围

需要以下 OAuth 范围：

https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅身份验证概览。

IAM 权限

需要拥有 parent 资源的以下 IAM 权限：

managedflink.jobs.create

如需了解详情，请参阅 IAM 文档。

CreateSession

CreateSession
`rpc CreateSession(CreateSessionRequest) returns (Operation)` 在指定的项目和位置中创建新会话。授权范围需要以下 OAuth 范围： `https://www.googleapis.com/auth/cloud-platform` 如需了解详情，请参阅身份验证概览。 IAM 权限需要拥有 `parent` 资源的以下 IAM 权限： `managedflink.sessions.create` 如需了解详情，请参阅 IAM 文档。

rpc CreateSession(CreateSessionRequest) returns (Operation)

在指定的项目和位置中创建新会话。

授权范围

需要以下 OAuth 范围：

https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅身份验证概览。

IAM 权限

需要拥有 parent 资源的以下 IAM 权限：

managedflink.sessions.create

如需了解详情，请参阅 IAM 文档。

DeleteDeployment

DeleteDeployment
`rpc DeleteDeployment(DeleteDeploymentRequest) returns (Operation)` 删除单个部署。授权范围需要以下 OAuth 范围： `https://www.googleapis.com/auth/cloud-platform` 如需了解详情，请参阅身份验证概览。 IAM 权限需要拥有 `name` 资源的以下 IAM 权限： `managedflink.deployments.delete` 如需了解详情，请参阅 IAM 文档。

rpc DeleteDeployment(DeleteDeploymentRequest) returns (Operation)

删除单个部署。

授权范围

需要以下 OAuth 范围：

https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅身份验证概览。

IAM 权限

需要拥有 name 资源的以下 IAM 权限：

managedflink.deployments.delete

如需了解详情，请参阅 IAM 文档。

DeleteJob

DeleteJob
`rpc DeleteJob(DeleteJobRequest) returns (Operation)` 删除单个作业。授权范围需要以下 OAuth 范围： `https://www.googleapis.com/auth/cloud-platform` 如需了解详情，请参阅身份验证概览。 IAM 权限需要拥有 `name` 资源的以下 IAM 权限： `managedflink.jobs.delete` 如需了解详情，请参阅 IAM 文档。

rpc DeleteJob(DeleteJobRequest) returns (Operation)

删除单个作业。

授权范围

需要以下 OAuth 范围：

https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅身份验证概览。

IAM 权限

需要拥有 name 资源的以下 IAM 权限：

managedflink.jobs.delete

如需了解详情，请参阅 IAM 文档。

DeleteSession

DeleteSession
`rpc DeleteSession(DeleteSessionRequest) returns (Operation)` 删除单个会话。授权范围需要以下 OAuth 范围： `https://www.googleapis.com/auth/cloud-platform` 如需了解详情，请参阅身份验证概览。 IAM 权限需要拥有 `name` 资源的以下 IAM 权限： `managedflink.sessions.delete` 如需了解详情，请参阅 IAM 文档。

rpc DeleteSession(DeleteSessionRequest) returns (Operation)

删除单个会话。

授权范围

需要以下 OAuth 范围：

https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅身份验证概览。

IAM 权限

需要拥有 name 资源的以下 IAM 权限：

managedflink.sessions.delete

如需了解详情，请参阅 IAM 文档。

GetDeployment

GetDeployment
`rpc GetDeployment(GetDeploymentRequest) returns (Deployment)` 获取有关单个部署的详细信息。授权范围需要以下 OAuth 范围： `https://www.googleapis.com/auth/cloud-platform` 如需了解详情，请参阅身份验证概览。 IAM 权限需要拥有 `name` 资源的以下 IAM 权限： `managedflink.deployments.get` 如需了解详情，请参阅 IAM 文档。

rpc GetDeployment(GetDeploymentRequest) returns (Deployment)

获取有关单个部署的详细信息。

授权范围

需要以下 OAuth 范围：

https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅身份验证概览。

IAM 权限

需要拥有 name 资源的以下 IAM 权限：

managedflink.deployments.get

如需了解详情，请参阅 IAM 文档。

GetJob

GetJob
`rpc GetJob(GetJobRequest) returns (Job)` 获取单个作业的详细信息。授权范围需要以下 OAuth 范围： `https://www.googleapis.com/auth/cloud-platform` 如需了解详情，请参阅身份验证概览。 IAM 权限需要拥有 `name` 资源的以下 IAM 权限： `managedflink.jobs.get` 如需了解详情，请参阅 IAM 文档。

rpc GetJob(GetJobRequest) returns (Job)

获取单个作业的详细信息。

授权范围

需要以下 OAuth 范围：

https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅身份验证概览。

IAM 权限

需要拥有 name 资源的以下 IAM 权限：

managedflink.jobs.get

如需了解详情，请参阅 IAM 文档。

GetSession

GetSession
`rpc GetSession(GetSessionRequest) returns (Session)` 获取单个会话的详细信息。授权范围需要以下 OAuth 范围： `https://www.googleapis.com/auth/cloud-platform` 如需了解详情，请参阅身份验证概览。 IAM 权限需要拥有 `name` 资源的以下 IAM 权限： `managedflink.sessions.get` 如需了解详情，请参阅 IAM 文档。

rpc GetSession(GetSessionRequest) returns (Session)

获取单个会话的详细信息。

授权范围

需要以下 OAuth 范围：

https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅身份验证概览。

IAM 权限

需要拥有 name 资源的以下 IAM 权限：

managedflink.sessions.get

如需了解详情，请参阅 IAM 文档。

ListDeployments

ListDeployments
`rpc ListDeployments(ListDeploymentsRequest) returns (ListDeploymentsResponse)` 列出指定项目和位置中的部署。授权范围需要以下 OAuth 范围： `https://www.googleapis.com/auth/cloud-platform` 如需了解详情，请参阅身份验证概览。 IAM 权限需要拥有 `parent` 资源的以下 IAM 权限： `managedflink.deployments.list` 如需了解详情，请参阅 IAM 文档。

rpc ListDeployments(ListDeploymentsRequest) returns (ListDeploymentsResponse)

列出指定项目和位置中的部署。

授权范围

需要以下 OAuth 范围：

https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅身份验证概览。

IAM 权限

需要拥有 parent 资源的以下 IAM 权限：

managedflink.deployments.list

如需了解详情，请参阅 IAM 文档。

ListJobs

ListJobs
`rpc ListJobs(ListJobsRequest) returns (ListJobsResponse)` 列出指定项目和位置中的作业。授权范围需要以下 OAuth 范围： `https://www.googleapis.com/auth/cloud-platform` 如需了解详情，请参阅身份验证概览。 IAM 权限需要拥有 `parent` 资源的以下 IAM 权限： `managedflink.jobs.list` 如需了解详情，请参阅 IAM 文档。

rpc ListJobs(ListJobsRequest) returns (ListJobsResponse)

列出指定项目和位置中的作业。

授权范围

需要以下 OAuth 范围：

https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅身份验证概览。

IAM 权限

需要拥有 parent 资源的以下 IAM 权限：

managedflink.jobs.list

如需了解详情，请参阅 IAM 文档。

ListSessions

ListSessions
`rpc ListSessions(ListSessionsRequest) returns (ListSessionsResponse)` 列出指定项目和位置中的会话。授权范围需要以下 OAuth 范围： `https://www.googleapis.com/auth/cloud-platform` 如需了解详情，请参阅身份验证概览。 IAM 权限需要拥有 `parent` 资源的以下 IAM 权限： `managedflink.sessions.list` 如需了解详情，请参阅 IAM 文档。

rpc ListSessions(ListSessionsRequest) returns (ListSessionsResponse)

列出指定项目和位置中的会话。

授权范围

需要以下 OAuth 范围：

https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅身份验证概览。

IAM 权限

需要拥有 parent 资源的以下 IAM 权限：

managedflink.sessions.list

如需了解详情，请参阅 IAM 文档。

UpdateDeployment

UpdateDeployment
`rpc UpdateDeployment(UpdateDeploymentRequest) returns (Operation)` 更新单个部署的参数。授权范围需要以下 OAuth 范围： `https://www.googleapis.com/auth/cloud-platform` 如需了解详情，请参阅身份验证概览。 IAM 权限需要拥有 `name` 资源的以下 IAM 权限： `managedflink.deployments.update` 如需了解详情，请参阅 IAM 文档。

rpc UpdateDeployment(UpdateDeploymentRequest) returns (Operation)

更新单个部署的参数。

授权范围

需要以下 OAuth 范围：

https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅身份验证概览。

IAM 权限

需要拥有 name 资源的以下 IAM 权限：

managedflink.deployments.update

如需了解详情，请参阅 IAM 文档。

UpdateJob

UpdateJob
`rpc UpdateJob(UpdateJobRequest) returns (Operation)` 更新单个作业的参数。授权范围需要以下 OAuth 范围： `https://www.googleapis.com/auth/cloud-platform` 如需了解详情，请参阅身份验证概览。 IAM 权限需要拥有 `name` 资源的以下 IAM 权限： `managedflink.jobs.update` 如需了解详情，请参阅 IAM 文档。

rpc UpdateJob(UpdateJobRequest) returns (Operation)

更新单个作业的参数。

授权范围

需要以下 OAuth 范围：

https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅身份验证概览。

IAM 权限

需要拥有 name 资源的以下 IAM 权限：

managedflink.jobs.update

如需了解详情，请参阅 IAM 文档。

UpdateSession

UpdateSession
`rpc UpdateSession(UpdateSessionRequest) returns (Operation)` 更新单个会话的参数。授权范围需要以下 OAuth 范围： `https://www.googleapis.com/auth/cloud-platform` 如需了解详情，请参阅身份验证概览。 IAM 权限需要拥有 `name` 资源的以下 IAM 权限： `managedflink.sessions.update` 如需了解详情，请参阅 IAM 文档。

rpc UpdateSession(UpdateSessionRequest) returns (Operation)

更新单个会话的参数。

授权范围

需要以下 OAuth 范围：

https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅身份验证概览。

IAM 权限

需要拥有 name 资源的以下 IAM 权限：

managedflink.sessions.update

如需了解详情，请参阅 IAM 文档。

AutotuningConfig

Apache Flink 作业的自动调整配置。

字段

字段
联合字段 `horizontal_autoscaling_policy`。作业的横向自动扩缩政策。`horizontal_autoscaling_policy` 只能是下列其中一项：
`fixed`	`Fixed` 修复了用于停用自动扩缩的政策。
`throughput_based`	`Elastic` 基于吞吐量的自动扩缩政策，可利用观察到的吞吐量和实际处理速率（估算的最大可实现吞吐量）来自动扩缩每个作业顶点的任务并行度。

联合字段 horizontal_autoscaling_policy。作业的横向自动扩缩政策。horizontal_autoscaling_policy 只能是下列其中一项：

fixed

Fixed

修复了用于停用自动扩缩的政策。

throughput_based

Elastic

基于吞吐量的自动扩缩政策，可利用观察到的吞吐量和实际处理速率（估算的最大可实现吞吐量）来自动扩缩每个作业顶点的任务并行度。

Elastic

弹性自动扩缩政策，用于启用设有下限/上限的自动扩缩。

字段

字段
`parallelism`	`int32` 可选。作业的初始任务并行处理数。
`min_parallelism`	`int32` 可选。作业的任务并行处理数下限。
`max_parallelism`	`int32` 可选。作业的任务并行数量上限。

parallelism

int32

可选。作业的初始任务并行处理数。

min_parallelism

int32

可选。作业的任务并行处理数下限。

max_parallelism

int32

可选。作业的任务并行数量上限。

固定

修复了用于停用自动扩缩的政策。

字段

字段
`parallelism`	`int32` 可选。作业的固定任务并行处理数。

parallelism

int32

可选。作业的固定任务并行处理数。

CreateDeploymentRequest

用于创建适用于 Apache Flink 的 BigQuery 引擎部署的消息。

字段
`parent`	`string` 必需。要在其中创建部署的父级区域，按以下格式指定：`projects/{project}/locations/{location}`。
`deployment_id`	`string` 必需。发出请求的对象的 ID。如果在服务器端自动生成 ID，请从 Create RPC 的 method_signature 中移除此字段和 deployment_id
`deployment`	`Deployment` 必需。要创建的资源。
`request_id`	`string` 可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID，这样，在您必须重试请求时，服务器就会知道忽略该请求（如果该请求已完成）。服务器至少可以保证在第一次完成该请求后的 60 分钟内避免重复处理该请求。例如，假设在您最初发出一个请求后，该请求超时，然后您使用相同的请求 ID 再次发出该请求，那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了该请求，服务器会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。请求 ID 必须是有效的 UUID，且不支持全部由零组成的 UUID（即 00000000-0000-0000-0000-000000000000）。

CreateJobRequest

用于创建作业的邮件。

字段
`parent`	`string` 必需。要在其中创建作业的父级区域，按以下格式指定：`projects/{project}/locations/{location}`。
`job_id`	`string` 必需。要用于作业的 ID，该 ID 将成为作业名称的最后一个组成部分。
`job`	`Job` 必需。要创建的作业的配置。系统会忽略 `name` 字段。
`request_id`	`string` 可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID，这样，在您必须重试请求时，服务器就会知道忽略该请求（如果该请求已完成）。服务器至少可以保证在第一次完成该请求后的 60 分钟内避免重复处理该请求。例如，假设在您最初发出一个请求后，该请求超时，然后您使用相同的请求 ID 再次发出该请求，那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了该请求，服务器会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。请求 ID 必须是有效的 UUID，且不支持全部由零组成的 UUID（即 00000000-0000-0000-0000-000000000000）。

CreateSessionRequest

创建会话的消息。

字段
`parent`	`string` 必需。要在其中创建会话的父级区域，格式如下：`projects/{project}/locations/{location}`。
`session_id`	`string` 必需。要为会话使用的 ID。
`session`	`Session` 必需。正在创建的会话。
`request_id`	`string` 可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID，这样，在您必须重试请求时，服务器就会知道忽略该请求（如果该请求已完成）。服务器至少可以保证在第一次完成该请求后的 60 分钟内避免重复处理该请求。例如，假设在您最初发出一个请求后，该请求超时，然后您使用相同的请求 ID 再次发出该请求，那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了该请求，服务器会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。请求 ID 必须是有效的 UUID，且不支持全部由零组成的 UUID（即 00000000-0000-0000-0000-000000000000）。

DeleteDeploymentRequest

用于删除适用于 Apache Flink 的 BigQuery 引擎部署的消息。

字段

字段
`name`	`string` 必需。资源的名称。
`request_id`	`string` 可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID，这样，在您必须重试请求时，服务器就会知道忽略该请求（如果该请求已完成）。服务器至少可以保证在第一次完成该请求后的 60 分钟内避免重复处理该请求。例如，假设在您最初发出一个请求后，该请求超时，然后您使用相同的请求 ID 再次发出该请求，那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了该请求，服务器会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。请求 ID 必须是有效的 UUID，且不支持全部由零组成的 UUID（即 00000000-0000-0000-0000-000000000000）。

name

string

必需。资源的名称。

request_id

string

可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID，这样，在您必须重试请求时，服务器就会知道忽略该请求（如果该请求已完成）。服务器至少可以保证在第一次完成该请求后的 60 分钟内避免重复处理该请求。

例如，假设在您最初发出一个请求后，该请求超时，然后您使用相同的请求 ID 再次发出该请求，那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了该请求，服务器会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。

请求 ID 必须是有效的 UUID，且不支持全部由零组成的 UUID（即 00000000-0000-0000-0000-000000000000）。

DeleteJobRequest

删除作业的相关消息。

字段

字段
`name`	`string` 必需。资源的名称。
`request_id`	`string` 可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID，这样，在您必须重试请求时，服务器就会知道忽略该请求（如果该请求已完成）。服务器至少可以保证在第一次完成该请求后的 60 分钟内避免重复处理该请求。例如，假设在您最初发出一个请求后，该请求超时，然后您使用相同的请求 ID 再次发出该请求，那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了该请求，服务器会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。请求 ID 必须是有效的 UUID，且不支持全部由零组成的 UUID（即 00000000-0000-0000-0000-000000000000）。

name

string

必需。资源的名称。

request_id

string

请求 ID 必须是有效的 UUID，且不支持全部由零组成的 UUID（即 00000000-0000-0000-0000-000000000000）。

DeleteSessionRequest

删除会话时显示的消息。

字段

字段
`name`	`string` 必需。会话名称，采用以下格式指定：`projects/{project}/locations/{location}/sessions/{session}`
`request_id`	`string` 可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID，这样，在您必须重试请求时，服务器就会知道忽略该请求（如果该请求已完成）。服务器至少可以保证在第一次完成该请求后的 60 分钟内避免重复处理该请求。例如，假设在您最初发出一个请求后，该请求超时，然后您使用相同的请求 ID 再次发出该请求，那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了该请求，服务器会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。请求 ID 必须是有效的 UUID，且不支持全部由零组成的 UUID（即 00000000-0000-0000-0000-000000000000）。

name

string

必需。会话名称，采用以下格式指定：projects/{project}/locations/{location}/sessions/{session}

request_id

string

请求 ID 必须是有效的 UUID，且不支持全部由零组成的 UUID（即 00000000-0000-0000-0000-000000000000）。

部署

介绍适用于 Apache Flink 的 BigQuery 引擎部署资源。

字段
`name`	`string` 标识符。部署的名称。
`display_name`	`string` 可选。部署的显示名称。
`state`	`State` 仅限输出。部署的状态。
`create_time`	`Timestamp` 仅限输出。部署的创建时间。
`update_time`	`Timestamp` 仅限输出。上次更新部署的时间。
`labels`	`map<string, string>` 可选。标签是键值对。
`deployment_spec`	`DeploymentSpec` 可选。用于描述部署的规范。

州

用于定义部署状态的枚举。

枚举
`STATE_UNSPECIFIED`	状态未指定。
`INITIALIZING`	部署正在初始化。
`CREATED`	部署已创建。
`RUNNING`	部署正在运行。
`TERMINATING`	部署正在终止。
`TERMINATED`	部署已终止。

DeploymentSpec

部署的规范。

字段

字段
`network_config`	`NetworkConfig` 可选。部署的网络配置。
`limits`	`Limits` 可选。部署的限制条件。
`secrets_paths[]`	`string` 可选。目前不支持。要与此部署关联的 Secret 的路径。

network_config

NetworkConfig

可选。部署的网络配置。

limits

Limits

可选。部署的限制条件。

secrets_paths[]

string

可选。目前不支持。要与此部署关联的 Secret 的路径。

DisplayGraph

作业的 Apache Flink 显示图表。

字段

字段
`display_graph_json`	`string` 仅限输出。JSON 格式的显示图表。
`state`	`State` 仅限输出。显示图表的状态。

display_graph_json

string

仅限输出。JSON 格式的显示图表。

state

State

仅限输出。显示图表的状态。

州

用于定义显示图表状态的枚举。

枚举
`STATE_UNSPECIFIED`	未指定显示图表状态。
`DISPLAY_GRAPH_POPULATED`	系统会填充显示图表。
`DISPLAY_GRAPH_TOO_LARGE`	显示图表过大。
`DISPLAY_GRAPH_EMPTY`	显示图表为空。

GetDeploymentRequest

用于获取部署的消息。

字段

字段
`name`	`string` 必需。资源的名称。

name

string

必需。资源的名称。

GetJobRequest

用于获取作业的邮件。

字段

字段
`name`	`string` 必需。资源的名称。

name

string

必需。资源的名称。

GetSessionRequest

用于获取会话的消息。

字段

字段
`name`	`string` 必需。资源的名称。

name

string

必需。资源的名称。

作业

介绍适用于 Apache Flink 的 BigQuery 引擎作业资源。

字段
`name`	`string` 标识符。作业的名称。
`state`	`State` 仅限输出。Apache Flink 作业的状态。
`create_time`	`Timestamp` 仅限输出。作业的创建时间。
`update_time`	`Timestamp` 仅限输出。上次更新作业的时间。
`labels`	`map<string, string>` 可选。用户定义的标签，以键值对的形式。
`deployment_id`	`string` 可选。此作业所属的部署。如果为空，则在临时按需 Apache Flink 集群中创建作业。
`job_spec`	`JobSpec` 必需。Apache Flink 作业的规范。
`display_graph`	`DisplayGraph` 仅限输出。Apache Flink 作业的显示图表。此字段仅在 `GetAPI` 调用时填充。系统不会在 `ListAPI` 调用中填充此值。

州

Apache Flink 作业的状态。这些状态基于 Apache Flink REST API。

枚举
`STATE_UNSPECIFIED`	状态未指定。
`PENDING_CREATION`	作业正在等待创建。
`INITIALIZING`	作业正在初始化。
`CREATED`	已创建作业。
`RUNNING`	作业正在运行。
`FAILING`	作业失败。
`FAILED`	作业已失败。
`CANCELLING`	作业正在取消。
`CANCELLED`	作业已取消。
`FINISHED`	作业已完成。
`RESTARTING`	作业正在重启。
`SUSPENDED`	作业已暂停。
`RECONCILING`	作业正在协调。

JobSpec

Apache Flink 作业的规范。

字段
`jar_uris[]`	`string` 可选。Cloud Storage 中作业 JAR 的 URI 列表。
`job_graph_uri`	`string` 必需。Cloud Storage 中的作业图 URI。
`artifact_uris[]`	`string` 必需。Cloud Storage 中作业工件文件的 URI 列表。
`autotuning_config`	`AutotuningConfig` 可选。作业的自动调整配置。
`network_config`	`NetworkConfig` 可选。作业的网络配置。
`display_name`	`string` 可选。作业的显示名称。此名称由用户明确设置。
`job_name`	`string` 可选。作业的作业名称。客户端会自动从作业图中派生此名称。
`managed_kafka_config`	`ManagedKafkaConfig` 可选。作业要使用的 Google Cloud Managed Service for Apache Kafka 集群的配置。
`job_graph_encoding`	`string` 可选。作业图的编码类型。

限制

部署的限制条件。这些限制基于不同底层资源的上限。

字段

字段
`max_slots`	`int64` 可选。部署的槽数上限。

max_slots

int64

可选。部署的槽数上限。

ListDeploymentsRequest

用于请求部署列表的消息。

字段
`parent`	`string` 必需。`ListDeploymentsRequest` 的父级值。该值是位置，采用以下格式指定：`projects/{project}/locations/{location}`。
`page_size`	`int32` 可选。请求的页面大小。服务器返回的项目数量可能少于请求的数量。如果未指定，服务器会选择相应的默认值。
`page_token`	`string` 可选。标识服务器应返回的结果页面的令牌。
`filter`	`string` 可选。用于过滤返回的部署列表的表达式。该表达式必须使用 AIP-160 中记录的语法。
`order_by`	`string` 可选。有关如何对结果进行排序的提示。必须按照 AIP-132 中所述指定提示。

ListDeploymentsResponse

对列出部署的请求的响应。

字段

字段
`deployments[]`	`Deployment` 部署列表。
`next_page_token`	`string` 标识服务器应返回的结果页面的令牌。
`unreachable[]`	`string` 无法到达的位置。

deployments[]

Deployment

部署列表。

next_page_token

string

标识服务器应返回的结果页面的令牌。

unreachable[]

string

无法到达的位置。

ListJobsRequest

用于请求作业列表的消息。

字段
`parent`	`string` 必需。`ListJobsRequest` 的父级值。该值是位置，采用以下格式指定：`projects/{project}/locations/{location}`。
`page_size`	`int32` 可选。请求的页面大小。服务器返回的项目数量可能少于请求的数量。如果未指定，服务器会选择相应的默认值。
`page_token`	`string` 可选。标识服务器应返回的结果页面的令牌。
`filter`	`string` 可选。用于过滤返回的作业列表的表达式。该表达式必须使用 AIP-160 中记录的语法。
`order_by`	`string` 可选。有关如何对结果进行排序的提示。必须按照 AIP-132 中所述指定提示。

ListJobsResponse

对列出作业请求的响应。

字段

字段
`jobs[]`	`Job` 作业列表。
`next_page_token`	`string` 标识服务器应返回的结果页面的令牌。
`unreachable[]`	`string` 无法到达的位置。

jobs[]

Job

作业列表。

next_page_token

string

标识服务器应返回的结果页面的令牌。

unreachable[]

string

无法到达的位置。

ListSessionsRequest

用于请求会话列表的消息。

字段
`parent`	`string` 必需。`ListSessionsRequest` 的父级值。该值是位置，采用以下格式指定：`projects/{project}/locations/{location}`。
`page_size`	`int32` 可选。请求的页面大小。服务器返回的项目数量可能少于请求的数量。如果未指定，服务器会选择相应的默认值。
`page_token`	`string` 可选。标识服务器应返回的结果页面的令牌。
`filter`	`string` 可选。用于过滤返回的会话列表的表达式。例如，您可以过滤出有效时段。该表达式必须使用 AIP-160 中记录的语法。
`order_by`	`string` 可选。有关如何对结果进行排序的提示。例如，您可以按创建时间或上次更改时间对报告进行排序。必须按照 AIP-132 中所述指定提示。

ListSessionsResponse

对列出会话的响应消息。

字段

字段
`sessions[]`	`Session` 会话列表。
`next_page_token`	`string` 要返回的会话数量上限。服务器返回的项目数量可能少于请求的数量。如果未指定，则最多返回 50 个会话。最大值为 1,000；大于 1,000 的值会强制转换为 1,000。
`unreachable[]`	`string` 无法到达的位置。

sessions[]

Session

会话列表。

next_page_token

string

要返回的会话数量上限。服务器返回的项目数量可能少于请求的数量。如果未指定，则最多返回 50 个会话。最大值为 1,000；大于 1,000 的值会强制转换为 1,000。

unreachable[]

string

无法到达的位置。

ManagedKafkaConfig

作业要使用的 Google Cloud Managed Service for Apache Kafka 集群的配置。

字段

字段
`managed_kafka_clusters[]`	`string` 可选。与作业关联的 Managed Service for Apache Kafka 集群的列表，采用以下格式指定：`projects/<project-id>/locations/<region>/clusters/<cluster-name>`。

managed_kafka_clusters[]

string

可选。与作业关联的 Managed Service for Apache Kafka 集群的列表，采用以下格式指定：projects/<project-id>/locations/<region>/clusters/<cluster-name>。

NetworkConfig

可连接到适用于 Apache Flink 的 BigQuery 引擎集群的 VPC、区域和子网。

字段

字段
`vpc`	`string` 可选。要将适用于 Apache Flink 的 BigQuery Engine 资源与之关联的 VPC 网络的名称，采用以下格式指定：`projects/{project}/global/networks/{network_id}`。
`subnetwork`	`string` 可选。资源的子网。

vpc

string

可选。要将适用于 Apache Flink 的 BigQuery Engine 资源与之关联的 VPC 网络的名称，采用以下格式指定：projects/{project}/global/networks/{network_id}。

subnetwork

string

可选。资源的子网。

OperationMetadata

表示长时间运行的操作的元数据。

字段
`create_time`	`Timestamp` 仅供输出。操作的创建时间。
`end_time`	`Timestamp` 仅供输出。操作完成运行的时间。
`target`	`string` 仅限输出。由服务器定义的操作目标的资源路径。
`verb`	`string` 仅限输出。操作执行的谓词的名称。
`status_message`	`string` 仅限输出。人类可读的操作状态（如果有）。
`requested_cancellation`	`bool` 仅限输出。标识用户是否已请求取消操作。已成功取消的操作具有 [Operation.error][] 值且 `google.rpc.Status.code` 为 1（对应于 `Code.CANCELLED`）。
`api_version`	`string` 仅限输出。用于启动操作的 API 版本。

会话

介绍 Apache Flink 会话对象。

字段
`name`	`string` 标识符。资源的名称。
`create_time`	`Timestamp` 仅限输出。[仅限输出] 创建时间戳。
`update_time`	`Timestamp` 仅限输出。[仅限输出] 更新时间戳。
`labels`	`map<string, string>` 可选。标签是键值对。
`staging_location`	`StagingLocation` 可选。会话中工件的暂存位置。此位置可以由用户提供，也可以由系统生成默认的暂存位置。

StagingLocation

Apache Flink 会话中工件的暂存位置。

字段

字段
`bucker_provider`	`string` 可选。用于在会话中暂存工件的存储桶类型。
`bucket`	`string` 可选。用于在会话中暂存工件的存储桶。
`path`	`string` 可选。存储桶中用于在会话中暂存工件的路径。

bucker_provider

string

可选。用于在会话中暂存工件的存储桶类型。

bucket

string

可选。用于在会话中暂存工件的存储桶。

path

string

可选。存储桶中用于在会话中暂存工件的路径。

UpdateDeploymentRequest

用于更新适用于 Apache Flink 的 BigQuery 引擎部署的消息。

字段

字段
`update_mask`	`FieldMask` 必需。字段掩码用于指定更新将在部署资源中覆盖的字段。`update_mask` 中指定的字段与资源相关，而不是与完整请求相关。如果字段在掩码中，则会被覆盖。如果您未提供掩码，则所有字段都会被覆盖。
`deployment`	`Deployment` 必需。要更新的资源。
`request_id`	`string` 可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID，这样，在您必须重试请求时，服务器就会知道忽略该请求（如果该请求已完成）。服务器至少可以保证在第一次完成该请求后的 60 分钟内避免重复处理该请求。例如，假设在您最初发出一个请求后，该请求超时，然后您使用相同的请求 ID 再次发出该请求，那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了该请求，服务器会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。请求 ID 必须是有效的 UUID，且不支持全部由零组成的 UUID（即 00000000-0000-0000-0000-000000000000）。

update_mask

FieldMask

必需。字段掩码用于指定更新将在部署资源中覆盖的字段。update_mask 中指定的字段与资源相关，而不是与完整请求相关。如果字段在掩码中，则会被覆盖。如果您未提供掩码，则所有字段都会被覆盖。

deployment

Deployment

必需。要更新的资源。

request_id

string

请求 ID 必须是有效的 UUID，且不支持全部由零组成的 UUID（即 00000000-0000-0000-0000-000000000000）。

UpdateJobRequest

用于更新作业的邮件。

字段

字段
`update_mask`	`FieldMask` 必需。字段掩码用于指定更新将在作业资源中覆盖的字段。`update_mask` 中指定的字段与资源相关，而不是与完整请求相关。如果字段在掩码中，则会被覆盖。如果您未提供掩码，则所有字段都会被覆盖。
`job`	`Job` 必需。要更新的资源。
`request_id`	`string` 可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID，这样，在您必须重试请求时，服务器就会知道忽略该请求（如果该请求已完成）。服务器至少可以保证在第一次完成该请求后的 60 分钟内避免重复处理该请求。例如，假设在您最初发出一个请求后，该请求超时，然后您使用相同的请求 ID 再次发出该请求，那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了该请求，服务器会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。请求 ID 必须是有效的 UUID，且不支持全部由零组成的 UUID（即 00000000-0000-0000-0000-000000000000）。

update_mask

FieldMask

必需。字段掩码用于指定更新将在作业资源中覆盖的字段。update_mask 中指定的字段与资源相关，而不是与完整请求相关。如果字段在掩码中，则会被覆盖。如果您未提供掩码，则所有字段都会被覆盖。

job

Job

必需。要更新的资源。

request_id

string

请求 ID 必须是有效的 UUID，且不支持全部由零组成的 UUID（即 00000000-0000-0000-0000-000000000000）。

UpdateSessionRequest

用于更新会话的消息。

字段

字段
`session`	`Session` 必需。要更新的会话。
`update_mask`	`FieldMask` 必需。字段掩码用于指定更新将在会话资源中覆盖的字段。`update_mask` 中指定的字段与资源相关，而不是与完整请求相关。如果字段在掩码中，则会被覆盖。如果您未提供掩码，则所有字段都会被覆盖。
`request_id`	`string` 可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID，这样，在您必须重试请求时，服务器就会知道忽略该请求（如果该请求已完成）。服务器至少可以保证在第一次完成该请求后的 60 分钟内避免重复处理该请求。例如，假设在您最初发出一个请求后，该请求超时，然后您使用相同的请求 ID 再次发出该请求，那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了该请求，服务器会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。请求 ID 必须是有效的 UUID，且不支持全部由零组成的 UUID（即 00000000-0000-0000-0000-000000000000）。

session

Session

必需。要更新的会话。

update_mask

FieldMask

必需。字段掩码用于指定更新将在会话资源中覆盖的字段。update_mask 中指定的字段与资源相关，而不是与完整请求相关。如果字段在掩码中，则会被覆盖。如果您未提供掩码，则所有字段都会被覆盖。

request_id

string

请求 ID 必须是有效的 UUID，且不支持全部由零组成的 UUID（即 00000000-0000-0000-0000-000000000000）。