Touchclient

TouchClient(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)

Touch client class to send a trace that can be used to update accessed_at for file or dataset DIDs

Constructor of the BaseClient.

Parameters:

Name	Type	Description	Default
rucio_host	Optional[str]	The address of the rucio server, if None it is read from the config file.	None
rucio_port		The port of the rucio server, if None it is read from the config file.	required
auth_host	Optional[str]	The address of the rucio authentication server, if None it is read from the config file.	None
auth_port		The port of the rucio authentication server, if None it is read from the config file.	required
account	Optional[str]	The account to authenticate to rucio.	None
use_ssl		Enable or disable ssl for commucation. Default is enabled.	required
ca_cert	Optional[str]	The path to the rucio server certificate.	None
auth_type	Optional[str]	The type of authentication (e.g.: 'userpass', 'kerberos' ...)	None
creds	Optional[dict[str, Any]]	Dictionary with credentials needed for authentication.	None
user_agent	Optional[str]	Indicates the client.	'rucio-clients'
vo	Optional[str]	The VO to authenticate into.	None
logger	Logger	Logger object to use. If None, use the default LOG created by the module	LOG

touch(scope, name, rse=None)

Sends a touch trace for a given file or dataset.

Parameters:

Name	Type	Description	Default
scope	str	the scope of the file/dataset to update.	required
name	str	the name of file/dataset to update.	required
rse	Optional[str]	optional parameter if a specific replica should be touched.	None

Raises:

Type	Description
DataIdentifierNotFound	if given dids does not exist.
RSENotFound	if rse is not None and given rse does not exist.
UnsupportedDIDType	if type of the given DID is not FILE or DATASET.
RucioException	if trace could not be sent successfully.