resource

Documentation

Overview

Package resource contains core abstract types for representing configuration resources.

Index

• Variables
• type Entry
  • func (r *Entry) IsEmpty() bool
• type Event
  • func (e Event) String() string
• type EventKind
  • func (k EventKind) String() string
• type Info
  • func (i *Info) NewProtoInstance() prlang.Message
  • func (i *Info) String() string
• type Key
  • func (k Key) String() string
• type Schema
  • func NewSchema() *Schema
  • func (s *Schema) All() []Info
  • func (s *Schema) Lookup(url string) (Info, bool)
  • func (s *Schema) Register(typeURL string, isGogo bool)
  • func (s *Schema) TypeURLs() []string
• type TypeURL
  • func (t TypeURL) String() string
• type Version
• type VersionedKey
  • func (k VersionedKey) String() string

Variables

var Types = NewSchema()

Types of known resources.

Types

type Entry

type Entry struct {
	ID   VersionedKey
	Item prlang.Message
}

Entry is the abstract representation of a versioned config resource in Istio.

func (*Entry) IsEmpty

func (r *Entry) IsEmpty() bool

IsEmpty returns true if the resource Entry.Item is nil.

type Event

type Event struct {
	Kind EventKind
	ID   VersionedKey
	Item proto.Message
}

Event represents a change that occurred against a resource in the source config system.

func (Event) String

func (e Event) String() string

String implements Stringer.String

type EventKind

type EventKind int

EventKind is the type of an event.

const (
	// None is a sentinel value. Should not be used.
	None EventKind = iota

	// Added indicates that a new resource has been added.
	Added

	// Updated indicates that an existing resource has been updated.
	Updated

	// Deleted indicates an existing resource has been deleted.
	Deleted

	// FullSync indicates that the initial state of the store has been published as a series of Added events.
	// Events after FullSync are actual change events that the source-store has encountered.
	FullSync
)

func (EventKind) String

func (k EventKind) String() string

String implements Stringer.String

type Info

type Info struct {
	// TypeURL of the resource that this info is about
	TypeURL TypeURL

	// Indicates whether the proto is defined as Gogo.
	IsGogo bool
	// contains filtered or unexported fields
}

Info is the type metadata for an Entry.

func (*Info) NewProtoInstance

func (i *Info) NewProtoInstance() prlang.Message

NewProtoInstance returns a new instance of the underlying proto for this resource.

func (*Info) String

func (i *Info) String() string

String interface method implementation.

type Key

type Key struct {
	// TypeURL of the resource.
	TypeURL TypeURL

	// Fully qualified name of the resource.
	FullName string
}

Key uniquely identifies a (mutable) config resource in the config space.

func (Key) String

func (k Key) String() string

String interface method implementation.

type Schema

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

Schema contains metadata about configuration resources.

func NewSchema

func NewSchema() *Schema

NewSchema returns a new instance of Schema.

func (*Schema) All

func (s *Schema) All() []Info

All returns all known info objects

func (*Schema) Lookup

func (s *Schema) Lookup(url string) (Info, bool)

Lookup looks up a resource.Info by its type url.

func (*Schema) Register

func (s *Schema) Register(typeURL string, isGogo bool)

Register a proto into the schema.

func (*Schema) TypeURLs

func (s *Schema) TypeURLs() []string

TypeURLs returns all known type URLs.

type TypeURL

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

TypeURL of the resource.

func (TypeURL) String

func (t TypeURL) String() string

String interface method implementation.

type Version

type Version string

Version is the version identifier of a resource.

type VersionedKey

type VersionedKey struct {
	Key
	Version Version
}

VersionedKey uniquely identifies a snapshot of a config resource in the config space, at a given time.

func (VersionedKey) String

func (k VersionedKey) String() string

String interface method implementation.