DataConnector

מנהל את החיבור למקורות נתונים חיצוניים לכל מאגרי הנתונים שמקובצים תחת Collection. זהו משאב Singleton של Collection. ההפעלה נתמכת רק באמצעות ה-method ‏DataConnectorService.SetUpDataConnector, שתיצור Collection חדש ותפעיל את DataConnector שלו.

ייצוג ב-JSON
{
  "name": string,
  "state": enum (State),
  "dataSource": string,
  "removeParamKeys": [
    string
  ],
  "refreshInterval": string,
  "nextSyncTime": {
    object (DateTime)
  },
  "entities": [
    {
      object (SourceEntity)
    }
  ],
  "createTime": string,
  "latestPauseTime": string,
  "lastSyncTime": string,
  "updateTime": string,
  "errors": [
    {
      object (Status)
    }
  ],
  "syncMode": enum (SyncMode),
  "kmsKeyName": string,
  "destinationConfigs": [
    {
      object (DestinationConfig)
    }
  ],
  "actionState": enum (State),
  "actionConfig": {
    object (ActionConfig)
  },
  "endUserConfig": {
    object (EndUserConfig)
  },
  "federatedConfig": {
    object (FederatedConfig)
  },
  "connectorModes": [
    enum (ConnectorMode)
  ],
  "staticIpEnabled": boolean,
  "staticIpAddresses": [
    string
  ],
  "oauthStaticIpAddresses": [
    string
  ],
  "blockingReasons": [
    enum (BlockingReason)
  ],
  "identityRefreshInterval": string,
  "identityScheduleConfig": {
    object (IdentityScheduleConfig)
  },
  "privateConnectivityProjectId": string,
  "bapConfig": {
    object (BAPConfig)
  },
  "connectorType": enum (ConnectorType),
  "realtimeState": enum (State),
  "alertPolicyConfigs": [
    {
      object (AlertPolicyConfig)
    }
  ],
  "realtimeSyncConfig": {
    object (RealtimeSyncConfig)
  },
  "aclEnabled": boolean,
  "createEuaSaas": boolean,
  "autoRunDisabled": boolean,
  "incrementalSyncDisabled": boolean,
  "incrementalRefreshInterval": string,
  "hybridIngestionDisabled": boolean,
  "dataProtectionPolicy": {
    object (DataProtectionPolicy)
  },
  "egressFqdns": [
    string
  ],
  "vpcscEnabled": boolean,
  "dynamicTools": [
    {
      object (DynamicTool)
    }
  ],
  "cliConfig": {
    object (CliConfig)
  },
  "connectorSourceId": string,
  "tag": string,
  "metadata": {
    object (ConnectorMetadata)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "params": {
    object
  },
  "jsonParams": string
  // End of mutually exclusive fields.
}
שדות
name

string

מזהה. השם המלא של המשאב של מחבר הנתונים. פורמט: projects/*/locations/*/collections/*/dataConnector

state

enum (State)

פלט בלבד. המצב של המחבר.

dataSource

string

חובה. המזהה של מקור הנתונים. הרשימה המלאה והעדכנית של המחברים הנתמכים והערכים שלהם זמינה במאמר קישור מקור נתונים של צד שלישי.

removeParamKeys[]

string

זה שינוי אופציונלי. מציין את המפתחות שיוסרו מהשדה params. ההגדרה הזו פעילה רק אם הפרמטר params נכלל ב-updateMask ב-UpdateDataConnectorRequest. המחיקה מקבלת עדיפות אם מפתח מופיע גם ב-removeParamKeys וגם בשדה params של הבקשה.

refreshInterval

string (Duration format)

חובה. מרווח הרענון של סנכרון הנתונים. אם משך הזמן מוגדר כ-0, הנתונים יסונכרנו בזמן אמת. עדיין אין תמיכה בתכונת הסטרימינג. המינימום הוא 30 דקות והמקסימום הוא 7 ימים. אם מגדירים את אותו ערך גם למרווח הרענון וגם למרווח הרענון המצטבר, הסנכרון המצטבר יושבת.

משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב-s. דוגמה: "3.5s".

nextSyncTime

object (DateTime)

הגדרת השעה המתוזמנת לסנכרון הנתונים הבא. בשדה הזה צריך לציין את השעה, הדקה ואזור הזמן ממסד הנתונים של אזור זמן IANA. האפשרות הזו שימושית כשמרווח הרענון של מחבר הנתונים גדול מיום אחד. אם לא תציינו שעות או דקות, נניח שזמן הסנכרון הוא 0:00. כדי למנוע דו-משמעות, המשתמש צריך לציין אזור זמן.

entities[]

object (SourceEntity)

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

createTime

string (Timestamp format)

פלט בלבד. חותמת הזמן שבה נוצר DataConnector.

הפורמט הוא 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".

latestPauseTime

string (Timestamp format)

פלט בלבד. חותמת הזמן האחרונה שבה DataConnector הושעה, וזה משפיע על כל הפונקציות, כמו סנכרון נתונים. השהיית מחבר גורמת לשינויים הבאים:

  • כל הפונקציות, כולל סנכרון הנתונים, מושבתות.
  • כל משימת סנכרון נתונים שמתבצעת תבוטל.
  • לא יתוזמנו הפעלות עתידיות של סנכרון נתונים, ואי אפשר יהיה להפעיל אותן.

הפורמט הוא 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".

lastSyncTime

string (Timestamp format)

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

הפורמט הוא 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)

פלט בלבד. חותמת הזמן של העדכון האחרון של DataConnector.

הפורמט הוא 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".

errors[]

object (Status)

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

syncMode

enum (SyncMode)

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

kmsKeyName

string

קלט בלבד. מפתח ה-KMS שישמש להגנה על מאגרי הנתונים שמנוהלים על ידי המחבר הזה.

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

אם השדה הזה מוגדר והעיבוד שלו מתבצע בהצלחה, מאגרי הנתונים שנוצרו על ידי המחבר הזה יהיו מוגנים על ידי מפתח ה-KMS.

destinationConfigs[]

object (DestinationConfig)

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

actionState

enum (State)

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

actionConfig

object (ActionConfig)

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

endUserConfig

object (EndUserConfig)

זה שינוי אופציונלי. כל הפרמטרים ופרטי הכניסה שמשמשים במיוחד לחיבורי EUA.

federatedConfig

object (FederatedConfig)

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

connectorModes[]

enum (ConnectorMode)

זה שינוי אופציונלי. המצבים שמופעלים למחבר הזה. מצב ברירת המחדל הוא CONNECTOR_MODE_UNSPECIFIED.

staticIpEnabled

boolean

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

staticIpAddresses[]

string

פלט בלבד. כתובות ה-IP הסטטיות שמשמשות את המחבר הזה.

oauthStaticIpAddresses[]

string

פלט בלבד. כתובות ה-IP הסטטיות שמשמשות את המחבר הזה לממשקי OAuth API (למשל, אימות משתמשי קצה). הם מוצגים בנפרד מ-staticIpAddresses כדי שהלקוחות יוכלו להחיל הגדרות מפורטות של חומת אש על נקודות קצה של OAuth. השדה הזה מאוכלס רק עבור מחברים שהופעלה בהם כתובת IP סטטית, ושמשמשים לפעולות או לחיפוש מאוחד.

blockingReasons[]

enum (BlockingReason)

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

identityRefreshInterval
(deprecated)

string (Duration format)

מרווח הרענון לסינכרון המידע של רשימת בקרת הגישה למסמכים שנקלטים על ידי המחבר הזה. אם לא מגדירים את המדיניות, רשימת בקרת הגישה תתעדכן במרווח הזמן שמוגדר כברירת מחדל של 30 דקות. פרק הזמן בין רענוני הזהות יכול להיות 30 דקות לכל הפחות ו-7 ימים לכל היותר.

משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב-s. דוגמה: "3.5s".

identityScheduleConfig

object (IdentityScheduleConfig)

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

privateConnectivityProjectId

string

פלט בלבד. מזהה פרויקט הדייר שמשויך למחברים של קישוריות פרטית. כדי שהמחבר יפעל, צריך להוסיף את הפרויקט הזה לרשימת ההיתרים.

bapConfig

object (BAPConfig)

זה שינוי אופציונלי. ההגדרה ליצירת חיבור BAP.

connectorType

enum (ConnectorType)

פלט בלבד. סוג המחבר. כל מקור יכול להיות ממופה רק לסוג אחד. לדוגמה, ל-Salesforce, ‏ Confluence ו-Jira יש סוג מחבר THIRD_PARTY. אחרי שהמערכת מגדירה את הערך, אי אפשר לשנות אותו.

realtimeState

enum (State)

פלט בלבד. מצב הסנכרון בזמן אמת

alertPolicyConfigs[]

object (AlertPolicyConfig)

זה שינוי אופציונלי. הגדרת ההתראות ברמת המחבר.

realtimeSyncConfig

object (RealtimeSyncConfig)

זה שינוי אופציונלי. ההגדרה של סנכרון בזמן אמת.

aclEnabled

boolean

זה שינוי אופציונלי. האם המחבר ייווצר עם הגדרת ACL. בשלב הזה, השדה הזה משפיע רק על מחברים של Cloud Storage ו-BigQuery.

createEuaSaas

boolean

זה שינוי אופציונלי. האם מחבר אימות משתמש הקצה נוצר ב-SaaS.

autoRunDisabled

boolean

זה שינוי אופציונלי. השדה מציין אם המחבר מושבת להפעלה אוטומטית. אפשר להשתמש בה כדי להשהות סנכרון תקופתי וסנכרון בזמן אמת. עדכון: עם ההשקה של incrementalSyncDisabled, ‏ autoRunDisabled משמש להשהיה או להשבתה של סנכרונים מלאים בלבד

incrementalSyncDisabled

boolean

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

incrementalRefreshInterval

string (Duration format)

זה שינוי אופציונלי. מרווח הרענון שמוגדר במיוחד לסנכרון מצטבר של נתונים. אם המדיניות לא מוגדרת, סנכרונים מצטברים ישתמשו בברירת המחדל מהסביבה, שהיא 3 שעות. המינימום הוא 30 דקות והמקסימום הוא 7 ימים. רלוונטי רק למחברים של צד שלישי. אם מגדירים את אותו ערך גם למרווח הרענון וגם למרווח הרענון המצטבר, הסנכרון המצטבר יושבת.

משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב-s. דוגמה: "3.5s".

hybridIngestionDisabled

boolean

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

dataProtectionPolicy

object (DataProtectionPolicy)

זה שינוי אופציונלי. מציינת את מדיניות ההגנה על הנתונים של המחבר.

egressFqdns[]

string

פלט בלבד. רשימת שמות הדומיין המלאים (FQDN) שאליהם מחבר הנתונים יכול לשלוח נתונים. זה כולל גם FQDN שנגזר מכתובת ה-URL של המופע שהלקוח סיפק, וגם FQDN שמוגדר כברירת מחדל לכל סוג מחבר.

vpcscEnabled

boolean

פלט בלבד. האם המחבר נוצר עם VPC-SC מופעל.

dynamicTools[]

object (DynamicTool)

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

cliConfig

object (CliConfig)

זה שינוי אופציונלי. ההגדרה ליצירת חיבור CLI.

connectorSourceId

string

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

tag

string

זה שינוי אופציונלי. אי אפשר לשנות. תווית גלויה למשתמשים, לא תלויה בגרסה של המחבר. יכול להיות שמשותף על ידי כמה מחברים באותו (פרויקט, מיקום, אוסף, מקור נתונים); חיפוש מבוסס-תגים מחזיר את זה עם createTime הגדול ביותר.

אופציונלי בזמן היצירה. אם המתקשר משמיט את tag, השרת גוזר אותו אוטומטית מ-collectionId (אם לא, הוא חוזר ל-dataSource, ואם לא, הוא משתמש בערך sentinel של t-<micros> שמבוסס על זמן). התג שנוצר אוטומטית כפוף לאותה ערבות של אי-שינוי כמו תג שסופק על ידי המתקשר, ולכן מתקשרים שחשוב להם ערך התג המדויק צריכים לספק אותו באופן מפורש ולא להסתמך על ברירת המחדל של השרת.

הכלי Agent Designer פותר בעיות שקשורות למחברים באמצעות (מקור נתונים, תג) כשהוא מוגדר, וחוזר לחיפוש שמות משאבים מדור קודם כשהוא לא מוגדר. לכן, מחברים שנוצרו לפני ההשקה של כתיבת התגים ממשיכים לפעול בלי מילוי חוסרים.

metadata

object (ConnectorMetadata)

זה שינוי אופציונלי. מטא-נתונים שמוצגים למשתמשים לגבי המחבר. השדה מאוכלס ממטא-הנתונים או מהרישום שנוצרו על ידי כלי הקישור ConnectorSource.

פרמטרים שנדרשים לגישה למקור בפורמט של צמדי (מפתח, ערך). ערכי מחרוזות בפורמט projects/*/[locations/*/]secrets/*/versions/* ייקראו מ-Secret Manager.

פרמטרים שנדרשים בכל מקורות הנתונים:

  • מקש: instance_uri
  • הערך: סוג STRING. כתובת ה-URI לגישה למקור הנתונים.

פרמטרים נדרשים למקורות שתומכים ב-OAuth, כלומר salesforce:

  • מקש: client_id
  • הערך: סוג STRING. מזהה הלקוח של ספק השירות מצד שלישי שמשמש לזיהוי האפליקציה שלכם.
  • מקש: client_secret
  • ערך:סוג STRING. סוד הלקוח שנוצר על ידי שרת ההרשאות של הצד השלישי.
  • מקש: access_token
  • הערך: סוג STRING. טוקן OAuth ל-UCS כדי לגשת למשאב המוגן.
  • מקש: refresh_token
  • הערך: סוג STRING. טוקן רענון מסוג OAuth ל-UCS כדי לקבל טוקן גישה חדש ללא אינטראקציה מצד המשתמש.

פרמטרים נדרשים למקורות שתומכים באימות בסיסי של טוקן API, כלומר jira, confluence:

  • מקש: user_account
  • הערך: סוג STRING. שם המשתמש או כתובת האימייל עם המקור.
  • מקש: api_token
  • הערך: סוג STRING. טוקן ה-API שנוצר לחשבון המקור, שמשמש לאימות בכל מקום שבו הייתם משתמשים בסיסמה.

דוגמה:

{
                                "instance_uri": "https://xxx.atlassian.net",
                                "user_account": "xxxx.xxx@xxx.com",
                                "api_token": "test-token"
                              }
                              

פרמטר אופציונלי לציון סוג ההרשאה שבו רוצים להשתמש אם יש תמיכה בכמה סוגי הרשאות:

  • מקש: auth_type
  • הערך: סוג STRING. סוג ההרשאה למקור הנתונים. ערכים נתמכים: BASIC_AUTH, ‏ OAUTH, ‏ OAUTH_ACCESS_TOKEN, ‏ OAUTH_TWO_LEGGED, ‏ OAUTH_JWT_BEARER, ‏ OAUTH_PASSWORD_GRANT, ‏ JWT, ‏ API_TOKEN, ‏ FEDERATED_CREDENTIAL, ‏ NO_AUTH. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
params

object (Struct format)

פרמטרים נדרשים של מחבר נתונים בפורמט json מובנה.

jsonParams

string

פרמטרים נדרשים של מחבר נתונים בפורמט מחרוזת json.

סוף השדות הבלעדיים.

מדינה

המצב של המחבר.

טיפוסים בני מנייה (enum)
STATE_UNSPECIFIED ערך ברירת המחדל.
CREATING המחבר נמצא בתהליך הגדרה.
ACTIVE המחבר מוגדר בהצלחה וממתין להפעלת הסנכרון הבאה.
FAILED המחבר במצב שגיאה. פרטי השגיאה מופיעים בDataConnector.errors. אם אי אפשר לתקן את השגיאה, אפשר למחוק את DataConnector באמצעות CollectionService.DeleteCollection API.
RUNNING המחבר מסנכרן באופן פעיל רשומות ממקור הנתונים.
WARNING המחבר השלים הפעלה של סנכרון, אבל נתקל בשגיאות לא קריטיות.
INITIALIZATION_FAILED האתחול של המחבר נכשל. הגורמים האפשריים כוללים שגיאות בזמן ריצה או בעיות בצינור האסינכרוני, שמונעות מהבקשה להגיע לשירותים במורד הזרם (חוץ מכמה סוגים של מחברים).
UPDATING המחבר נמצא בתהליך עדכון.

SourceEntity

מייצג ישות במקור הנתונים. לדוגמה, האובייקט Account ב-Salesforce.

ייצוג ב-JSON
{
  "entityName": string,
  "keyPropertyMappings": {
    string: string,
    ...
  },
  "dataStore": string,
  "startingSchema": {
    object (Schema)
  },
  "healthcareFhirConfig": {
    object (HealthcareFhirConfig)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "params": {
    object
  },
  "jsonParams": string
  // End of mutually exclusive fields.
}
שדות
entityName

string

שם הישות. ערכים נתמכים לפי מקור נתונים:

  • ‫Salesforce: ‏ Lead, ‏ Opportunity, ‏ Contact, ‏ Account, ‏ Case, ‏ Contract, ‏ Campaign
  • ‫Jira: Issue
  • Confluence: ‏ Content, ‏ Space
keyPropertyMappings

map (key: string, value: string)

מאפיינים לאינדוקס. מפתח: שם השדה. ערך: מאפיין המפתח למיפוי שדה, כמו title ו-description. מאפייני מפתח נתמכים:

  • title: הכותרת של רשומת הנתונים. המידע הזה יוצג בתוצאות החיפוש.
  • ‫description: תיאור רשומת הנתונים. הוא יוצג בתוצאות החיפוש.
dataStore

string

פלט בלבד. השם המלא של המשאב במאגר הנתונים המשויך לישות המקור. פורמט: projects/*/locations/*/collections/*/dataStores/* כשמחברים את המחבר באמצעות השיטה DataConnectorService.SetUpDataConnector, נוצר באופן אוטומטי DataStore לכל ישות מקור.

startingSchema

object (Schema)

זה שינוי אופציונלי. סכימת ההתחלה שתשמש ליצירת DataStore מה-SourceEntity הזה. אם לא מגדירים את המדיניות, המערכת תשתמש בסכימה אנכית מיוחדת שמוגדרת כברירת מחדל.

השדה הזה משמש רק ב-SetUpDataConnector API, והמערכת תתעלם ממנו אם הוא ישמש בממשקי API אחרים. השדה הזה לא יופיע בכל התגובות מה-API, כולל GetDataConnector API. כדי לאחזר סכמה של DataStore, צריך להשתמש ב-SchemaService.GetSchema API.

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

healthcareFhirConfig

object (HealthcareFhirConfig)

זה שינוי אופציונלי. ההגדרה של HEALTHCARE_FHIR.

הפרמטרים של הישות כדי להקל על הטמעת הנתונים. לדוגמה, במחברים ל-BigQuery:

  • מקש: document_id_column
  • הערך: סוג STRING. הערך של מזהה העמודה. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
params

object (Struct format)

הפרמטרים של הישות כדי להקל על הטמעת הנתונים בפורמט json מובנה.

jsonParams

string

הפרמטרים של הישות כדי להקל על הטמעת הנתונים בפורמט של מחרוזת JSON.

סוף השדות הבלעדיים.

SyncMode

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

טיפוסים בני מנייה (enum)
PERIODIC המחבר יסנכרן את הנתונים מעת לעת על סמך הערך של refreshInterval. אפשר להשתמש בו עם autoRunDisabled כדי להשהות את הסנכרון התקופתי, או כדי לציין סנכרון חד-פעמי.
STREAMING הנתונים יסונכרנו בזמן אמת.
UNSPECIFIED מחבר שלא קולט נתונים יקבל את הערך הזה

DestinationConfig

מגדיר נקודות קצה (endpoint) של יעד שמשמשות להתחברות למקורות של צד שלישי.

ייצוג ב-JSON
{
  "key": string,
  "destinations": [
    {
      object (Destination)
    }
  ],

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "params": {
    object
  },
  "jsonParams": string
  // End of mutually exclusive fields.
}
שדות
key

string

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

destinations[]

object (Destination)

זה שינוי אופציונלי. יעדי המפתח המתאים.

פרמטרים נוספים להגדרת היעד הזה. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
params

object (Struct format)

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

jsonParams

string

פרמטרים נוספים להגדרת היעד הזה בפורמט של מחרוזת JSON.

סוף השדות הבלעדיים.

יעד

הגדרת נקודת קצה של יעד

ייצוג ב-JSON
{
  "port": integer,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "host": string
  // End of mutually exclusive fields.
}
שדות
port

integer

זה שינוי אופציונלי. מספר היציאה של היעד שאושר על ידי היעד.

יעד נקודת הקצה. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
host

string

מארח שאפשר לנתב באופן ציבורי.

סוף השדות הבלעדיים.

ActionConfig

מידע לתמיכה בפעולות במחבר.

ייצוג ב-JSON
{
  "isActionConfigured": boolean,
  "serviceName": string,
  "useStaticSecrets": boolean,
  "createBapConnection": boolean,
  "userDefinedScopesMapping": {
    string: {
      object (ScopeList)
    },
    ...
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "actionParams": {
    object
  },
  "jsonActionParams": string
  // End of mutually exclusive fields.
}
שדות
isActionConfigured

boolean

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

serviceName

string

זה שינוי אופציונלי. שם המשאב של Service Directory (projects/*/locations/*/namespaces/*/services/*) שמייצג נקודת קצה של רשת VPC שמשמשת לחיבור אל instanceUri של מקור הנתונים, שמוגדר ב-DataConnector.params.

נדרש כש-VPC Service Controls מופעל.

useStaticSecrets

boolean

זה שינוי אופציונלי. האם להשתמש בסודות סטטיים עבור המחבר. אם הערך הוא True, המערכת תתעלם מהסודות שסופקו ב-actionParams.

createBapConnection

boolean

זה שינוי אופציונלי. האם ליצור חיבור BAP למחבר.

userDefinedScopesMapping

map (key: string, value: object (ScopeList))

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

פרמטרים שנדרשים לתמיכה בפעולות בפורמט של צמדי (מפתח, ערך). ערכי מחרוזות בפורמט projects/*/[locations/*/]secrets/*/versions/* ייקראו מ-Secret Manager.

פרמטרים נדרשים למקורות שתומכים ב-OAuth, כלומר gmail, ‏ google_calendar, ‏ jira, ‏ workday, ‏ salesforce, ‏ confluence:

  • מקש: client_id
  • הערך: סוג STRING. מזהה הלקוח של ספק השירות שמשמש לזיהוי האפליקציה שלכם.
  • מקש: client_secret
  • ערך:סוג STRING. סוד הלקוח שנוצר על ידי שרת ההרשאות של האפליקציה. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
actionParams

object (Struct format)

זה שינוי אופציונלי. פרמטרים של פעולה בפורמט JSON מובנה.

jsonActionParams

string

זה שינוי אופציונלי. פרמטרים של פעולה בפורמט מחרוזת JSON.

סוף השדות הבלעדיים.

ScopeList

מאחסן רשימה של היקפי הרשאות.

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

string

זה שינוי אופציונלי. רשימת ההיקפים.

EndUserConfig

כל הפרמטרים ופרטי הכניסה שמשמשים במיוחד לחיבורי EUA.

ייצוג ב-JSON
{
  "additionalParams": {
    object
  },
  "tenant": {
    object (Tenant)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "authParams": {
    object
  },
  "jsonAuthParams": string
  // End of mutually exclusive fields.
}
שדות
additionalParams

object (Struct format)

זה שינוי אופציונלי. כל פרמטר נוסף שנדרש ל-EUA.

tenant

object (Tenant)

זה שינוי אופציונלי. פרויקט הדייר שאליו המחבר מחובר.

הגדרת האימות של מחברי EUA.

שני המאגרי נתונים מחזיקים פרמטרים לאימות שסופקו על ידי הלקוח, כולל מפתחות פרטיים בפורמט PEM. אם לא מציינים סוג סמנטי של צנזורה, DebugString() מדפיס את חומר המפתח במלואו. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:

authParams

object (Struct format)

זה שינוי אופציונלי. כל פרמטר אימות שספציפי למחברי EUA.

jsonAuthParams

string

זה שינוי אופציונלי. פרמטרים של אימות שספציפיים למחברי EUA בפורמט מחרוזת JSON.

סוף השדות הבלעדיים.

דייר (tenant)

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

ייצוג ב-JSON
{
  "id": string,
  "uri": string,
  "displayName": string
}
שדות
id

string

מזהה המכונה של הדייר. דוגמאות: Jira ‏ ("8594f221-9797-5f78-1fa4-485e198d7cd0"), ‏ Slack ‏ ("T123456").

uri

string

ה-URI של הדייר, אם רלוונטי. לדוגמה, ה-URI של מופע Jira הוא https://my-jira-instance.atlassian.net, ולדייר Slack אין URI.

displayName

string

שם מוצג אופציונלי לדייר, למשל 'הצוות שלי ב-Slack'.

FederatedConfig

כל הפרמטרים והאישורים שמשמשים במיוחד לחיבורים היברידיים שתומכים במצב מאוחד.

ייצוג ב-JSON
{
  "additionalParams": {
    object
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "authParams": {
    object
  },
  "jsonAuthParams": string
  // End of mutually exclusive fields.
}
שדות
additionalParams

object (Struct format)

זה שינוי אופציונלי. כל הפרמטרים הנוספים שנדרשים ל-FEDERATED.

הגדרת האימות למחברים מאוחדים. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
authParams

object (Struct format)

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

jsonAuthParams

string

זה שינוי אופציונלי. פרמטרים של אימות שספציפיים למחברים מאוחדים בפורמט מחרוזת JSON.

סוף השדות הבלעדיים.

ConnectorMode

המצבים שמופעלים למחבר הזה. INGESTION, ACTIONS, FEDERATED, OR EUA

טיפוסים בני מנייה (enum)
CONNECTOR_MODE_UNSPECIFIED לא צוין מצב המחבר.
DATA_INGESTION מחבר שמשמש להעברת נתונים.
ACTIONS המחבר שמשמש לפעולות.
FEDERATED מחבר שמשמש לחיפוש מאוחד.
EUA מחבר שמשמש לאימות משתמשי קצה.
FEDERATED_AND_EUA מחבר היברידי שמשמש לחיפוש מאוחד ולאימות משתמשי קצה.

BlockingReason

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

טיפוסים בני מנייה (enum)
BLOCKING_REASON_UNSPECIFIED ערך ברירת המחדל.
ALLOWLIST_STATIC_IP כדי להשתמש במחבר, הלקוח צריך להוסיף לרשימת ההיתרים כתובות IP סטטיות.
ALLOWLIST_IN_SERVICE_ATTACHMENT כדי להשתמש בכלי לחיבור, הלקוח צריך להוסיף את הפרויקט שלנו לרשימת ההיתרים בקובץ המצורף של השירות שלו.
ALLOWLIST_SERVICE_ACCOUNT כדי להשתמש במחבר, הלקוח צריך להוסיף את חשבון השירות לרשימת ההיתרים בפרויקט שלו.

IdentityScheduleConfig

ההגדרה של הרצות הסנכרון של נתוני הזהויות.

ייצוג ב-JSON
{
  "refreshInterval": string,
  "nextSyncTime": {
    object (DateTime)
  }
}
שדות
refreshInterval

string (Duration format)

זה שינוי אופציונלי. מרווח הרענון לסינכרון המידע של רשימת בקרת הגישה למסמכים שנקלטים על ידי המחבר הזה. אם לא מגדירים את המדיניות, רשימת בקרת הגישה תתעדכן במרווח הזמן שמוגדר כברירת מחדל של 30 דקות. פרק הזמן בין רענוני הזהות יכול להיות 30 דקות לכל הפחות ו-7 ימים לכל היותר.

משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב-s. דוגמה: "3.5s".

nextSyncTime

object (DateTime)

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

BAPConfig

ההגדרה של מחבר BAP.

ייצוג ב-JSON
{
  "supportedConnectorModes": [
    enum (ConnectorMode)
  ],
  "enabledActions": [
    string
  ],
  "toolspecOverride": {
    object (ToolspecOverride)
  }
}
שדות
supportedConnectorModes[]

enum (ConnectorMode)

חובה. מצבי המחבר הנתמכים לחיבור BAP המשויך.

enabledActions[]

string

זה שינוי אופציונלי. הפעולות שמופעלות בחיבור ה-BAP המשויך.

toolspecOverride

object (ToolspecOverride)

זה שינוי אופציונלי. החלפת הגדרות של כלי מותאם אישית בחיבור הזה. במחברים של Enterprise BAP שתומכים בהגדרות כלים שאדמינים בוחרים, המאפיין הזה מכיל את ההגדרות (הפשוטות) שמוגדרות כברירת מחדל לכל כלי. ב-Get, מאוכלס על ידי השרת על ידי מיזוג של שינויים ששמורים בזיכרון עם הגדרות של כלי בזמן ריצה, וקיצוץ התוצאה לשימוש בממשק המשתמש. בפעולת העדכון, הערך שסופק מחליף את הביטולים הקיימים אחרי אימות ומיזוג בצד השרת: השדה baseVersion חייב להתאים לגרסת כלי הבסיס הנוכחית של השרת (אחרת הבקשה נדחית עם שגיאה גלויה למשתמשים שמפנה את האדמין להוריד מחדש את הכלים העדכניים קודם).

ConnectorMode

תרחישי שימוש שנתמכים על ידי מחבר BAP.

טיפוסים בני מנייה (enum)
CONNECTOR_MODE_UNSPECIFIED לא צוין מצב המחבר.
DATA_INGESTION מחבר שמשמש להעברת נתונים.
ACTIONS המחבר משמש לפעולות
END_USER_AUTHENTICATION מחבר שמשמש לאימות משתמשי קצה.

ToolspecOverride

תצוגה שפונה ללקוח של מפרט כלי שנוצר על ידי האדמין לחיבור BAP. ההגדרות (הפשוטות) של כל כלי שמוצגות לאדמין בממשק המשתמש של Discovery Engine וניתנות לעריכה על ידו.

הוא משקף את הצורה של הודעת google.cloud.connectorexecution.v1.ToolspecOverride ה-backend, אבל הוא מוגדר בכוונה כסוג ציבורי נפרד כדי שממשק Discovery Engine API יוכל להתפתח בנפרד מממשק fed-API (AIP-215). ה-Handlers מבצעים את ההמרה בין השניים באמצעות פונקציות עזר ב-‎ //cloud/ml/discoveryengine/external_service/v1main/data_connector_service/lib:bap_custom_tool_util.

ייצוג ב-JSON
{
  "tools": [
    {
      object
    }
  ],
  "baseVersion": string
}
שדות
tools[]

object (Struct format)

חובה. הגדרות של כלים (מבנה אחד לכל כלי) שהאדמין התאים אישית בנוסף למפרט הכלים הבסיסי שמוחזר על ידי ה-API המאוחד. חובה, כי זה השדה היחיד שמשתמש יכול לערוך ב-API של שינוי; הבקשה חייבת להכיל לפחות כלי אחד.

baseVersion

string

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

ConnectorType

סוג המחבר. יכול להיות שבעתיד נוסיף ערכים חדשים ל-enum הזה.

טיפוסים בני מנייה (enum)
CONNECTOR_TYPE_UNSPECIFIED ערך ברירת המחדל.
THIRD_PARTY מחבר של צד שלישי למחבר לאפליקציה של צד שלישי.
GCP_FHIR מחבר הנתונים מקשר בין מאגר FHIR למאגר הנתונים של VAIS.
BIG_QUERY מחבר ל-BigQuery.
GCS מחבר Google Cloud Storage.
GOOGLE_MAIL מחבר Gmail.
GOOGLE_CALENDAR מחבר של יומן Google.
GOOGLE_DRIVE מחבר ל-Google Drive.
NATIVE_CLOUD_IDENTITY מחבר מקורי של Cloud Identity לחיפוש אנשים, שמבוסס על People API.
THIRD_PARTY_FEDERATED מחבר מאוחד, שהוא מחבר צד שלישי שלא מבצע הטמעה של נתונים, והחיפוש מופעל על ידי API של אפליקציית צד שלישי.
THIRD_PARTY_EUA מחבר שמשמש לתכונות של אימות משתמשי קצה.
GCNV מחבר Google Cloud NetApp Volumes.
GOOGLE_CHAT מחבר Google Chat.
GOOGLE_SITES מחבר Google Sites.
REMOTE_MCP מחבר מבוסס MCP מרחוק.
GOOGLE_WORKSPACE מחבר ל-Google Workspace.

AlertPolicyConfig

הגדרת ההתראות ברמת המחבר.

ייצוג ב-JSON
{
  "alertPolicyName": string,
  "alertEnrollments": [
    {
      object (AlertEnrollment)
    }
  ]
}
שדות
alertPolicyName

string

אי אפשר לשנות. השם המלא של משאב AlertPolicy.

alertEnrollments[]

object (AlertEnrollment)

זה שינוי אופציונלי. מצבי ההרשמה של כל התראה.

AlertEnrollment

סטטוס ההרשמה להתראות.

ייצוג ב-JSON
{
  "alertId": string,
  "enrollState": enum (EnrollStates)
}
שדות
alertId

string

אי אפשר לשנות. המזהה של התראה.

enrollState

enum (EnrollStates)

חובה. סטטוס ההרשמה של לקוח.

EnrollStates

טיפוס ה-enum של סטטוס ההרשמה להתראה.

טיפוסים בני מנייה (enum)
ENROLL_STATES_UNSPECIFIED ערך ברירת המחדל. משמש לקוחות שלא הגיבו למדיניות ההתראות.
ENROLLED הלקוח רשום למדיניות הזו.
DECLINED הלקוח דחה את המדיניות הזו.

RealtimeSyncConfig

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

ייצוג ב-JSON
{
  "webhookUri": string,
  "realtimeSyncSecret": string,
  "streamingError": {
    object (StreamingError)
  }
}
שדות
webhookUri

string

זה שינוי אופציונלי. כתובת URL של Webhook למחבר, כדי לציין פרמטרים נוספים לסנכרון בזמן אמת.

realtimeSyncSecret

string

זה שינוי אופציונלי. המזהה של הסוד ב-Secret Manager שמשמש כסוד של ה-webhook.

streamingError

object (StreamingError)

זה שינוי אופציונלי. פרטי שגיאה של סטרימינג.

StreamingError

פרטי שגיאה של סטרימינג.

ייצוג ב-JSON
{
  "streamingErrorReason": enum (StreamingErrorReason),
  "error": {
    object (Status)
  }
}
שדות
streamingErrorReason

enum (StreamingErrorReason)

זה שינוי אופציונלי. שגיאה בסטרימינג.

error

object (Status)

זה שינוי אופציונלי. פרטי השגיאה.

StreamingErrorReason

סוגים כלליים של שגיאות בסטרימינג.

טיפוסים בני מנייה (enum)
STREAMING_ERROR_REASON_UNSPECIFIED לא צוינה סיבה לשגיאת הסטרימינג.
STREAMING_SETUP_ERROR אירעה שגיאה במהלך הגדרת המשאבים לסנכרון בזמן אמת.
STREAMING_SYNC_ERROR אירעה שגיאה במהלך הפעלת סנכרון בזמן אמת של המחבר.
INGRESS_ENDPOINT_REQUIRED כשמגדירים סנכרון בזמן אמת בחיבור מבודד, צריך להגדיר נקודת קצה של תעבורת נתונים נכנסת.

DynamicTool

הגדרות של כלים דינמיים.

ייצוג ב-JSON
{
  "name": string,
  "description": string,
  "enabled": boolean,
  "displayName": string
}
שדות
name

string

חובה. שם הכלי.

description

string

זה שינוי אופציונלי. תיאור הכלי.

enabled

boolean

זה שינוי אופציונלי. אם הכלי מופעל.

displayName

string

זה שינוי אופציונלי. השם המוצג של הכלי.

CliConfig

ההגדרה של המחברים שמבוססים על הפעלת ה-CLI.

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

string

זה שינוי אופציונלי. הפעולות שמופעלות בחיבור ה-CLI המשויך.