backend

Documentation

Overview

* © 2023 Snyk Limited * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License.

Index

• type Backend
  • func New(clusterName string, cfg *config.Egress, reg prometheus.Registerer) *Backend
  • func (m Backend) Collect(ch chan<- prometheus.Metric)
  • func (m Backend) Describe(ch chan<- *prometheus.Desc)
  • func (b *Backend) List(ctx context.Context, orgID string) ([]ResponseData, error)
  • func (b *Backend) Upsert(ctx context.Context, requestID string, obj client.Object, ...) error
• type HTTPError
  • func (h *HTTPError) Error() string
  • func (h *HTTPError) Values() map[string]any
• type ResponseAttributes
• type ResponseData

Types

type Backend

type Backend struct {
	// contains filtered or unexported fields
}

func New

func New(clusterName string, cfg *config.Egress, reg prometheus.Registerer) *Backend

func (Backend) Collect

func (m Backend) Collect(ch chan<- prometheus.Metric)

func (Backend) Describe

func (m Backend) Describe(ch chan<- *prometheus.Desc)

func (*Backend) List

func (b *Backend) List(ctx context.Context, orgID string) ([]ResponseData, error)

func (*Backend) Upsert

func (b *Backend) Upsert(ctx context.Context, requestID string, obj client.Object, preferredVersion string, orgID string, deletedAt *metav1.Time) error

type HTTPError

type HTTPError struct {
	StatusCode int
	Header     http.Header
	// contains filtered or unexported fields
}

func (*HTTPError) Error

func (h *HTTPError) Error() string

func (*HTTPError) Values

func (h *HTTPError) Values() map[string]any

Values returns a map that is suitable for usage with a `logr.Logger.WithValues` in order to log properly indexed / structured fields.

type ResponseAttributes

type ResponseAttributes struct {
	ClusterName      string                 `json:"cluster_name"`
	DeletedAt        string                 `json:"deleted_at,omitempty"`
	ID               string                 `json:"id"`
	ManifestBlob     map[string]interface{} `json:"manifest_blob"`
	PreferredVersion string                 `json:"preferred_version"`
	ScannedAt        string                 `json:"scanned_at,omitempty"`
}

type ResponseData

type ResponseData struct {
	Attributes *ResponseAttributes `json:"attributes,omitempty"`
	ID         string              `json:"id"`
	Type       string              `json:"type"`
}