src/crypto/key/dto/provider-health-response.dto.ts

Index

Properties

Properties

Optional error
Type : string
Decorators :
@ApiProperty({description: 'Optional health check error', required: false})
Optional latencyMs
Type : number
Decorators :
@ApiProperty({description: 'Health check latency in milliseconds', required: false})
ok
Type : boolean
Decorators :
@ApiProperty({description: 'Whether the provider health check passed'})
providerId
Type : string
Decorators :
@ApiProperty({description: 'KMS provider id'})
type
Type : string
Decorators :
@ApiProperty({description: 'KMS provider type'})
import { ApiProperty } from "@nestjs/swagger";

export class ProviderHealthResponseDto {
    @ApiProperty({ description: "KMS provider id" })
    providerId!: string;

    @ApiProperty({ description: "KMS provider type" })
    type!: string;

    @ApiProperty({ description: "Whether the provider health check passed" })
    ok!: boolean;

    @ApiProperty({
        description: "Health check latency in milliseconds",
        required: false,
    })
    latencyMs?: number;

    @ApiProperty({
        description: "Optional health check error",
        required: false,
    })
    error?: string;
}

results matching ""

    No results matching ""