本頁面由 Cloud Translation API 翻譯而成。

Package google.cloud.dataproc.v1

索引

BatchController (介面)
SessionController (介面)
SessionTemplateController (介面)
AnalyzeOperationMetadata (訊息)
AnalyzeOperationMetadata.WorkloadType (enum)
AutotuningConfig (訊息)
AutotuningConfig.Scenario (enum)
Batch (訊息)
Batch.State (enum)
Batch.StateHistory (訊息)
BatchOperationMetadata (訊息)
BatchOperationMetadata.BatchOperationType (enum)
CreateBatchRequest (訊息)
CreateSessionRequest (訊息)
CreateSessionTemplateRequest (訊息)
DeleteBatchRequest (訊息)
DeleteSessionRequest (訊息)
DeleteSessionTemplateRequest (訊息)
DiagnoseClusterResults (訊息)
EnvironmentConfig (訊息)
ExecutionConfig (訊息)
GetBatchRequest (訊息)
GetSessionRequest (訊息)
GetSessionTemplateRequest (訊息)
JupyterConfig (訊息)
JupyterConfig.Kernel (enum)
ListBatchesRequest (訊息)
ListBatchesResponse (訊息)
ListSessionTemplatesRequest (訊息)
ListSessionTemplatesResponse (訊息)
ListSessionsRequest (訊息)
ListSessionsResponse (訊息)
PeripheralsConfig (訊息)
PyPiRepositoryConfig (訊息)
PySparkBatch (訊息)
RepositoryConfig (訊息)
RuntimeConfig (訊息)
RuntimeInfo (訊息)
Session (訊息)
Session.SessionStateHistory (訊息)
Session.State (enum)
SessionOperationMetadata (訊息)
SessionOperationMetadata.SessionOperationType (enum)
SessionTemplate (訊息)
SparkBatch (訊息)
SparkConnectConfig (訊息)
SparkHistoryServerConfig (訊息)
SparkRBatch (訊息)
SparkSqlBatch (訊息)
TerminateSessionRequest (訊息)
UpdateSessionTemplateRequest (訊息)
UsageMetrics (訊息)
UsageSnapshot (訊息)

BatchController

BatchController 提供管理批次工作負載的方法。

CreateBatch

CreateBatch
`rpc CreateBatch(CreateBatchRequest) returns (Operation)` 建立非同步執行的批次工作負載。授權範圍需要下列 OAuth 範圍： `https://www.googleapis.com/auth/cloud-platform` 詳情請參閱驗證總覽一文。

rpc CreateBatch(CreateBatchRequest) returns (Operation)

建立非同步執行的批次工作負載。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱驗證總覽一文。

DeleteBatch

DeleteBatch
`rpc DeleteBatch(DeleteBatchRequest) returns (Empty)` 刪除批次工作負載資源。如果批次不在 `CANCELLED`、`SUCCEEDED` 或 `FAILED` `State` 中，刪除作業就會失敗，且回應會傳回 `FAILED_PRECONDITION`。授權範圍需要下列 OAuth 範圍： `https://www.googleapis.com/auth/cloud-platform` 詳情請參閱驗證總覽一文。

rpc DeleteBatch(DeleteBatchRequest) returns (Empty)

刪除批次工作負載資源。如果批次不在 CANCELLED、SUCCEEDED 或 FAILED State 中，刪除作業就會失敗，且回應會傳回 FAILED_PRECONDITION。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱驗證總覽一文。

GetBatch

GetBatch
`rpc GetBatch(GetBatchRequest) returns (Batch)` 取得批次工作負載資源表示法。授權範圍需要下列 OAuth 範圍： `https://www.googleapis.com/auth/cloud-platform` 詳情請參閱驗證總覽一文。

rpc GetBatch(GetBatchRequest) returns (Batch)

取得批次工作負載資源表示法。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱驗證總覽一文。

ListBatches

ListBatches
`rpc ListBatches(ListBatchesRequest) returns (ListBatchesResponse)` 列出批次工作負載。授權範圍需要下列 OAuth 範圍： `https://www.googleapis.com/auth/cloud-platform` 詳情請參閱驗證總覽一文。

rpc ListBatches(ListBatchesRequest) returns (ListBatchesResponse)

列出批次工作負載。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱驗證總覽一文。

SessionController

SessionController 提供管理互動式工作階段的方法。

CreateSession

CreateSession
`rpc CreateSession(CreateSessionRequest) returns (Operation)` 以非同步方式建立互動工作階段。授權範圍需要下列 OAuth 範圍： `https://www.googleapis.com/auth/cloud-platform` 詳情請參閱驗證總覽一文。

rpc CreateSession(CreateSessionRequest) returns (Operation)

以非同步方式建立互動工作階段。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱驗證總覽一文。

DeleteSession

DeleteSession
`rpc DeleteSession(DeleteSessionRequest) returns (Operation)` 刪除互動工作階段資源。如果工作階段並未處於終端狀態，系統會終止工作階段，然後刪除。授權範圍需要下列 OAuth 範圍： `https://www.googleapis.com/auth/cloud-platform` 詳情請參閱驗證總覽一文。

rpc DeleteSession(DeleteSessionRequest) returns (Operation)

刪除互動工作階段資源。如果工作階段並未處於終端狀態，系統會終止工作階段，然後刪除。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱驗證總覽一文。

GetSession

GetSession
`rpc GetSession(GetSessionRequest) returns (Session)` 取得互動工作階段的資源表示法。授權範圍需要下列 OAuth 範圍： `https://www.googleapis.com/auth/cloud-platform` 詳情請參閱驗證總覽一文。

rpc GetSession(GetSessionRequest) returns (Session)

取得互動工作階段的資源表示法。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱驗證總覽一文。

ListSessions

ListSessions
`rpc ListSessions(ListSessionsRequest) returns (ListSessionsResponse)` 列出互動工作階段。授權範圍需要下列 OAuth 範圍： `https://www.googleapis.com/auth/cloud-platform` 詳情請參閱驗證總覽一文。

rpc ListSessions(ListSessionsRequest) returns (ListSessionsResponse)

列出互動工作階段。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱驗證總覽一文。

TerminateSession

TerminateSession
`rpc TerminateSession(TerminateSessionRequest) returns (Operation)` 終止互動工作階段。授權範圍需要下列 OAuth 範圍： `https://www.googleapis.com/auth/cloud-platform` 詳情請參閱驗證總覽一文。

rpc TerminateSession(TerminateSessionRequest) returns (Operation)

終止互動工作階段。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱驗證總覽一文。

SessionTemplateController

SessionTemplateController 提供管理工作階段範本的方法。

CreateSessionTemplate

CreateSessionTemplate
`rpc CreateSessionTemplate(CreateSessionTemplateRequest) returns (SessionTemplate)` 同步建立工作階段範本。授權範圍需要下列 OAuth 範圍： `https://www.googleapis.com/auth/cloud-platform` 詳情請參閱驗證總覽一文。

rpc CreateSessionTemplate(CreateSessionTemplateRequest) returns (SessionTemplate)

同步建立工作階段範本。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱驗證總覽一文。

DeleteSessionTemplate

DeleteSessionTemplate
`rpc DeleteSessionTemplate(DeleteSessionTemplateRequest) returns (Empty)` 刪除工作階段範本。授權範圍需要下列 OAuth 範圍： `https://www.googleapis.com/auth/cloud-platform` 詳情請參閱驗證總覽一文。

rpc DeleteSessionTemplate(DeleteSessionTemplateRequest) returns (Empty)

刪除工作階段範本。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱驗證總覽一文。

GetSessionTemplate

GetSessionTemplate
`rpc GetSessionTemplate(GetSessionTemplateRequest) returns (SessionTemplate)` 取得工作階段範本的資源表示法。授權範圍需要下列 OAuth 範圍： `https://www.googleapis.com/auth/cloud-platform` 詳情請參閱驗證總覽一文。

rpc GetSessionTemplate(GetSessionTemplateRequest) returns (SessionTemplate)

取得工作階段範本的資源表示法。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱驗證總覽一文。

ListSessionTemplates

ListSessionTemplates
`rpc ListSessionTemplates(ListSessionTemplatesRequest) returns (ListSessionTemplatesResponse)` 列出工作階段範本。授權範圍需要下列 OAuth 範圍： `https://www.googleapis.com/auth/cloud-platform` 詳情請參閱驗證總覽一文。

rpc ListSessionTemplates(ListSessionTemplatesRequest) returns (ListSessionTemplatesResponse)

列出工作階段範本。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱驗證總覽一文。

UpdateSessionTemplate

UpdateSessionTemplate
`rpc UpdateSessionTemplate(UpdateSessionTemplateRequest) returns (SessionTemplate)` 同步更新工作階段範本。授權範圍需要下列 OAuth 範圍： `https://www.googleapis.com/auth/cloud-platform` 詳情請參閱驗證總覽一文。

rpc UpdateSessionTemplate(UpdateSessionTemplateRequest) returns (SessionTemplate)

同步更新工作階段範本。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱驗證總覽一文。

AnalyzeOperationMetadata

說明分析作業的中繼資料。

欄位
`analyzed_workload_name`	`string` 僅供輸出。正在分析的工作負載名稱。
`analyzed_workload_type`	`WorkloadType` 僅供輸出。所分析的工作負載類型。
`analyzed_workload_uuid`	`string` 僅供輸出。工作負載的專屬 ID，通常由控制平面產生。例如批次 UUID。
`create_time`	`Timestamp` 僅供輸出。作業的建立時間。
`done_time`	`Timestamp` 僅供輸出。作業完成的時間。
`description`	`string` 僅供輸出。作業的簡短說明。
`labels`	`map<string, string>` 僅供輸出。與作業相關聯的標籤。
`warnings[]`	`string` 僅供輸出。在作業執行期間遇到的警告。

WorkloadType

工作負載類型

列舉
`WORKLOAD_TYPE_UNSPECIFIED`	未定義的選項
`BATCH`	無伺服器批次工作

AutotuningConfig

工作負載的自動調整設定。

欄位

欄位
`scenarios[]`	`Scenario` (非必要) 套用微調的情況。

scenarios[]

Scenario

(非必要) 套用微調的情況。

情境

情境代表自動調整功能會透過修改工作負載來嘗試達成的特定目標。

列舉
`SCENARIO_UNSPECIFIED`	預設值。
`SCALING`	擴充建議，例如 initialExecutors。
`BROADCAST_HASH_JOIN`	新增可能的關聯廣播提示。
`MEMORY`	工作負載的記憶體管理。

批次

服務中的批次工作負載表示法。

欄位
`name`	`string` 僅供輸出。批次的資源名稱。
`uuid`	`string` 僅供輸出。批次 UUID (通用專屬 ID)。服務會在建立批次時產生這個值。
`create_time`	`Timestamp` 僅供輸出。建立批次的時間。
`runtime_info`	`RuntimeInfo` 僅供輸出。批次執行作業的執行階段資訊。
`state`	`State` 僅供輸出。批次的狀態。
`state_message`	`string` 僅供輸出。批次狀態詳細資料，例如狀態為 `FAILED` 時的失敗說明。
`state_time`	`Timestamp` 僅供輸出。批次進入目前狀態的時間。
`creator`	`string` 僅供輸出。建立批次的使用者電子郵件地址。
`labels`	`map<string, string>` (非必要) 要與此批次相關聯的標籤。標籤鍵必須包含 1 至 63 個字元，且必須符合 RFC 1035 標準。標籤值可以為空白，但如果有值，則必須包含 1 到 63 個字元，且必須符合 RFC 1035。一個批次最多可關聯 32 個標籤。
`runtime_config`	`RuntimeConfig` (非必要) 批次執行作業的執行階段設定。
`environment_config`	`EnvironmentConfig` (非必要) 批次執行作業的環境設定。
`operation`	`string` 僅供輸出。與此批次相關聯的作業資源名稱。
`state_history[]`	`StateHistory` 僅供輸出。批次的歷史狀態資訊。
聯集欄位 `batch_config`。批次設定的應用程式/架構專屬部分。`batch_config` 只能是下列其中一項：
`pyspark_batch`	`PySparkBatch` (非必要) PySpark 批次設定。
`spark_batch`	`SparkBatch` (非必要) Spark 批次設定。
`spark_r_batch`	`SparkRBatch` (非必要) SparkR 批次設定。
`spark_sql_batch`	`SparkSqlBatch` (非必要) SparkSql 批次設定。

狀態

批次狀態。

列舉
`STATE_UNSPECIFIED`	批次狀態不明。
`PENDING`	批次會在執行前建立。
`RUNNING`	批次正在執行。
`CANCELLING`	批次正在取消。
`CANCELLED`	已成功取消批次。
`SUCCEEDED`	批次已順利完成。
`FAILED`	批次因發生錯誤而停止運作。

StateHistory

歷來狀態資訊。

欄位

欄位
`state`	`State` 僅供輸出。批次在這個時間點的狀態。
`state_message`	`string` 僅供輸出。歷史記錄中此時點的狀態詳細資料。
`state_start_time`	`Timestamp` 僅供輸出。批次進入歷史狀態的時間。

state

State

僅供輸出。批次在這個時間點的狀態。

state_message

string

僅供輸出。歷史記錄中此時點的狀態詳細資料。

state_start_time

Timestamp

僅供輸出。批次進入歷史狀態的時間。

批次作業中繼資料

描述批次作業的中繼資料。

欄位
`batch`	`string` 作業的批次名稱。
`batch_uuid`	`string` 作業的批次 UUID。
`create_time`	`Timestamp` 作業的建立時間。
`done_time`	`Timestamp` 作業完成的時間。
`operation_type`	`BatchOperationType` 作業類型。
`description`	`string` 作業的簡短說明。
`labels`	`map<string, string>` 與作業相關聯的標籤。
`warnings[]`	`string` 在作業執行期間遇到的警告。

BatchOperationType

Batch 資源的作業類型

列舉
`BATCH_OPERATION_TYPE_UNSPECIFIED`	批次作業類型不明。
`BATCH`	批次作業類型。

CreateBatchRequest

建立批次工作負載的要求。

欄位
`parent`	`string` 這是必要旗標，表示將建立這個批次的父項資源。授權需要指定資源 `parent` 的下列 IAM 權限： `dataproc.batches.create`
`batch`	`Batch` 這是必要旗標，要建立的批次。
`batch_id`	`string` (非必要) 要用於批次的 ID，這會成為批次資源名稱的最終元件。這個值的長度必須介於 4 至 63 個字元之間。有效字元為 `/[a-z][0-9]-/`。
`request_id`	`string` (非必要) 用於識別要求的專屬 ID。如果服務收到兩個具有相同 request_id 的 CreateBatchRequest，系統會忽略第二個要求，並傳回與在後端建立及儲存的第一個批次相對應的作業。建議：請將這個值設為 UUID。值只能包含英文字母 (a-z、A-Z)、數字 (0-9)、底線 (_) 和連字號 (-)，長度上限為 40 個半形字元。

CreateSessionRequest

建立工作階段的要求。

欄位
`parent`	`string` 這是必要旗標，表示將建立這個工作階段的父項資源。授權需要指定資源 `parent` 的下列 IAM 權限： `dataproc.sessions.create`
`session`	`Session` 這是必要旗標，要建立的互動工作階段。
`session_id`	`string` 這是必要旗標，工作階段要使用的 ID，會成為工作階段資源名稱的最終元件。這個值的長度必須介於 4 至 63 個字元之間。有效字元為 /[a-z][0-9]-/。
`request_id`	`string` (非必要) 用於識別要求的專屬 ID。如果服務收到兩個 ID 相同的 CreateSessionRequests，系統會忽略第二個要求，並建立並在後端儲存第一個 `Session`。建議：請將這個值設為 UUID。值只能包含英文字母 (a-z、A-Z)、數字 (0-9)、底線 (_) 和連字號 (-)，長度上限為 40 個半形字元。

CreateSessionTemplateRequest

建立工作階段範本的要求。

欄位

欄位
`parent`	`string` 這是必要旗標，表示將建立這個工作階段範本的父項資源。授權需要指定資源 `parent` 的下列 IAM 權限： `dataproc.sessionTemplates.create`
`session_template`	`SessionTemplate` 這是必要旗標，要建立的工作階段範本。

parent

string

這是必要旗標，表示將建立這個工作階段範本的父項資源。

授權需要指定資源 parent 的下列 IAM 權限：

dataproc.sessionTemplates.create

session_template

SessionTemplate

這是必要旗標，要建立的工作階段範本。

DeleteBatchRequest

刪除批次工作負載的要求。

欄位

欄位
`name`	`string` 這是必要旗標，要擷取的批次完整名稱，格式為「projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID」授權需要指定資源 `name` 的下列 IAM 權限： `dataproc.batches.delete`

name

string

這是必要旗標，要擷取的批次完整名稱，格式為「projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID」

授權需要指定資源 name 的下列 IAM 權限：

dataproc.batches.delete

DeleteSessionRequest

刪除工作階段的要求。

欄位

欄位
`name`	`string` 這是必要旗標，要刪除的工作階段資源名稱。授權需要指定資源 `name` 的下列 IAM 權限： `dataproc.sessions.delete`
`request_id`	`string` (非必要) 用於識別要求的專屬 ID。如果服務收到兩個 ID 相同的 DeleteSessionRequest，系統會忽略第二個要求。建議：請將這個值設為 UUID。值只能包含英文字母 (a-z、A-Z)、數字 (0-9)、底線 (_) 和連字號 (-)，長度上限為 40 個半形字元。

name

string

這是必要旗標，要刪除的工作階段資源名稱。

授權需要指定資源 name 的下列 IAM 權限：

dataproc.sessions.delete

request_id

string

(非必要) 用於識別要求的專屬 ID。如果服務收到兩個 ID 相同的 DeleteSessionRequest，系統會忽略第二個要求。

建議：請將這個值設為 UUID。

值只能包含英文字母 (a-z、A-Z)、數字 (0-9)、底線 (_) 和連字號 (-)，長度上限為 40 個半形字元。

DeleteSessionTemplateRequest

刪除工作階段範本的要求。

欄位

欄位
`name`	`string` 這是必要旗標，要刪除的會話範本資源名稱。授權需要指定資源 `name` 的下列 IAM 權限： `dataproc.sessionTemplates.delete`

name

string

這是必要旗標，要刪除的會話範本資源名稱。

授權需要指定資源 name 的下列 IAM 權限：

dataproc.sessionTemplates.delete

DiagnoseClusterResults

診斷輸出內容的位置。

欄位

欄位
`output_uri`	`string` 僅供輸出。診斷輸出的 Cloud Storage URI。輸出報表是純文字檔案，其中包含所收集診斷資料的摘要。

output_uri

string

僅供輸出。診斷輸出的 Cloud Storage URI。輸出報表是純文字檔案，其中包含所收集診斷資料的摘要。

EnvironmentConfig

工作負載的環境設定。

欄位

欄位
`execution_config`	`ExecutionConfig` (非必要) 工作負載的執行設定。
`peripherals_config`	`PeripheralsConfig` (非必要) 工作負載可存取的外接裝置設定。

execution_config

ExecutionConfig

(非必要) 工作負載的執行設定。

peripherals_config

PeripheralsConfig

(非必要) 工作負載可存取的外接裝置設定。

ExecutionConfig

工作負載的執行設定。

欄位
`service_account`	`string` (非必要) 用於執行工作負載的服務帳戶。
`network_tags[]`	`string` (非必要) 用於控制網路流量的標記。
`kms_key`	`string` (非必要) 用於加密的 Cloud KMS 金鑰。
`idle_ttl`	`Duration` (非必要) 僅適用於工作階段。在閒置期間，維持工作階段運作的時間長度。如果超過這個門檻，系統就會終止工作階段。這個欄位無法在批次工作負載上設定。最小值為 10 分鐘，最大值為 14 天 (請參閱 Duration 的 JSON 表示法)。如果未設定，預設值為 1 小時。如果為互動工作階段指定 `ttl` 和 `idle_ttl`，系統會將這些條件視為 `OR` 條件：工作負載閒置 `idle_ttl` 或超過 `ttl` 時，系統會終止工作負載 (以先發生者為準)。
`ttl`	`Duration` (非必要) 工作負載結束的時間長度，以 Duration 的 JSON 表示法指定。如果工作負載超過這個時間長度，系統就會無條件終止工作，不等待目前的工作完成。如果未為批次工作負載指定 `ttl`，系統會允許工作負載執行，直到自然結束 (或永遠執行而不結束) 為止。如果未為互動工作階段指定 `ttl`，則預設值為 24 小時。如果針對使用 2.1 以上執行階段版本的批次未指定 `ttl`，則預設為 4 小時。最小值為 10 分鐘，最大值為 14 天。如果同時指定 `ttl` 和 `idle_ttl` (針對互動式工作階段)，系統會將這些條件視為 `OR` 條件：工作負載閒置 `idle_ttl` 或超過 `ttl` 時，系統會終止工作負載 (以先發生者為準)。
`staging_bucket`	`string` (非必要) 用於暫存工作負載依附元件、設定檔，以及儲存工作負載輸出和其他暫時性資料 (例如 Spark 歷程記錄檔) 的 Cloud Storage 值區。如果未指定暫存值區，Cloud Dataproc 會根據工作負載執行的地區，判斷 Cloud Storage 位置，然後建立及管理專案層級、每個位置的暫存和臨時值區。這個欄位需要 Cloud Storage 值區名稱，而不是 Cloud Storage 值區的 `gs://...` URI。
聯集欄位 `network`。工作負載執行作業的網路設定。`network` 只能是下列其中一項：
`network_uri`	`string` (非必要) 要連結工作負載的網路 URI。
`subnetwork_uri`	`string` (非必要) 要連結至工作負載的子網路 URI。

GetBatchRequest

要求取得批次工作負載的資源表示法。

欄位

欄位
`name`	`string` 這是必要旗標，要擷取的批次完整名稱，格式為「projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID」授權需要指定資源 `name` 的下列 IAM 權限： `dataproc.batches.get`

name

string

這是必要旗標，要擷取的批次完整名稱，格式為「projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID」

授權需要指定資源 name 的下列 IAM 權限：

dataproc.batches.get

GetSessionRequest

要求取得工作階段的資源表示法。

欄位

欄位
`name`	`string` 這是必要旗標，要擷取的工作階段名稱。授權需要指定資源 `name` 的下列 IAM 權限： `dataproc.sessions.get`

name

string

這是必要旗標，要擷取的工作階段名稱。

授權需要指定資源 name 的下列 IAM 權限：

dataproc.sessions.get

GetSessionTemplateRequest

要求取得工作階段範本的資源表示法。

欄位

欄位
`name`	`string` 這是必要旗標，要擷取的工作階段範本名稱。授權需要指定資源 `name` 的下列 IAM 權限： `dataproc.sessionTemplates.get`

name

string

這是必要旗標，要擷取的工作階段範本名稱。

授權需要指定資源 name 的下列 IAM 權限：

dataproc.sessionTemplates.get

JupyterConfig

互動工作階段的 Jupyter 設定。

欄位

欄位
`kernel`	`Kernel` (非必要) 核心
`display_name`	`string` (非必要) 顯示名稱，會顯示在 Jupyter kernelspec 資訊卡中。

kernel

Kernel

(非必要) 核心

display_name

string

(非必要) 顯示名稱，會顯示在 Jupyter kernelspec 資訊卡中。

核心

Jupyter 核心類型。

列舉
`KERNEL_UNSPECIFIED`	核心不明。
`PYTHON`	Python 核心。
`SCALA`	Scala 核心。

ListBatchesRequest

要求列出專案中的批次工作負載。

欄位
`parent`	`string` 這是必要旗標，擁有此批次集合的父項。授權需要指定資源 `parent` 的下列 IAM 權限： `dataproc.batches.list`
`page_size`	`int32` (非必要) 每個回應中傳回的批次數量上限。服務傳回的產品數量可能會少於這個值。預設的頁面大小為 20，最大頁面大小為 1000。
`page_token`	`string` (非必要) 從先前 `ListBatches` 呼叫收到的網頁權杖。提供此符記即可擷取後續網頁。
`filter`	`string` (非必要) 在回應中傳回批次的篩選器。篩選器是邏輯運算式，可限制每個批次資源中各個欄位的值。篩選器會區分大小寫，且可能包含多個子句，並結合邏輯運算子 (AND/OR)。支援的欄位為 `batch_id`、`batch_uuid`、`state`、`create_time` 和 `labels`。例如：`state = RUNNING and create_time < "2023-01-01T00:00:00Z"` 篩選器會篩除 2023-01-01 之前建立的資料批次，這些資料批次的狀態為 RUNNING。`state = RUNNING and labels.environment=production` 篩選器會針對具有實際工作環境標籤的 RUNNING 狀態批次進行篩選。如要進一步瞭解篩選器語法和支援的比較項目清單，請參閱 https://google.aip.dev/assets/misc/ebnf-filtering.txt。
`order_by`	`string` (非必要) 用來排序批次清單的欄位。目前僅支援未指定 (空白) 和 `create_time desc` 的排序順序，以便先依最近建立的批次排序。詳情請參閱 https://google.aip.dev/132#ordering。

ListBatchesResponse

批次工作負載清單。

欄位

欄位
`batches[]`	`Batch` 僅供輸出。指定集合的批次。
`next_page_token`	`string` 可做為 `page_token` 傳送的權杖，用於擷取後續網頁。如果省略這個欄位，就不會有後續頁面。
`unreachable[]`	`string` 僅供輸出。無法納入回應的批次清單。嘗試取得其中一個資源，可能會顯示為何該資源未納入清單回應。

batches[]

Batch

僅供輸出。指定集合的批次。

next_page_token

string

可做為 page_token 傳送的權杖，用於擷取後續網頁。如果省略這個欄位，就不會有後續頁面。

unreachable[]

string

僅供輸出。無法納入回應的批次清單。嘗試取得其中一個資源，可能會顯示為何該資源未納入清單回應。

ListSessionTemplatesRequest

要求列出專案中的會話範本。

欄位
`parent`	`string` 這是必要旗標，擁有此工作階段範本集合的父項。授權需要指定資源 `parent` 的下列 IAM 權限： `dataproc.sessionTemplates.list`
`page_size`	`int32` (非必要) 每個回應中傳回的會話數量上限。服務傳回的產品數量可能會少於這個值。
`page_token`	`string` (非必要) 從先前 `ListSessions` 呼叫收到的網頁權杖。提供此符記即可擷取後續網頁。
`filter`	`string` (非必要) 會傳回工作階段範本的篩選器。篩選器會區分大小寫，語法如下： [欄位 = 值] AND [欄位 [= 值]] ...

ListSessionTemplatesResponse

工作階段範本清單。

欄位

欄位
`session_templates[]`	`SessionTemplate` 僅供輸出。工作階段範本清單
`next_page_token`	`string` 可做為 `page_token` 傳送的權杖，用於擷取後續網頁。如果省略這個欄位，就不會有後續頁面。

session_templates[]

SessionTemplate

僅供輸出。工作階段範本清單

next_page_token

string

可做為 page_token 傳送的權杖，用於擷取後續網頁。如果省略這個欄位，就不會有後續頁面。

ListSessionsRequest

要求列出專案中的工作階段。

欄位
`parent`	`string` 這是必要旗標，擁有這個工作階段集合的父項。授權需要指定資源 `parent` 的下列 IAM 權限： `dataproc.sessions.list`
`page_size`	`int32` (非必要) 每個回應中傳回的會話數量上限。服務傳回的產品數量可能會少於這個值。
`page_token`	`string` (非必要) 從先前 `ListSessions` 呼叫收到的網頁權杖。提供此符記即可擷取後續網頁。
`filter`	`string` (非必要) 在回應中傳回的工作階段篩選器。篩選器是邏輯運算式，可限制每個工作階段資源中各個欄位的值。篩選器會區分大小寫，且可能包含多個子句，並結合邏輯運算子 (AND、OR)。支援的欄位為 `session_id`、`session_uuid`、`state`、`create_time` 和 `labels`。範例：`state = ACTIVE and create_time < "2023-01-01T00:00:00Z"` 是 2023-01-01 前建立的「ACTIVE」狀態工作階段篩選器。`state = ACTIVE and labels.environment=production` 是工作階段的篩選器，適用於具有實際工作環境標籤的 ACTIVE 狀態。如要進一步瞭解篩選器語法和支援的比較器清單，請參閱 https://google.aip.dev/assets/misc/ebnf-filtering.txt。

ListSessionsResponse

互動工作階段清單。

欄位

欄位
`sessions[]`	`Session` 僅供輸出。指定集合的工作階段。
`next_page_token`	`string` 可做為 `page_token` 傳送的權杖，用於擷取後續網頁。如果省略這個欄位，就不會有後續頁面。

sessions[]

Session

僅供輸出。指定集合的工作階段。

next_page_token

string

可做為 page_token 傳送的權杖，用於擷取後續網頁。如果省略這個欄位，就不會有後續頁面。

PeripheralsConfig

工作負載的輔助服務設定。

欄位

欄位
`metastore_service`	`string` (非必要) 現有 Dataproc Metastore 服務的資源名稱。範例： `projects/[project_id]/locations/[region]/services/[service_id]`
`spark_history_server_config`	`SparkHistoryServerConfig` (非必要) 工作負載的 Spark 記錄伺服器設定。

metastore_service

string

(非必要) 現有 Dataproc Metastore 服務的資源名稱。

範例：

projects/[project_id]/locations/[region]/services/[service_id]

spark_history_server_config

SparkHistoryServerConfig

(非必要) 工作負載的 Spark 記錄伺服器設定。

PyPiRepositoryConfig

PyPi 存放區的設定

欄位

欄位
`pypi_repository`	`string` (非必要) PyPi 存放區位址

pypi_repository

string

(非必要) PyPi 存放區位址

PySparkBatch

執行 Apache PySpark 批次工作負載的設定。

欄位
`main_python_file_uri`	`string` 這是必要旗標，主要 Python 檔案的 HCFS URI，用於做為 Spark 驅動程式。必須是 .py 檔案。
`args[]`	`string` (非必要) 要傳遞至驅動程式的引數。請勿納入可設為批次屬性的引數，例如 `--conf`，因為這可能會發生衝突，導致提交的批次不正確。
`python_file_uris[]`	`string` (非必要) 要傳遞至 PySpark 架構的 Python 檔案 HCFS 檔案 URI。支援的檔案類型：`.py`、`.egg` 和 `.zip`。
`jar_file_uris[]`	`string` (非必要) 要新增至 Spark 驅動程式和工作群組的 JAR 檔案 HCFS URI。
`file_uris[]`	`string` (非必要) 要遷入各項執行程式工作目錄的檔案 HCFS URI。
`archive_uris[]`	`string` (非必要) 要擷取至各執行程式工作目錄的封存檔 HCFS URI。支援的檔案類型：`.jar`、`.tar`、`.tar.gz`、`.tgz` 和 `.zip`。

RepositoryConfig

依附元件存放區的設定

欄位

欄位
`pypi_repository_config`	`PyPiRepositoryConfig` (非必要) PyPi 存放區的設定。

pypi_repository_config

PyPiRepositoryConfig

(非必要) PyPi 存放區的設定。

RuntimeConfig

工作負載的執行階段設定。

欄位
`version`	`string` (非必要) 批次執行階段的版本。
`container_image`	`string` (非必要) 工作執行階段環境的選用自訂容器映像檔。如未指定，系統會使用預設容器映像檔。
`properties`	`map<string, string>` (非必要) 屬性名稱與值的對應項目，用於設定工作負載執行作業。
`repository_config`	`RepositoryConfig` (非必要) 依附元件存放區設定。
`autotuning_config`	`AutotuningConfig` (非必要) 工作負載的自動調整設定。
`cohort`	`string` (非必要) 同類群組 ID。識別形狀相同的工作負載系列，例如每日 ETL 工作。

RuntimeInfo

工作負載執行作業的執行階段資訊。

欄位
`endpoints`	`map<string, string>` 僅供輸出。將遠端存取端點 (例如網頁介面和 API) 對應至其 URI。
`output_uri`	`string` 僅供輸出。指向工作負載的 stdout 和 stderr 位置的 URI。
`diagnostic_output_uri`	`string` 僅供輸出。指向診斷 tarball 位置的 URI。
`approximate_usage`	`UsageMetrics` 僅供輸出。工作負載資源的預估用量，計算方式為在工作負載完成時計算 (請參閱「Dataproc Serverless 定價」)。注意：這個指標的計算方式日後可能會有所變更，例如為了擷取工作負載執行期間的工作負載資源累積用量 (如要查看公告、變更、修正和其他 Dataproc 開發項目，請參閱 Dataproc Serverless 版本說明)。
`current_usage`	`UsageSnapshot` 僅供輸出。目前工作負載資源用量的快照。

工作階段

工作階段的表示法。

欄位
`name`	`string` 這是必要旗標，工作階段的資源名稱。
`uuid`	`string` 僅供輸出。工作階段 UUID (通用專屬 ID)。服務會在建立工作階段時產生這個值。
`create_time`	`Timestamp` 僅供輸出。建立工作階段的時間。
`runtime_info`	`RuntimeInfo` 僅供輸出。工作階段執行作業的執行階段資訊。
`state`	`State` 僅供輸出。工作階段的狀態。
`state_message`	`string` 僅供輸出。工作階段狀態詳細資料，例如狀態為 `FAILED` 時的失敗說明。
`state_time`	`Timestamp` 僅供輸出。工作階段進入目前狀態的時間。
`creator`	`string` 僅供輸出。建立工作階段的使用者電子郵件地址。
`labels`	`map<string, string>` (非必要) 要與工作階段建立關聯的標籤。標籤鍵必須包含 1 至 63 個字元，且必須符合 RFC 1035 標準。標籤值可以為空白，但如果有值，則必須包含 1 到 63 個字元，且必須符合 RFC 1035。一個工作階段最多只能關聯 32 個標籤。
`runtime_config`	`RuntimeConfig` (非必要) 工作階段執行作業的執行階段設定。
`environment_config`	`EnvironmentConfig` (非必要) 工作階段執行作業的環境設定。
`user`	`string` (非必要) 擁有工作階段的使用者電子郵件地址。
`state_history[]`	`SessionStateHistory` 僅供輸出。工作階段的歷來狀態資訊。
`session_template`	`string` (非必要) 工作階段使用的工作階段範本。只有資源名稱 (包括專案 ID 和位置) 才有效。示例：* `https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/sessionTemplates/[template_id]` * `projects/[project_id]/locations/[dataproc_region]/sessionTemplates/[template_id]` 範本必須與工作階段位於相同專案和 Dataproc 區域。
聯集欄位 `session_config`。工作階段設定。`session_config` 只能是下列其中一項：
`jupyter_session`	`JupyterConfig` (非必要) Jupyter 工作階段設定。
`spark_connect_session`	`SparkConnectConfig` (非必要) Spark 連線工作階段設定。

SessionStateHistory

歷來狀態資訊。

欄位

state

State

僅供輸出。工作階段歷史記錄中此時的工作階段狀態。

state_message

string

僅供輸出。會話記錄中此時狀態的詳細資料。

state_start_time

Timestamp

僅供輸出。工作階段進入歷史狀態的時間。

狀態

工作階段狀態。

列舉
`STATE_UNSPECIFIED`	工作階段狀態不明。
`CREATING`	系統會在執行前建立工作階段。
`ACTIVE`	工作階段正在執行。
`TERMINATING`	工作階段即將結束。
`TERMINATED`	工作階段已順利終止。
`FAILED`	因發生錯誤，工作階段已停止執行。

SessionOperationMetadata

用於說明工作階段作業的中繼資料。

欄位
`session`	`string` 作業的工作階段名稱。
`session_uuid`	`string` 作業的工作階段 UUID。
`create_time`	`Timestamp` 作業的建立時間。
`done_time`	`Timestamp` 作業完成的時間。
`operation_type`	`SessionOperationType` 作業類型。
`description`	`string` 作業的簡短說明。
`labels`	`map<string, string>` 與作業相關聯的標籤。
`warnings[]`	`string` 在作業執行期間遇到的警告。

SessionOperationType

工作階段資源的作業類型

列舉
`SESSION_OPERATION_TYPE_UNSPECIFIED`	工作階段作業類型不明。
`CREATE`	建立工作階段作業類型。
`TERMINATE`	終止工作階段作業類型。
`DELETE`	刪除工作階段作業類型。

SessionTemplate

工作階段範本的表示法。

欄位
`name`	`string` 這是必要旗標，工作階段範本的資源名稱。
`description`	`string` (非必要) 範本的簡短說明。
`create_time`	`Timestamp` 僅供輸出。建立範本的時間。
`creator`	`string` 僅供輸出。建立範本的使用者電子郵件地址。
`labels`	`map<string, string>` (非必要) 與使用此範本建立的工作階段相關聯的標籤。標籤鍵必須包含 1 至 63 個字元，且必須符合 RFC 1035 標準。標籤值可以為空白，但如果有值，則必須包含 1 到 63 個字元，且符合 RFC 1035 規定。一個工作階段最多只能關聯 32 個標籤。
`runtime_config`	`RuntimeConfig` (非必要) 工作階段執行作業的執行階段設定。
`environment_config`	`EnvironmentConfig` (非必要) 工作階段執行作業的環境設定。
`update_time`	`Timestamp` 僅供輸出。上次更新範本的時間。
`uuid`	`string` 僅供輸出。工作階段範本 UUID (通用專屬 ID)。服務會在建立工作階段範本時產生這個值。
聯集欄位 `session_config`。工作階段設定。`session_config` 只能是下列其中一項：
`jupyter_session`	`JupyterConfig` (非必要) Jupyter 工作階段設定。
`spark_connect_session`	`SparkConnectConfig` (非必要) Spark Connect 工作階段設定。

SparkBatch

用於執行 Apache Spark 批次工作負載的設定。

欄位
`args[]`	`string` (非必要) 要傳遞至驅動程式的引數。請勿納入可設為批次屬性的引數，例如 `--conf`，因為這可能會發生衝突，導致提交的批次不正確。
`jar_file_uris[]`	`string` (非必要) 要新增至 Spark 驅動程式和工作類別路徑的 JAR 檔案 HCFS URI。
`file_uris[]`	`string` (非必要) 要遷入各項執行程式工作目錄的檔案 HCFS URI。
`archive_uris[]`	`string` (非必要) 要擷取至各執行程式工作目錄的封存檔 HCFS URI。支援的檔案類型：`.jar`、`.tar`、`.tar.gz`、`.tgz` 和 `.zip`。
聯集欄位 `driver`。用於呼叫 Spark 工作負載的主要方法規格。指定包含主要類別的 jar 檔案或主要類別名稱。如要傳遞主要 jar 和該 jar 中的主類別，請將 jar 新增至 `jar_file_uris`，然後在 `main_class` 中指定主類別名稱。`driver` 只能是下列其中一項：
`main_jar_file_uri`	`string` (非必要) 包含主類別的 jar 檔案的 HCFS URI。
`main_class`	`string` (非必要) 驅動程式主類別的名稱。包含類別的 JAR 檔案必須位於 classpath 中，或在 `jar_file_uris` 中指定。

SparkConnectConfig

這個類型沒有任何欄位。

互動工作階段的 Spark Connect 設定。

SparkHistoryServerConfig

工作負載的 Spark 記錄伺服器設定。

欄位

dataproc_cluster

string

(非必要) 現有 Dataproc 叢集的資源名稱，用於做為工作負載的 Spark 記錄伺服器。

範例：

projects/[project_id]/regions/[region]/clusters/[cluster_name]

SparkRBatch

用於執行 Apache SparkR 批次工作負載的設定。

欄位
`main_r_file_uri`	`string` 這是必要旗標，要用來做為驅動程式的主 R 檔案的 HCFS URI。必須是 `.R` 或 `.r` 檔案。
`args[]`	`string` (非必要) 要傳遞至 Spark 驅動程式的引數。請勿納入可設為批次屬性的引數，例如 `--conf`，因為這可能會發生衝突，導致提交的批次不正確。
`file_uris[]`	`string` (非必要) 要遷入各項執行程式工作目錄的檔案 HCFS URI。
`archive_uris[]`	`string` (非必要) 要擷取至各執行程式工作目錄的封存檔 HCFS URI。支援的檔案類型：`.jar`、`.tar`、`.tar.gz`、`.tgz` 和 `.zip`。

SparkSqlBatch

用於將 Apache Spark SQL 查詢當作批次工作負載執行的設定。

欄位

query_file_uri

string

這是必要旗標，指令碼的 HCFS URI，其中包含要執行的 Spark SQL 查詢。

query_variables

map<string, string>

(非必要) 將查詢變數名稱對應至值 (等同於 Spark SQL 指令：SET name="value";)。

jar_file_uris[]

string

(非必要) 要新增至 Spark CLASSPATH 的 jar 檔案 HCFS URI。

TerminateSessionRequest

終止互動工作階段的要求。

欄位

name

string

這是必要旗標，要終止的工作階段資源名稱。

授權需要指定資源 name 的下列 IAM 權限：

dataproc.sessions.terminate

request_id

string

(非必要) 用於識別要求的專屬 ID。如果服務收到兩個 ID 相同的 TerminateSessionRequest，系統會忽略第二個要求。

建議：請將這個值設為 UUID。

值只能包含英文字母 (a-z、A-Z)、數字 (0-9)、底線 (_) 和連字號 (-)，長度上限為 40 個半形字元。

UpdateSessionTemplateRequest

要求更新工作階段範本。

欄位

session_template

SessionTemplate

這是必要旗標，更新後的工作階段範本。

授權需要指定資源 sessionTemplate 的下列 IAM 權限：

dataproc.sessionTemplates.update

UsageMetrics

用量指標代表工作負載耗用的大致總資源。

欄位
`milli_dcu_seconds`	`int64` (非必要) DCU (Dataproc 運算單元) 用量 (`milliDCU` x `seconds`) (請參閱「Dataproc Serverless 定價」)。
`shuffle_storage_gb_seconds`	`int64` (非必要) Shuffle 儲存空間用量 (`GB` x `seconds`) (請參閱「Dataproc Serverless 定價」)。
`milli_accelerator_seconds`	`int64` (非必要) 加速器用量 (`milliAccelerator` x `seconds`) (請參閱「Dataproc Serverless 定價」)。
`accelerator_type`	`string` (非必要) 使用的加速器類型 (如果有的話)

UsageSnapshot

用量快照代表工作負載在指定時間的資源用量。

欄位
`milli_dcu`	`int64` (非必要) 每千分之一 Dataproc 運算單元 (DCUs) (請參閱「Dataproc Serverless 定價」)。
`shuffle_storage_gb`	`int64` (非必要) Shuffle 儲存空間 (單位為 GB)。(請參閱「Dataproc Serverless 定價」)
`milli_dcu_premium`	`int64` (非必要) 以進階級收費的 Dataproc 運算單元 (DCUs) 毫 (千分之一) (請參閱「Dataproc Serverless 定價」)。
`shuffle_storage_gb_premium`	`int64` (非必要) 以 GB 為單位的 Shuffle 儲存空間 (以進階級別收費)。(請參閱「Dataproc Serverless 定價」)
`milli_accelerator`	`int64` (非必要) 千分之一加速器。(請參閱「Dataproc Serverless 定價」)
`accelerator_type`	`string` (非必要) 使用的加速器類型 (如果有的話)
`snapshot_time`	`Timestamp` (非必要) 用量快照的時間戳記。

Package google.cloud.dataproc.v1 透過集合功能整理內容 你可以依據偏好儲存及分類內容。

索引

BatchController

SessionController

SessionTemplateController

AnalyzeOperationMetadata

WorkloadType

AutotuningConfig

情境

批次

狀態

StateHistory

批次作業中繼資料

BatchOperationType

CreateBatchRequest

CreateSessionRequest

CreateSessionTemplateRequest

DeleteBatchRequest

DeleteSessionRequest

DeleteSessionTemplateRequest

DiagnoseClusterResults

EnvironmentConfig

ExecutionConfig

GetBatchRequest

GetSessionRequest

GetSessionTemplateRequest

JupyterConfig

核心

ListBatchesRequest

ListBatchesResponse

ListSessionTemplatesRequest

ListSessionTemplatesResponse

ListSessionsRequest

ListSessionsResponse

PeripheralsConfig

PyPiRepositoryConfig

PySparkBatch

RepositoryConfig

RuntimeConfig

RuntimeInfo

工作階段

SessionStateHistory

狀態

SessionOperationMetadata

SessionOperationType

SessionTemplate

SparkBatch

SparkConnectConfig

SparkHistoryServerConfig

SparkRBatch

SparkSqlBatch

TerminateSessionRequest

UpdateSessionTemplateRequest

UsageMetrics

UsageSnapshot

Package google.cloud.dataproc.v1