REST Resource: projects.datasets

Ressource : Ensemble de données

Représentation d'une ressource d'ensemble de données.

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. Format: projects/{project}/datasets/{datasetId}

displayName

string

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

Doit être unique au sein d'un projet.

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

updateTime

string (Timestamp format)

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

versionCreateTime

string (Timestamp format)

Uniquement en sortie. Heure à laquelle cette version a été créée.

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

Informations sur 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 du fichier importé.

fileFormat

enum (FileFormat)

Format du fichier en cours d'importation.

FileFormat

Format du fichier importé.

Enums
FILE_FORMAT_UNSPECIFIED Format de fichier non spécifié.
FILE_FORMAT_GEOJSON 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.

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. Elle est principalement utilisée pour la validation.

État

État 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 l'ensemble de données.

Enums
STATE_UNSPECIFIED L'état de cet ensemble de données n'est pas défini.
STATE_IMPORTING Les 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 "É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 Les données sont en cours de traitement.
STATE_PROCESSING_FAILED État d'échec du traitement. Cet état indique que le traitement a échoué et peut signaler des erreurs.
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 "Échec de la publication". 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ée un ensemble de données pour le projet spécifié.

delete

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

fetchDatasetErrors

Récupère toutes les erreurs d'un ensemble de données.

get

Récupère l'ensemble de données.

list

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

patch

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