Package google.maps.mapsplatformdatasets.v1alpha

Index

MapsPlatformDatasetsV1Alpha

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

CreateDataset

rpc CreateDataset(CreateDatasetRequest) returns (Dataset)

Crée 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)

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

Récupérez 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.
ListDatasets

rpc ListDatasets(ListDatasetsRequest) returns (ListDatasetsResponse)

Répertorie tous les ensembles 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.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 de création d'un ensemble de données Maps.

Champs
parent

string

Obligatoire. Projet parent qui possédera 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 Maps Platform

Champs
name

string

Nom de la ressource, projects/{project}/datasets/{dataset_id}
display_name

string

Nom lisible, 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. Date et heure de la première création de l'ensemble de données.
update_time

Timestamp

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

Timestamp

Uniquement en sortie. Date et heure de création de cette version de l'ensemble de données. (cela s'est produit lors de l'importation de données dans le jeu 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

Une source de fichier locale pour l'ensemble de données en une seule importation.
gcs_source

GcsSource

Une source de fichier Google Cloud Storage pour l'ensemble de données en une seule importation.

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

Requête de téléchargement de l'ensemble de données.

Champs
name

string

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

DownloadDatasetResponse

Réponse du 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 KML.
FILE_FORMAT_CSV CSV.

GcsSource

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

Champs
input_uri

string

URI des données source. 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 d'obtention de l'ensemble de données spécifié.

Champs
name

string

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

ImportDatasetRequest

Requête d'importation d'une nouvelle version de l'ensemble de données.

Champs
name

string

Obligatoire. Nom de la 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

Un fichier source local pour l'ensemble de données, pour une importation unique.
gcs_source

GcsSource

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

ImportDatasetResponse

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

Champs
name

string

Obligatoire. Nom de ressource de la nouvelle version de l'ensemble de données : projects/{project}/datasets/{dataset_id}@{version_id}

ListDatasetsRequest

Requête permettant de répertorier les ensembles de données du projet.

Champs
parent

string

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

int32

Nombre maximal de versions à renvoyer par page. Si aucune valeur n'est spécifiée (ou si la valeur est zéro), tous les ensembles de données sont renvoyés.
page_token

string

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

ListDatasetsResponse

Réponse pour répertorier les ensembles de données du 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 concernant la source de données lorsqu'il s'agit d'un fichier local.

Champs
filename

string

Nom et extension du fichier importé.
file_format

FileFormat

Format du fichier en cours d'importation.

État

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

Champs
state

State

Énumération d'état pour le statut.
error_message

string

Message d'erreur indiquant la raison de l'échec. Ce champ est vide si les ensembles de données ne présentent pas l'état "Échec".

État

Liste des états de l'ensemble de données.

Enums
STATE_UNSPECIFIED L'état de cet ensemble de données n'est pas défini.
STATE_IMPORTING Des données sont en cours d'importation dans un ensemble de données.
STATE_IMPORT_SUCCEEDED Les données ont bien été importées dans un ensemble de données.
STATE_IMPORT_FAILED Échec de l'importation des données dans un ensemble de données.
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é. Une nouvelle tentative de suppression peut être effectuée.
STATE_PROCESSING État du traitement. Cet état représente la mise en correspondance et le traitement initiaux des ensembles de données avec les ensembles de données dérivés.
STATE_PROCESSING_FAILED Données en cours de traitement.
STATE_NEEDS_REVIEW Cet état n'est pas utilisé actuellement.
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é. Une nouvelle tentative de publication est possible.
STATE_COMPLETED État "Terminé". Cet état représente l'ensemble de données disponible pour son utilisation spécifique.

UpdateDatasetMetadataRequest

Requête 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 celui à mettre à jour. Le nom est au format suivant: projects/{project}/datasets/{dataset_id}
update_mask

FieldMask

Liste des champs à mettre à jour. Prenez en charge la valeur "*" pour un remplacement complet.

Utilisation

L'utilisation indique où les données sont destinées à être utilisées pour informer le mode de traitement.

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.