v1

package
v0.16.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 18, 2020 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Overview

Package v1 is a container for endpoints that are used to power the v1 of the service.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type BackFillEventsInput added in v0.15.0 

type BackFillEventsInput struct {
	From string `json:"from"`
	To   string `json:"to"`
}

BackFillEventsInput represents the incoming arguments to initiate schema back-fill

type BackFillEventsLocalHandler added in v0.15.0 

type BackFillEventsLocalHandler struct {
	LogFn  domain.LogFn
	Runner domain.BackFillSchemaRunner
}

BackFillEventsLocalHandler handles requests for local back-fill

func (*BackFillEventsLocalHandler) Handle added in v0.15.0 

func (h *BackFillEventsLocalHandler) Handle(ctx context.Context, input BackFillEventsInput) error

Handle handles the partition creation request

type CloudAssetChanges 

type CloudAssetChanges struct {
	Changes      []NetworkChanges  `json:"changes"`
	ChangeTime   string            `json:"changeTime"`
	ResourceType string            `json:"resourceType"`
	AccountID    string            `json:"accountId"`
	Region       string            `json:"region"`
	ARN          string            `json:"arn"`
	Tags         map[string]string `json:"tags"`
}

CloudAssetChanges represents the incoming payload

type CloudAssetDetails 

type CloudAssetDetails struct {
	PrivateIPAddresses []string          `json:"privateIpAddresses"`
	PublicIPAddresses  []string          `json:"publicIpAddresses"`
	Hostnames          []string          `json:"hostnames"`
	ResourceType       string            `json:"resourceType"`
	AccountID          string            `json:"accountId"`
	Region             string            `json:"region"`
	ARN                string            `json:"arn"`
	Tags               map[string]string `json:"tags"`
}

CloudAssetDetails represent an asset and associated attributes

type CloudAssetFetchAllByTimeStampPageParameters added in v0.9.0 

type CloudAssetFetchAllByTimeStampPageParameters struct {
	PageToken string `json:"pageToken"`
}

CloudAssetFetchAllByTimeStampPageParameters represents the request for subsequent pages of bulk fetching cloud assets

type CloudAssetFetchAllByTimestampParameters added in v0.9.0 

type CloudAssetFetchAllByTimestampParameters struct {
	Timestamp string `json:"time"`
	Count     uint   `json:"count"`
	Offset    uint   `json:"offset"`
	Type      string `json:"type"`
}

CloudAssetFetchAllByTimestampParameters represents the incoming payload for bulk fetching cloud assets for point in time with optional pagination

type CloudAssetFetchByHostnameParameters 

type CloudAssetFetchByHostnameParameters struct {
	Hostname  string `json:"hostname"`
	Timestamp string `json:"time"`
}

CloudAssetFetchByHostnameParameters represents the incoming payload for fetching cloud assets by hostname

type CloudAssetFetchByIPParameters 

type CloudAssetFetchByIPParameters struct {
	IPAddress string `json:"ipAddress"`
	Timestamp string `json:"time"`
}

CloudAssetFetchByIPParameters represents the incoming payload for fetching cloud assets by IP address

type CloudAssets 

type CloudAssets struct {
	Assets []CloudAssetDetails `json:"assets"`
}

CloudAssets represents a list of assets

type CloudFetchAllAssetsByTimeHandler added in v0.9.0 

type CloudFetchAllAssetsByTimeHandler struct {
	LogFn   domain.LogFn
	StatFn  domain.StatFn
	Fetcher domain.CloudAllAssetsByTimeFetcher
}

CloudFetchAllAssetsByTimeHandler defines a lambda handler for bulk fetching cloud assets known at specific point in time

func (*CloudFetchAllAssetsByTimeHandler) Handle added in v0.9.0 

func (h *CloudFetchAllAssetsByTimeHandler) Handle(ctx context.Context, input CloudAssetFetchAllByTimestampParameters) (PagedCloudAssets, error)

Handle handles fetching cloud assets with pagination

type CloudFetchAllAssetsByTimePageHandler added in v0.9.0 

type CloudFetchAllAssetsByTimePageHandler struct {
	LogFn   domain.LogFn
	StatFn  domain.StatFn
	Fetcher domain.CloudAllAssetsByTimeFetcher
}

CloudFetchAllAssetsByTimePageHandler defines a lambda handler for bulk fetching subsequent pages of cloud assets known at specific point in time

func (*CloudFetchAllAssetsByTimePageHandler) Handle added in v0.9.0 

func (h *CloudFetchAllAssetsByTimePageHandler) Handle(ctx context.Context, input CloudAssetFetchAllByTimeStampPageParameters) (PagedCloudAssets, error)

Handle handles subsequent page fetching of cloud assets

type CloudFetchByHostnameHandler 

type CloudFetchByHostnameHandler struct {
	LogFn   domain.LogFn
	StatFn  domain.StatFn
	Fetcher domain.CloudAssetByHostnameFetcher
}

CloudFetchByHostnameHandler defines a lambda handler for fetching cloud assets with a given hostname

func (*CloudFetchByHostnameHandler) Handle 

func (h *CloudFetchByHostnameHandler) Handle(ctx context.Context, input CloudAssetFetchByHostnameParameters) (CloudAssets, error)

Handle handles fetching cloud assets by hostname

type CloudFetchByIPHandler 

type CloudFetchByIPHandler struct {
	LogFn   domain.LogFn
	StatFn  domain.StatFn
	Fetcher domain.CloudAssetByIPFetcher
}

CloudFetchByIPHandler defines a lambda handler for fetching cloud assets with a given IP address

func (*CloudFetchByIPHandler) Handle 

func (h *CloudFetchByIPHandler) Handle(ctx context.Context, input CloudAssetFetchByIPParameters) (CloudAssets, error)

Handle handles fetching cloud assets by IP address

type CloudInsertHandler 

type CloudInsertHandler struct {
	LogFn            domain.LogFn
	StatFn           domain.StatFn
	CloudAssetStorer domain.CloudAssetStorer
}

CloudInsertHandler defines a lambda handler for inserting new cloud asset or changes to existing cloud assets

func (*CloudInsertHandler) Handle 

func (h *CloudInsertHandler) Handle(ctx context.Context, input CloudAssetChanges) error

Handle handles the insert operation for cloud assets

type CreatePartitionHandler added in v0.2.0 

type CreatePartitionHandler struct {
	LogFn     domain.LogFn
	Generator domain.PartitionGenerator
}

CreatePartitionHandler handles requests for creating the next time-based partition

func (*CreatePartitionHandler) Handle added in v0.2.0 

func (h *CreatePartitionHandler) Handle(ctx context.Context, input CreatePartitionInput) error

Handle handles the partition creation request

type CreatePartitionInput added in v0.2.0 

type CreatePartitionInput struct {
	Begin time.Time `json:"begin"`
	Days  int       `json:"days"`
}

CreatePartitionInput has two optional values begin - the start date for the partition days - the duration in number of days for which the partition will capture data

type DeletePartitionsHandler added in v0.4.0 

type DeletePartitionsHandler struct {
	LogFn   domain.LogFn
	Deleter domain.PartitionsDeleter
}

DeletePartitionsHandler handles requests for deleting partitions

func (*DeletePartitionsHandler) Handle added in v0.4.0 

func (h *DeletePartitionsHandler) Handle(ctx context.Context, input DeletePartitionsInput) error

Handle handles the partition creation request

type DeletePartitionsInput added in v0.4.0 

type DeletePartitionsInput struct {
	Name string `json:"name"`
}

DeletePartitionsInput contains the partition name to delete.

type ForceSchemaHandler added in v0.16.0 

type ForceSchemaHandler struct {
	LogFn               domain.LogFn
	SchemaVersionForcer domain.SchemaVersionForcer
}

ForceSchemaHandler defines a lambda handler for forcing database schema version after failed migration

func (*ForceSchemaHandler) Handle added in v0.16.0 

func (h *ForceSchemaHandler) Handle(ctx context.Context, input SchemaVersion) error

Handle handles the call to force database schema version after failed migration

type GetPartitionsHandler added in v0.3.0 

type GetPartitionsHandler struct {
	LogFn  domain.LogFn
	Getter domain.PartitionsGetter
}

GetPartitionsHandler handles requests for getting the time based partitions

func (*GetPartitionsHandler) Handle added in v0.3.0 

func (h *GetPartitionsHandler) Handle(ctx context.Context) (GetPartitionsOutput, error)

Handle handles the partition creation request

type GetPartitionsOutput added in v0.3.0 

type GetPartitionsOutput struct {
	Results []Partition `json:"results"`
}

GetPartitionsOutput returns the list of current partitions

type GetSchemaVersionHandler added in v0.13.0 

type GetSchemaVersionHandler struct {
	LogFn  domain.LogFn
	Getter domain.SchemaVersionGetter
}

GetSchemaVersionHandler handles requests for getting the currently active database schema version

func (*GetSchemaVersionHandler) Handle added in v0.13.0 

func (h *GetSchemaVersionHandler) Handle(ctx context.Context) (SchemaVersion, error)

Handle handles the request for schema version

type InvalidInput 

type InvalidInput struct {
	Field string
	Cause error
}

InvalidInput is an error indicating the request was malformed

func (InvalidInput) Error 

func (i InvalidInput) Error() string

type NetworkChanges 

type NetworkChanges struct {
	PrivateIPAddresses []string `json:"privateIpAddresses"`
	PublicIPAddresses  []string `json:"publicIpAddresses"`
	Hostnames          []string `json:"hostnames"`
	ChangeType         string   `json:"changeType"`
}

NetworkChanges detail the changes in ip addresses and host names for an asset

type NotFound 

type NotFound struct {
	ID string
}

NotFound is an error indicating no assets with the given ID were found

func (NotFound) Error 

func (n NotFound) Error() string

type PagedCloudAssets added in v0.9.0 

type PagedCloudAssets struct {
	CloudAssets
	NextPageToken string `json:"nextPageToken"`
}

PagedCloudAssets represents a list of assets with next page token for bulk requests

type Partition added in v0.3.0 

type Partition struct {
	Name      string    `json:"name"`
	CreatedAt time.Time `json:"createdAt"`
	Begin     time.Time `json:"begin"`
	End       time.Time `json:"end"`
	Count     int       `json:"count"`
}

Partition represents a created database partition

type SchemaVersion added in v0.13.0 

type SchemaVersion struct {
	Version uint `json:"version"`
}

SchemaVersion represents an active database schema version

type SchemaVersionStepDownHandler added in v0.13.0 

type SchemaVersionStepDownHandler struct {
	LogFn    domain.LogFn
	Migrator domain.SchemaMigratorDown
}

SchemaVersionStepDownHandler handles requests for schema migration

func (*SchemaVersionStepDownHandler) Handle added in v0.13.0 

func (h *SchemaVersionStepDownHandler) Handle(ctx context.Context) (SchemaVersion, error)

Handle handles the partition creation request

type SchemaVersionStepUpHandler added in v0.13.0 

type SchemaVersionStepUpHandler struct {
	LogFn    domain.LogFn
	Migrator domain.SchemaMigratorUp
}

SchemaVersionStepUpHandler handles requests for schema migration

func (*SchemaVersionStepUpHandler) Handle added in v0.13.0 

func (h *SchemaVersionStepUpHandler) Handle(ctx context.Context) (SchemaVersion, error)

Handle handles the partition creation request

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.