Prefect Docs

# Tenant

Experimental

The functionality here is experimental, and may change between versions without notice. Use at your own risk.

# 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

EXPERIMENTAL: This interface is experimental and subject to change

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 n/a
on February 23, 2022 at 19:26 UTC

← Client →