Package Classes (0.1.0)

Summary of entries of Classes for google-cloud-biglake.

Classes

IcebergCatalogServiceAsyncClient

Iceberg Catalog Service API: this implements the open-source Iceberg REST Catalog API. See the API definition here: https://github.com/apache/iceberg/blob/main/open-api/rest-catalog-open-api.yaml

The API is defined as OpenAPI 3.1.1 spec.

Currently we only support the following methods:

  • GetConfig/GetIcebergCatalogConfig
  • ListIcebergNamespaces
  • CheckIcebergNamespaceExists
  • GetIcebergNamespace
  • CreateIcebergNamespace (only supports single level)
  • DeleteIcebergNamespace
  • UpdateIcebergNamespace properties
  • ListTableIdentifiers
  • CreateIcebergTable
  • DeleteIcebergTable
  • GetIcebergTable
  • UpdateIcebergTable (CommitTable)
  • LoadIcebergTableCredentials
  • RegisterTable

Users are required to provided the X-Goog-User-Project header with the project id or number which can be different from the bucket project id. That project will be charged for the API calls and the calling user must have access to that project. The caller must have serviceusage.services.use permission on the project.

IcebergCatalogServiceClient

Iceberg Catalog Service API: this implements the open-source Iceberg REST Catalog API. See the API definition here: https://github.com/apache/iceberg/blob/main/open-api/rest-catalog-open-api.yaml

The API is defined as OpenAPI 3.1.1 spec.

Currently we only support the following methods:

  • GetConfig/GetIcebergCatalogConfig
  • ListIcebergNamespaces
  • CheckIcebergNamespaceExists
  • GetIcebergNamespace
  • CreateIcebergNamespace (only supports single level)
  • DeleteIcebergNamespace
  • UpdateIcebergNamespace properties
  • ListTableIdentifiers
  • CreateIcebergTable
  • DeleteIcebergTable
  • GetIcebergTable
  • UpdateIcebergTable (CommitTable)
  • LoadIcebergTableCredentials
  • RegisterTable

Users are required to provided the X-Goog-User-Project header with the project id or number which can be different from the bucket project id. That project will be charged for the API calls and the calling user must have access to that project. The caller must have serviceusage.services.use permission on the project.

ListIcebergCatalogsAsyncPager

A pager for iterating through list_iceberg_catalogs requests.

This class thinly wraps an initial ListIcebergCatalogsResponse object, and provides an __aiter__ method to iterate through its iceberg_catalogs field.

If there are more pages, the __aiter__ method will make additional ListIcebergCatalogs requests and continue to iterate through the iceberg_catalogs field on the corresponding responses.

All the usual ListIcebergCatalogsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListIcebergCatalogsPager

A pager for iterating through list_iceberg_catalogs requests.

This class thinly wraps an initial ListIcebergCatalogsResponse object, and provides an __iter__ method to iterate through its iceberg_catalogs field.

If there are more pages, the __iter__ method will make additional ListIcebergCatalogs requests and continue to iterate through the iceberg_catalogs field on the corresponding responses.

All the usual ListIcebergCatalogsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

CreateIcebergCatalogRequest

The request message for the CreateIcebergCatalog API.

FailoverIcebergCatalogRequest

Request message for FailoverIcebergCatalog.

FailoverIcebergCatalogResponse

Response message for FailoverIcebergCatalog.

GetIcebergCatalogRequest

The request message for the GetIcebergCatalog API.

IcebergCatalog

The Iceberg REST Catalog information.

CatalogType

Determines the catalog type.

CredentialMode

The credential mode used for the catalog.

    See:
    https://github.com/apache/iceberg/blob/931865ecaf40a827f9081dddb675bf1c95c05461/open-api/rest-catalog-open-api.yaml#L1854
    for more details.

ListIcebergCatalogsRequest

The request message for the ListIcebergCatalogs API.

CatalogView

The enumeration of the views that can be returned.

ListIcebergCatalogsResponse

The response message for the ListIcebergCatalogs API.

UpdateIcebergCatalogRequest

The request message for the UpdateIcebergCatalog API.

Modules

pagers

API documentation for biglake_v1.services.iceberg_catalog_service.pagers module.