REST Resource: projects.locations.datasetConfigs

Ressource: DatasetConfig

Message décrivant les propriétés de configuration de l'ensemble de données. Pour en savoir plus, consultez la section Propriétés de configuration de l'ensemble de données.

Représentation JSON 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "uid": string,
  "organizationNumber": string,
  "includeNewlyCreatedBuckets": boolean,
  "retentionPeriodDays": integer,
  "link": {
    object (Link)
  },
  "identity": {
    object (Identity)
  },
  "status": {
    object (Status)
  },
  "datasetConfigState": enum (ConfigState),
  "description": string,

  // Union field source_options can be only one of the following:
  "sourceProjects": {
    object (SourceProjects)
  },
  "sourceFolders": {
    object (SourceFolders)
  },
  "organizationScope": boolean,
  "cloudStorageObjectPath": string
  // End of list of possible types for union field source_options.

  // Union field cloud_storage_locations can be only one of the following:
  "includeCloudStorageLocations": {
    object (CloudStorageLocations)
  },
  "excludeCloudStorageLocations": {
    object (CloudStorageLocations)
  }
  // End of list of possible types for union field cloud_storage_locations.

  // Union field cloud_storage_buckets can be only one of the following:
  "includeCloudStorageBuckets": {
    object (CloudStorageBuckets)
  },
  "excludeCloudStorageBuckets": {
    object (CloudStorageBuckets)
  }
  // End of list of possible types for union field cloud_storage_buckets.
}
Champs
name

string

Identifiant. nom de la ressource
createTime

string (Timestamp format)

Uniquement en sortie. Heure UTC à laquelle la configuration de l'ensemble de données a été créée. Ce champ est renseigné automatiquement.

Utilise la norme RFC 3339, où la sortie générée est toujours normalisée avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" sont également acceptés. Exemples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Uniquement en sortie. Heure UTC à laquelle la configuration de l'ensemble de données a été mise à jour pour la dernière fois. Ce champ est renseigné automatiquement.

Utilise la norme RFC 3339, où la sortie générée est toujours normalisée avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" sont également acceptés. Exemples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
labels

map (key: string, value: string)

Étiquettes sous forme de paires clé-valeur

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.
uid

string

Uniquement en sortie. Identifiant unique généré par le système pour la ressource.
organizationNumber

string (int64 format)

Facultatif. ID de la ressource de l'organisation à laquelle les projets sources doivent appartenir. Les projets qui n'appartiennent pas à l'organisation indiquée ne sont pas pris en compte lors de la création de l'ensemble de données.
includeNewlyCreatedBuckets

boolean

Si cette valeur est définie sur true, la requête inclut tous les buckets nouvellement créés dans l'ensemble de données qui répondent aux règles d'inclusion et d'exclusion.
retentionPeriodDays

integer

Nombre de jours d'historique à conserver.
identity

object (Identity)

Identité utilisée par ce datasetConfig.
status

object (Status)

Uniquement en sortie. État de l'datasetConfig.
datasetConfigState

enum (ConfigState)

Uniquement en sortie. État de l'datasetConfig.
description

string

Facultatif. Description fournie par l'utilisateur pour la configuration de l'ensemble de données.

Longueur maximale: 256 caractères.
Champ d'union source_options. Définit les options permettant de fournir des identifiants de source pour l'ensemble de données. source_options ne peut être qu'un des éléments suivants :
sourceProjects

object (SourceProjects)

Définit les options permettant de fournir des projets sources pour l'ensemble de données.
sourceFolders

object (SourceFolders)

Définit les options permettant de fournir des dossiers sources pour l'ensemble de données.
organizationScope

boolean

Définit les options permettant de fournir une organisation source pour l'ensemble de données.
cloudStorageObjectPath

string

Uniquement en entrée. Chemin d'accès à un objet Cloud Storage contenant une liste de numéros de projet ou de dossier à inclure dans l'ensemble de données. Il ne peut pas contenir à la fois des projets et des dossiers.

L'objet doit être un fichier texte dont chaque ligne contient l'une des entrées suivantes:

  • Numéro de projet au format projects/{projectNumber} (par exemple, projects/1234567890).
  • Identifiant de dossier, au format folders/{folder_number} (par exemple, folders/9876543210). Le chemin d'accès doit être au format gs://{bucketName}/{objectName}.
Champ d'union cloud_storage_locations. Emplacements Cloud Storage à inclure ou à exclure. cloud_storage_locations ne peut être qu'un des éléments suivants :
includeCloudStorageLocations

object (CloudStorageLocations)
excludeCloudStorageLocations

object (CloudStorageLocations)
Champ d'union cloud_storage_buckets. Buckets Cloud Storage à inclure ou à exclure. cloud_storage_buckets ne peut être qu'un des éléments suivants :
includeCloudStorageBuckets

object (CloudStorageBuckets)
excludeCloudStorageBuckets

object (CloudStorageBuckets)

SourceProjects

Collection de numéros de projet

Représentation JSON 
{
  "projectNumbers": [
    string
  ]
}
Champs
projectNumbers[]

string (int64 format)

SourceFolders

Spécifie un ensemble de dossiers à inclure dans l'ensemble de données

Représentation JSON 
{
  "folderNumbers": [
    string
  ]
}
Champs
folderNumbers[]

string (int64 format)

Facultatif. Liste des numéros de dossiers à inclure dans l'ensemble de données.

CloudStorageLocations

Ensemble d'emplacements Cloud Storage.

Représentation JSON 
{
  "locations": [
    string
  ]
}
Champs
locations[]

string

CloudStorageBuckets

Collection de buckets Cloud Storage.

Représentation JSON 
{
  "cloudStorageBuckets": [
    {
      object (CloudStorageBucket)
    }
  ]
}
Champs
cloudStorageBuckets[]

object (CloudStorageBucket)

CloudStorageBucket

Définit le bucket par son nom ou par un modèle d'expression régulière pour faire correspondre les buckets.

Représentation JSON 
{

  // Union field cloud_storage_bucket can be only one of the following:
  "bucketName": string,
  "bucketPrefixRegex": string
  // End of list of possible types for union field cloud_storage_bucket.
}
Champs

Champ d'union cloud_storage_bucket.

cloud_storage_bucket ne peut être qu'un des éléments suivants :
bucketName

string

Nom du bucket Cloud Storage.
bucketPrefixRegex

string

Modèle d'expression régulière pour les noms de buckets correspondant à l'expression régulière. Les expressions régulières doivent respecter la syntaxe spécifiée dans google/re2 sur GitHub.

Identité

Identity permet à l'utilisateur de spécifier le type d'identité à utiliser et d'afficher la chaîne d'identité pouvant être utilisée pour modifier les stratégies IAM.

Représentation JSON 
{
  "name": string,
  "type": enum (IdentityType)
}
Champs
name

string

Uniquement en sortie. Nom de l'identité.
type

enum (IdentityType)

Type d'identité à utiliser pour le datasetConfig.

IdentityType

Type de compte de service à utiliser pour la configuration de l'ensemble de données.

Enums
IDENTITY_TYPE_UNSPECIFIED La valeur par défaut n'est pas spécifiée et ne doit pas être utilisée.
IDENTITY_TYPE_PER_CONFIG Compte de service géré par Google par ressource.
IDENTITY_TYPE_PER_PROJECT Compte de service géré par Google par projet.

ConfigState

État de la configuration.

Enums
CONFIG_STATE_UNSPECIFIED État non spécifié.
CONFIG_STATE_ACTIVE Une configuration active indique que la configuration ingère activement des données.
CONFIG_STATE_VERIFICATION_IN_PROGRESS Dans cet état, la configuration est en cours de vérification pour diverses autorisations.
CONFIG_STATE_CREATED La configuration est créée et un traitement supplémentaire doit être effectué.
CONFIG_STATE_PROCESSING La configuration est en cours de traitement

Méthodes

create

 Crée une configuration d'ensemble de données dans un projet donné pour un emplacement donné.

delete

 Supprime une configuration d'ensemble de données dans un projet donné pour un emplacement donné.

get

 Récupère la configuration de l'ensemble de données dans un projet donné pour un emplacement donné.

linkDataset

 Associe un ensemble de données à BigQuery dans un projet donné pour un emplacement donné.

list

 Répertorie les configurations d'ensemble de données d'un projet donné pour un emplacement donné.

patch

 Met à jour la configuration d'un ensemble de données dans un projet donné pour un emplacement donné.

unlinkDataset

 Dissocie un ensemble de données de BigQuery dans un projet donné pour un emplacement donné.