REST Resource: projects.datasets

Ressource : Ensemble de données

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

Représentation JSON
{
  "name": string,
  "displayName": string,
  "description": string,
  "versionId": string,
  "usage": [
    enum (Usage)
  ],
  "status": {
    object (Status)
  },
  "createTime": string,
  "updateTime": string,
  "versionCreateTime": string,
  "versionDescription": string,

  // Union field data_source can be only one of the following:
  "localFileSource": {
    object (LocalFileSource)
  },
  "gcsSource": {
    object (GcsSource)
  }
  // End of list of possible types for union field data_source.
}
Champs
name

string

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

displayName

string

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

description

string

Description de cet ensemble de données .

versionId

string

ID de version de l'ensemble de données.

usage[]

enum (Usage)

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

status

object (Status)

Uniquement en sortie. État de la version de cet ensemble de données.

createTime

string (Timestamp format)

Uniquement en sortie. Heure à laquelle l'ensemble de données a été créé pour la première fois.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

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

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

versionCreateTime

string (Timestamp format)

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)

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

versionDescription

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

object (LocalFileSource)

Source de fichiers locale pour l'ensemble de données pour une seule importation.

gcsSource

object (GcsSource)

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

Utilisation

"Utilisation" indique où les données sont destinées à être utilisées pour déterminer 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.

LocalFileSource

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

Représentation JSON
{
  "filename": string,
  "fileFormat": enum (FileFormat)
}
Champs
filename

string

Nom et extension du fichier importé.

fileFormat

enum (FileFormat)

Format du fichier importé.

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

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

Représentation JSON
{
  "inputUri": string,
  "fileFormat": enum (FileFormat)
}
Champs
inputUri

string

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

fileFormat

enum (FileFormat)

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

État

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

Représentation JSON
{
  "state": enum (State),
  "errorMessage": string
}
Champs
state

enum (State)

Énumération de l'état pour l'état.

errorMessage

string

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

État

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

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 La version de l'ensemble de données a bien été importée.
STATE_IMPORT_FAILED Échec de l'importation de la version de l'ensemble de données.
STATE_DELETING L'ensemble de données est en cours de suppression.
STATE_DELETION_FAILED État de la suppression (échec). Cet état indique que la suppression de l'ensemble de données a échoué. La suppression peut être retentée.
STATE_PROCESSING État du traitement. Cet état représente la mise en correspondance et le traitement initiaux des ensembles de données avec des ensembles de données dérivés.
STATE_PROCESSING_FAILED État du traitement ayant échoué. Cet état indique que le traitement a échoué et peut signaler des erreurs.
STATE_NEEDS_REVIEW État "Examen requis". Cet état indique que les données peuvent être publiées et diffusées pour l'utilisation spécifique.
STATE_PUBLISHING État de la publication. Cet état indique que la publication est en cours.
STATE_PUBLISHING_FAILED L'état de la publication indique un échec. Cet état indique que la publication a échoué. Une nouvelle tentative de publication peut être effectuée.
STATE_COMPLETED État terminé. Cet état représente l'ensemble de données disponible pour son utilisation spécifique.

Méthodes

create

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

delete

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

get

Obtenez l'ensemble de données.

list

Permet de répertorier tous les ensembles de données du projet spécifié.

patch

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