Subscriptionclient

Classes¶

SubscriptionClient ¶

SubscriptionClient(
    rucio_host=None,
    auth_host=None,
    account=None,
    ca_cert=None,
    auth_type=None,
    creds=None,
    timeout=600,
    user_agent="rucio-clients",
    vo=None,
    logger=LOG,
)

SubscriptionClient class for working with subscriptions

Functions¶

add_subscription ¶

add_subscription(
    name,
    account,
    filter_,
    replication_rules,
    comments,
    lifetime,
    retroactive,
    dry_run,
    priority=3,
)

Adds a new subscription which will be verified against every new added file and dataset

PARAMETER	DESCRIPTION
`name`	Name of the subscription TYPE: `str`
`account`	Account identifier TYPE: `str`
`filter_`	Dictionary of attributes by which the input data should be filtered Example: `{'dsn': 'data11_hi.express_express.,data11_hiphysics_MinBiasOverlay', 'account': 'tzero'}` TYPE: `dict[str, Any]`
`replication_rules`	Replication rules to be set : Dictionary with keys copies, rse_expression, weight, rse_expression TYPE: `dict[str, Any]`
`comments`	Comments for the subscription TYPE: `str`
`lifetime`	Subscription's lifetime (days); False if subscription has no lifetime TYPE: `Union[int, Literal[False]]`
`retroactive`	Flag to know if the subscription should be applied on previous data TYPE: `bool`
`dry_run`	Just print the subscriptions actions without actually executing them (Useful if retroactive flag is set) TYPE: `bool`
`priority`	The priority of the subscription (3 by default) TYPE: `int` DEFAULT: `3`

list_subscriptions ¶

list_subscriptions(name=None, account=None)

Returns a dictionary with the subscription information : Examples: {'status': 'INACTIVE/ACTIVE/BROKEN', 'last_modified_date': ...}

PARAMETER	DESCRIPTION
`name`	Name of the subscription TYPE: `Optional[str]` DEFAULT: `None`
`account`	Account identifier TYPE: `Optional[dict[str, Any]]` DEFAULT: `None`

RETURNS	DESCRIPTION
`Union[Iterator[dict[str, Any]], list]`	Dictionary containing subscription parameter

update_subscription ¶

update_subscription(
    name,
    account=None,
    filter_=None,
    replication_rules=None,
    comments=None,
    lifetime=None,
    retroactive=None,
    dry_run=None,
    priority=None,
)

Updates a subscription

PARAMETER	DESCRIPTION
`name`	Name of the subscription
`account`	Account identifier TYPE: `Optional[str]` DEFAULT: `None`
`filter_`	Dictionary of attributes by which the input data should be filtered Example: `{'dsn': 'data11_hi.express_express.,data11_hiphysics_MinBiasOverlay', 'account': 'tzero'}` TYPE: `Optional[dict[str, Any]]` DEFAULT: `None`
`replication_rules`	Replication rules to be set : Dictionary with keys copies, rse_expression, weight, rse_expression TYPE: `Optional[dict[str, Any]]` DEFAULT: `None`
`comments`	Comments for the subscription TYPE: `Optional[str]` DEFAULT: `None`
`lifetime`	Subscription's lifetime (days); False if subscription has no lifetime TYPE: `Optional[Union[int, Literal[False]]]` DEFAULT: `None`
`retroactive`	Flag to know if the subscription should be applied on previous data TYPE: `Optional[bool]` DEFAULT: `None`
`dry_run`	Just print the subscriptions actions without actually executing them (Useful if retroactive flag is set) TYPE: `Optional[bool]` DEFAULT: `None`
`priority`	The priority of the subscription TYPE: `Optional[int]` DEFAULT: `None`

list_subscription_rules ¶

list_subscription_rules(account, name)

List the associated rules of a subscription.

PARAMETER	DESCRIPTION
`account`	Account of the subscription. TYPE: `str`
`name`	Name of the subscription. TYPE: `str`