REST Resource: projects.datasets

Recurso: conjunto de dados

Uma representação de um recurso de conjunto de dados.

Representação JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "versionId": string,
  "usage": [
    enum (Usage)
  ],
  "status": {
    object (Status)
  },
  "createTime": string,
  "updateTime": string,
  "versionCreateTime": string,
  "versionDescription": string,

  // Union field data_source can be only one of the following:
  "localFileSource": {
    object (LocalFileSource)
  },
  "gcsSource": {
    object (GcsSource)
  }
  // End of list of possible types for union field data_source.
}
Campos
name

string

Nome do recurso. Formato: projects/{project}/datasets/{datasetId}
displayName

string

Nome legível por humanos, mostrado na interface do console.

Precisa ser exclusivo dentro de um projeto.
description

string

Uma descrição do conjunto de dados.
versionId

string

O ID da versão do conjunto de dados.
usage[]

enum (Usage)

Caso de uso especificado para este conjunto de dados.
status

object (Status)

Apenas saída. O status dessa versão do conjunto de dados.
createTime

string (Timestamp format)

Apenas saída. Hora em que o conjunto de dados foi criado pela primeira vez.
updateTime

string (Timestamp format)

Apenas saída. Hora em que os metadados do conjunto de dados foram atualizados pela última vez.
versionCreateTime

string (Timestamp format)

Apenas saída. Hora em que a versão foi criada.
versionDescription

string

Apenas saída. A descrição desta versão do conjunto de dados. Ele é fornecido durante a importação de dados para o conjunto de dados.
Campo de união data_source. Detalhes sobre a origem dos dados do conjunto de dados. data_source pode ser apenas de um dos tipos a seguir:
localFileSource

object (LocalFileSource)

Uma origem de arquivo local para o conjunto de dados para um único upload.
gcsSource

object (GcsSource)

Uma origem de arquivo do Google Cloud Storage para o conjunto de dados para um único upload.

Uso

Uso especifica onde os dados devem ser usados para informar como processá-los.

Enums
USAGE_UNSPECIFIED O uso deste conjunto de dados não está definido.
USAGE_DATA_DRIVEN_STYLING Este conjunto de dados será usado para o estilo baseado em dados.

LocalFileSource

Detalhes sobre a fonte de dados quando ela é um arquivo local.

Representação JSON 
{
  "filename": string,
  "fileFormat": enum (FileFormat)
}
Campos
filename

string

O nome do arquivo enviado.
fileFormat

enum (FileFormat)

O formato do arquivo que está sendo enviado.

FileFormat

O formato do arquivo que está sendo enviado.

Enums
FILE_FORMAT_UNSPECIFIED Formato de arquivo não especificado.
FILE_FORMAT_GEOJSON GeoJson.
FILE_FORMAT_KML Arquivo KML.
FILE_FORMAT_CSV arquivo CSV.

GcsSource

Detalhes sobre a fonte de dados quando ela está no Google Cloud Storage.

Representação JSON 
{
  "inputUri": string,
  "fileFormat": enum (FileFormat)
}
Campos
inputUri

string

URI dos dados de origem. Por exemplo, gs://my_bucket/my_object.
fileFormat

enum (FileFormat)

O formato do arquivo do objeto do Google Cloud Storage. Isso é usado principalmente para validação.

Status

Status do conjunto de dados.

Representação JSON 
{
  "state": enum (State),
  "errorMessage": string
}
Campos
state

enum (State)

Enumeração de estado para o status.
errorMessage

string

Mensagem de erro indicando o motivo da falha. Ficará vazio se os conjuntos de dados não estiverem em estado de falha.

Estado

Uma lista de estados para o conjunto de dados.

Enums
STATE_UNSPECIFIED O estado deste conjunto de dados não está definido.
STATE_IMPORTING Os dados estão sendo importados para um conjunto de dados.
STATE_IMPORT_SUCCEEDED Os dados foram importados para um conjunto de dados.
STATE_IMPORT_FAILED Falha ao importar dados para um conjunto.
STATE_DELETING O conjunto de dados está em processo de exclusão.
STATE_DELETION_FAILED O estado de falha na exclusão. Esse estado representa que houve uma falha na exclusão do conjunto de dados. Uma nova tentativa de exclusão pode ser feita.
STATE_PROCESSING Os dados estão sendo processados.
STATE_PROCESSING_FAILED O estado de falha no processamento. Esse estado representa que o processamento falhou e pode relatar erros.
STATE_NEEDS_REVIEW Esse estado não está sendo usado no momento.
STATE_PUBLISHING O estado da publicação. Esse estado representa que a publicação está em andamento.
STATE_PUBLISHING_FAILED Os estados de falha na publicação. Esse estado representa que a publicação falhou. Uma nova tentativa de publicação pode ser feita.
STATE_COMPLETED O estado concluído. Esse estado representa o conjunto de dados que está disponível para uso específico.

Métodos

create

 Cria um novo conjunto de dados para o projeto especificado.

delete

 Exclui o conjunto de dados especificado.

fetchDatasetErrors

 Recebe todos os erros de um conjunto de dados.

get

 Recebe o conjunto de dados.

list

 Lista todos os conjuntos de dados do projeto especificado.

patch

 Atualiza os metadados do conjunto de dados.