Package google.maps.mapsplatformdatasets.v1alpha

Index

MapsPlatformDatasetsV1Alpha

Définition du service pour l'API Datasets Maps Platform.

CreateDataset

rpc CreateDataset(CreateDatasetRequest) returns (Dataset)

Créez un ensemble de données pour le projet spécifié.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/cloud-platform
Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource parent :

  • mapsplatformdatasets.datasets.create

Pour en savoir plus, consultez la documentation IAM.
DeleteDataset

rpc DeleteDataset(DeleteDatasetRequest) returns (Empty)

Supprime l'ensemble de données spécifié .

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/cloud-platform
Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource name :

  • mapsplatformdatasets.datasets.delete

Pour en savoir plus, consultez la documentation IAM.
DownloadDataset

rpc DownloadDataset(DownloadDatasetRequest) returns (DownloadDatasetResponse)

Télécharge un ensemble de données.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/cloud-platform
Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource name :

  • mapsplatformdatasets.datasets.export

Pour en savoir plus, consultez la documentation IAM.
GetDataset

rpc GetDataset(GetDatasetRequest) returns (Dataset)

Obtenez l'ensemble de données.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/cloud-platform
Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource name :

  • mapsplatformdatasets.datasets.get

Pour en savoir plus, consultez la documentation IAM.
ImportDataset

rpc ImportDataset(ImportDatasetRequest) returns (ImportDatasetResponse)

Importe une nouvelle version des données pour l'ensemble de données.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/cloud-platform
Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource name :

  • mapsplatformdatasets.datasets.import

Pour en savoir plus, consultez la documentation IAM.
ListDatasetErrors

rpc ListDatasetErrors(ListDatasetErrorsRequest) returns (ListDatasetErrorsResponse)

Obtenez toutes les erreurs d'un ensemble de données (pour le moment, cela ne fonctionne que pour le cas d'utilisation DDS).

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/cloud-platform
Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource name :

  • mapsplatformdatasets.datasets.get

Pour en savoir plus, consultez la documentation IAM.
ListDatasets

rpc ListDatasets(ListDatasetsRequest) returns (ListDatasetsResponse)

Répertorie tous les ensembles de données du projet spécifié.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/cloud-platform
Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource parent :

  • mapsplatformdatasets.datasets.list

Pour en savoir plus, consultez la documentation IAM.
UpdateDatasetMetadata

rpc UpdateDatasetMetadata(UpdateDatasetMetadataRequest) returns (Dataset)

Mettez à jour les métadonnées de l'ensemble de données.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/cloud-platform
Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource name :

  • mapsplatformdatasets.datasets.update

Pour en savoir plus, consultez la documentation IAM.

CreateDatasetRequest

Requête permettant de créer un ensemble de données Maps.

Champs
parent

string

Obligatoire. Projet parent qui sera propriétaire de l'ensemble de données. Format : projects/{$project}
dataset

Dataset

Obligatoire. Version de l'ensemble de données à créer.

Ensemble de données

Représentation d'un ensemble de données de la plate-forme Maps.

Champs
name

string

Nom de ressource : projects/{project}/datasets/{dataset_id}
display_name

string

Nom intelligible, affiché dans l'interface utilisateur de la console .
description

string

Description de cet ensemble de données .
version_id

string

ID de version de l'ensemble de données.
usage[]

Usage

Cas d'utilisation spécifiés pour cet ensemble de données.
status

Status

Uniquement en sortie. État de cette version de l'ensemble de données.
create_time

Timestamp

Uniquement en sortie. Heure à laquelle l'ensemble de données a été créé.
update_time

Timestamp

Uniquement en sortie. Heure de la dernière mise à jour des métadonnées de l'ensemble de données.
version_create_time

Timestamp

Uniquement en sortie. Heure à laquelle cette version de l'ensemble de données a été créée. (Cela s'est produit lors de l'importation de données dans l'ensemble de données.)
version_description

string

Uniquement en sortie. Description de cette version de l'ensemble de données. Il est fourni lors de l'importation de données dans l'ensemble de données.
Champ d'union data_source. Détails sur la source des données de l'ensemble de données. data_source ne peut être qu'un des éléments suivants :
local_file_source

LocalFileSource

Source de fichier local pour l'ensemble de données pour un seul import.
gcs_source

GcsSource

Source de fichier Google Cloud Storage pour l'ensemble de données pour un seul import.

DeleteDatasetRequest

Requête de suppression d'un ensemble de données.

Ensemble de données à supprimer.

Champs
name

string

Obligatoire. Format : projects/${project}/datasets/{dataset_id}

DownloadDatasetRequest

Demandez à télécharger l'ensemble de données.

Champs
name

string

Ensemble de données à récupérer. Format : projects/${project}/datasets/${dataset_id}

DownloadDatasetResponse

Réponse au téléchargement de l'ensemble de données.

FileFormat

Format du fichier importé.

Enums
FILE_FORMAT_UNSPECIFIED Format de fichier non spécifié.
FILE_FORMAT_GEOJSON Fichier GeoJSON.
FILE_FORMAT_KML Fichier KML.
FILE_FORMAT_CSV CSV.

GcsSource

Détails sur la source de données lorsqu'elle se trouve dans Google Cloud Storage.

Champs
input_uri

string

URI des données sources. Par exemple, gs://my_bucket/my_object.
file_format

FileFormat

Format de fichier de l'objet Google Cloud Storage. Elle est principalement utilisée pour la validation.

GetDatasetRequest

Requête permettant d'obtenir l'ensemble de données spécifié.

Champs
name

string

Obligatoire. Nom de ressource : projects/{project}/datasets/{dataset_id}

ImportDatasetRequest

Demande d'importation d'une nouvelle version de l'ensemble de données.

Champs
name

string

Obligatoire. Nom de ressource : projects/{project}/datasets/{dataset_id}
version_description

string

Description des nouvelles données importées.
Champ d'union data_source. Détails sur la source des données de l'ensemble de données. data_source ne peut être qu'un des éléments suivants :
local_file_source

LocalFileSource

Source de fichier local pour l'ensemble de données pour une importation unique.
gcs_source

GcsSource

Source de fichier Google Cloud Storage pour l'ensemble de données pour une importation unique.

ImportDatasetResponse

Réponse à l'importation d'une nouvelle version de l'ensemble de données.

Champs
name

string

Obligatoire. Nom de ressource de la version de l'ensemble de données qui vient d'être créée : projects/{project}/datasets/{dataset_id}@{version_id}

ListDatasetErrorsRequest

Demande de liste des erreurs détaillées appartenant à un ensemble de données.

Champs
name

string

Obligatoire. Format : projects/${project}/datasets/{dataset_id}
page_size

int32

Nombre maximal de versions à renvoyer par page. Valeur par défaut : 10
page_token

string

Jeton de page reçu lors d'un appel ListDatasetErrors précédent. Fournissez-le pour récupérer la page suivante.

ListDatasetErrorsResponse

Réponse de ListDatasetErrors. Renvoie une chaîne répétée pour les messages d'erreur.

Champs
error_messages[]

string

Erreurs appartenant à un ensemble de données.
next_page_token

string

Jeton pouvant être envoyé en tant que page_token pour récupérer la page suivante. Si ce champ est omis, il n'y a pas d'autres pages.

ListDatasetsRequest

Demande de liste des ensembles de données pour le projet.

Champs
parent

string

Obligatoire. Nom du projet pour lequel lister tous les ensembles de données.
page_size

int32

Nombre maximal de versions à renvoyer par page. Si ce paramètre n'est pas spécifié (ou est défini sur zéro), tous les ensembles de données sont renvoyés.
page_token

string

Jeton de page reçu lors d'un appel ListDatasets précédent. Fournissez-le pour récupérer la page suivante.

ListDatasetsResponse

Réponse à la liste des ensembles de données pour le projet.

Champs
datasets[]

Dataset

Tous les ensembles de données du projet.
next_page_token

string

Jeton pouvant être envoyé en tant que page_token pour récupérer la page suivante. Si ce champ est omis, il n'y a pas d'autres pages.

LocalFileSource

Détails sur la source de données lorsqu'il s'agit d'un fichier local.

Champs
filename

string

Nom de fichier et extension du fichier importé.
file_format

FileFormat

Format du fichier importé.

État

État de la version de l'ensemble de données.

Champs
state

State

Énumération de l'état.
error_message

string

Message d'erreur indiquant la raison de l'échec. Il est vide si l'ensemble de données n'est pas dans un état d'échec.

État

Liste des états de la version de l'ensemble de données. Si des valeurs sont modifiées ici, pensez à mettre à jour les méthodes utilitaires de l'état.

Enums
STATE_UNSPECIFIED L'état de cet ensemble de données n'est pas défini.
STATE_IMPORTING La version de l'ensemble de données est en cours d'importation.
STATE_IMPORT_SUCCEEDED L'importation de la version de l'ensemble de données a réussi.
STATE_IMPORT_FAILED L'importation de la version de l'ensemble de données a échoué.
STATE_DELETING L'ensemble de données est en cours de suppression.
STATE_DELETION_FAILED État d'échec de la suppression. Cet état indique que la suppression de l'ensemble de données a échoué. La suppression peut être réessayée.
STATE_PROCESSING État du traitement. Cet état représente la mise en correspondance et le traitement initiaux des ensembles de données pour obtenir des ensembles de données dérivés.
STATE_PROCESSING_FAILED État d'échec du traitement. Cet état indique que le traitement a échoué et peut signaler des erreurs.
STATE_NEEDS_REVIEW État de l'examen des besoins. Cet état indique que les données sont disponibles pour être publiées et diffusées pour l'utilisation spécifique.
STATE_PUBLISHING État de publication. Cet état indique que la publication est en cours.
STATE_PUBLISHING_FAILED États d'échec de la publication. Cet état indique que la publication a échoué. Vous pouvez réessayer de publier.
STATE_COMPLETED État "Terminé". Cet état indique que l'ensemble de données est disponible pour son utilisation spécifique.

UpdateDatasetMetadataRequest

Demande de mise à jour des champs de métadonnées de l'ensemble de données.

Champs
dataset

Dataset

Obligatoire. Ensemble de données à mettre à jour. Le nom de l'ensemble de données permet d'identifier l'ensemble de données à mettre à jour. Le nom a le format suivant : projects/{project}/datasets/{dataset_id}
update_mask

FieldMask

Liste des champs à mettre à jour. Acceptez la valeur "*" pour un remplacement complet.

Utilisation

L'utilisation spécifie où les données sont censées être utilisées pour indiquer comment les traiter.

Enums
USAGE_UNSPECIFIED L'utilisation de cet ensemble de données n'est pas définie.
USAGE_DATA_DRIVEN_STYLING Cet ensemble de données sera utilisé pour le style basé sur les données.