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

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)

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)

Atualizar 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. Projeto pai que será o 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, mostrado na interface do usuário do console .

description

string

Uma descrição deste 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 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 esta versão do conjunto de dados foi criada. (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 durante a importação de dados para o conjunto de dados.

Campo de união data_source. Detalhes sobre a origem dos dados para o 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 arquivos do Google Cloud Storage para o conjunto de dados para 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. Format: projects/${project}/datasets/{dataset_id}

DownloadDatasetRequest

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

Campos
name

string

O conjunto de dados a ser buscado. Format: 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 GeoJson.
FILE_FORMAT_KML 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 de dados de origem. Por exemplo, gs://my_bucket/my_object.

file_format

FileFormat

O formato de 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 para o conjunto de dados. data_source pode ser apenas de um dos tipos a seguir:
local_file_source

LocalFileSource

Uma fonte de arquivo local para o conjunto de dados para uma importação única.

gcs_source

GcsSource

Uma fonte de arquivos do Google Cloud Storage para o conjunto de dados para 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 recém-criada do conjunto de dados: 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.

page_size

int32

O número máximo de versões a serem retornadas 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.

ListDatasetsResponse

Resposta para listar os 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 do estado do 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 foi definido.
STATE_IMPORTING Os dados estão sendo importados para um conjunto de dados.
STATE_IMPORT_SUCCEEDED Dados importados para um conjunto de dados.
STATE_IMPORT_FAILED Falha ao importar dados para um conjunto de dados.
STATE_DELETING O conjunto de dados está em processo de exclusão.
STATE_DELETION_FAILED Estado de falha na exclusão. Esse estado representa que não foi possível excluir o conjunto de dados. Você pode tentar excluir novamente.
STATE_PROCESSING O estado de processamento. Esse estado representa a correspondência e o processamento inicial dos conjuntos de dados com os derivados.
STATE_PROCESSING_FAILED Os dados estão sendo processados.
STATE_NEEDS_REVIEW Este estado não é usado no momento.
STATE_PUBLISHING O estado de publicação. Esse estado representa que a publicação está em andamento.
STATE_PUBLISHING_FAILED Os estados de falha de publicação. Esse estado representa que a publicação falhou. É possível tentar publicar novamente.
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. O conjunto de dados a ser atualizado. O nome do conjunto de dados é usado para identificar o conjunto que será atualizado. O nome tem o formato: projects/{project}/datasets/{dataset_id}

update_mask

FieldMask

Lista de campos a serem atualizados. Ofereça suporte ao valor "*" para substituição completa.

Uso

O uso especifica onde os dados devem ser utilizados para informar como processá-los.

Enums
USAGE_UNSPECIFIED O uso deste conjunto de dados não está definido.
USAGE_DATA_DRIVEN_STYLING Ele será usado para a estilização baseada em dados.