REST Resource: projects.locations.jobs

Recurso: Job

A descrição do job de operações em lote do Storage.

Representação 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.
}
Campos
name

string

Identificador. O nome do recurso do job.

Formato: projects/{projectId}/locations/global/jobs/{jobId}.

Por exemplo, projects/123456/locations/global/jobs/job01.

jobId é exclusivo em um determinado projeto.
description

string

Opcional. Uma descrição do job fornecida pelo usuário.

Tamanho máximo: 1.024 bytes quando codificado em unicode.
loggingConfig

object (LoggingConfig)

Opcional. Configuração da geração de registros.
createTime

string (Timestamp format)

Apenas saída. O horário em que o job foi criado.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
scheduleTime

string (Timestamp format)

Apenas saída. O horário em que o job foi programado.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
completeTime

string (Timestamp format)

Apenas saída. O horário em que o trabalho foi concluído.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
counters

object (Counters)

Apenas saída. Informações sobre o andamento do trabalho.
errorSummaries[]

object (ErrorSummary)

Apenas saída. Resume os erros encontrados com exemplos de entradas no registro de erros.
state

enum (State)

Apenas saída. Situação atual do trabalho.
dryRun

boolean

Opcional. Se verdadeiro, o trabalho é executado em modo de teste, retornando a contagem total de objetos e, se a configuração do objeto for uma lista de prefixos, os bytes encontrados na origem. Nenhuma transformação é realizada.
isMultiBucketJob

boolean

Apenas saída. Se for verdade, este trabalho opera em vários buckets. Tarefas com múltiplos buckets estão sujeitas a limites de cota diferentes das tarefas com um único bucket.
Campo de união source. Especifica os objetos a serem transformados. source pode ser apenas de um dos tipos a seguir:
bucketList

object (BucketList)

Especifica uma lista de buckets e seus respectivos objetos a serem transformados.
projectSource

object (ProjectSource)

Especifica uma origem de projeto e filtros para identificar os objetos a serem transformados.
Campo de união transformation. Operação a ser realizada nos objetos. transformation pode ser apenas de um dos tipos a seguir:
putObjectHold

object (PutObjectHold)

Altera o status de retenção do objeto.
deleteObject

object (DeleteObject)

Excluir objetos.
putMetadata

object (PutMetadata)

Atualiza os metadados do objeto. Permite atualizar metadados de chave fixa e personalizados. Por exemplo, Cache-Control, Content-Disposition, Content-Encoding, Content-Language, Content-Type, Custom-Time e Retention configuration.
rewriteObject

object (RewriteObject)

Reescreva o objeto e atualize os metadados, como a chave KMS.
updateObjectCustomContext

object (UpdateObjectCustomContext)

Atualizar contexto personalizado do objeto.
setObjectAcls

object (SetObjectAcls)

Atualiza as ACLs de objetos.

BucketList

Descreve a lista de buckets e seus respectivos objetos a serem transformados.

Representação JSON 
{
  "buckets": [
    {
      object (Bucket)
    }
  ]
}
Campos
buckets[]

object (Bucket)

Obrigatório. Lista de baldes e seus respectivos objetos a serem transformados. Você pode especificar apenas um bucket por tarefa. Se forem especificados vários buckets, ocorrerá um erro.

Bucket

Descreve a configuração de um único bucket e seus objetos a serem transformados.

Representação 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.
}
Campos
bucket

string

Obrigatório. Nome do bucket dos objetos a serem transformados.
Campo de união object_configuration. Especifica os objetos a serem transformados. object_configuration pode ser apenas de um dos tipos a seguir:
prefixList

object (PrefixList)

Especifica objetos que correspondem a um conjunto de prefixos.
manifest

object (Manifest)

Especifica objetos em um arquivo de manifesto.

LoggingConfig

Especifica o comportamento do Cloud Logging.

Representação JSON 
{
  "logActions": [
    enum (LoggableAction)
  ],
  "logActionStates": [
    enum (LoggableActionState)
  ]
}
Campos
logActions[]

enum (LoggableAction)

Obrigatório. Especifica as ações a serem registradas.
logActionStates[]

enum (LoggableActionState)

Obrigatório. Estados em que a ação é registrada.Se estiver vazio, nenhum registro será gerado.

LoggableAction

Tipos de ações registráveis.

Tipos enumerados
LOGGABLE_ACTION_UNSPECIFIED Valor ilegal para evitar permitir um padrão.
TRANSFORM A ação de transformação correspondente neste job.

LoggableActionState

Filtro de estados de ações registradas.

Tipos enumerados
LOGGABLE_ACTION_STATE_UNSPECIFIED Valor ilegal para evitar permitir um padrão.
SUCCEEDED LoggableAction foi concluído. As ações do SUCCEEDED são registradas como [INFO][google.logging.type.LogSeverity.INFO].
FAILED LoggableAction foi encerrado em um estado de erro. As ações FAILED são registradas como [ERROR][google.logging.type.LogSeverity.ERROR].

Estado

Descreve o estado de um job.

Tipos enumerados
STATE_UNSPECIFIED Valor padrão. Esse valor não é usado.
RUNNING Em andamento.
SUCCEEDED Concluído.
CANCELED Ação cancelada pelo usuário.
FAILED Encerrado devido a uma falha irrecuperável.
QUEUED Na fila, mas ainda não iniciada.

Métodos

cancel

 Cancela um job em lote.

create

 Cria um job em lote.

delete

 Exclui um job em lote.

get

 Recebe um job em lote.

list

 Lista jobs em um determinado projeto.