REST Resource: projects.locations.datasetConfigs

Ressource: DatasetConfig

Nachricht, die die Konfigurationsattribute des Datasets beschreibt. Weitere Informationen finden Sie unter Konfigurationsattribute für Datasets.

JSON-Darstellung 
{
  "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.
  "activityDataRetentionPeriodDays": integer
}
Felder
name

string

Kennung. Name der Ressource.
createTime

string (Timestamp format)

Nur Ausgabe. Die UTC-Zeit, zu der die Dataset-Konfiguration erstellt wurde. Diese Felder werden automatisch ausgefüllt.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30"
updateTime

string (Timestamp format)

Nur Ausgabe. Die UTC-Zeit, zu der die Dataset-Konfiguration zuletzt aktualisiert wurde. Diese Felder werden automatisch ausgefüllt.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
labels

map (key: string, value: string)

Labels als Schlüssel/Wert-Paare.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
uid

string

Nur Ausgabe. Vom System generierte eindeutige Kennung für die Ressource.
organizationNumber

string (int64 format)

Optional. Organisationsressourcen-ID, zu der die Quellprojekte gehören sollen. Projekte, die nicht zur angegebenen Organisation gehören, werden beim Erstellen des Datasets nicht berücksichtigt.
includeNewlyCreatedBuckets

boolean

Wenn der Wert auf true festgelegt ist, enthält die Anfrage alle neu erstellten Segmente im Dataset, die den Ein- und Ausschlussregeln entsprechen.
retentionPeriodDays

integer

Anzahl der Tage, für die der Verlauf beibehalten werden muss.
identity

object (Identity)

Identität, die von diesem datasetConfig verwendet wird.
status

object (Status)

Nur Ausgabe. Status von datasetConfig.
datasetConfigState

enum (ConfigState)

Nur Ausgabe. Status von datasetConfig.
description

string

Optional. Eine vom Nutzer angegebene Beschreibung der Dataset-Konfiguration.

Maximale Länge: 256 Zeichen.
Union-Feld source_options. Definiert die Optionen zum Bereitstellen von Quellkennungen für das Dataset. Für source_options ist nur einer der folgenden Werte zulässig:
sourceProjects

object (SourceProjects)

Definiert die Optionen zum Bereitstellen von Quellprojekten für das Dataset.
sourceFolders

object (SourceFolders)

Definiert die Optionen zum Bereitstellen von Quellordnern für das Dataset.
organizationScope

boolean

Definiert die Optionen zum Bereitstellen einer Quellorganisation für das Dataset.
cloudStorageObjectPath

string

Nur Eingabe. Cloud Storage-Objektpfad mit einer Liste von Projekt- oder Ordnernummern, die im Dataset enthalten sein sollen. Er darf keine Mischung aus Projekten und Ordnern enthalten.

Das Objekt muss eine Textdatei sein, in der jede Zeile einen der folgenden Einträge enthält:

  • Projektnummer im Format projects/{projectNumber}, z. B. projects/1234567890.
  • Ordner-ID im Format folders/{folder_number}, z. B. folders/9876543210. Der Pfad muss das Format gs://{bucketName}/{objectName} haben.
Union-Feld cloud_storage_locations. Cloud Storage-Speicherorte, die ein- oder ausgeschlossen werden sollen. Für cloud_storage_locations ist nur einer der folgenden Werte zulässig:
includeCloudStorageLocations

object (CloudStorageLocations)
excludeCloudStorageLocations

object (CloudStorageLocations)
Union-Feld cloud_storage_buckets. Cloud Storage-Buckets, die ein- oder ausgeschlossen werden sollen. Für cloud_storage_buckets ist nur einer der folgenden Werte zulässig:
includeCloudStorageBuckets

object (CloudStorageBuckets)
excludeCloudStorageBuckets

object (CloudStorageBuckets)
activityDataRetentionPeriodDays

integer

Optional. Wenn festgelegt, wird die Aufbewahrungsdauer für Aktivitätsdaten überschrieben. Wenn nichts festgelegt ist, werden für Aktivitätsdaten die Werte verwendet, die in retentionPeriodDays angegeben sind.

SourceProjects

Sammlung von Projektnummern

JSON-Darstellung 
{
  "projectNumbers": [
    string
  ]
}
Felder
projectNumbers[]

string (int64 format)

SourceFolders

Gibt eine Reihe von Ordnern an, die in das Dataset aufgenommen werden sollen.

JSON-Darstellung 
{
  "folderNumbers": [
    string
  ]
}
Felder
folderNumbers[]

string (int64 format)

Optional. Die Liste der Ordnernummern, die in das Dataset aufgenommen werden sollen.

CloudStorageLocations

Sammlung von Cloud Storage-Speicherorten.

JSON-Darstellung 
{
  "locations": [
    string
  ]
}
Felder
locations[]

string

CloudStorageBuckets

Sammlung von Cloud Storage-Buckets.

JSON-Darstellung 
{
  "cloudStorageBuckets": [
    {
      object (CloudStorageBucket)
    }
  ]
}
Felder
cloudStorageBuckets[]

object (CloudStorageBucket)

CloudStorageBucket

Definiert den Bucket anhand seines Namens oder eines regulären Ausdrucksmusters, das mit Buckets abgeglichen wird.

JSON-Darstellung 
{

  // 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.
}
Felder

Union-Feld cloud_storage_bucket.

Für cloud_storage_bucket ist nur einer der folgenden Werte zulässig:
bucketName

string

Name des Cloud Storage-Bucket.
bucketPrefixRegex

string

Ein Regex-Muster für Bucket-Namen, die mit dem Regex übereinstimmen. Reguläre Ausdrücke müssen der in google/re2 auf GitHub angegebenen Syntax entsprechen.

Identität

Mit „Identity“ kann der Nutzer den zu verwendenden Identitätstyp angeben. Die Identitäts-String-Ausgabe kann für Änderungen an IAM-Richtlinien verwendet werden.

JSON-Darstellung 
{
  "name": string,
  "type": enum (IdentityType)
}
Felder
name

string

Nur Ausgabe. Name der Identität.
type

enum (IdentityType)

Der Identitätstyp, der für die datasetConfig verwendet werden soll.

IdentityType

Typ des Dienstkontos, das für die Dataset-Konfiguration verwendet werden soll.

Enums
IDENTITY_TYPE_UNSPECIFIED Der Standardwert ist nicht angegeben und sollte nicht verwendet werden.
IDENTITY_TYPE_PER_CONFIG Von Google verwaltetes Dienstkonto pro Ressource.
IDENTITY_TYPE_PER_PROJECT Von Google verwaltetes Dienstkonto pro Projekt.

ConfigState

Status der Konfiguration.

Enums
CONFIG_STATE_UNSPECIFIED Nicht angegebener Zustand.
CONFIG_STATE_ACTIVE „Aktive Konfiguration“ bedeutet, dass in der Konfiguration aktiv Daten erfasst werden.
CONFIG_STATE_VERIFICATION_IN_PROGRESS In diesem Status wird die Konfiguration auf verschiedene Berechtigungen geprüft.
CONFIG_STATE_CREATED Die Konfiguration wurde erstellt und muss weiter verarbeitet werden.
CONFIG_STATE_PROCESSING Konfiguration wird verarbeitet

Methoden

create

 Erstellt eine Dataset-Konfiguration in einem angegebenen Projekt für einen angegebenen Standort.

delete

 Löscht eine Dataset-Konfiguration in einem angegebenen Projekt für eine angegebene Zone.

get

 Ruft die Dataset-Konfiguration in einem angegebenen Projekt für eine angegebene Zone ab.

linkDataset

 Verknüpft ein Dataset in einem angegebenen Projekt für eine angegebene Zone mit BigQuery.

list

 Listet die Dataset-Konfigurationen in einem angegebenen Projekt für eine angegebene Zone auf.

patch

 Aktualisiert eine Dataset-Konfiguration in einem angegebenen Projekt für eine angegebene Zone.

unlinkDataset

 Hebt die Verknüpfung eines Datasets mit BigQuery in einem angegebenen Projekt für eine angegebene Zone auf.