Package google.maps.mapsplatformdatasets.v1

Índice

MapsPlatformDatasets

Definição de serviço para a API Datasets da Plataforma Google Maps.

CreateDataset

rpc CreateDataset(CreateDatasetRequest) returns (Dataset)

Cria um novo conjunto de dados para o projeto especificado.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/cloud-platform
Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • mapsplatformdatasets.datasets.create

Para mais informações, consulte a documentação do IAM.
DeleteDataset

rpc DeleteDataset(DeleteDatasetRequest) returns (Empty)

Exclui o conjunto de dados especificado.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/cloud-platform
Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • mapsplatformdatasets.datasets.delete

Para mais informações, consulte a documentação do IAM.
DownloadDataset

rpc DownloadDataset(DownloadDatasetRequest) returns (DownloadDatasetResponse)

Faz o download de um conjunto de dados.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/cloud-platform
Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • mapsplatformdatasets.datasets.export

Para mais informações, consulte a documentação do IAM.
FetchDatasetErrors

rpc FetchDatasetErrors(FetchDatasetErrorsRequest) returns (FetchDatasetErrorsResponse)

Recebe todos os erros de um conjunto de dados.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/cloud-platform
Permissões do IAM

Requer a seguinte permissão do IAM no recurso dataset:

  • mapsplatformdatasets.datasets.get

Para mais informações, consulte a documentação do IAM.
GetDataset

rpc GetDataset(GetDatasetRequest) returns (Dataset)

Recebe o conjunto de dados.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/cloud-platform
Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • mapsplatformdatasets.datasets.get

Para mais informações, consulte a documentação do IAM.
ImportDataset

rpc ImportDataset(ImportDatasetRequest) returns (ImportDatasetResponse)

Importa uma nova versão dos dados para o conjunto de dados.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/cloud-platform
Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • mapsplatformdatasets.datasets.import

Para mais informações, consulte a documentação do IAM.
ListDatasets

rpc ListDatasets(ListDatasetsRequest) returns (ListDatasetsResponse)

Lista todos os conjuntos de dados do projeto especificado.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/cloud-platform
Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • mapsplatformdatasets.datasets.list

Para mais informações, consulte a documentação do IAM.
UpdateDatasetMetadata

rpc UpdateDatasetMetadata(UpdateDatasetMetadataRequest) returns (Dataset)

Atualiza os metadados do conjunto de dados.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/cloud-platform
Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • mapsplatformdatasets.datasets.update

Para mais informações, consulte a documentação do IAM.

CreateDatasetRequest

Solicitação para criar um conjunto de dados de mapas.

Campos
parent

string

Obrigatório. O projeto pai que será proprietário do conjunto de dados. Formato: projects/{project}
dataset

Dataset

Obrigatório. A versão do conjunto de dados a ser criada.

Conjunto de dados

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

Campos
name

string

Nome do recurso. Formato: projects/{project}/datasets/{dataset_id}
display_name

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.
version_id

string

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

Usage

Caso de uso especificado para este conjunto de dados.
status

Status

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

Timestamp

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

Timestamp

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

Timestamp

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

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:
local_file_source

LocalFileSource

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

GcsSource

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

DeleteDatasetRequest

Solicitação para excluir um conjunto de dados.

Campos
name

string

Obrigatório. O nome do conjunto de dados a ser excluído. Formato: projects/{project}/datasets/{dataset_id}

DownloadDatasetRequest

Solicitação para fazer o download do conjunto de dados.

Campos
name

string

Nome do recurso do conjunto de dados a ser buscado. Formato: projects/{project}/datasets/{dataset_id}

DownloadDatasetResponse

Objeto de resposta de DownloadDataset.

FetchDatasetErrorsRequest

Solicitação para listar erros detalhados pertencentes a um conjunto de dados.

Campos
dataset

string

Obrigatório. O nome do conjunto de dados para listar todos os erros. Formato: projects/{project}/datasets/{dataset_id}
page_size

int32

O número máximo de erros a serem retornados por página.

O valor máximo é 500. valores acima de 500 serão limitados a 500.

Se não for especificado, serão retornados no máximo 50 erros.
page_token

string

O token da página, recebido de uma chamada ListDatasetErrors anterior. Forneça isso para recuperar a página subsequente.

FetchDatasetErrorsResponse

Objeto de resposta de FetchDatasetErrors.

Campos
next_page_token

string

Um token que pode ser enviado como page_token para recuperar a próxima página.

Se esse campo for omitido, não haverá páginas subsequentes.
errors[]

Status

Os erros associados a um conjunto de dados.

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.

Campos
input_uri

string

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

FileFormat

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

GetDatasetRequest

Solicitação para receber o conjunto de dados especificado.

Campos
name

string

Obrigatório. Nome do recurso. Formato: projects/{project}/datasets/{dataset_id}

Também é possível buscar algumas versões especiais anexando "@" e uma tag. Formato: projects/{project}/datasets/{dataset_id}@{tag}

Tag "active": as informações da última versão concluída serão incluídas, e NOT_FOUND se o conjunto de dados não tiver uma.

ImportDatasetRequest

Solicitação para importar uma nova versão do conjunto de dados.

Campos
name

string

Obrigatório. Nome do recurso. Formato: projects/{project}/datasets/{dataset_id}
version_description

string

Uma descrição dos novos dados que estão sendo importados.
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:
local_file_source

LocalFileSource

Fonte de arquivo local para o conjunto de dados para uma importação única.
gcs_source

GcsSource

Uma origem de arquivo do Google Cloud Storage para o conjunto de dados para uma importação única.

ImportDatasetResponse

Objeto de resposta de ImportDataset.

Campos
name

string

Obrigatório. Nome do recurso da versão recém-criada do conjunto de dados. Formato: projects/{project}/datasets/{dataset_id}@{version_id}

ListDatasetsRequest

Solicitação para listar conjuntos de dados do projeto.

Campos
parent

string

Obrigatório. O nome do projeto para listar todos os conjuntos de dados. Formato: projects/{project}
page_size

int32

O número máximo de conjuntos de dados a serem retornados por página.

Se não for especificado (ou zero), todos os conjuntos de dados serão retornados.
page_token

string

O token da página, recebido de uma chamada anterior de ListDatasets. Forneça isso para recuperar a página subsequente.
tag

string

A tag que especifica a versão desejada para cada conjunto de dados.

Quando a paginação também é especificada, alguns filtros podem acontecer após a paginação, o que pode fazer com que a resposta tenha menos conjuntos de dados do que o tamanho da página, mesmo que não seja a última.

Tag "active": cada conjunto de dados na resposta incluirá as informações da última versão concluída, e o conjunto de dados será ignorado se não tiver uma.

ListDatasetsResponse

Objeto de resposta de ListDatasets.

Campos
datasets[]

Dataset

Todos os conjuntos de dados do projeto.
next_page_token

string

Um token que pode ser enviado como page_token para recuperar a próxima página.

Se esse campo for omitido, não haverá páginas subsequentes.

LocalFileSource

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

Campos
filename

string

O nome do arquivo enviado.
file_format

FileFormat

O formato do arquivo que está sendo enviado.

Status

Status do conjunto de dados.

Campos
state

State

Enumeração de estado para o status.
error_message

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.

UpdateDatasetMetadataRequest

Solicitação para atualizar os campos de metadados do conjunto de dados.

Campos
dataset

Dataset

Obrigatório. Nome do recurso do conjunto de dados a ser atualizado. Formato: projects/{project}/datasets/{dataset_id}
update_mask

FieldMask

Lista de campos a serem atualizados.

O valor "*" é usado para substituição completa (padrão).

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.