Package google.maps.mapsplatformdatasets.v1alpha

Индекс

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

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

CreateDataset

rpc CreateDataset( CreateDatasetRequest ) returns ( Dataset )

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

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

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

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

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

  • mapsplatformdatasets.datasets.create

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

DeleteDataset

rpc DeleteDataset( DeleteDatasetRequest ) returns ( Empty )

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

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

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

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

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

  • mapsplatformdatasets.datasets.delete

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

ЗагрузитьDataset

rpc DownloadDataset( DownloadDatasetRequest ) returns ( DownloadDatasetResponse )

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

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

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

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

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

  • mapsplatformdatasets.datasets.export

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

GetDataset

rpc GetDataset( GetDatasetRequest ) returns ( Dataset )

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

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

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

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

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

  • mapsplatformdatasets.datasets.get

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

ImportDataset

rpc ImportDataset( ImportDatasetRequest ) returns ( ImportDatasetResponse )

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

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

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

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

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

  • mapsplatformdatasets.datasets.import

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

ListDatasetErrors

rpc ListDatasetErrors( ListDatasetErrorsRequest ) returns ( ListDatasetErrorsResponse )

Получить все ошибки набора данных (в настоящее время это работает только для случая использования DDS).

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

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

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

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

  • mapsplatformdatasets.datasets.get

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

ListDatasets

rpc ListDatasets( ListDatasetsRequest ) returns ( ListDatasetsResponse )

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

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

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

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

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

  • mapsplatformdatasets.datasets.list

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

UpdateDatasetMetadata

rpc UpdateDatasetMetadata( UpdateDatasetMetadataRequest ) returns ( Dataset )

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

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

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

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

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

  • mapsplatformdatasets.datasets.update

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

CreateDatasetRequest

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

Поля
parent

string

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

dataset

Dataset

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

Набор данных

Представление набора данных платформы карт.

Поля
name

string

Имя ресурса, projects/{project}/datasets/{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 для набора данных для однократной загрузки.

DeleteDatasetRequest

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

Набор данных, подлежащий удалению.

Поля
name

string

Обязательно. Формат: projects/${project}/datasets/{dataset_id}

DownloadDatasetRequest

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

Поля
name

string

Набор данных для извлечения. Формат: projects/${project}/datasets/${dataset_id}

DownloadDatasetResponse

Ответ на загрузку набора данных.

Формат файла

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

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

GcsSource

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

Поля
input_uri

string

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

file_format

FileFormat

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

GetDatasetRequest

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

Поля
name

string

Обязательно. Имя ресурса. projects/{project}/datasets/{dataset_id}

ImportDatasetRequest

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

Поля
name

string

Обязательно. Имя ресурса: projects/{project}/datasets/{dataset_id}

version_description

string

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

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

LocalFileSource

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

gcs_source

GcsSource

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

ImportDatasetResponse

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

Поля
name

string

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

ListDatasetErrorsRequest

Запрос на составление подробного списка ошибок, относящихся к набору данных.

Поля
name

string

Обязательно. Формат: projects/${project}/datasets/{dataset_id}

page_size

int32

Максимальное количество версий, возвращаемых на страницу. Значение по умолчанию — 10.

page_token

string

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

ListDatasetErrorsResponse

Ответ ListDatasetErrors. Возвращает повторяющуюся строку для сообщений об ошибках.

Поля
error_messages[]

string

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

next_page_token

string

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

ListDatasetsRequest

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

Поля
parent

string

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

page_size

int32

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

page_token

string

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

ListDatasetsResponse

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

Поля
datasets[]

Dataset

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

next_page_token

string

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

LocalFileSource

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

Поля
filename

string

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

file_format

FileFormat

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

Статус

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

Поля
state

State

Перечисление состояний для статуса.

error_message

string

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

Состояние

Список состояний версии набора данных. Если значения здесь изменены, рассмотрите возможность обновления методов утилиты Status.

Перечисления
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

Обязательно. Набор данных для обновления. Имя набора данных используется для его идентификации. Имя имеет следующий формат: projects/{project}/datasets/{dataset_id}

update_mask

FieldMask

Список полей для обновления. Поддерживается значение «*» для полной замены.

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

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

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