lsst.obs.base  16.0-35-g468643a+1
Static Public Attributes | List of all members
lsst.obs.base.gen3.ingest.RawIngestConfig Class Reference
Inheritance diagram for lsst.obs.base.gen3.ingest.RawIngestConfig:

Static Public Attributes

 transfer
 
 conflict
 
 stash
 
 onError
 

Detailed Description

Definition at line 41 of file ingest.py.

Member Data Documentation

◆ conflict

lsst.obs.base.gen3.ingest.RawIngestConfig.conflict
static
Initial value:
= ChoiceField(
("What to do if a raw Dataset with the same data ID as an "
"ingested file already exists in the Butler's Collection."),
dtype=str,
allowed={"ignore": ("Do not add the new file to the Collection. If "
"'stash' is not None, the new file will be "
"ingested into the stash Collection instead."),
"fail": ("Raise RuntimeError if a conflict is encountered "
"(which may then be caught if onError == 'continue')."),
},
optional=False,
default="ignore",
)

Definition at line 51 of file ingest.py.

◆ onError

lsst.obs.base.gen3.ingest.RawIngestConfig.onError
static
Initial value:
= ChoiceField(
"What to do if an error (including fatal conflicts) occurs.",
dtype=str,
allowed={"continue": "Warn and continue with the next file.",
"break": ("Stop processing immediately, but leave "
"already-ingested datasets in the repository."),
"rollback": ("Stop processing and attempt to remove aleady-"
"ingested datasets from the repository."),
},
optional=False,
default="continue",
)

Definition at line 69 of file ingest.py.

◆ stash

lsst.obs.base.gen3.ingest.RawIngestConfig.stash
static
Initial value:
= Field(
"Name of an alternate Collection to hold Datasets that lose conflicts.",
dtype=str,
default=None,
)

Definition at line 64 of file ingest.py.

◆ transfer

lsst.obs.base.gen3.ingest.RawIngestConfig.transfer
static
Initial value:
= ChoiceField(
("How to transfer files (None for no transfer)."),
dtype=str,
allowed={"move": "move",
"copy": "copy",
"hardlink": "hard link",
"symlink": "symbolic (soft) link"},
optional=True,
)

Definition at line 42 of file ingest.py.


The documentation for this class was generated from the following file: