Class Reader

Class that supports reading metrics from S3. It initializes an S3 client, and then uses this to read metrics based on their key and a time interval.

Hierarchy

Reader

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Reader(s3Bucket: string, s3Client: S3): Reader

- Defined in reader.ts:17
Parameters
- s3Bucket: string
- s3Client: S3
Returns Reader

Properties

s3Bucket

s3Bucket: string

s3Client

s3Client: S3

Methods

readMetrics

readMetrics(key: MetricKey, from: Date, to: Date): Promise<Metric[]>

- Defined in reader.ts:37
Reads all the metrics for the given key that are within the given time interval.

Parameters
- key: MetricKey
  
  The metric we are looking for.
- from: Date
  
  The date from which we want to read the metrics
- to: Date
  
  The to date we want to read the metrics to.
Returns Promise<Metric[]>

Private readMetricsFromObject

readMetricsFromObject(objectKey: string): Promise<Metric[]>

- Defined in reader.ts:67
Parameters
- objectKey: string
Returns Promise<Metric[]>

Static builder

builder(): IBuilder<Reader>

- Defined in reader.ts:24
Returns IBuilder<Reader>

Generated using TypeDoc