antimatter.session_mixins.read_context_mixin#

Module Contents#

Classes#

ReadContextMixin

Session mixin defining CRUD functionality for read contexts.
class antimatter.session_mixins.read_context_mixin.ReadContextMixin(authz: antimatter.authz.Authorization, **kwargs)#

Bases: antimatter.session_mixins.base.BaseMixin

Session mixin defining CRUD functionality for read contexts.

add_read_context(name: str, builder: antimatter.builders.ReadContextBuilder) → None#

Upserts a read context for the current domain and auth

Parameters:

  • name – The name of the read context to add or update

  • builder – The builder containing read context configuration

list_read_context() → List[antimatter_api.ReadContextShortDetails]#

Returns a list of read contexts available for the current domain and auth

describe_read_context(name: str) → antimatter_api.ReadContextDetails#

Returns the read context with the given name for the current domain and auth

Parameters:

name – The name of the read context to describe

Returns:

The full details of the read context

delete_read_context(name: str) → None#

Delete a read context. All configuration associated with this read context will also be deleted. Domain policy rules referencing this read context will be left as-is.

Parameters:

name – The name of the read context to delete