resources

Documentation

Index

• type BytesSource
  • func NewBytesSource(bs []byte) BytesSource
  • func (s BytesSource) Bytes() ([]byte, error)
  • func (s BytesSource) Description() string
• type FileResource
  • func NewFileResources(file string) ([]FileResource, error)
  • func (r FileResource) Description() string
  • func (r FileResource) Resources() ([]Resource, error)
• type FileSource
• type HTTPFileSource
  • func NewHTTPFileSource(path string) HTTPFileSource
  • func (s HTTPFileSource) Bytes() ([]byte, error)
  • func (s HTTPFileSource) Description() string
• type LocalFileSource
  • func NewLocalFileSource(path string) LocalFileSource
  • func (s LocalFileSource) Bytes() ([]byte, error)
  • func (s LocalFileSource) Description() string
• type Path
  • func NewPathFromInterfaces(parts []interface{}) Path
  • func NewPathFromStrings(strs []string) Path
  • func (p Path) AsString() string
  • func (p Path) AsStrings() []string
  • func (p Path) ContainsNonMapKeys() bool
  • func (p Path) HasMatchingSuffix(ending Path) bool
  • func (p Path) MarshalJSON() ([]byte, error)
  • func (p Path) Matches(p2 Path) bool
• type PathPart
  • func NewPathPartFromIndex(i int) *PathPart
  • func NewPathPartFromIndexAll() *PathPart
  • func NewPathPartFromString(str string) *PathPart
  • func (p *PathPart) AsString() string
  • func (p *PathPart) Matches(p2 *PathPart) bool
  • func (p *PathPart) UnmarshalJSON(data []byte) error
• type PathPartArrayIndex
• type Resource
  • func NewResourcesFromBytes(data []byte) ([]Resource, error)
• type ResourceImpl
  • func MustNewResourceFromBytes(data []byte) *ResourceImpl
  • func NewResourceFromBytes(data []byte) (*ResourceImpl, error)
  • func NewResourceUnstructured(un unstructured.Unstructured, gvr schema.GroupVersionResource) *ResourceImpl
  • func (r *ResourceImpl) APIGroup() string
  • func (r *ResourceImpl) APIVersion() string
  • func (r *ResourceImpl) Annotations() map[string]string
  • func (r *ResourceImpl) AsYAMLBytes() ([]byte, error)
  • func (r *ResourceImpl) DeepCopy() Resource
  • func (r *ResourceImpl) DeepCopyRaw() map[string]interface{}
  • func (r *ResourceImpl) Description() string
  • func (r *ResourceImpl) Equal(res Resource) bool
  • func (r *ResourceImpl) GroupVersionResource() schema.GroupVersionResource
  • func (r *ResourceImpl) Kind() string
  • func (r *ResourceImpl) Labels() map[string]string
  • func (r *ResourceImpl) Name() string
  • func (r *ResourceImpl) Namespace() string
• type StdinSource
  • func NewStdinSource() StdinSource
  • func (s StdinSource) Bytes() ([]byte, error)
  • func (s StdinSource) Description() string
• type YAMLFile
  • func NewYAMLFile(fileSrc FileSource) YAMLFile
  • func (f YAMLFile) Docs() ([][]byte, error)

Types

type BytesSource

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

func NewBytesSource

func NewBytesSource(bs []byte) BytesSource

func (BytesSource) Bytes

func (s BytesSource) Bytes() ([]byte, error)

func (BytesSource) Description

func (s BytesSource) Description() string

type FileResource

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

func NewFileResources

func NewFileResources(file string) ([]FileResource, error)

func (FileResource) Description

func (r FileResource) Description() string

func (FileResource) Resources

func (r FileResource) Resources() ([]Resource, error)

type FileSource

type FileSource interface {
	Description() string
	Bytes() ([]byte, error)
}

type HTTPFileSource

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

func NewHTTPFileSource

func NewHTTPFileSource(path string) HTTPFileSource

func (HTTPFileSource) Bytes

func (s HTTPFileSource) Bytes() ([]byte, error)

func (HTTPFileSource) Description

func (s HTTPFileSource) Description() string

type LocalFileSource

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

func NewLocalFileSource

func NewLocalFileSource(path string) LocalFileSource

func (LocalFileSource) Bytes

func (s LocalFileSource) Bytes() ([]byte, error)

func (LocalFileSource) Description

func (s LocalFileSource) Description() string

type Path

type Path []*PathPart

func NewPathFromInterfaces

func NewPathFromInterfaces(parts []interface{}) Path

func NewPathFromStrings

func NewPathFromStrings(strs []string) Path

func (Path) AsString

func (p Path) AsString() string

func (Path) AsStrings

func (p Path) AsStrings() []string

func (Path) ContainsNonMapKeys

func (p Path) ContainsNonMapKeys() bool

func (Path) HasMatchingSuffix

func (p Path) HasMatchingSuffix(ending Path) bool

func (Path) MarshalJSON

func (p Path) MarshalJSON() ([]byte, error)

func (Path) Matches

func (p Path) Matches(p2 Path) bool

type PathPart

type PathPart struct {
	MapKey     *string             `json:"mapKey,omitempty"`
	ArrayIndex *PathPartArrayIndex `json:"arrayIndex,omitempty"`
}

func NewPathPartFromIndex

func NewPathPartFromIndex(i int) *PathPart

func NewPathPartFromIndexAll

func NewPathPartFromIndexAll() *PathPart

func NewPathPartFromString

func NewPathPartFromString(str string) *PathPart

func (*PathPart) AsString

func (p *PathPart) AsString() string

func (*PathPart) Matches

func (p *PathPart) Matches(p2 *PathPart) bool

func (*PathPart) UnmarshalJSON

func (p *PathPart) UnmarshalJSON(data []byte) error

type PathPartArrayIndex

type PathPartArrayIndex struct {
	Index *int  `json:"index,omitempty"`
	All   *bool `json:"allIndexes,omitempty"`
}

type Resource

type Resource interface {
	GroupVersionResource() schema.GroupVersionResource
	Kind() string
	APIVersion() string
	APIGroup() string

	Name() string
	Description() string

	Annotations() map[string]string
	Labels() map[string]string

	Equal(res Resource) bool
	DeepCopy() Resource
	DeepCopyRaw() map[string]interface{}
	AsYAMLBytes() ([]byte, error)
	// contains filtered or unexported methods
}

func NewResourcesFromBytes

func NewResourcesFromBytes(data []byte) ([]Resource, error)

type ResourceImpl

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

func MustNewResourceFromBytes

func MustNewResourceFromBytes(data []byte) *ResourceImpl

func NewResourceFromBytes

func NewResourceFromBytes(data []byte) (*ResourceImpl, error)

func NewResourceUnstructured

func NewResourceUnstructured(un unstructured.Unstructured, gvr schema.GroupVersionResource) *ResourceImpl

func (*ResourceImpl) APIGroup

func (r *ResourceImpl) APIGroup() string

func (*ResourceImpl) APIVersion

func (r *ResourceImpl) APIVersion() string

func (*ResourceImpl) Annotations

func (r *ResourceImpl) Annotations() map[string]string

func (*ResourceImpl) AsYAMLBytes

func (r *ResourceImpl) AsYAMLBytes() ([]byte, error)

func (*ResourceImpl) DeepCopy

func (r *ResourceImpl) DeepCopy() Resource

func (*ResourceImpl) DeepCopyRaw

func (r *ResourceImpl) DeepCopyRaw() map[string]interface{}

func (*ResourceImpl) Description

func (r *ResourceImpl) Description() string

func (*ResourceImpl) Equal

func (r *ResourceImpl) Equal(res Resource) bool

func (*ResourceImpl) GroupVersionResource

func (r *ResourceImpl) GroupVersionResource() schema.GroupVersionResource

func (*ResourceImpl) Kind

func (r *ResourceImpl) Kind() string

func (*ResourceImpl) Labels

func (r *ResourceImpl) Labels() map[string]string

func (*ResourceImpl) Name

func (r *ResourceImpl) Name() string

func (*ResourceImpl) Namespace

func (r *ResourceImpl) Namespace() string

type StdinSource

type StdinSource struct{}

func NewStdinSource

func NewStdinSource() StdinSource

func (StdinSource) Bytes

func (s StdinSource) Bytes() ([]byte, error)

func (StdinSource) Description

func (s StdinSource) Description() string

type YAMLFile

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

func NewYAMLFile

func NewYAMLFile(fileSrc FileSource) YAMLFile

func (YAMLFile) Docs

func (f YAMLFile) Docs() ([][]byte, error)