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),

  // Union field source can be only one of the following:
  "bucketList": {
    object (BucketList)
  }
  // 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)
  }
  // End of list of possible types for union field transformation.
}
필드
name

string

식별자. 작업의 리소스 이름입니다.

형식은 projects/{project}/locations/global/jobs/{jobId}입니다.

예를 들면 projects/123456/locations/global/jobs/job01입니다.

jobId는 특정 위치의 특정 프로젝트에서 고유합니다. jobId를 지정하지 않으면 서버에서 생성된 식별자가 할당됩니다.
description

string

선택사항입니다. 사용자가 제공한 작업 설명입니다.

최대 길이는 유니코드 인코딩 시 1,024바이트입니다.
loggingConfig

object (LoggingConfig)

선택사항입니다. 로깅 구성입니다.
createTime

string (Timestamp format)

출력 전용입니다. 작업이 생성된 시간입니다.

생성된 출력은 항상 Z-정규화되고 소수점 이하 0, 3, 6 또는 9자리인 RFC 3339를 사용합니다. 'Z' 이외의 오프셋도 허용됩니다. 예를 들면 "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" 또는 "2014-10-02T15:01:23+05:30"입니다.
scheduleTime

string (Timestamp format)

출력 전용입니다. 작업이 예약된 시간입니다.

생성된 출력은 항상 Z-정규화되고 소수점 이하 0, 3, 6 또는 9자리인 RFC 3339를 사용합니다. 'Z' 이외의 오프셋도 허용됩니다. 예를 들면 "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" 또는 "2014-10-02T15:01:23+05:30"입니다.
completeTime

string (Timestamp format)

출력 전용입니다. 작업이 완료된 시간입니다.

생성된 출력은 항상 Z-정규화되고 소수점 이하 0, 3, 6 또는 9자리인 RFC 3339를 사용합니다. '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)

출력 전용입니다. 작업 상태입니다.
통합 필드 source. 변환할 객체를 지정합니다. source은 다음 중 하나여야 합니다.
bucketList

object (BucketList)

변환할 버킷 및 객체 목록을 지정합니다.
통합 필드 transformation. 객체에서 수행할 작업입니다. transformation은 다음 중 하나여야 합니다.
putObjectHold

object (PutObjectHold)

객체 보존 상태를 변경합니다.
deleteObject

object (DeleteObject)

객체를 삭제합니다.
putMetadata

object (PutMetadata)

객체 메타데이터를 업데이트합니다. 고정 키 및 커스텀 메타데이터와 고정 키 메타데이터를 업데이트할 수 있습니다. 예를 들면 Cache-Control, Content-Disposition, Content-Encoding, Content-Language, Content-Type, Custom-Time입니다.
rewriteObject

object (RewriteObject)

객체를 다시 작성하고 KMS 키와 같은 메타데이터를 업데이트합니다.

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)

매니페스트 파일에서 객체를 지정합니다.

PrefixList

변환할 객체의 프리픽스를 설명합니다.

JSON 표현 
{
  "includedObjectPrefixes": [
    string
  ]
}
필드
includedObjectPrefixes[]

string

선택사항입니다. 객체 프리픽스를 하나 이상 지정합니다. 예를 들면 다음과 같습니다.

  • 객체 하나를 일치시키려면 단일 프리픽스 prefix1을 사용합니다.

  • 여러 객체를 일치시키려면 쉼표로 구분된 프리픽스 prefix1,prefix2를 사용합니다.

  • 모든 객체를 일치시키려면 빈 프리픽스 ''를 사용합니다.

매니페스트

변환할 객체 목록을 설명합니다.

JSON 표현 
{
  "manifestLocation": string
}
필드
manifestLocation

string

필수 항목입니다. 매니페스트 파일 위치(예: gs://bucket_name/path/object_name.csv)를 지정합니다. 매니페스트는 Cloud Storage에 업로드되는 CSV 파일로, 처리할 객체 하나 또는 객체 목록이 포함됩니다. 매니페스트의 각 행에는 객체의 bucket 및 name이 포함되어야 합니다. 원하는 경우 객체의 generation를 지정할 수 있습니다. generation을 지정하지 않으면 객체의 현재 버전이 사용됩니다.

파일에는 bucket,name,generation 형식의 헤더 행이 포함되어야 합니다. generation 열은 선택사항입니다. 예를 들면 다음과 같습니다.

bucket,name,generation
bucket_1,object_1,generation_1
bucket_1,object_2,generation_2
bucket_1,object_3,generation_3

참고: 매니페스트 파일은 작업에 제공된 버킷 내의 객체만 지정해야 합니다. 다른 버킷의 객체를 참조하는 행은 무시됩니다.

PutObjectHold

객체 보존을 업데이트하는 옵션을 설명합니다.

JSON 표현 
{
  "temporaryHold": enum (HoldStatus),
  "eventBasedHold": enum (HoldStatus)
}
필드
temporaryHold

enum (HoldStatus)

필수 항목입니다. 객체 임시 보존 상태를 업데이트합니다. 객체 임시 보존이 설정되면 객체를 삭제하거나 대체할 수 없습니다.
eventBasedHold

enum (HoldStatus)

필수 항목입니다. 객체 이벤트 기반 보존 상태를 업데이트합니다. 객체 이벤트 기반 보존이 설정되면 객체를 삭제하거나 대체할 수 없습니다. 보관 기간을 위해 버킷에 있는 객체의 시간을 재설정합니다.

HoldStatus

보존 상태를 설명합니다.

열거형
HOLD_STATUS_UNSPECIFIED 기본값 객체 보존 상태가 변경되지 않았습니다.
SET 보존을 설정합니다.
UNSET 보존을 해제합니다.

DeleteObject

객체를 삭제하는 옵션을 설명합니다.

JSON 표현 
{
  "permanentObjectDeletionEnabled": boolean
}
필드
permanentObjectDeletionEnabled

boolean

필수 항목입니다. 객체 버킷에 버전 관리가 사용 설정된 경우 삭제 동작을 제어합니다. 이 값이 true이면 라이브 객체와 이전 객체가 모두 영구적으로 삭제됩니다. 그 밖의 경우 버전 관리가 적용된 버킷의 라이브 객체가 이전 버전이 되고 이미 이전 버전이었던 객체는 건너뜁니다. 이 설정은 소프트 삭제 기능에는 영향을 미치지 않습니다. 이 서비스에서 삭제된 모든 객체는 소프트 삭제 보관 기간 동안 복원할 수 있습니다(사용 설정된 경우). 사용 설정되어 있고 매니페스트가 객체의 세대를 지정하지 않으면 GetObjectMetadata 호출이 수행되어 라이브 객체 세대를 결정합니다.

PutMetadata

객체 메타데이터를 업데이트하는 옵션을 설명합니다.

JSON 표현 
{
  "customMetadata": {
    string: string,
    ...
  },
  "contentDisposition": string,
  "contentEncoding": string,
  "contentLanguage": string,
  "contentType": string,
  "cacheControl": string,
  "customTime": string
}
필드
customMetadata

map (key: string, value: string)

선택사항입니다. 객체의 커스텀 메타데이터를 업데이트합니다. 이 작업은 개별 커스텀 메타데이터 키-값 쌍을 추가하거나 설정합니다. 빈 값으로 지정된 키는 값이 삭제됩니다. 요청에 포함되지 않은 기존 커스텀 메타데이터 키는 변경되지 않습니다. 자세한 내용은 Custom-Metadata를 참조하세요.

"key": "value" 쌍 목록을 포함하는 객체입니다. 예: { "name": "wrench", "mass": "1.3kg", "count": "3" }
contentDisposition

string

선택사항입니다. 객체 Content-Disposition 고정 메타데이터를 업데이트합니다. 요청에서 설정되지 않은 값은 무시됩니다. 메타데이터를 삭제하려면 빈 값을 설정합니다. 자세한 내용은 Content-Disposition을 참조하세요.
contentEncoding

string

선택사항입니다. 객체 Content-Encoding 고정 메타데이터를 업데이트합니다. 요청에서 설정되지 않은 값은 무시됩니다. 메타데이터를 삭제하려면 빈 값을 설정합니다. 자세한 내용은 Content-Encoding을 참조하세요.
contentLanguage

string

선택사항입니다. 객체 고정 콘텐츠 언어 메타데이터를 업데이트합니다. 메타데이터 값은 ISO 639-1 언어 코드를 사용해야 합니다. 메타데이터 값의 최대 길이는 100자(영문 기준)입니다. 요청에서 설정되지 않은 값은 무시됩니다. 메타데이터를 삭제하려면 빈 값을 설정합니다. 자세한 내용은 Content-Language를 참조하세요.
contentType

string

선택사항입니다. 객체 Content-Type 고정 메타데이터를 업데이트합니다. 요청에서 설정되지 않은 값은 무시됩니다. 메타데이터를 삭제하려면 빈 값을 설정합니다. 자세한 내용은 Content-Type을 참조하세요.
cacheControl

string

선택사항입니다. 객체 Cache-Control 고정 메타데이터를 업데이트합니다. 요청에서 설정되지 않은 값은 무시됩니다. 메타데이터를 삭제하려면 빈 값을 설정합니다. 또한 Custom-Time의 값은 줄일 수 없습니다. 자세한 내용은 Cache-Control을 참조하세요.
customTime

string

선택사항입니다. 객체의 고정 커스텀 시간 메타데이터를 업데이트합니다. 요청에서 설정되지 않은 값은 무시됩니다. 메타데이터를 삭제하려면 빈 값을 설정합니다. 자세한 내용은 Custom-Time을 참조하세요.

RewriteObject

객체 재작성 옵션을 설명합니다.

JSON 표현 
{
  "kmsKey": string
}
필드
kmsKey

string

필수 항목입니다. 객체를 암호화하는 데 사용되는 Cloud KMS 키의 리소스 이름입니다. Cloud KMS 키는 객체와 동일한 위치에 있어야 합니다. 자세한 내용은 Cloud KMS 키로 객체 암호화를 참조하세요.

형식: projects/{project}/locations/{locationid}/keyRings/{keyring}/cryptoKeys/{key}

예를 들면 projects/123456/locations/us-central1/keyRings/my-keyring/cryptoKeys/my-key입니다. 객체가 재작성되고 지정된 KMS 키로 설정됩니다.

LoggingConfig

Cloud Logging 동작을 지정합니다.

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]로 로깅됩니다.

Counters

작업 진행 상황에 관한 세부정보를 설명합니다.

JSON 표현 
{
  "totalObjectCount": string,
  "succeededObjectCount": string,
  "failedObjectCount": string
}
필드
totalObjectCount

string (int64 format)

출력 전용입니다. 표시된 객체 수입니다.
succeededObjectCount

string (int64 format)

출력 전용입니다. 완료된 객체 수입니다.
failedObjectCount

string (int64 format)

출력 전용입니다. 실패한 객체 수입니다.

ErrorSummary

오류 코드별 오류 요약과 개수 및 샘플 오류 로그 항목입니다.

JSON 표현 
{
  "errorCode": enum (Code),
  "errorCount": string,
  "errorLogEntries": [
    {
      object (ErrorLogEntry)
    }
  ]
}
필드
errorCode

enum (Code)

필수 항목입니다. 표준 오류 코드입니다.
errorCount

string (int64 format)

필수 항목입니다. errorCode당 발생한 오류 수입니다.
errorLogEntries[]

object (ErrorLogEntry)

필수 항목입니다. 샘플 오류 로그입니다.

코드

gRPC API 응답을 처리하는 데 사용되는 오류 코드를 정의합니다.

여러 오류 코드가 적용되는 경우 가장 구체적인 오류 코드를 반환합니다. 예를 들어 두 코드가 모두 적용되는 경우 FAILED_PRECONDITION보다는 OUT_OF_RANGE를 사용하세요. 마찬가지로 FAILED_PRECONDITION보다는 NOT_FOUND 또는 ALREADY_EXISTS를 사용해야 합니다.

열거형
OK

작업이 성공적으로 완료되면 반환됩니다.

HTTP 매핑: 200 OK
CANCELLED

작업이 취소되었습니다. 대개 호출자에 의해 취소됩니다.

HTTP 매핑: 499 클라이언트에서 닫은 요청
UNKNOWN

알 수 없는 오류입니다. 예를 들어 다른 주소 공간에서 수신된 Status 값이 이 주소 공간에서 알려지지 않은 오류 공간에 속하는 경우 이 오류가 반환될 수 있습니다. 오류 정보를 충분히 반환하지 않는 API에서 발생한 오류가 이 오류로 변환될 수도 있습니다.

HTTP 매핑: 500 내부 서버 오류
INVALID_ARGUMENT

클라이언트에서 잘못된 인수를 지정했습니다. 이는 FAILED_PRECONDITION과 다릅니다. INVALID_ARGUMENT는 시스템 상태에 관계없이 문제(예: 잘못된 형식의 파일 이름)가 있는 인수를 나타냅니다.

HTTP 매핑: 400 잘못된 요청
DEADLINE_EXCEEDED

작업을 완료하기 전에 기한이 지났습니다. 작업에서 시스템의 상태를 변경하는 경우 작업이 정상적으로 완료되었어도 이 오류가 반환될 수 있습니다. 예를 들어 서버의 성공 응답이 오래 지연되어 기한이 지났을 수 있습니다.

HTTP 매핑: 504 게이트웨이 시간 초과
NOT_FOUND

요청한 일부 항목(예: 파일 또는 디렉터리)을 찾을 수 없습니다.

서버 개발자 참고사항: 단계적 기능 출시, 잠정적 허용 목록 등으로 인해 전체 사용자 클래스에게 요청이 거부된 경우에는 NOT_FOUND를 사용할 수 있습니다. 사용자별 액세스 제어 등으로 인해 사용자 클래스에 속하는 일부 사용자에게 요청이 거부된 경우에는 PERMISSION_DENIED를 사용해야 합니다.

HTTP 매핑: 404 찾을 수 없음
ALREADY_EXISTS

클라이언트에서 만들려고 시도한 항목(예: 파일 또는 디렉터리)이 이미 존재합니다.

HTTP 매핑: 409 충돌
PERMISSION_DENIED

호출자에 지정한 작업을 실행할 권한이 없습니다. 일부 리소스가 소진되었기 때문에 거부된 경우에는 PERMISSION_DENIED가 아닌 RESOURCE_EXHAUSTED를 사용해야 합니다. 호출자를 식별할 수 없는 경우에는 PERMISSION_DENIED가 아닌 UNAUTHENTICATED를 사용해야 합니다. 이 오류 코드는 요청이 유효하다거나, 요청된 항목이 존재한다거나, 다른 전제조건이 충족되었음을 의미하지 않습니다.

HTTP 매핑: 403 금지됨
UNAUTHENTICATED

요청에 작업과 관련된 올바른 사용자 인증 정보가 없습니다.

HTTP 매핑: 401 승인되지 않음
RESOURCE_EXHAUSTED

일부 리소스가 소진되었습니다. 사용자당 할당량이나 전체 파일 시스템의 저장용량이 부족하기 때문일 수 있습니다.

HTTP 매핑: 429 요청한 횟수가 너무 많음
FAILED_PRECONDITION

시스템이 작업 실행에 필요한 상태가 아니기 때문에 작업이 거부되었습니다. 예를 들어 삭제할 디렉토리가 비어 있지 않거나, 디렉토리가 아닌 항목에 rmdir 작업을 적용한 경우입니다.

서비스 구현 시 다음과 같은 가이드라인에 따라 FAILED_PRECONDITION, ABORTED, UNAVAILABLE 중에서 결정할 수 있습니다.

  • 클라이언트가 실패한 호출만 다시 시도할 수 있는 경우 UNAVAILABLE을 사용합니다.
  • 클라이언트가 상위 수준에서 다시 시도해야 하는 경우 ABORTED를 사용합니다. 예를 들어 클라이언트에서 지정한 테스트 후 설정 작업이 실패하여 클라이언트가 읽기-수정-쓰기 시퀀스를 다시 시작해야 하는 경우입니다.
  • 시스템 상태가 명시적으로 수정될 때까지 클라이언트에서 재시도하지 말아야 하는 경우 FAILED_PRECONDITION을 사용합니다. 예를 들어 디렉터리가 비어 있지 않아서 'rmdir'이 실패한 경우, 디렉터리에서 파일이 삭제될 때까지 클라이언트에서 재시도하지 말아야 하므로 FAILED_PRECONDITION을 반환해야 합니다.

HTTP 매핑: 400 잘못된 요청
ABORTED

작업이 취소되었습니다. 대개 시퀀서 확인 실패, 트랜잭션 취소 등의 동시 실행 문제가 원인입니다.

FAILED_PRECONDITION, ABORTED, UNAVAILABLE 중에서 결정하는 방법은 위 가이드라인을 참조하세요.

HTTP 매핑: 409 충돌
OUT_OF_RANGE

유효한 범위를 벗어나는 작업을 시도했습니다. 예를 들어 파일 끝을 지나서 탐색하거나 읽으려고 했습니다.

INVALID_ARGUMENT와 달리, 이 오류는 시스템 상태가 변경되면 문제가 해결될 수 있음을 나타냅니다. 예를 들어 32비트 파일 시스템에서 [0,2^32-1] 범위를 벗어나는 오프셋으로 읽으려고 하면 INVALID_ARGUMENT가 발생하지만, 현재 파일 크기를 넘어서는 오프셋으로 읽으려고 하면 OUT_OF_RANGE가 발생합니다.

FAILED_PRECONDITION과 OUT_OF_RANGE는 다소 겹치는 부분이 있지만, 해당하는 상황이라면 더 구체적인 OUT_OF_RANGE를 사용하는 것이 좋습니다. 그 이유는 특정 공간에서 반복 실행하는 호출자가 간단히 OUT_OF_RANGE 오류를 조회하여 작업이 끝났음을 감지할 수 있기 때문입니다.

HTTP 매핑: 400 잘못된 요청
UNIMPLEMENTED

작업이 구현되지 않았거나 이 서비스에서 지원되지 않거나 사용 설정되지 않았습니다.

HTTP 매핑: 501 구현되지 않음
INTERNAL

내부 오류가 발생했습니다. 내부 시스템에서 예상하는 불변 항목에 문제가 있는 경우입니다. 이 오류 코드는 심각한 오류를 위해 예약되어 있습니다.

HTTP 매핑: 500 내부 서버 오류
UNAVAILABLE

현재 서비스를 사용할 수 없습니다. 일시적인 상태일 가능성이 높으며, 잠시 시간을 두고 다시 시도하면 해결될 수 있습니다. 멱등성이 없는 작업을 재시도하는 것이 항상 안전한 것은 아닙니다.

FAILED_PRECONDITION, ABORTED, UNAVAILABLE 중에서 결정하는 방법은 위 가이드라인을 참조하세요.

HTTP 매핑: 503 사용할 수 없는 서비스
DATA_LOSS

복구할 수 없는 데이터 손실이나 손상이 발생했습니다.

HTTP 매핑: 500 내부 서버 오류

ErrorLogEntry

발생한 오류를 설명하는 항목입니다.

JSON 표현 
{
  "objectUri": string,
  "errorDetails": [
    string
  ]
}
필드
objectUri

string

필수 항목입니다. 출력 전용입니다. 객체 URL입니다. 예를 들면 gs://my_bucket/object.txt입니다.
errorDetails[]

string

선택사항입니다. 출력 전용입니다. 각 작업의 오류 코드당 최대 5개의 오류 로그 항목이 기록됩니다.

State

작업 상태를 설명합니다.

열거형
STATE_UNSPECIFIED 기본값 이 값은 사용되지 않습니다.
RUNNING 진행 중입니다.
SUCCEEDED 완료되었습니다.
CANCELED 사용자가 취소했습니다.
FAILED 복구 불가능한 오류로 인해 종료되었습니다.

메서드

cancel

 특정 위치의 특정 프로젝트에서 일괄 작업을 취소합니다.

create

 특정 위치의 특정 프로젝트에 일괄 작업을 만듭니다.

delete

 특정 위치의 특정 프로젝트에서 일괄 작업을 삭제합니다.

get

 특정 위치의 특정 프로젝트에서 일괄 작업을 가져옵니다.

list

 특정 위치의 특정 프로젝트에 있는 모든 일괄 작업을 나열합니다.