vaccines

Documentation

Index

• type APIBatchResponse
  • func (b APIBatchResponse) GetAttributeNames() []string
  • func (b APIBatchResponse) GetAttributeValues() (values []float64)
  • func (b APIBatchResponse) GetGroupFieldValue(groupField int) (value string)
  • func (b APIBatchResponse) GetTimestamp() time.Time
  • func (b APIBatchResponse) GetTotalValue() float64
• type Client
  • func (client *Client) GetBatches(ctx context.Context) (batches []apiclient.APIResponse, err error)
  • func (client *Client) Update(ctx context.Context, ch chan<- cache.FetcherResponse)
• type Getter
• type Timestamp
  • func (date *Timestamp) UnmarshalJSON(b []byte) (err error)

Types

type APIBatchResponse

type APIBatchResponse struct {
	Date         Timestamp `json:"date"`
	Manufacturer string    `json:"manufacturer"`
	Amount       int       `json:"amount"`
}

APIBatchResponse represents one batch of vaccines

func (APIBatchResponse) GetAttributeNames

func (b APIBatchResponse) GetAttributeNames() []string

GetAttributeNames returns the names of the types of vaccinations

func (APIBatchResponse) GetAttributeValues

func (b APIBatchResponse) GetAttributeValues() (values []float64)

GetAttributeValues gets the value for each supported type of vaccination

func (APIBatchResponse) GetGroupFieldValue

func (b APIBatchResponse) GetGroupFieldValue(groupField int) (value string)

GetGroupFieldValue returns the value of a groupable field. Not used for APIBatchResponse.

func (APIBatchResponse) GetTimestamp

func (b APIBatchResponse) GetTimestamp() time.Time

GetTimestamp returns the batch's timestamp

func (APIBatchResponse) GetTotalValue

func (b APIBatchResponse) GetTotalValue() float64

GetTotalValue returns the entry's total number of vaccines

type Client

type Client struct {
	URL        string
	HTTPClient *http.Client
	cache.Cache
	Metrics metrics.APIClientMetrics
}

Client calls the API to retrieve vaccine batches

func (*Client) GetBatches

func (client *Client) GetBatches(ctx context.Context) (batches []apiclient.APIResponse, err error)

GetBatches returns all vaccine batches

func (*Client) Update

func (client *Client) Update(ctx context.Context, ch chan<- cache.FetcherResponse)

Update calls all endpoints and returns this to the caller. This is used by a cache to refresh its content

type Getter

type Getter interface {
	GetBatches(ctx context.Context) (batches []apiclient.APIResponse, err error)
}

Getter interface retrieves vaccine batches

type Timestamp

type Timestamp struct {
	time.Time
}

Timestamp representation for APIBatchResponse. Needed to unmarshal the date as received from the API

func (*Timestamp) UnmarshalJSON

func (date *Timestamp) UnmarshalJSON(b []byte) (err error)

UnmarshalJSON unmarshals the Timestamp in a APIBatchResponse