Package google.maps.mapsplatformdatasets.v1alpha

Índice

MapsPlatformDatasetsV1Alpha

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

CreateDataset

rpc CreateDataset(CreateDatasetRequest) returns (Dataset)

Crie um 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.
GetDataset

rpc GetDataset(GetDatasetRequest) returns (Dataset)

Acesse 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.
ListDatasetErrors

rpc ListDatasetErrors(ListDatasetErrorsRequest) returns (ListDatasetErrorsResponse)

Recebe todos os erros de um conjunto de dados. No momento, isso só funciona para o caso de uso do DDS.

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

rpc ListDatasets(ListDatasetsRequest) returns (ListDatasetsResponse)

Liste 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)

Atualize 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 do Maps.

Campos
parent

string

Obrigatório. Projeto principal 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 conjunto de dados da plataforma de mapas.

Campos
name

string

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

string

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

string

Uma descrição do conjunto de dados .
version_id

string

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

Usage

Casos de uso especificados para este conjunto de dados.
status

Status

Apenas saída. O status desta 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 esta versão do conjunto de dados foi criada. (Isso aconteceu ao importar dados para o conjunto de dados)
version_description

string

Apenas saída. A descrição desta versão do conjunto de dados. Ele é fornecido ao importar dados para o conjunto de dados.
Campo de união data_source. Detalhes sobre a origem dos dados do conjunto. 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 de um único upload.
gcs_source

GcsSource

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

DeleteDatasetRequest

Solicitação para excluir um conjunto de dados.

O conjunto de dados a ser excluído.

Campos
name

string

Obrigatório. Formato: projects/${project}/datasets/{dataset_id}

DownloadDatasetRequest

Solicite o download do conjunto de dados.

Campos
name

string

O conjunto de dados a ser buscado. Formato: projects/${project}/datasets/${dataset_id}

DownloadDatasetResponse

Resposta do download do 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 Arquivo GeoJson.
FILE_FORMAT_KML Arquivo KML.
FILE_FORMAT_CSV arquivo CSV.

GcsSource

Os 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: projects/{project}/datasets/{dataset_id}

ImportDatasetRequest

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

Campos
name

string

Obrigatório. Nome do recurso: 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. 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 de uma importação única.
gcs_source

GcsSource

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

ImportDatasetResponse

Resposta da importação de uma nova versão do conjunto de dados.

Campos
name

string

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

ListDatasetErrorsRequest

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

Campos
name

string

Obrigatório. Formato: projects/${project}/datasets/{dataset_id}
page_size

int32

O número máximo de versões a serem retornadas por página. O valor padrão é 10.
page_token

string

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

ListDatasetErrorsResponse

Resposta de "ListDatasetErrors". Retorna uma string repetida para mensagens de erro.

Campos
error_messages[]

string

Os erros pertencentes a um conjunto de dados.
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.

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

int32

O número máximo de versões a serem retornadas por página. Se não for especificado (ou for zero), todos os conjuntos de dados serão retornados.
page_token

string

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

ListDatasetsResponse

Resposta para listar conjuntos de dados do projeto.

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

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

Campos
filename

string

O nome e a extensão do arquivo enviado.
file_format

FileFormat

O formato do arquivo que está sendo enviado.

Status

Status da versão do conjunto de dados.

Campos
state

State

Enumeração de estado para status.
error_message

string

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

Estado

Uma lista de estados para a versão do conjunto de dados. Se os valores forem modificados aqui, considere atualizar os métodos utilitários de status.

Enums
STATE_UNSPECIFIED O estado deste conjunto de dados não está definido.
STATE_IMPORTING A versão do conjunto de dados está sendo importada.
STATE_IMPORT_SUCCEEDED A importação da versão do conjunto de dados foi concluída.
STATE_IMPORT_FAILED A importação da versão do conjunto de dados falhou.
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 a exclusão do conjunto de dados falhou. A exclusão pode ser repetida.
STATE_PROCESSING O estado de processamento. Esse estado representa a correspondência e o processamento iniciais de conjuntos de dados para conjuntos de dados derivados.
STATE_PROCESSING_FAILED O estado de falha no processamento. Esse estado representa que o processamento falhou e pode informar erros.
STATE_NEEDS_REVIEW O estado de revisão necessária. Esse estado representa que os dados estão disponíveis para publicação e veiculação para o uso específico.
STATE_PUBLISHING O estado de 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. É possível tentar publicar de novo.
STATE_COMPLETED O estado concluído. Esse estado representa o conjunto de dados disponível para uso específico.

UpdateDatasetMetadataRequest

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

Campos
dataset

Dataset

Obrigatório. O conjunto de dados a ser atualizado. O nome do conjunto de dados é usado para identificar o conjunto a ser atualizado. O nome tem o formato: projects/{project}/datasets/{dataset_id}
update_mask

FieldMask

A lista de campos a serem atualizados. Compatibilidade com o valor "*" para substituição completa.

Uso

O 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 Esse conjunto de dados será usado para o estilo baseado em dados.