REST Resource: projects.locations.jobs

Recurso: Job

Es la descripción del trabajo de operaciones de almacenamiento por lotes.

Representación 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

Es el identificador. Es el nombre del recurso del trabajo.

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

Por ejemplo: projects/123456/locations/global/jobs/job01.

jobId es único en un proyecto determinado.

description

string

Es opcional. Es una descripción del trabajo proporcionada por el usuario.

Longitud máxima: 1,024 bytes cuando se codifica en Unicode.

loggingConfig

object (LoggingConfig)

Es opcional. Configuración de registros.

createTime

string (Timestamp format)

Solo salida. Es la fecha y hora en que se creó el trabajo.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

scheduleTime

string (Timestamp format)

Solo salida. Es la fecha y hora en que se programó el trabajo.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

completeTime

string (Timestamp format)

Solo salida. Fecha y hora en que se completó el trabajo.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

counters

object (Counters)

Solo salida. Es información sobre el progreso del trabajo.

errorSummaries[]

object (ErrorSummary)

Solo salida. Resume los errores que se encontraron con las entradas de registro de errores de muestra.

state

enum (State)

Solo salida. Es el estado del trabajo.

dryRun

boolean

Es opcional. Si es verdadero, el trabajo se ejecuta en modo de prueba, lo que devuelve el recuento total de objetos y, si la configuración del objeto es una lista de prefijos, los bytes encontrados en la fuente. No se realizan transformaciones.

isMultiBucketJob

boolean

Solo salida. Si es verdadero, este trabajo opera en varios buckets. Los trabajos con varios buckets están sujetos a límites de cuota diferentes de los trabajos con un solo bucket.

Campo de unión source. Especifica los objetos que se transformarán. source puede ser solo uno de los parámetros siguientes:
bucketList

object (BucketList)

Especifica una lista de buckets y sus objetos que se transformarán.

projectSource

object (ProjectSource)

Especifica una fuente de proyecto y filtros para identificar los objetos que se transformarán.

Campo de unión transformation. Operación que se realizará en los objetos. transformation puede ser solo uno de los parámetros siguientes:
putObjectHold

object (PutObjectHold)

Cambia el estado de retención del objeto.

deleteObject

object (DeleteObject)

Borra objetos.

putMetadata

object (PutMetadata)

Actualiza los metadatos del objeto. Permite actualizar los metadatos personalizados y de clave fija. Por ejemplo, Cache-Control, Content-Disposition, Content-Encoding, Content-Language, Content-Type, Custom-Time y Retention configuration.

rewriteObject

object (RewriteObject)

Vuelve a escribir el objeto y actualiza los metadatos, como la clave de KMS.

updateObjectCustomContext

object (UpdateObjectCustomContext)

Actualiza el contexto personalizado del objeto.

setObjectAcls

object (SetObjectAcls)

Actualiza las ACL de los objetos.

BucketList

Describe la lista de buckets y sus objetos que se transformarán.

Representación JSON
{
  "buckets": [
    {
      object (Bucket)
    }
  ]
}
Campos
buckets[]

object (Bucket)

Obligatorio. Es la lista de buckets y sus objetos que se transformarán. Solo puedes especificar un bucket por trabajo. Si se especifican varios buckets, se produce un error.

Bucket

Describe la configuración de un solo bucket y sus objetos que se transformarán.

Representación 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

Obligatorio. Nombre del depósito para los objetos que se van a transformar.

Campo de unión object_configuration. Especifica los objetos que se van a transformar. object_configuration puede ser solo uno de los parámetros siguientes:
prefixList

object (PrefixList)

Especifica los objetos que coinciden con un conjunto de prefijos.

manifest

object (Manifest)

Especifica los objetos en un archivo de manifiesto.

LoggingConfig

Especifica el comportamiento del registro en la nube.

Representación JSON
{
  "logActions": [
    enum (LoggableAction)
  ],
  "logActionStates": [
    enum (LoggableActionState)
  ]
}
Campos
logActions[]

enum (LoggableAction)

Obligatorio. Especifica las acciones que se registrarán.

logActionStates[]

enum (LoggableActionState)

Obligatorio. Estados en los que se registran las acciones.Si está vacío, no se generan registros.

LoggableAction

Tipos de acciones registrables.

Enums
LOGGABLE_ACTION_UNSPECIFIED Valor ilegal, para evitar permitir un valor predeterminado.
TRANSFORM La acción de transformación correspondiente en este trabajo.

LoggableActionState

Filtro de estados de acción registrables.

Enums
LOGGABLE_ACTION_STATE_UNSPECIFIED Valor ilegal, para evitar permitir un valor predeterminado.
SUCCEEDED LoggableAction se completó correctamente. Las acciones de SUCCEEDED se registran como [INFO][google.logging.type.LogSeverity.INFO].
FAILED LoggableAction finalizó en un estado de error. Las acciones de FAILED se registran como [ERROR][google.logging.type.LogSeverity.ERROR].

Estado

Describe el estado de un trabajo.

Enums
STATE_UNSPECIFIED Valor predeterminado. Este valor no se usa.
RUNNING En curso.
SUCCEEDED Se completó correctamente.
CANCELED El usuario la canceló.
FAILED Se detuvo debido a una falla irrecuperable.
QUEUED En cola, pero aún no comenzó.

Métodos

cancel

Cancela un trabajo por lotes.

create

Crea un trabajo por lotes.

delete

Borra un trabajo por lotes.

get

Obtiene un trabajo por lotes.

list

Enumera los trabajos en un proyecto determinado.