Package google.maps.mapsplatformdatasets.v1

Индекс

КартыПлатформаНаборы данных

Определение сервиса для API наборов данных платформы Карт.

Создать набор данных

rpc CreateDataset( CreateDatasetRequest ) returns ( Dataset )

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

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/cloud-platform
IAM-разрешения

Требуется следующее разрешение IAM для parent ресурса:

  • mapsplatformdatasets.datasets.create

Дополнительную информацию см. в документации IAM .

Удалить набор данных

rpc DeleteDataset( DeleteDatasetRequest ) returns ( Empty )

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

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/cloud-platform
IAM-разрешения

Требуется следующее разрешение IAM для ресурса name :

  • mapsplatformdatasets.datasets.delete

Дополнительную информацию см. в документации IAM .

СкачатьНабор данных

rpc DownloadDataset( DownloadDatasetRequest ) returns ( DownloadDatasetResponse )

Загружает набор данных.

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/cloud-platform
IAM-разрешения

Требуется следующее разрешение IAM для ресурса name :

  • mapsplatformdatasets.datasets.export

Дополнительную информацию см. в документации IAM .

FetchDatasetErrors

rpc FetchDatasetErrors( FetchDatasetErrorsRequest ) returns ( FetchDatasetErrorsResponse )

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

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/cloud-platform
IAM-разрешения

Требуется следующее разрешение IAM для ресурса dataset :

  • mapsplatformdatasets.datasets.get

Дополнительную информацию см. в документации IAM .

Получить набор данных

rpc GetDataset( GetDatasetRequest ) returns ( Dataset )

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

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/cloud-platform
IAM-разрешения

Требуется следующее разрешение IAM для ресурса name :

  • mapsplatformdatasets.datasets.get

Дополнительную информацию см. в документации IAM .

Импортдататасет

rpc ImportDataset( ImportDatasetRequest ) returns ( ImportDatasetResponse )

Импортирует новую версию данных для набора данных.

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/cloud-platform
IAM-разрешения

Требуется следующее разрешение IAM для ресурса name :

  • mapsplatformdatasets.datasets.import

Дополнительную информацию см. в документации IAM .

Список наборов данных

rpc ListDatasets( ListDatasetsRequest ) returns ( ListDatasetsResponse )

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

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/cloud-platform
IAM-разрешения

Требуется следующее разрешение IAM для parent ресурса:

  • mapsplatformdatasets.datasets.list

Дополнительную информацию см. в документации IAM .

ОбновлениеDatasetMetadata

rpc UpdateDatasetMetadata( UpdateDatasetMetadataRequest ) returns ( Dataset )

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

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/cloud-platform
IAM-разрешения

Требуется следующее разрешение IAM для ресурса name :

  • mapsplatformdatasets.datasets.update

Дополнительную информацию см. в документации IAM .

Создать запрос набора данных

Запрос на создание набора данных карт.

Поля
parent

string

Необходимый. Родительский проект, которому будет принадлежать набор данных. Формат: проекты/{проект}

dataset

Dataset

Необходимый. Версия набора данных, которую необходимо создать.

Набор данных

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

Поля
name

string

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

display_name

string

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

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

description

string

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

version_id

string

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

usage[]

Usage

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

status

Status

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

create_time

Timestamp

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

update_time

Timestamp

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

version_create_time

Timestamp

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

version_description

string

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

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

LocalFileSource

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

gcs_source

GcsSource

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

Удалить запрос набора данных

Запрос на удаление набора данных.

Поля
name

string

Необходимый. Имя набора данных, который необходимо удалить. Формат: проекты/{проект}/наборы данных/{dataset_id}

Загрузить запрос набора данных

Запросить загрузку набора данных.

Поля
name

string

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

СкачатьDatasetResponse

Объект ответа DownloadDataset.

FetchDatasetErrorsRequest

Запрос на подробный список ошибок, принадлежащих набору данных.

Поля
dataset

string

Необходимый. Имя набора данных, для которого нужно перечислить все ошибки. Формат: проекты/{проект}/наборы данных/{dataset_id}

page_size

int32

Максимальное количество ошибок, возвращаемых на страницу.

Максимальное значение — 500; значения выше 500 будут ограничены до 500.

Если не указано, будет возвращено не более 50 ошибок.

page_token

string

Токен страницы, полученный в результате предыдущего вызова ListDatasetErrors. Предоставьте это, чтобы получить следующую страницу.

FetchDatasetErrorsResponse

Объект ответа FetchDatasetErrors.

Поля
next_page_token

string

Токен, который можно отправить как page_token для получения следующей страницы.

Если это поле опущено, последующие страницы отсутствуют.

errors[]

Status

Ошибки, связанные с набором данных.

Формат файла

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

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

GcsИсточник

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

Поля
input_uri

string

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

file_format

FileFormat

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

GetDatasetRequest

Запрос на получение указанного набора данных.

Поля
name

string

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

Также можно получить некоторые специальные версии, добавив «@» и тег. Формат: проекты/{project}/datasets/{dataset_id}@{tag}

Тег «активный»: будет включена информация о последней завершенной версии и NOT_FOUND, если в наборе данных ее нет.

Импортдатасетрекуест

Запрос на импорт новой версии набора данных.

Поля
name

string

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

version_description

string

Описание новых импортируемых данных.

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

LocalFileSource

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

gcs_source

GcsSource

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

Импортдатасетответ

Объект ответа ImportDataset.

Поля
name

string

Необходимый. Имя ресурса вновь созданной версии набора данных. Формат: проекты/{project}/datasets/{dataset_id}@{version_id}

Запрос ListDatasetsRequest

Запрос на список наборов данных для проекта.

Поля
parent

string

Необходимый. Имя проекта, для которого нужно перечислить все наборы данных. Формат: проекты/{проект}

page_size

int32

Максимальное количество наборов данных, возвращаемых на страницу.

Если значение не указано (или равно нулю), будут возвращены все наборы данных.

page_token

string

Токен страницы, полученный в результате предыдущего вызова ListDatasets. Предоставьте это, чтобы получить следующую страницу.

tag

string

Тег, указывающий желаемую версию для каждого набора данных.

Обратите внимание: если также указано разбиение на страницы, некоторая фильтрация может произойти после разбивки на страницы, что может привести к тому, что ответ будет содержать меньше наборов данных, чем размер страницы, даже если это не последняя страница.

Тег «активный»: каждый набор данных в ответе будет включать информацию о своей последней завершенной версии, а набор данных будет пропущен, если у него его нет.

ListDatasetsResponse

Объект ответа ListDatasets.

Поля
datasets[]

Dataset

Все наборы данных для проекта.

next_page_token

string

Токен, который можно отправить как page_token для получения следующей страницы.

Если это поле опущено, последующие страницы отсутствуют.

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

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

Поля
filename

string

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

file_format

FileFormat

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

Положение дел

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

Поля
state

State

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

error_message

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 Завершенное состояние. Это состояние представляет собой набор данных, доступный для конкретного использования.

UpdateDatasetMetadataRequest

Запрос на обновление полей метаданных набора данных.

Поля
dataset

Dataset

Необходимый. Имя ресурса набора данных для обновления. Формат: проекты/{проект}/наборы данных/{dataset_id}

update_mask

FieldMask

Список полей, которые необходимо обновить.

Значение «*» используется для полной замены (по умолчанию).

Применение

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

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