File

src/datasets/dto/update-dataset.dto.ts

Extends

CreateDatasetDto

Index

Properties

Readonly Optional classification
Readonly Optional comment
Readonly contactEmail
Readonly creationTime
Readonly Optional dataQualityMetrics
Readonly datasetlifecycle
Readonly Optional datasetName
Readonly Optional description
Readonly Optional isPublished
Readonly Optional keywords
Readonly Optional license
Readonly Optional numberOfFiles
Readonly Optional numberOfFilesArchived
Readonly Optional orcidOfOwner
Readonly owner
Readonly Optional ownerEmail
Readonly Optional packedSize
Optional pid
Readonly Optional relationships
Readonly Optional scientificMetadata
Readonly Optional sharedWith
Readonly Optional size
Readonly sourceFolder
Readonly Optional sourceFolderHost
Readonly Optional techniques
Readonly type
Readonly Optional validationStatus
Readonly Optional version
Readonly Optional accessGroups
Readonly Optional instrumentGroup
Readonly ownerGroup

Properties

Readonly Optional classification

Type : string

Decorators :


                            @ApiProperty({type: String, required: false, description: 'ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low''})
@IsOptional()
@IsString()

Inherited from CreateDatasetDto

Defined in CreateDatasetDto:207

Readonly Optional comment

Type : string

Decorators :


                            @ApiProperty({type: String, required: false, description: 'Comment the user has about a given dataset.'})
@IsOptional()
@IsString()

Inherited from CreateDatasetDto

Defined in CreateDatasetDto:305

Readonly contactEmail

Type : string

Decorators :


                            @ApiProperty({type: String, required: true, description: 'Email of the contact person for this dataset. The string may contain a list of emails, which should then be separated by semicolons.'})
@IsEmail()

Inherited from CreateDatasetDto

Defined in CreateDatasetDto:72

Readonly creationTime

Type : Date

Decorators :


                            @ApiProperty({type: Date, required: true, description: 'Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server.'})
@IsDateString()

Inherited from CreateDatasetDto

Defined in CreateDatasetDto:146

Readonly Optional dataQualityMetrics

Type : number

Decorators :


                            @ApiProperty({type: Number, required: false, description: 'Data Quality Metrics is a number given by the user to rate the dataset.'})
@IsOptional()
@IsNumber()

Inherited from CreateDatasetDto

Defined in CreateDatasetDto:315

Readonly datasetlifecycle

Type : LifecycleClass

Decorators :


                            @ApiProperty({type: LifecycleClass, required: false, default: undefined, description: 'Describes the current status of the dataset during its lifetime with respect to the storage handling systems.'})
@IsOptional()

Inherited from CreateDatasetDto

Defined in CreateDatasetDto:286

Readonly Optional datasetName

Type : string

Decorators :


                            @ApiProperty({type: String, required: false, description: 'A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder.'})
@IsOptional()
@IsString()

Inherited from CreateDatasetDto

Defined in CreateDatasetDto:197

Readonly Optional description

Type : string

Decorators :


                            @ApiProperty({type: String, required: false, description: 'Free text explanation of contents of dataset.'})
@IsOptional()
@IsString()

Inherited from CreateDatasetDto

Defined in CreateDatasetDto:187

Readonly Optional isPublished

Type : boolean

Decorators :


                            @ApiProperty({type: Boolean, required: false, default: false, description: 'Flag is true when data are made publicly available.'})
@IsOptional()
@IsBoolean()

Inherited from CreateDatasetDto

Defined in CreateDatasetDto:236

Readonly Optional keywords

Type : string[]

Decorators :


                            @ApiProperty({type: undefined, required: false, description: 'Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs.'})
@IsOptional()
@IsString({each: true})

Inherited from CreateDatasetDto

Defined in CreateDatasetDto:178

Readonly Optional license

Type : string

Decorators :


                            @ApiProperty({type: String, required: false, description: 'Name of the license under which the data can be used.'})
@IsOptional()
@IsString()

Inherited from CreateDatasetDto

Defined in CreateDatasetDto:216

Readonly Optional numberOfFiles

Type : number

Default value : 0

Decorators :


                            @ApiProperty({type: Number, default: 0, required: false, description: 'Total number of files in all OrigDatablocks for this dataset.'})
@IsOptional()
@IsInt()

Inherited from CreateDatasetDto

Defined in CreateDatasetDto:127

Readonly Optional numberOfFilesArchived

Type : number

Decorators :


                            @ApiProperty({type: Number, default: 0, required: true, description: 'Total number of files in all Datablocks for this dataset.'})
@IsOptional()
@IsInt()

Inherited from CreateDatasetDto

Defined in CreateDatasetDto:137

Readonly Optional orcidOfOwner

Type : string

Decorators :


                            @ApiProperty({type: String, required: false, description: 'ORCID of the owner or custodian. The string may contain a list of ORCIDs, which should then be separated by semicolons.'})
@IsOptional()
@IsString()

Inherited from CreateDatasetDto

Defined in CreateDatasetDto:63

Readonly owner

Type : string

Decorators :


                            @ApiProperty({type: String, required: true, description: 'Owner or custodian of the dataset, usually first name + last name. The string may contain a list of persons, which should then be separated by semicolons.'})
@IsString()

Inherited from CreateDatasetDto

Defined in CreateDatasetDto:43

Readonly Optional ownerEmail

Type : string

Decorators :


                            @ApiProperty({type: String, required: false, description: 'Email of the owner or custodian of the dataset. The string may contain a list of emails, which should then be separated by semicolons.'})
@IsOptional()
@IsEmail()

Inherited from CreateDatasetDto

Defined in CreateDatasetDto:53

Readonly Optional packedSize

Type : number

Default value : 0

Decorators :


                            @ApiProperty({type: Number, default: 0, required: false, description: 'Total size of all datablock package files created for this dataset.'})
@IsOptional()
@IsInt()

Inherited from CreateDatasetDto

Defined in CreateDatasetDto:116

Optional pid

Type : string

Decorators :


                            @ApiProperty({type: String, required: false, description: 'Persistent identifier of the dataset.'})
@IsOptional()
@IsString()

Inherited from CreateDatasetDto

Defined in CreateDatasetDto:34

Readonly Optional relationships

Type : RelationshipClass[]

Decorators :


                            @ApiProperty({type: 'array', items: undefined, required: false, default: undefined, description: 'Stores the relationships with other datasets.'})
@IsArray()
@IsOptional()
@ValidateNested({each: true})
@Type(undefined)

Inherited from CreateDatasetDto

Defined in CreateDatasetDto:276

Readonly Optional scientificMetadata

Type : Record<string | >

Decorators :


                            @ApiProperty({type: Object, required: false, default: undefined, description: 'JSON object containing the scientific metadata.'})
@IsOptional()
@IsObject()

Inherited from CreateDatasetDto

Defined in CreateDatasetDto:296

Readonly Optional sharedWith

Type : string[]

Decorators :


                            @ApiProperty({type: undefined, required: false, default: undefined, description: 'List of users that the dataset has been shared with.'})
@IsOptional()
@IsString({each: true})

Inherited from CreateDatasetDto

Defined in CreateDatasetDto:262

Readonly Optional size

Type : number

Default value : 0

Decorators :


                            @ApiProperty({type: Number, default: 0, required: false, description: 'Total size of all source files contained in source folder on disk when unpacked.'})
@IsOptional()
@IsInt()

Inherited from CreateDatasetDto

Defined in CreateDatasetDto:105

Readonly sourceFolder

Type : string

Decorators :


                            @ApiProperty({type: String, required: true, description: 'Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed.'})
@IsString()

Inherited from CreateDatasetDto

Defined in CreateDatasetDto:81

Readonly Optional sourceFolderHost

Type : string

Decorators :


                            @ApiProperty({type: String, required: false, description: 'DNS host name of file server hosting sourceFolder, optionally including a protocol e.g. [protocol://]fileserver1.example.com'})
@IsOptional()
@IsFQDN()

Inherited from CreateDatasetDto

Defined in CreateDatasetDto:91

Readonly Optional techniques

Type : TechniqueClass[]

Decorators :


                            @ApiProperty({type: 'array', items: undefined, required: false, default: undefined, description: 'Stores the metadata information for techniques.'})
@IsOptional()
@IsArray()
@ValidateNested({each: true})
@Type(undefined)

Inherited from CreateDatasetDto

Defined in CreateDatasetDto:249

Readonly type

Type : string

Decorators :


                            @ApiProperty({type: String, required: true, enum: undefined, description: 'Characterize type of dataset, either 'raw' or 'derived'. Autofilled when choosing the proper inherited models.'})
@IsEnum(DatasetType)

Inherited from CreateDatasetDto

Defined in CreateDatasetDto:156

Readonly Optional validationStatus

Type : string

Decorators :


                            @ApiProperty({type: String, required: false, description: 'Defines a level of trust, e.g. a measure of how much data was verified or used by other persons.'})
@IsOptional()
@IsString()

Inherited from CreateDatasetDto

Defined in CreateDatasetDto:166

Readonly Optional version

Type : string

Decorators :


                            @ApiProperty({type: String, required: false, description: 'Version of the API used in creation of the dataset.'})
@IsOptional()
@IsString()

Inherited from CreateDatasetDto

Defined in CreateDatasetDto:225

Readonly Optional accessGroups

Type : string[]

Decorators :


                            @ApiProperty({type: undefined, required: false, description: 'List of groups which have access to this item.'})
@IsOptional()
@IsString({each: true})

Inherited from OwnableDto

Defined in OwnableDto:22

Readonly Optional instrumentGroup

Type : string

Decorators :


                            @ApiProperty({type: String, required: false, description: 'Group of the instrument which this item was acquired on.'})
@IsOptional()
@IsString()

Inherited from OwnableDto

Defined in OwnableDto:31

Readonly ownerGroup

Type : string

Decorators :


                            @ApiProperty({type: String, required: true, description: 'Name of the group owning this item.'})
@IsString()

Inherited from OwnableDto

Defined in OwnableDto:11

import { PartialType } from "@nestjs/swagger";
import { CreateDatasetDto } from "./create-dataset.dto";

export class UpdateDatasetDto extends CreateDatasetDto {}
export class PartialUpdateDatasetDto extends PartialType(CreateDatasetDto) {}

File

Extends

Index

Properties

Properties

results matching ""

No results matching ""