unversioned

Documentation

Index

• Variables
• type ListMetadata
• type ObjectMetadata
  • func (md ObjectMetadata) GetObjectMetadata() ObjectMetadata
• type Resource
• type ResourceMetadata
• type ResourceObject
• type TypeMetadata
  • func (md TypeMetadata) GetTypeMetadata() TypeMetadata

Variables

var (
	// `apiVersion` in the config yaml files
	VersionV1      = "v1"
	VersionCurrent = VersionV1
)

Define available versions.

Types

type ListMetadata

type ListMetadata struct {
}

---- Metadata common to all lists ----

type ObjectMetadata

type ObjectMetadata struct {
	// Object revision used to perform atomic updates and deletes.  Currently
	// only supported on Get and Delete operations of the WorkloadEndpoint
	// resource type.
	Revision interface{} `json:"-"`
}

---- Metadata common to all resources ----

func (ObjectMetadata) GetObjectMetadata

func (md ObjectMetadata) GetObjectMetadata() ObjectMetadata

type Resource

type Resource interface {
	GetTypeMetadata() TypeMetadata
}

All resources (and resource lists) implement the Resource interface.

type ResourceMetadata

type ResourceMetadata interface {
	// GetObjectMetadata returns the ObjectMetadata instance of the ResourceMetadata.
	GetObjectMetadata() ObjectMetadata
}

All resource Metadata (not lists) implement the ResourceMetadata interface.

type ResourceObject

type ResourceObject interface {
	Resource

	// GetResourceMetadata returns the ResourceMetadata for each Resource Object.
	GetResourceMetadata() ResourceMetadata

	// String returns a human-readable string representation of a ResourceObject which
	// includes the important ID fields for a ResourceObject.
	String() string
}

All singular resources (all resources not including lists) implement the ResourceObject interface.

type TypeMetadata

type TypeMetadata struct {
	Kind       string `json:"kind"`
	APIVersion string `json:"apiVersion"`
}

---- Type metadata ----

All resource and resource lists embed a TypeMetadata as an anonymous field.

func (TypeMetadata) GetTypeMetadata

func (md TypeMetadata) GetTypeMetadata() TypeMetadata