REST Resource: projects.locations.jobs

資源:Job

儲存批次操作崗位描述。

JSON 表示法
{
  "name": string,
  "description": string,
  "loggingConfig": {
    object (LoggingConfig)
  },
  "createTime": string,
  "scheduleTime": string,
  "completeTime": string,
  "counters": {
    object (Counters)
  },
  "errorSummaries": [
    {
      object (ErrorSummary)
    }
  ],
  "state": enum (State),
  "dryRun": boolean,
  "isMultiBucketJob": boolean,

  // Union field source can be only one of the following:
  "bucketList": {
    object (BucketList)
  },
  "projectSource": {
    object (ProjectSource)
  }
  // End of list of possible types for union field source.

  // Union field transformation can be only one of the following:
  "putObjectHold": {
    object (PutObjectHold)
  },
  "deleteObject": {
    object (DeleteObject)
  },
  "putMetadata": {
    object (PutMetadata)
  },
  "rewriteObject": {
    object (RewriteObject)
  },
  "updateObjectCustomContext": {
    object (UpdateObjectCustomContext)
  },
  "setObjectAcls": {
    object (SetObjectAcls)
  }
  // End of list of possible types for union field transformation.
}
欄位
name

string

ID。作業的資源名稱。

格式:projects/{projectId}/locations/global/jobs/{jobId}。

例如:projects/123456/locations/global/jobs/job01。

jobId 在給定項目中是唯一的。

description

string

選用。使用者提供的職位說明。

最大長度:Unicode 編碼時為 1024 位元組。

loggingConfig

object (LoggingConfig)

選用。日誌配置。

createTime

string (Timestamp format)

僅供輸出。該職位設立的時間。

使用 RFC 3339,產生的輸出內容一律會經過 Z 正規化,並使用 0、3、6 或 9 個小數位數,也接受「Z」以外的偏移量。範例:"2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。

scheduleTime

string (Timestamp format)

僅供輸出。工作安排時間。

使用 RFC 3339,產生的輸出內容一律會經過 Z 正規化,並使用 0、3、6 或 9 個小數位數,也接受「Z」以外的偏移量。範例:"2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。

completeTime

string (Timestamp format)

僅供輸出。工作完成的時間。

使用 RFC 3339,產生的輸出內容一律會經過 Z 正規化,並使用 0、3、6 或 9 個小數位數,也接受「Z」以外的偏移量。範例:"2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。

counters

object (Counters)

僅供輸出。工作進度資訊。

errorSummaries[]

object (ErrorSummary)

僅供輸出。並以錯誤記錄檔項目範例歸納遇到的錯誤。

state

enum (State)

僅供輸出。工作狀態。

dryRun

boolean

選用。如為 true,工作會在模擬測試模式下執行,並傳回物件總數,以及 (如果物件設定是前置字元清單) 從來源找到的位元組。不會執行任何轉換。

isMultiBucketJob

boolean

僅供輸出。如為 true,這項工作會在多個值區運作。多值區工作與單一值區工作適用的配額限制不同。

聯集欄位 source。指定要轉換的物件。source 只能是下列其中一個設定:
bucketList

object (BucketList)

指定要轉換的儲存桶及其物件的清單。

projectSource

object (ProjectSource)

指定項目來源和篩選條件,以識別要轉換的物件。

聯集欄位 transformation。要對物件執行的操作。transformation 只能是下列其中一個設定:
putObjectHold

object (PutObjectHold)

更改物件保持狀態。

deleteObject

object (DeleteObject)

刪除物件。

putMetadata

object (PutMetadata)

更新對像元資料。允許更新固定密鑰和自訂元資料。例如,Cache-Control、Content-Disposition、Content-Encoding、Content-Language、Content-Type、Custom-Time 和 Retention configuration。

rewriteObject

object (RewriteObject)

重寫物件並更新元數據,例如 KMS 金鑰。

updateObjectCustomContext

object (UpdateObjectCustomContext)

更新物件自訂上下文。

setObjectAcls

object (SetObjectAcls)

更新物件存取控制清單。

BucketList

描述要轉換的桶子及其物件的清單。

JSON 表示法
{
  "buckets": [
    {
      object (Bucket)
    }
  ]
}
欄位
buckets[]

object (Bucket)

這是必要旗標,待轉換的儲存桶及其物件清單。每個作業只能指定一個儲存桶。如果指定了多個儲存桶,則會發生錯誤。

值區

描述單一儲存桶及其待轉換物件的配置。

JSON 表示法
{
  "bucket": string,

  // Union field object_configuration can be only one of the following:
  "prefixList": {
    object (PrefixList)
  },
  "manifest": {
    object (Manifest)
  }
  // End of list of possible types for union field object_configuration.
}
欄位
bucket

string

這是必要旗標,待轉換物件的儲存桶名稱。

聯集欄位 object_configuration。指定要轉換的物件。object_configuration 只能是下列其中一個設定:
prefixList

object (PrefixList)

指定與前綴集相符的物件。

manifest

object (Manifest)

指定清單文件中的物件。

LoggingConfig

指定雲日誌記錄行為。

JSON 表示法
{
  "logActions": [
    enum (LoggableAction)
  ],
  "logActionStates": [
    enum (LoggableActionState)
  ]
}
欄位
logActions[]

enum (LoggableAction)

這是必要旗標,指定要記錄的操作。

logActionStates[]

enum (LoggableActionState)

這是必要旗標,記錄操作的狀態。如果為空,則不產生任何日誌。

LoggableAction

可記錄的操作類型。

列舉
LOGGABLE_ACTION_UNSPECIFIED 非法值,以避免允許預設值。
TRANSFORM 此作業中對應的轉換操作。

LoggableActionState

可記錄操作狀態篩選器。

列舉
LOGGABLE_ACTION_STATE_UNSPECIFIED 非法值,以避免允許預設值。
SUCCEEDED 已順利完成 LoggableAction。SUCCEEDED 操作記錄為 [INFO][google.logging.type.LogSeverity.INFO]。
FAILED LoggableAction 終止,且處於錯誤狀態。FAILED 操作被記錄為 [ERROR][google.logging.type.LogSeverity.ERROR]。

狀態

說明工作狀態。

列舉
STATE_UNSPECIFIED 預設值。這個值不會使用。
RUNNING 執行中。
SUCCEEDED 已成功完成。
CANCELED 用戶已取消。
FAILED 因發生無法恢復的故障而終止。
QUEUED 已排隊但尚未開始。

方法

cancel

取消批次作業。

create

建立批次作業。

delete

刪除批次工作。

get

取得批次工作。

list

列出指定專案中的工作。