REST Resource: projects.locations.datasetConfigs

Ressource: DatasetConfig

Nachricht mit den Konfigurationseigenschaften des Datensatzes. Weitere Informationen finden Sie unter Konfigurationseigenschaften für Datensätze.

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

string

Kennung. Name der Ressource
createTime

string (Timestamp format)

Nur Ausgabe. Die UTC-Zeit, zu der die Dataset-Konfiguration erstellt wurde. Dieser Wert wird automatisch ausgefüllt.

Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. 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. Dieser Wert wird automatisch ausgefüllt.

Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. 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. Die Ressourcen-ID der Organisation, zu der die Quellprojekte gehören sollen. Projekte, die nicht zur angegebenen Organisation gehören, werden beim Erstellen des Datensatzes nicht berücksichtigt.
includeNewlyCreatedBuckets

boolean

Wenn true festgelegt ist, enthält die Anfrage alle neu erstellten Bucket im Datensatz, die die Ein- und Ausschlussregeln erfüllen.
retentionPeriodDays

integer

Anzahl der Tage, für die der Verlauf aufbewahrt werden soll.
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 für die Datensatzkonfiguration.

Maximale Länge: 256 Zeichen.
Union-Feld source_options. Hier werden die Optionen für die Angabe von Quell-IDs für den Datensatz definiert. Für source_options ist nur einer der folgenden Werte zulässig:
sourceProjects

object (SourceProjects)

Hier werden die Optionen für die Bereitstellung von Quellprojekten für den Datensatz definiert.
sourceFolders

object (SourceFolders)

Hier werden die Optionen für die Bereitstellung von Quellordnern für den Datensatz definiert.
organizationScope

boolean

Hier werden die Optionen für die Angabe einer Quellorganisation für den Datensatz definiert.
cloudStorageObjectPath

string

Nur Eingabe. Cloud Storage-Objektpfad mit einer Liste von Projekt- oder Ordnernummern, die in den Datensatz aufgenommen werden sollen. Er darf keine Kombination 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. Zu includerende oder auszuschließende Cloud Storage-Speicherorte. Für cloud_storage_locations ist nur einer der folgenden Werte zulässig:
includeCloudStorageLocations

object (CloudStorageLocations)
excludeCloudStorageLocations

object (CloudStorageLocations)
Union-Feld cloud_storage_buckets. Zu includerende oder auszuschließende Cloud Storage-Buckets. Für cloud_storage_buckets ist nur einer der folgenden Werte zulässig:
includeCloudStorageBuckets

object (CloudStorageBuckets)
excludeCloudStorageBuckets

object (CloudStorageBuckets)

SourceProjects

Sammlung von Projektnummern

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

string (int64 format)

SourceFolders

Gibt eine Reihe von Ordnern an, die in den Datensatz aufgenommen werden sollen.

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

string (int64 format)

Optional. Die Liste der Ordnernummern, die in den Datensatz 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

Hiermit wird der Bucket anhand seines Namens oder eines regulären Ausdrucks für die Übereinstimmung mit Buckets definiert.

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-Buckets.
bucketPrefixRegex

string

Ein reguläres Ausdrucksmuster für Bucket-Namen, die mit dem regulären Ausdruck übereinstimmen. Der reguläre Ausdruck muss der Syntax entsprechen, die in google/re2 auf GitHub angegeben ist.

Identität

Mit „Identity“ kann der Nutzer den zu verwendenden Identitätstyp angeben. Daraufhin wird der Identitätsstring ausgegeben, der für Änderungen an IAM-Richtlinien verwendet werden kann.

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

string

Nur Ausgabe. Name der Identität.
type

enum (IdentityType)

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

IdentityType

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

Enums
IDENTITY_TYPE_UNSPECIFIED Standardmäßig ist keine Angabe erforderlich und sollte auch 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 aufgenommen werden.
CONFIG_STATE_VERIFICATION_IN_PROGRESS In diesem Status wird die Konfiguration auf verschiedene Berechtigungen geprüft.
CONFIG_STATE_CREATED Die Konfiguration wird erstellt und es muss eine weitere Verarbeitung erfolgen.
CONFIG_STATE_PROCESSING Konfiguration wird verarbeitet

Methoden

create

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

delete

 Löscht eine Datasetkonfiguration in einem bestimmten Projekt für einen bestimmten Standort.

get

 Ruft die Datasetkonfiguration in einem bestimmten Projekt für einen bestimmten Standort ab.

linkDataset

 Verknüpft ein Dataset mit BigQuery in einem bestimmten Projekt für einen bestimmten Speicherort.

list

 Listet die Datensatzkonfigurationen in einem bestimmten Projekt für einen bestimmten Standort auf.

patch

 Aktualisiert die Datasetkonfiguration in einem bestimmten Projekt für einen bestimmten Standort.

unlinkDataset

 Heben Sie die Verknüpfung eines Datenpools mit BigQuery in einem bestimmten Projekt für einen bestimmten Speicherort auf.