REST Resource: projects.datasets

Ресурс: Набор данных

Представление ресурса набора данных.

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.
}
Поля
name

string

Имя ресурса. Формат: проекты/{проект}/наборы данных/{datasetId}

displayName

string

Читаемое человеком имя, отображаемое в пользовательском интерфейсе консоли.

Должно быть уникальным в рамках проекта.

description

string

Описание этого набора данных.

versionId

string

Идентификатор версии набора данных.

usage[]

enum ( Usage )

Указанный вариант использования для этого набора данных.

status

object ( Status )

Только вывод. Статус этой версии набора данных.

createTime

string ( Timestamp format)

Только вывод. Время, когда набор данных был впервые создан.

updateTime

string ( Timestamp format)

Только вывод. Время последнего обновления метаданных набора данных.

versionCreateTime

string ( Timestamp format)

Только вывод. Время создания этой версии.

versionDescription

string

Только вывод. Описание этой версии набора данных. Он предоставляется при импорте данных в набор данных.

Поле объединения data_source . Подробная информация об источнике данных для набора данных. data_source может быть только одним из следующих:
localFileSource

object ( LocalFileSource )

Локальный источник файла для набора данных для одной загрузки.

gcsSource

object ( GcsSource )

Источник файла Google Cloud Storage для набора данных для одной загрузки.

Использование

Использование указывает, где данные будут использоваться, чтобы указать, как их обрабатывать.

Перечисления
USAGE_UNSPECIFIED Использование этого набора данных не установлено.
USAGE_DATA_DRIVEN_STYLING Этот набор данных будет использоваться для стилизации на основе данных.

Локальныйфилесаурце

Подробная информация об источнике данных, если это локальный файл.

JSON-представление
{
  "filename": string,
  "fileFormat": enum (FileFormat)
}
Поля
filename

string

Имя загруженного файла.

fileFormat

enum ( FileFormat )

Формат загружаемого файла.

Формат файла

Формат загружаемого файла.

Перечисления
FILE_FORMAT_UNSPECIFIED Неуказанный формат файла.
FILE_FORMAT_GEOJSON Файл GeoJson.
FILE_FORMAT_KML KML-файл.
FILE_FORMAT_CSV CSV-файл.

GcsИсточник

Подробная информация об источнике данных, когда он находится в Google Cloud Storage.

JSON-представление
{
  "inputUri": string,
  "fileFormat": enum (FileFormat)
}
Поля
inputUri

string

URI исходных данных. Например, gs://my_bucket/my_object .

fileFormat

enum ( FileFormat )

Формат файла объекта Google Cloud Storage. Используется в основном для проверки.

Статус

Статус набора данных.

JSON-представление
{
  "state": enum (State),
  "errorMessage": string
}
Поля
state

enum ( State )

Государственное перечисление для статуса.

errorMessage

string

Сообщение об ошибке с указанием причины сбоя. Он пуст, если наборы данных не находятся в состоянии сбоя.

Состояние

Список состояний для набора данных.

Перечисления
STATE_UNSPECIFIED Состояние этого набора данных не установлено.
STATE_IMPORTING Данные импортируются в набор данных.
STATE_IMPORT_SUCCEEDED Импорт данных в набор данных выполнен успешно.
STATE_IMPORT_FAILED Не удалось импортировать данные в набор данных.
STATE_DELETING Набор данных находится в процессе удаления.
STATE_DELETION_FAILED Состояние неудачного удаления. Это состояние означает, что удаление набора данных не удалось. Удаление можно повторить.
STATE_PROCESSING Данные обрабатываются.
STATE_PROCESSING_FAILED Состояние сбоя обработки. Это состояние означает, что обработка не удалась, и может сообщать об ошибках.
STATE_NEEDS_REVIEW Это состояние в настоящее время не используется.
STATE_PUBLISHING Государство издательства. Это состояние означает, что публикация продолжается.
STATE_PUBLISHING_FAILED Публикация провалилась. Это состояние означает, что публикация не удалась. Публикацию можно повторить.
STATE_COMPLETED Завершенное состояние. Это состояние представляет собой набор данных, доступный для конкретного использования.

Методы

create

Создает новый набор данных для указанного проекта.

delete

Удаляет указанный набор данных.

fetchDatasetErrors

Получает все ошибки набора данных.

get

Получает набор данных.

list

Перечисляет все наборы данных для указанного проекта.

patch

Обновляет метаданные для набора данных.