Name reference

Functions defining shared names of various entities in the transfer system.

BucketNamer

Bases: Protocol

Protocol for bucket naming

control_bucket

control_bucket(stem: str, dataset: str, delivery_id: str, az_id: str) -> str

Parameters:

• stem (str) –

  global bucket name stem

• dataset (str) –

  dataset as specified in label

• delivery_id (str) –

  delivery id as specified in label

• az_id (str) –

  short AWS availability zone ID (e.g. 'use1-az4')

Returns:

• str –

  Control bucket name.

index_key

index_key(dataset: str, delivery_id: str, transfer_type: TransferType) -> str

Parameters:

• dataset (str) –

  dataset as specified in label

• delivery_id (str) –

  delivery id as specified in label

• transfer_type (TransferType) –

  'sample' or 'staging'

Returns:

• str –

  Key of CSV index object.

label_key

label_key(dataset_name: str, delivery_id: str | int) -> str

Parameters:

• dataset_name (str) –

  dataset as specified in label

• delivery_id (str | int) –

  delivery id as specified in label

Returns:

• str –

  Key of YAML label.

lock_key

lock_key(writer: TransferEntity) -> str

Parameters:

• writer (TransferEntity) –

  'client', 'validator', or 'lambda'

Returns:

• str –

  Key of lock object containing agent_id of current holder.

log_key

log_key(transfer_type: TransferType, writer: TransferEntity) -> str

Parameters:

• transfer_type (TransferType) –

  'sample' or 'staging'

• writer (TransferEntity) –

  'client' or 'validator'

Returns:

• str –

  Key of TSV log object.

regularize_bucket_name

regularize_bucket_name(func: BucketNamer) -> BucketNamer

Regularize an S3 bucket name

transfer_bucket

transfer_bucket(stem: str, dataset: str, delivery_id: str, transfer_type: TransferType) -> str

Parameters:

• stem (str) –

  global bucket name stem

• dataset (str) –

  dataset as specified in label

• delivery_id (str) –

  delivery id as specified in label

• transfer_type (TransferType) –

  'sample' or 'staging'

Returns:

• str –

  Transfer bucket name.

validation_task

validation_task(dataset: str, delivery_id: str) -> str

Parameters:

• dataset (str) –

  dataset as specified in label

• delivery_id (str) –

  delivery id as specified in label

Returns:

• str –

  Validation task name.