הערה: קבוצת המסמכים הזו מיועדת למהדורות Standard,‏ Plus ו-Frontline של Gemini Enterprise. לעיון במסמכי התיעוד של מהדורת Business, אפשר להיכנס אל מרכז העזרה של Gemini Enterprise – מהדורת Business.

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

REST Resource: projects.locations.collections

משאב: Collection
- ייצוג ב-JSON
DataConnector
- ייצוג ב-JSON
מדינה
SourceEntity
- ייצוג ב-JSON
SyncMode
DestinationConfig
- ייצוג ב-JSON
יעד
- ייצוג ב-JSON
ActionConfig
- ייצוג ב-JSON
ScopeList
- ייצוג ב-JSON
EndUserConfig
- ייצוג ב-JSON
דייר
- ייצוג ב-JSON
FederatedConfig
- ייצוג ב-JSON
ConnectorMode
BlockingReason
IdentityScheduleConfig
- ייצוג ב-JSON
BAPConfig
- ייצוג ב-JSON
ConnectorMode
ToolspecOverride
- ייצוג ב-JSON
ConnectorType
AlertPolicyConfig
- ייצוג ב-JSON
AlertEnrollment
- ייצוג ב-JSON
EnrollStates
RealtimeSyncConfig
- ייצוג ב-JSON
StreamingError
- ייצוג ב-JSON
StreamingErrorReason
DynamicTool
- ייצוג ב-JSON
CliConfig
- ייצוג ב-JSON
Methods

משאב: אוסף

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

ייצוג JSON
{ "name": string, "displayName": string, "dataConnector": { object (`DataConnector`) }, "createTime": string }

שדות
`name`	`string` אי אפשר לשנות. השם המלא של המשאב של האוסף. פורמט: `projects/{project}/locations/{location}/collections/{collectionId}` השדה הזה חייב להיות מחרוזת בקידוד UTF-8, עם מגבלת אורך של 1,024 תווים.
`displayName`	`string` חובה. השם המוצג של האוסף. השדה הזה חייב להיות מחרוזת בקידוד UTF-8, עם מגבלת אורך של 128 תווים. אחרת, מוחזרת שגיאת INVALID_ARGUMENT.
`dataConnector`	`object (DataConnector)` פלט בלבד. אם יש מחבר נתונים, הוא מנהל את החיבור למאגרי נתונים באוסף. כדי להגדיר את המחבר, משתמשים ב-method ‏`DataConnectorService.SetUpDataConnector`, שיוצרת `Collection` חדש בזמן ההגדרה של משאב הסינגלטון `DataConnector`. אי אפשר להגדיר מחבר ב-`Collection` קיים. שדה הפלט הזה מכיל קבוצת משנה של השדות `DataConnector`, כולל `name`, `dataSource`, `entities.entity_name` ו-`entities.data_store`. כדי לקבל פרטים נוספים על מחבר נתונים, משתמשים בשיטה `DataConnectorService.GetDataConnector`.
`createTime`	`string (Timestamp format)` פלט בלבד. חותמת הזמן שבה נוצר `Collection`. הפלט שנוצר תמיד יהיה בפורמט 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"`.

DataConnector

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

ייצוג JSON

ייצוג 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,
  "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 של המופע שהלקוח סיפק, וגם FQDNs שמוגדרים כברירת מחדל לכל סוג מחבר.
`vpcscEnabled`	`boolean` פלט בלבד. האם המחבר נוצר עם VPC-SC מופעל.
`dynamicTools[]`	`object (DynamicTool)` פלט בלבד. הכלים הדינמיים שאוחזרו עבור המחבר הזה.
`cliConfig`	`object (CliConfig)` זה שינוי אופציונלי. ההגדרה ליצירת חיבור ל-CLI.
`connectorSourceId`	`string` זה שינוי אופציונלי. אם הערך הזה מוגדר, המערכת משתמשת בו במקום בערך `dataSource` כדי לאחזר את מקור המחבר המתאים.
`tag`	`string` זה שינוי אופציונלי. אי אפשר לשנות. תווית שמוצגת למשתמשים, לא תלויה בגרסה של המחבר. יכול להיות שמשותף על ידי כמה מחברים באותו (פרויקט, מיקום, אוסף, מקור נתונים); חיפוש מבוסס-תגים מחזיר את זה עם createTime הגדול ביותר. אופציונלי בזמן היצירה. כלי לתכנון סוכנים פותר בעיות שקשורות למחברים באמצעות (מקור נתונים, תג) כשהוא מוגדר, וחוזר לחיפוש שמות משאבים מדור קודם כשהוא לא מוגדר. לכן, מחברים שנוצרו לפני השקת הכתיבה של התגים ממשיכים לפעול בלי מילוי חוסרים.
`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

ייצוג 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,
  "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, כולל `collections.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

ייצוג 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)
    }
  ],

  // 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

ייצוג 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,
  "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` זה שינוי אופציונלי. שם המשאב של ספריית השירותים (projects//locations//namespaces//services/) המייצג נקודת קצה של רשת VPC המשמשת להתחברות ל-`instanceUri` של מקור הנתונים, כפי שהוגדר ב-`DataConnector.params`. נדרש כאשר בקרות שירות VPC מופעלות.
`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` זה שינוי אופציונלי. רשימת ההיקפים.

scopes[]

string

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

EndUserConfig

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

ייצוג JSON

ייצוג 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
  },
  "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. בהמשך מפורטת רשימה של שדות שאי אפשר להשתמש בהם בו-זמנית. רק אחד מהשדות הבאים יוגדר בתשובה:
`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'.

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

ייצוג 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`	כדי להשתמש ב-Connector, הלקוח צריך להוסיף את הפרויקט שלנו לרשימת ההיתרים בקובץ המצורף של השירות שלו.
`ALLOWLIST_SERVICE_ACCOUNT`	כדי להשתמש בכלי לחיבור נתונים, הלקוח צריך להוסיף את חשבון השירות לרשימת מורשי הגישה בפרויקט שלו.

IdentityScheduleConfig

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

ייצוג JSON
{ "refreshInterval": string, "nextSyncTime": { object (`DateTime`) } }

שדות

שדות
`refreshInterval`	`string (Duration format)` זה שינוי אופציונלי. מרווח הרענון לסנכרון המידע של רשימת בקרת הגישה למסמכים שנקלטים על ידי המחבר הזה. אם לא מגדירים את המדיניות, רשימת בקרת הגישה תתעדכן במרווח הזמן שמוגדר כברירת מחדל של 30 דקות. אפשר להגדיר את פרק הזמן בין רענוני הזהות ל-30 דקות לפחות ועד 7 ימים לכל היותר. משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב-`s`. דוגמה: `"3.5s"`.
`nextSyncTime`	`object (DateTime)` זה שינוי אופציונלי. השעה לפי שעון UTC שבה צפוי להתחיל סנכרון הנתונים הבא של מחבר הנתונים. הלקוחות יכולים לציין רק את השעה והדקה שבהן יתבצע סנכרון הנתונים. האפשרות הזו שימושית כשמרווח הרענון של מחבר הנתונים גדול מיום אחד.

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

supportedConnectorModes[]

enum (ConnectorMode)

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

enabledActions[]

string

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

toolspecOverride

object (ToolspecOverride)

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

ConnectorMode

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

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

ToolspecOverride

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

הוא משקף את הצורה של הודעת google.cloud.connectorexecution.v1.ToolspecOverride בקצה העורפי, אבל הוא מוגדר בכוונה כסוג ציבורי נפרד כדי שממשק 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 המאוחד. חובה, כי זה השדה היחיד שמשתמש יכול לערוך ב-modify API. הבקשה חייבת להכיל לפחות כלי אחד.
`baseVersion`	`string` חובה. גרסת מפרט כלי הבסיס שבה נוצרו `tools`. במהלך עדכון, הגרסה חייבת להיות זהה לגרסה היציבה הנוכחית של כלי המפרט בשרת לצורך החיבור. אם יש אי התאמה, העדכון נדחה ומוצגת למשתמש שגיאה שמפנה את האדמין להורדה מחדש של הגרסה העדכנית ביותר.

tools[]

object (Struct format)

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

baseVersion

string

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

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 Calendar connector.
`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)` זה שינוי אופציונלי. מצב ההרשמה של כל התראה.

alertPolicyName

string

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

alertEnrollments[]

object (AlertEnrollment)

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

AlertEnrollment

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

ייצוג JSON
{ "alertId": string, "enrollState": enum (`EnrollStates`) }

שדות

שדות
`alertId`	`string` אי אפשר לשנות. המזהה של ההתראה.
`enrollState`	`enum (EnrollStates)` חובה. סטטוס ההרשמה של הלקוח.

alertId

string

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

enrollState

enum (EnrollStates)

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

EnrollStates

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

טיפוסים בני מנייה (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)` זה שינוי אופציונלי. פרטים על שגיאה בשידור.

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 (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 המשויך.

enabledActions[]

string

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

Methods
`delete`	מחיקת `Collection`.
`get`	הפונקציה מחזירה `Collection`.
`getDataConnector`	הפונקציה מחזירה את ה-`DataConnector`.
`getIamPolicy`	מקבל את מדיניות בקרת הגישה ב-IAM עבור `Collection`.
`list`	מקבל רשימה של `Collection`.
`patch`	עדכון של `Collection`.
`setIamPolicy`	הגדרת מדיניות בקרת הגישה ב-IAM עבור `Collection`.
`updateDataConnector`	עדכון של `DataConnector`.

REST Resource: projects.locations.collections

משאב: אוסף

DataConnector

מדינה

SourceEntity

SyncMode

DestinationConfig

יעד

ActionConfig

ScopeList

EndUserConfig

דייר (tenant)

FederatedConfig

ConnectorMode

BlockingReason

IdentityScheduleConfig

BAPConfig

ConnectorMode

ToolspecOverride

ConnectorType

AlertPolicyConfig

AlertEnrollment

EnrollStates

RealtimeSyncConfig

StreamingError

StreamingErrorReason

DynamicTool

CliConfig

Methods

`delete`

`get`

`getDataConnector`

`getIamPolicy`

`list`

`patch`

`setIamPolicy`

`updateDataConnector`

REST Resource: projects.locations.collections קל לארגן דפים בעזרת אוספים אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.

משאב: אוסף

DataConnector

מדינה

SourceEntity

SyncMode

DestinationConfig

יעד

ActionConfig

ScopeList

EndUserConfig

דייר (tenant)

FederatedConfig

ConnectorMode

BlockingReason

IdentityScheduleConfig

BAPConfig

ConnectorMode

ToolspecOverride

ConnectorType

AlertPolicyConfig

AlertEnrollment

EnrollStates

RealtimeSyncConfig

StreamingError

StreamingErrorReason

DynamicTool

CliConfig

Methods

REST Resource: projects.locations.collections