Recurso REST: projects.locations.transferConfigs.runs

Recurso: TransferRun

Representa uma execução de transferência de dados.

Representação JSON

{
  "name": string,
  "scheduleTime": string,
  "runTime": string,
  "errorStatus": {
    object (Status)
  },
  "startTime": string,
  "endTime": string,
  "updateTime": string,
  "params": {
    object
  },
  "dataSourceId": string,
  "state": enum (TransferState),
  "userId": string,
  "schedule": string,
  "notificationPubsubTopic": string,
  "emailPreferences": {
    object (EmailPreferences)
  },
  "destinationDatasetId": string
}
Campos
name

string

O nome do recurso da execução de transferência. Os nomes das execuções de transferência têm o formato projects/{projectId}/locations/{location}/transferConfigs/{configId}/runs/{run_id}. O nome é ignorado ao criar uma execução de transferência.

scheduleTime

string (Timestamp format)

Tempo mínimo para iniciar uma execução de transferência.

runTime

string (Timestamp format)

Especifica a data e a hora dos dados que serão ingeridos em execuções de transferência em lote.

errorStatus

object (Status)

Status da execução da transferência.

startTime

string (Timestamp format)

Apenas saída. Hora em que a execução da transferência foi iniciada. Parâmetro ignorado pelo servidor para solicitações de entrada.

endTime

string (Timestamp format)

Apenas saída. Hora em que a execução da transferência foi finalizada. Parâmetro ignorado pelo servidor para solicitações de entrada.

updateTime

string (Timestamp format)

Apenas saída. Última vez que o estado de execução da transferência de dados foi atualizado.

params

object (Struct format)

Apenas saída. Parâmetros específicos de transferência de dados.

dataSourceId

string

Apenas saída. Código da fonte de dados.

state

enum (TransferState)

Estado de execução da transferência de dados. Ignorado para solicitações de entrada.

userId

string (int64 format)

Obsoleto. ID exclusivo do usuário que tem a transferência feita em seu nome.

schedule

string

Apenas saída. Descreve a programação dessa execução de transferência se ela foi criada como parte de uma programação regular. Para execuções de transferência em lote programadas manualmente, este parâmetro fica vazio. Observação: o sistema pode atrasar a programação, dependendo da carga atual. Portanto, scheduleTime nem sempre corresponde a isso.

notificationPubsubTopic

string

Apenas saída. Tópico do Pub/Sub a que uma notificação será enviada quando a transferência for concluída

emailPreferences

object (EmailPreferences)

Apenas saída. Essas preferências serão usadas para enviar notificações para o endereço de e-mail do usuário que é proprietário da configuração de transferência que serviu como base para derivar a execução.

destinationDatasetId

string

Apenas saída. O ID do conjunto de dados de destino do BigQuery.

Status

O tipo Status define um modelo de erro lógico que é adequado a diferentes ambientes de programação, incluindo APIs REST e RPC. É usado por gRPC (em inglês). Cada mensagem Status contém três partes de dados: código do erro, mensagem de erro e detalhes do erro.

É possível descobrir mais sobre esse modelo de erro e como trabalhar com ele no Guia de design de API.

Representação JSON

{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Campos
code

integer

O código de status, que precisa ser um valor de enumeração de google.rpc.Code.

message

string

Uma mensagem de erro em inglês para o desenvolvedor. Qualquer mensagem de erro para o usuário precisa ser localizada e enviada no campo google.rpc.Status.details, ou localizada pelo cliente.

details[]

object

Uma lista de mensagens com os detalhes do erro. Há um conjunto comum de tipos de mensagens para as APIs usarem.

Um objeto contendo campos de um tipo arbitrário. Um campo adicional "@type" contém uma URI que identifica o tipo. Exemplo: { "id": 1234, "@type": "types.example.com/standard/id" }.

Métodos

delete

Exclui a execução da transferência especificada.

get

Retorna informações sobre a execução de transferência específica.

list

Retorna informações sobre jobs em execução e concluídos.