REST Resource: projects.locations.datasetConfigs

משאב: DatasetConfig

הודעה שמתארת את מאפייני ההגדרה של מערך הנתונים. מידע נוסף מופיע במאמר מאפייני ההגדרה של מערך נתונים.

ייצוג ב-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.
  "activityDataRetentionPeriodDays": integer
}
שדות
name

string

מזהה. שם המשאב
createTime

string (Timestamp format)

פלט בלבד. השעה לפי UTC שבה נוצרה ההגדרה של מערך הנתונים. השדה הזה מאוכלס אוטומטית.

הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים חוץ מ-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

פלט בלבד. השעה בשעון UTC שבה עודכנה לאחרונה ההגדרה של מערך הנתונים. השדה הזה מאוכלס אוטומטית.

הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים חוץ מ-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
labels

map (key: string, value: string)

תוויות כצמדי מפתח/ערך

אובייקט שמכיל רשימה של "key": value זוגות. לדוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
uid

string

פלט בלבד. מזהה ייחודי של המשאב שנוצר על ידי המערכת.
organizationNumber

string (int64 format)

זה שינוי אופציונלי. מזהה משאב הארגון שאליו צריכים להשתייך פרויקטי המקור. פרויקטים שלא שייכים לארגון שצוין לא נלקחים בחשבון כשיוצרים את מערך הנתונים.
includeNewlyCreatedBuckets

boolean

אם הערך הוא true, הבקשה כוללת את כל הדליים החדשים שנוצרו במערך הנתונים ועומדים בכללי ההכללה וההחרגה.
retentionPeriodDays

integer

מספר הימים של ההיסטוריה שצריך לשמור.
identity

object (Identity)

הזהות שמשמשת את datasetConfig.
status

object (Status)

פלט בלבד. הסטטוס של datasetConfig.
datasetConfigState

enum (ConfigState)

פלט בלבד. המצב של datasetConfig.
description

string

זה שינוי אופציונלי. תיאור שהמשתמש סיפק להגדרת מערך הנתונים.

האורך המקסימלי הוא 256 תווים.
שדה איחוד source_options. הגדרת האפשרויות לאספקת מזהי מקור למערך הנתונים. הערך source_options יכול להיות רק אחד מהבאים:
sourceProjects

object (SourceProjects)

הגדרת האפשרויות לאספקת פרויקטים של מקורות למערך הנתונים.
sourceFolders

object (SourceFolders)

הגדרה של האפשרויות לאספקת תיקיות מקור למערך הנתונים.
organizationScope

boolean

הגדרת האפשרויות לאספקת ארגון מקור למערך הנתונים.
cloudStorageObjectPath

string

קלט בלבד. נתיב האובייקט ב-Cloud Storage שמכיל רשימה של מספרי פרויקטים או תיקיות שייכללו במערך הנתונים. אי אפשר לכלול גם פרויקטים וגם תיקיות.

האובייקט חייב להיות קובץ טקסט שבו כל שורה מכילה אחת מהרשומות הבאות:

  • מספר הפרויקט, בפורמט projects/{projectNumber}, לדוגמה, projects/1234567890.
  • מזהה התיקייה, בפורמט folders/{folder_number}, לדוגמה, folders/9876543210. הנתיב צריך להיות בפורמט gs://{bucketName}/{objectName}.
שדה איחוד cloud_storage_locations. מיקומי Cloud Storage שרוצים לכלול או להחריג. הערך cloud_storage_locations יכול להיות רק אחד מהבאים:
includeCloudStorageLocations

object (CloudStorageLocations)
excludeCloudStorageLocations

object (CloudStorageLocations)
שדה איחוד cloud_storage_buckets. קטגוריות של Cloud Storage שרוצים לכלול או להחריג. הערך cloud_storage_buckets יכול להיות רק אחד מהבאים:
includeCloudStorageBuckets

object (CloudStorageBuckets)
excludeCloudStorageBuckets

object (CloudStorageBuckets)
activityDataRetentionPeriodDays

integer

זה שינוי אופציונלי. אם מגדירים את האפשרות הזו, היא מבטלת את תקופת השמירה של נתוני הפעילות. אם לא מגדירים ערך, נתוני הפעילות משתמשים בערך שצוין ב-retentionPeriodDays.

SourceProjects

אוסף של מספרי פרויקטים

ייצוג ב-JSON 
{
  "projectNumbers": [
    string
  ]
}
שדות
projectNumbers[]

string (int64 format)

SourceFolders

מציין קבוצה של תיקיות שייכללו במערך הנתונים

ייצוג ב-JSON 
{
  "folderNumbers": [
    string
  ]
}
שדות
folderNumbers[]

string (int64 format)

זה שינוי אופציונלי. רשימת מספרי התיקיות שרוצים לכלול במערך הנתונים.

CloudStorageLocations

אוסף של מיקומי Cloud Storage.

ייצוג ב-JSON 
{
  "locations": [
    string
  ]
}
שדות
locations[]

string

CloudStorageBuckets

אוסף של קטגוריות של Cloud Storage.

ייצוג ב-JSON 
{
  "cloudStorageBuckets": [
    {
      object (CloudStorageBucket)
    }
  ]
}
שדות
cloudStorageBuckets[]

object (CloudStorageBucket)

CloudStorageBucket

הגדרה של הקטגוריה לפי השם שלה או לפי תבנית של ביטוי רגולרי להתאמה לקטגוריות.

ייצוג ב-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.
}
שדות

שדה איחוד cloud_storage_bucket.

הערך cloud_storage_bucket יכול להיות רק אחד מהבאים:
bucketName

string

שם הקטגוריה של Cloud Storage.
bucketPrefixRegex

string

תבנית ביטוי רגולרי לשמות של קטגוריות שתואמים לביטוי הרגולרי. הביטוי הרגולרי צריך להיות בהתאם לתחביר שצוין ב-google/re2 ב-GitHub.

זהויות

הפרמטר Identity מאפשר למשתמש לציין את סוג הזהות שבה רוצים להשתמש, ומחזיר את מחרוזת הזהות שאפשר להשתמש בה לשינויים במדיניות IAM.

ייצוג ב-JSON 
{
  "name": string,
  "type": enum (IdentityType)
}
שדות
name

string

פלט בלבד. שם הזהות.
type

enum (IdentityType)

סוג הזהות שמשמשת ל-datasetConfig.

IdentityType

סוג חשבון השירות שבו רוצים להשתמש להגדרת מערך הנתונים.

טיפוסים בני מנייה (enum)
IDENTITY_TYPE_UNSPECIFIED ברירת המחדל לא מוגדרת ואין להשתמש בה.
IDENTITY_TYPE_PER_CONFIG חשבון שירות בניהול Google לכל משאב.
IDENTITY_TYPE_PER_PROJECT חשבון שירות בניהול Google לכל פרויקט.

ConfigState

המצב של ההגדרה.

טיפוסים בני מנייה (enum)
CONFIG_STATE_UNSPECIFIED מצב לא מוגדר.
CONFIG_STATE_ACTIVE ההגדרה 'הגדרה פעילה' מציינת שההגדרה קולטת נתונים באופן פעיל.
CONFIG_STATE_VERIFICATION_IN_PROGRESS במצב הזה, המערכת בודקת את ההגדרות כדי לוודא שיש לכם את ההרשאות הנדרשות.
CONFIG_STATE_CREATED ההגדרה נוצרה וצריך לבצע עיבוד נוסף.
CONFIG_STATE_PROCESSING ההגדרה נמצאת בתהליך עיבוד

Methods

create

 יוצר הגדרות של מערך נתונים בפרויקט ובמיקום נתונים.

delete

 מוחק הגדרה של מערך נתונים בפרויקט נתון עבור מיקום נתון.

get

 קבלת ההגדרה של מערך הנתונים בפרויקט נתון עבור מיקום נתון.

linkDataset

 מקשר מערך נתונים ל-BigQuery בפרויקט נתון במיקום נתון.

list

 מציג את הגדרות מערך הנתונים בפרויקט נתון במיקום נתון.

patch

 מעדכנת את ההגדרה של מערך נתונים בפרויקט נתון עבור מיקום נתון.

unlinkDataset

 מבטל את הקישור של מערך נתונים מ-BigQuery בפרויקט נתון במיקום נתון.