REST Resource: iceberg.v1.restcatalog.extensions.projects.catalogs

משאב: IcebergCatalog

פרטי קטלוג ה-REST של Iceberg.

ייצוג ב-JSON
{
  "name": string,
  "credential-mode": enum (CredentialMode),
  "biglake-service-account": string,
  "biglake-service-account-id": string,
  "catalog-type": enum (CatalogType),
  "default-location": string,
  "storage-regions": [
    string
  ],
  "create-time": string,
  "update-time": string,
  "replicas": [
    {
      object (Replica)
    }
  ],
  "description": string,
  "restricted-locations-config": {
    object (RestrictedLocationsConfig)
  },
  "federated-catalog-options": {
    object (FederatedCatalogOptions)
  },
  "cross-cloud-cache-options": {
    object (CrossCloudCacheOptions)
  },
  "encryption-config": {
    object (EncryptionConfig)
  }
}
שדות
name

string

מזהה. שם הקטלוג, projects/my-project/catalogs/my-catalog. אי אפשר לשנות את השדה הזה. המערכת מתעלמת מהשדה הזה ב-catalogs.create.

credential-mode

enum (CredentialMode)

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

biglake-service-account

string

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

בקטלוגים מאוחדים, חשבון השירות תמיד יוקצה וישמש לגישה לקטלוג המרוחק לצורך רענון המטא-נתונים ברקע. אם google.cloud.biglake.v1main.IcebergCatalog.FederatedCatalogOptions.IdentityMode מוגדר ל-IDENTITY_MODE_SERVICE_IDENTITY, הוא ישמש גם לשאילתות.

biglake-service-account-id

string

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

catalog-type

enum (CatalogType)

חובה. סוג הקטלוג. נדרש ל-catalogs.create. אי אפשר לשנות את סוג הקטלוג, חוץ מאשר המרה מ-CATALOG_TYPE_GCS_BUCKET ל-CATALOG_TYPE_BIGLAKE.

default-location

string

זה שינוי אופציונלי. מיקום האחסון שמוגדר כברירת מחדל לקטלוג, למשל gs://my-bucket. בקטלוגים של קטגוריות ב-Google Cloud Storage, זהו פלט בלבד.

בקטלוגים של BigLake, צריך לציין את השדה הזה והוא צריך להפנות לקטגוריה של Google Cloud Storage או לנתיב בתוך הקטגוריה הזו. הנתיב הזה משמש כספריית הבסיס לבניית הנתיב המלא לספריות הנתונים והמטא-נתונים של הטבלה, כשלא מצוין מיקום ברמת מרחב השמות או הטבלה. הנתיב המלא נוצר על ידי הוספת המזהים של מרחב השמות והטבלה למיקום ברירת המחדל.

storage-regions[]

string

פלט בלבד. האזורים ב-Google Cloud של הקטגוריה במיקום ברירת המחדל, למשל us-central1,‏ nam4 או us. הוא יכיל ערך אחד לכל המיקומים, חוץ מהקטלוגים שמוגדרים לשימוש בקטגוריות מותאמות אישית בשני אזורים. במקרה כזה, הוא יכיל את שני האזורים של הקטגוריה. האזורים בשדה הזה צריכים להיות בתחום השיפוט של המיקום הראשי של הקטלוג או בקרבתו.

create-time

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

update-time

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

replicas[]

object (Replica)

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

description

string

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

restricted-locations-config

object (RestrictedLocationsConfig)

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

אם השדה הזה לא מוגדר, או אם restrictedLocationsConfig.restricted_locations ריק, כל המיקומים הנגישים מותרים. אם השדה restrictedLocationsConfig.restricted_locations לא ריק, מותר להשתמש רק במיקומים ב-defaultLocation וב-restrictedLocationsConfig.restricted_locations.

federated-catalog-options

object (FederatedCatalogOptions)

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

cross-cloud-cache-options

object (CrossCloudCacheOptions)

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

encryption-config

object (EncryptionConfig)

זה שינוי אופציונלי. הגדרת הצפנה בהתאמה אישית (למשל, מפתחות Cloud KMS).

CredentialMode

מצב פרטי הכניסה שמשמש לקטלוג.

טיפוסים בני מנייה (enum)
CREDENTIAL_MODE_UNSPECIFIED ערך ברירת מחדל/לא מוגדר. הערך הזה לא בשימוש.
CREDENTIAL_MODE_END_USER מצב פרטי כניסה של משתמש קצה, ברירת מחדל. למשתמש המאמת צריכה להיות גישה למשאבי הקטלוג ולאובייקטים הבסיסיים של Google Cloud Storage.
CREDENTIAL_MODE_VENDED_CREDENTIALS

מצב הפצת פרטי כניסה. המשתמש המאמת צריך רק גישה למשאבי הקטלוג, והמערכת תספק למתקשר פרטי כניסה עם היקף מצומצם כדי לגשת לאובייקטים של Google Cloud Storage. בכל הפעולות בטבלה במצב הזה, צריך להגדיר את הכותרת X-Iceberg-Access-Delegation כ-vended-credentials. המערכת תיצור חשבון שירות ב-google.cloud.biglake.v1main.IcebergCatalog.biglake_service_account, ומנהל הקטלוג יצטרך לתת לו גישה לאובייקטים ב-Google Cloud Storage.

פרטים נוספים זמינים בכתובת https://docs.cloud.google.com/lakehouse/docs/credential-vending.

CatalogType

קובע את סוג הקטלוג.

טיפוסים בני מנייה (enum)
CATALOG_TYPE_UNSPECIFIED ערך ברירת מחדל/לא מוגדר. הערך הזה לא בשימוש.
CATALOG_TYPE_GCS_BUCKET סוג הקטלוג של קטגוריית Google Cloud Storage.
CATALOG_TYPE_BIGLAKE סוג הקטלוג של BigLake.
CATALOG_TYPE_FEDERATED סוג הקטלוג המאוחד.
CATALOG_TYPE_ALLOYDB_AGENT_MODE קטלוג לשליחת שאילתות לטבלאות AlloyDB במצב סוכן.

רפליקה

הרפליקה של הקטלוג.

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

string

פלט בלבד. האזור של הרפליקה. לדוגמה, "us-east1"

state

enum (State)

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

מדינה

אם הקטלוג משוכפל לכמה אזורים, ה-enum הזה מתאר את המצב הנוכחי של הרפליקה.

טיפוסים בני מנייה (enum)
STATE_UNKNOWN ערך ברירת מחדל/לא מוגדר. הערך הזה לא בשימוש.
STATE_PRIMARY הרפליקה היא הרפליקה הראשית שניתן לכתוב בה.
STATE_PRIMARY_IN_PROGRESS הרפליקה הוקצתה לאחרונה כראשית, אבל עדיין לא ניתן לכתוב בכל מרחבי השמות.
STATE_SECONDARY הרפליקה היא רפליקה משנית לקריאה בלבד.

RestrictedLocationsConfig

הגדרת הגבלות מיקום.

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

string

זה שינוי אופציונלי. קטגוריות ומיקומים נוספים של Google Cloud Storage (למשל, gs://my-other-bucket/...) שמותר להשתמש בהם במשאבים בתוך קטלוג. השדה הזה משמש כרגע רק לקטלוגים של BigLake.

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

EncryptionConfig

הגדרת הצפנה בהתאמה אישית (למשל, מפתחות Cloud KMS).

ייצוג ב-JSON
{
  "kms-key-name": string
}
שדות
kms-key-name

string

זה שינוי אופציונלי. שם המפתח ב-Cloud KMS שמשמש להצפנת נתונים שנשמרו במטמון ונשלפו מהקטלוג. פורמט: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey}

FederatedCatalogOptions

אפשרויות להגדרת קטלוג מאוחד.

ייצוג ב-JSON
{
  "identity-mode": enum (IdentityMode),
  "refresh-options": {
    object (RefreshOptions)
  },
  "refresh-status": {
    object (RefreshStatus)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "identity-federation-organization-service-account": {
    object (IdentityFederationOrganizationServiceAccount)
  }
  // End of mutually exclusive fields.

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "unity-catalog-info": {
    object (UnityCatalogInfo)
  },
  "glue-catalog-info": {
    object (GlueCatalogInfo)
  },
  "snowflake-catalog-info": {
    object (SnowflakeCatalogInfo)
  },
  "workday-catalog-info": {
    object (WorkdayCatalogInfo)
  }
  // End of mutually exclusive fields.
  "secret-name": string,
  "service-directory-name": string,
  "metadata-service-directory-name": string,
  "user-identity-federation-oidc-claims": {
    object (UserIdentityFederationOidcClaims)
  },
  "user-identity-federation-oidc": {
    object (UserIdentityFederationOidc)
  }
}
שדות
identity-mode

enum (IdentityMode)

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

refresh-options

object (RefreshOptions)

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

refresh-status

object (RefreshStatus)

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

ברשימה הבאה מפורטים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים:
identity-federation-organization-service-account

object (IdentityFederationOrganizationServiceAccount)

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

סוף השדות שמוציאים זה את זה.
מידע ספציפי לקטלוג REST של Iceberg מרחוק. ברשימה הבאה מפורטים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים:
unity-catalog-info

object (UnityCatalogInfo)

זה שינוי אופציונלי. מידע ספציפי ל-Databricks Unity Catalog.

glue-catalog-info

object (GlueCatalogInfo)

זה שינוי אופציונלי. מידע ספציפי ל-AWS Glue Data Catalog.

snowflake-catalog-info

object (SnowflakeCatalogInfo)

זה שינוי אופציונלי. מידע ספציפי ל-Snowflake Horizon Catalog.

workday-catalog-info

object (WorkdayCatalogInfo)

זה שינוי אופציונלי. מידע ספציפי על Workday Data Lake.

סוף השדות שמוציאים זה את זה.
secret-name

string

זה שינוי אופציונלי. שם המשאב של הסוד ב-Secret Manager, בפורמט projects/{projectId}/locations/{location}/secrets/{secret_id} או projects/{projectId}/locations/{location}/secrets/{secret_id}/versions/{version_id}.

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

המערכת לא משתמשת בשדה הזה אם מוגדרים השדות google.cloud.biglake.v1main.IcebergCatalog.FederatedCatalogOptions.UnityCatalogInfo.service_principal_application_id,‏ google.cloud.biglake.v1main.IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo.snowflake_role או google.cloud.biglake.v1main.IcebergCatalog.FederatedCatalogOptions.WorkdayCatalogInfo.api_client_client_id.

service-directory-name

string

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

פורמט: projects/{projectId}/locations/{locationId}/namespaces/{namespace_id}/services/{serviceId}

הוא משמש את השאילתות של BigQuery כדי לפתור נקודות קצה פרטיות לאחזור קובצי נתונים (למשל, נתוני Iceberg ב-S3 או ב-Azure Data Lake Storage) דרך חיבור לרשת פרטית כמו Cross-Cloud Interconnect.

metadata-service-directory-name

string

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

פורמט: projects/{projectId}/locations/{locationId}/namespaces/{namespace_id}/services/{serviceId}

משמש לאחזור מטא-נתונים של קטלוג (כמו הגדרות, מרחבי שמות וטבלאות של Iceberg) דרך חיבור לרשת פרטית, כמו Cross-Cloud Interconnect. משמש גם לאחזור אסימוני OAuth כשלא מוגדר oauth2ServerUrl. אם השדה הזה לא מוגדר, הבקשות נשלחות דרך האינטרנט הציבורי.

user-identity-federation-oidc-claims
(deprecated)

object (UserIdentityFederationOidcClaims)

פלט בלבד. הוצא משימוש: צריך להשתמש ב-google.cloud.biglake.v1main.IcebergCatalog.FederatedCatalogOptions.user_identity_federation_oidc במקום זאת.

הצהרות ה-OIDC שמונפקות בטוקן של המזהה לאיחוד זהויות של משתמשים.

user-identity-federation-oidc

object (UserIdentityFederationOidc)

פלט בלבד. הגדרת ה-OIDC לאיחוד שירותי אימות הזהות של המשתמשים.

IdentityFederationOrganizationServiceAccount

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

ייצוג ב-JSON
{
  "service-account": string,
  "service-account-unique-id": string
}
שדות
service-account

string

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

service-account-unique-id

string

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

UnityCatalogInfo

מידע ספציפי ל-Databricks Unity Catalog. נקודת הקצה של קטלוג REST של Iceberg היא בפורמט: https://<instanceName>/api/2.1/unity-catalog/iceberg-rest/v1/config?warehouse=<catalogName>.

ייצוג ב-JSON
{
  "instance-name": string,
  "catalog-name": string,
  "service-principal-application-id": string
}
שדות
instance-name

string

חובה. לא ניתן לשינוי. שם המכונה של סביבת העבודה ב-Databricks. לדוגמה, בכתובת ה-URL של סביבת העבודה ב-Databricks‏ https://1.1.gcp.databricks.com, שם המכונה הוא 1.1.gcp.databricks.com.

catalog-name

string

חובה. לא ניתן לשינוי. שם הקטלוג ב-Databricks Unity Catalog.

service-principal-application-id

string

זה שינוי אופציונלי. מזהה האפליקציה של חשבון השירות של Databricks שמשמש לגישה ל-Databricks Unity Catalog בתהליך האימות של OIDC.

GlueCatalogInfo

מידע ספציפי ל-AWS Glue Data Catalog. נקודת הקצה של קטלוג REST של Iceberg היא בפורמט: https://glue.<awsRegion>.amazonaws.com/iceberg/v1/config?warehouse=<warehouse>.

ייצוג ב-JSON
{
  "warehouse": string,
  "aws-region": string,
  "aws-role-arn": string
}
שדות
warehouse

string

חובה. לא ניתן לשינוי. מיקום המחסן ב-AWS Glue Data Catalog.

בקטלוג ברירת המחדל של החשבון, משתמשים במזהה החשבון ב-AWS שמורכב מ-12 ספרות (לדוגמה, 111222333444). בקטגוריית טבלה של Amazon S3, משתמשים בפורמט <account_id>:s3tablescatalog/<table_bucket_name> (לדוגמה, 111222333444:s3tablescatalog/my-table-bucket).

aws-region

string

חובה. לא ניתן לשינוי. האזור ב-AWS של AWS Glue Data Catalog (לדוגמה, us-east-1). כדי לקבל את הביצועים הכי טובים, האזור של הקטלוג המאוחד צריך להיות באותו מיקום גיאוגרפי ובאותה סמכות שיפוט כמו האזור ב-AWS.

aws-role-arn

string

חובה. שם המשאב ב-Amazon‏ (ARN) של תפקיד AWS IAM שהקטלוג המאוחד מקבל כדי לגשת ל-AWS Glue Data Catalog.

SnowflakeCatalogInfo

מידע ספציפי ל-Snowflake Horizon Catalog. נקודת הקצה של קטלוג REST של Iceberg היא בפורמט: https://<accountIdentifier>.snowflakecomputing.com/polaris/api/catalog/v1/config?warehouse=<warehouse>.

ייצוג ב-JSON
{
  "account-identifier": string,
  "warehouse": string,
  "snowflake-role": string
}
שדות
account-identifier

string

חובה. לא ניתן לשינוי. מזהה החשבון ב-Snowflake. לדוגמה, בכתובת ה-URL של פריסת Snowflake‏ https://myorg-myaccount.snowflakecomputing.com, מזהה החשבון הוא myorg-myaccount.

מזהה החשבון יכול להכיל אותיות, ספרות וקווים תחתונים, עם מקטעים שמופרדים במקפים (-) או בנקודות (.). המזהה תומך בפורמט של חשבון ארגוני (לדוגמה, myorg-myaccount), בפורמט של מאתר חשבונות מדור קודם (לדוגמה, xy12345.us-east-1) ובפורמטים של קישוריות פרטית (PrivateLink) (לדוגמה, myorg-myaccount.privatelink או xy12345.us-east-1.privatelink). מידע נוסף זמין בכתובת https://docs.snowflake.com/en/user-guide/admin-account-identifier.

warehouse

string

חובה. לא ניתן לשינוי. שם מסד הנתונים ב-Snowflake Horizon Catalog.

snowflake-role

string

זה שינוי אופציונלי. התפקיד ב-Snowflake שמשמש להגדרת היקף הגישה ל-Snowflake Horizon Catalog בתהליך האימות של איחוד שירותי אימות הזהות של עומסי עבודה (OIDC).

WorkdayCatalogInfo

מידע ספציפי על Workday Data Lake. נקודת הקצה של קטלוג REST של Iceberg היא בפורמט: https://<baseUrl>/datalake/api/catalog/v1/config?warehouse=workday.

ייצוג ב-JSON
{
  "base-url": string,
  "tenant": string,
  "api-client-client-id": string
}
שדות
base-url

string

חובה. לא ניתן לשינוי. כתובת ה-URL הבסיסית של המכונה ב-Workday. לדוגמה, impl-services1.wd12.myworkday.com או wd501.myworkday.com.

tenant

string

חובה. לא ניתן לשינוי. שם הדייר ב-Workday.

api-client-client-id

string

זה שינוי אופציונלי. מזהה הלקוח של לקוח ה-API של Workday שמשמש לגישה ל-Workday Data Lake בתהליך האימות של OIDC.

IdentityMode

מצב הזהות שבו הקטלוג משתמש לשאילתות.

טיפוסים בני מנייה (enum)
IDENTITY_MODE_UNSPECIFIED ערך ברירת מחדל/לא מוגדר. הערך הזה מטופל כמו IDENTITY_MODE_SERVICE_IDENTITY.
IDENTITY_MODE_SERVICE_IDENTITY השאילתות מופעלות באמצעות חשבון השירות ב-google.cloud.biglake.v1main.IcebergCatalog.biglake_service_account.
IDENTITY_MODE_USER_IDENTITY_FEDERATION

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

מידע נוסף זמין בכתובת https://docs.cloud.google.com/lakehouse/docs/about-cross-cloud-data-access#identity-mode.

UserIdentityFederationOidcClaims

הצהרות OIDC שמונפקות בטוקן של המזהה כש-IDENTITY_MODE_USER_IDENTITY_FEDERATION מופעל.

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

ייצוג ב-JSON
{
  "issuer-url": string,
  "audience": string
}
שדות
issuer-url

string

פלט בלבד. כתובת ה-URL של המנפיק של ספק הזהויות.

audience

string

פלט בלבד. הקהל שהקטלוג הזה מצפה לו באסימון.

UserIdentityFederationOidc

הגדרת OIDC שמשמשת כש-IDENTITY_MODE_USER_IDENTITY_FEDERATION מופעל.

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

ייצוג ב-JSON
{
  "issuer-url": string,
  "audience": string,
  "jwks-url": string
}
שדות
issuer-url

string

פלט בלבד. כתובת ה-URL של המנפיק של ספק הזהויות.

audience

string

פלט בלבד. הקהל שהקטלוג הזה מצפה לו באסימון.

jwks-url

string

פלט בלבד. כתובת ה-URL של JSON Web Key Set‏ (JWKS) שמספקת את המפתחות הציבוריים שמשמשים לאימות הטוקן. מוגדר רק לקטלוגים מאוחדים של Snowflake Horizon, שבהם הוא משמש כ-EXTERNAL_OAUTH_JWS_KEYS_URL בשילוב האבטחה של Snowflake.

RefreshOptions

מרעננים את ההגדרות.

ייצוג ב-JSON
{
  "refresh-schedule": {
    object (RefreshSchedule)
  },
  "refresh-scope": {
    object (RefreshScope)
  }
}
שדות
refresh-schedule

object (RefreshSchedule)

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

refresh-scope

object (RefreshScope)

זה שינוי אופציונלי. רענון הגדרות ההיקף.

RefreshSchedule

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

ייצוג ב-JSON
{
  "refresh-interval": string
}
שדות
refresh-interval

string (Duration format)

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

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

RefreshScope

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

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

string

זה שינוי אופציונלי. מסננים שקובעים אילו מרחבי שמות נכללים בתהליך הרענון. - רשימה ריקה פירושה לכלול את כל מרחבי השמות. ‫- "[namespaces]" פירושו לכלול את מרחבי השמות שצוינו. ‫['ns1', 'ns2'] : גילוי רק של מרחבי השמות 'ns1' ו-'ns2'.

RefreshStatus

סטטוס הרענון של המטא-נתונים ברקע של הקטלוג המרוחק.

ייצוג ב-JSON
{
  "start-time": string,
  "end-time": string,
  "status": {
    object (Status)
  }
}
שדות
start-time

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

end-time

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

status

object (Status)

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

CrossCloudCacheOptions

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

ייצוג ב-JSON
{
  "enabled": boolean
}
שדות
enabled

boolean

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

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

אם הערך הוא false, השמירה במטמון חוצה-עננים מושבתת.

Methods

create

יוצר את קטלוג REST של Iceberg.

delete

מחיקת קטלוג REST של Iceberg.

failover

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

get

הפונקציה מחזירה את אפשרויות ההגדרה של קטלוג REST של Iceberg.

list

הצגת רשימה של קטלוגי REST של Iceberg.

patch

מעדכנים את אפשרויות ההגדרה של קטלוג REST של Iceberg.