scicat-backend-next documentation
  1. Classes
  2. CreateOrigDatablockDto

File

src/origdatablocks/dto/create-origdatablock.dto.ts

Extends

OwnableDto

Index

Properties

Properties

Readonly chkAlg
Type : string
Decorators :
@ApiProperty({type: String, required: false, description: 'Name of the hashing algorithm used to compute the hash for each file.'})
@IsOptional()
@IsString()
@IsNotEmpty()
Defined in src/origdatablocks/dto/create-origdatablock.dto.ts:43
Readonly dataFileList
Type : DataFile[]
Decorators :
@ApiProperty({type: 'array', items: undefined, required: true, description: 'List of the files contained in this orig datablock.'})
@IsArray()
@ArrayNotEmpty()
@ValidateNested({each: true})
@Type(undefined)
Defined in src/origdatablocks/dto/create-origdatablock.dto.ts:55
Readonly datasetId
Type : string
Decorators :
@ApiProperty({type: String, required: true, description: 'Persistent identifier of the dataset this orig datablock belongs to.'})
@IsString()
Defined in src/origdatablocks/dto/create-origdatablock.dto.ts:24
Readonly ownerGroup
Type : string
Decorators :
@ApiProperty({type: String, required: false, description: 'Name of the group owning this item. If it is not specified, the datasets owner group is used.'})
@IsOptional()
@IsString()
@IsNotEmpty()
Inherited from OwnableDto
Defined in OwnableDto:66
Readonly size
Type : number
Decorators :
@ApiProperty({type: Number, required: true, description: 'Total size of the files in this orig datablock'})
@IsInt()
Defined in src/origdatablocks/dto/create-origdatablock.dto.ts:32
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 
import { Type } from "class-transformer";
import {
  ArrayNotEmpty,
  IsArray,
  IsInt,
  IsOptional,
  IsString,
  IsNotEmpty,
  ValidateNested,
} from "class-validator";
import { DataFileDto } from "src/common/dto/datafile.dto";
import { OwnableDto } from "src/common/dto/ownable.dto";
import { DataFile } from "../../common/schemas/datafile.schema";
import { ApiProperty, getSchemaPath } from "@nestjs/swagger";

export class CreateOrigDatablockDto extends OwnableDto {
  @ApiProperty({
    type: String,
    required: true,
    description:
      "Persistent identifier of the dataset this orig datablock belongs to.",
  })
  @IsString()
  readonly datasetId: string;

  @ApiProperty({
    type: Number,
    required: true,
    description: "Total size of the files in this orig datablock",
  })
  @IsInt()
  readonly size: number;

  @ApiProperty({
    type: String,
    required: false,
    description:
      "Name of the hashing algorithm used to compute the hash for each file.",
  })
  @IsOptional()
  @IsString()
  @IsNotEmpty()
  readonly chkAlg: string;

  @ApiProperty({
    type: "array",
    items: { $ref: getSchemaPath(DataFile) },
    required: true,
    description: "List of the files contained in this orig datablock.",
  })
  @IsArray()
  @ArrayNotEmpty()
  @ValidateNested({ each: true })
  @Type(() => DataFileDto)
  readonly dataFileList: DataFile[];

  @ApiProperty({
    type: String,
    required: false,
    description:
      "Name of the group owning this item. If it is not specified, the datasets owner group is used.",
  })
  @IsOptional()
  @IsString()
  @IsNotEmpty()
  declare readonly ownerGroup: string;
}

results matching ""

    No results matching ""