REST Resource: projects.datasets

משאב: מערך נתונים

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

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

string

שם המשאב, projects/{project}/datasets/{dataset_id}
displayName

string

שם קריא לאנשים, מוצג בממשק המשתמש של המסוף .
description

string

תיאור של מערך הנתונים הזה.
versionId

string

מזהה הגרסה של מערך הנתונים.
usage[]

enum (Usage)

תרחישים לדוגמה שצוינו למערך הנתונים הזה.
status

object (Status)

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

string (Timestamp format)

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

חותמת זמן בפורמט 'Zulu' בפורמט RFC3339 UTC, עם רזולוציה של ננו-שנייה ועד תשע ספרות אחרי הנקודה. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

פלט בלבד. השעה שבה עודכנו לאחרונה המטא-נתונים של מערך הנתונים.

חותמת זמן בפורמט UTC 'Zulu' של RFC3339, עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".
versionCreateTime

string (Timestamp format)

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

חותמת זמן בפורמט UTC 'Zulu' של RFC3339, עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".
versionDescription

string

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

object (LocalFileSource)

מקור קובץ מקומי של מערך הנתונים להעלאה יחידה.
gcsSource

object (GcsSource)

מקור קובץ ב-Google Cloud Storage למערך הנתונים להעלאה אחת.

שימוש

הנתונים של 'שימוש' מציינים את המקום שבו הנתונים מיועדים לשמש, כדי להנחות את אופן העיבוד שלהם.

טיפוסים בני מנייה (enum)
USAGE_UNSPECIFIED השימוש במערך הנתונים הזה לא מוגדר.
USAGE_DATA_DRIVEN_STYLING מערך הנתונים הזה ישמש לסגנון מבוסס-נתונים.

LocalFileSource

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

ייצוג JSON 
{
  "filename": string,
  "fileFormat": enum (FileFormat)
}
שדות
filename

string

שם הקובץ והסיומת שלו.
fileFormat

enum (FileFormat)

הפורמט של הקובץ שמעלים.

FileFormat

הפורמט של הקובץ שמעלים.

טיפוסים בני מנייה (enum)
FILE_FORMAT_UNSPECIFIED פורמט הקובץ לא צוין.
FILE_FORMAT_GEOJSON קובץ GeoJson.
FILE_FORMAT_KML קובץ KML.
FILE_FORMAT_CSV קובץ ה-CSV.

GcsSource

הפרטים על מקור הנתונים כשהוא נמצא ב-Google Cloud Storage.

ייצוג ב-JSON 
{
  "inputUri": string,
  "fileFormat": enum (FileFormat)
}
שדות
inputUri

string

URI של נתוני מקור. לדוגמה, gs://my_bucket/my_object.
fileFormat

enum (FileFormat)

פורמט הקובץ של האובייקט של Google Cloud Storage. הוא משמש בעיקר לאימות.

סטטוס

הסטטוס של גרסת מערך הנתונים.

ייצוג JSON 
{
  "state": enum (State),
  "errorMessage": string
}
שדות
state

enum (State)

'טיפוסים בני מנייה (enum)' לסטטוס.
errorMessage

string

הודעת שגיאה שמציינת את הסיבה לכשל. היא ריקה אם מערכי הנתונים לא במצב 'נכשל'.

מדינה

רשימת מצבים של גרסת מערך הנתונים. אם ערכים השתנו כאן, כדאי לעדכן את שיטות השירות של Status.

טיפוסים בני מנייה (enum)
STATE_UNSPECIFIED המצב של מערך הנתונים הזה לא הוגדר.
STATE_IMPORTING מתבצע ייבוא של גרסת מערך הנתונים.
STATE_IMPORT_SUCCEEDED הייבוא של גרסת מערך הנתונים בוצע בהצלחה.
STATE_IMPORT_FAILED גרסת מערך הנתונים לא יובאה.
STATE_DELETING מערך הנתונים נמצא בתהליך מחיקה.
STATE_DELETION_FAILED המצב 'המחיקה נכשלה'. המצב הזה מייצג שהמחיקה של מערך הנתונים נכשלה. אפשר לנסות שוב למחוק את הקובץ.
STATE_PROCESSING מצב העיבוד. המצב הזה מייצג את ההתאמה והעיבוד הראשוניים של מערכי נתונים למערכי נתונים נגזרים.
STATE_PROCESSING_FAILED העיבוד נכשל. המצב הזה מציין שהעיבוד נכשל ועלול לדווח על שגיאות.
STATE_NEEDS_REVIEW הסטטוס 'נדרשת בדיקה'. המצב הזה מייצג שהנתונים זמינים לפרסום ולהצגה בהתאם לשימוש הספציפי.
STATE_PUBLISHING מצב הפרסום. המצב הזה מייצג שהפרסום נמצא בתהליך.
STATE_PUBLISHING_FAILED המצבים שבהם הפרסום נכשל. המצב הזה מייצג שהפרסום נכשל. אפשר לנסות שוב לפרסם את הנתונים.
STATE_COMPLETED המצב הושלם. המצב הזה מייצג את מערך הנתונים שזמין לשימוש הספציפי שלו.

שיטות

create

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

delete

 מוחקים את מערך הנתונים שצוין .

get

 מקבלים את מערך הנתונים.

list

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

patch

 עדכון המטא-נתונים של מערך הנתונים.