schemaversion

Documentation

Index

• func DetermineSchemaVersion(requestedSV *hcsschema.Version) *hcsschema.Version
• func IsSupported(sv *hcsschema.Version) error
• func IsV10(sv *hcsschema.Version) bool
• func IsV21(sv *hcsschema.Version) bool
• func SchemaV10() *hcsschema.Version
• func SchemaV21() *hcsschema.Version
• func String(sv *hcsschema.Version) string

Functions

func DetermineSchemaVersion

func DetermineSchemaVersion(requestedSV *hcsschema.Version) *hcsschema.Version

DetermineSchemaVersion works out what schema version to use based on build and requested option.

func IsSupported

func IsSupported(sv *hcsschema.Version) error

isSupported determines if a given schema version is supported

func IsV10

func IsV10(sv *hcsschema.Version) bool

IsV10 determines if a given schema version object is 1.0. This was the only thing supported in RS1..3. It lives on in RS5, but will be deprecated in a future release.

func IsV21

func IsV21(sv *hcsschema.Version) bool

IsV21 determines if a given schema version object is 2.0. This was introduced in RS4, but not fully implemented. Recommended for applications using HCS in RS5 onwards.

func SchemaV10

func SchemaV10() *hcsschema.Version

SchemaV10 makes it easy for callers to get a v1.0 schema version object

func SchemaV21

func SchemaV21() *hcsschema.Version

SchemaV21 makes it easy for callers to get a v2.1 schema version object

func String

func String(sv *hcsschema.Version) string

String returns a JSON encoding of a schema version object