Prefect Docs

# Tenant

# TenantView

class

prefect.backend.tenant.TenantView

(tenant_id, name, slug)[source]

A view of tenant data stored in the Prefect API.

This object is designed to be an immutable view of the data stored in the Prefect backend API at the time it is created

Args:

  • tenant_id: The uuid of the tenant
  • name: The name of the tenant
  • slug: A machine compatible unique identifier for the tenant

methods:                                                                                                                                                       

prefect.backend.tenant.TenantView.from_current_tenant

()[source]

Get an instance of this class filled with information by querying for the tenant id set in the Prefect Client

Returns: A populated TenantView instance

prefect.backend.tenant.TenantView.from_tenant_id

(tenant_id)[source]

Get an instance of this class filled with information by querying for the given tenant id

Args:

  • tenant_id: the tenant to lookup
Returns: A populated TenantView instance


This documentation was auto-generated from commit bd9182e
on July 31, 2024 at 18:02 UTC

← Client →