types

Documentation

Overview

Package types is a generated protocol buffer package.

It is generated from these files:

github.com/containerd/containerd/api/types/descriptor.proto
github.com/containerd/containerd/api/types/metrics.proto
github.com/containerd/containerd/api/types/mount.proto
github.com/containerd/containerd/api/types/platform.proto

It has these top-level messages:

Descriptor
Metric
Mount
Platform

Index

• Variables
• type Descriptor
  • func (*Descriptor) Descriptor() ([]byte, []int)
  • func (m *Descriptor) Marshal() (dAtA []byte, err error)
  • func (m *Descriptor) MarshalTo(dAtA []byte) (int, error)
  • func (*Descriptor) ProtoMessage()
  • func (m *Descriptor) Reset()
  • func (m *Descriptor) Size() (n int)
  • func (this *Descriptor) String() string
  • func (m *Descriptor) Unmarshal(dAtA []byte) error
• type Metric
  • func (*Metric) Descriptor() ([]byte, []int)
  • func (m *Metric) Marshal() (dAtA []byte, err error)
  • func (m *Metric) MarshalTo(dAtA []byte) (int, error)
  • func (*Metric) ProtoMessage()
  • func (m *Metric) Reset()
  • func (m *Metric) Size() (n int)
  • func (this *Metric) String() string
  • func (m *Metric) Unmarshal(dAtA []byte) error
• type Mount
  • func (*Mount) Descriptor() ([]byte, []int)
  • func (m *Mount) Marshal() (dAtA []byte, err error)
  • func (m *Mount) MarshalTo(dAtA []byte) (int, error)
  • func (*Mount) ProtoMessage()
  • func (m *Mount) Reset()
  • func (m *Mount) Size() (n int)
  • func (this *Mount) String() string
  • func (m *Mount) Unmarshal(dAtA []byte) error
• type Platform
  • func (*Platform) Descriptor() ([]byte, []int)
  • func (m *Platform) Marshal() (dAtA []byte, err error)
  • func (m *Platform) MarshalTo(dAtA []byte) (int, error)
  • func (*Platform) ProtoMessage()
  • func (m *Platform) Reset()
  • func (m *Platform) Size() (n int)
  • func (this *Platform) String() string
  • func (m *Platform) Unmarshal(dAtA []byte) error

Variables

var (
	ErrInvalidLengthDescriptor = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowDescriptor   = fmt.Errorf("proto: integer overflow")
)

var (
	ErrInvalidLengthMetrics = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowMetrics   = fmt.Errorf("proto: integer overflow")
)

var (
	ErrInvalidLengthMount = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowMount   = fmt.Errorf("proto: integer overflow")
)

var (
	ErrInvalidLengthPlatform = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowPlatform   = fmt.Errorf("proto: integer overflow")
)

Types

type Descriptor

type Descriptor struct {
	MediaType string                                     `protobuf:"bytes,1,opt,name=media_type,json=mediaType,proto3" json:"media_type,omitempty"`
	Digest    github_com_opencontainers_go_digest.Digest `protobuf:"bytes,2,opt,name=digest,proto3,customtype=github.com/opencontainers/go-digest.Digest" json:"digest"`
	Size_     int64                                      `protobuf:"varint,3,opt,name=size,proto3" json:"size,omitempty"`
}

Descriptor describes a blob in a content store.

This descriptor can be used to reference content from an oci descriptor found in a manifest. See https://godoc.org/github.com/opencontainers/image-spec/specs-go/v1#Descriptor

func (*Descriptor) Descriptor

func (*Descriptor) Descriptor() ([]byte, []int)

func (*Descriptor) Marshal

func (m *Descriptor) Marshal() (dAtA []byte, err error)

func (*Descriptor) MarshalTo

func (m *Descriptor) MarshalTo(dAtA []byte) (int, error)

func (*Descriptor) ProtoMessage

func (*Descriptor) ProtoMessage()

func (*Descriptor) Reset

func (m *Descriptor) Reset()

func (*Descriptor) Size

func (m *Descriptor) Size() (n int)

func (*Descriptor) String

func (this *Descriptor) String() string

func (*Descriptor) Unmarshal

func (m *Descriptor) Unmarshal(dAtA []byte) error

type Metric

type Metric struct {
	Timestamp time.Time             `protobuf:"bytes,1,opt,name=timestamp,stdtime" json:"timestamp"`
	ID        string                `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"`
	Data      *google_protobuf1.Any `protobuf:"bytes,3,opt,name=data" json:"data,omitempty"`
}

func (*Metric) Descriptor

func (*Metric) Descriptor() ([]byte, []int)

func (*Metric) Marshal

func (m *Metric) Marshal() (dAtA []byte, err error)

func (*Metric) MarshalTo

func (m *Metric) MarshalTo(dAtA []byte) (int, error)

func (*Metric) ProtoMessage

func (*Metric) ProtoMessage()

func (*Metric) Reset

func (m *Metric) Reset()

func (*Metric) Size

func (m *Metric) Size() (n int)

func (*Metric) String

func (this *Metric) String() string

func (*Metric) Unmarshal

func (m *Metric) Unmarshal(dAtA []byte) error

type Mount

type Mount struct {
	// Type defines the nature of the mount.
	Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	// Source specifies the name of the mount. Depending on mount type, this
	// may be a volume name or a host path, or even ignored.
	Source string `protobuf:"bytes,2,opt,name=source,proto3" json:"source,omitempty"`
	// Target path in container
	Target string `protobuf:"bytes,3,opt,name=target,proto3" json:"target,omitempty"`
	// Options specifies zero or more fstab style mount options.
	Options []string `protobuf:"bytes,4,rep,name=options" json:"options,omitempty"`
}

Mount describes mounts for a container.

This type is the lingua franca of ContainerD. All services provide mounts to be used with the container at creation time.

The Mount type follows the structure of the mount syscall, including a type, source, target and options.

func (*Mount) Descriptor

func (*Mount) Descriptor() ([]byte, []int)

func (*Mount) Marshal

func (m *Mount) Marshal() (dAtA []byte, err error)

func (*Mount) MarshalTo

func (m *Mount) MarshalTo(dAtA []byte) (int, error)

func (*Mount) ProtoMessage

func (*Mount) ProtoMessage()

func (*Mount) Reset

func (m *Mount) Reset()

func (*Mount) Size

func (m *Mount) Size() (n int)

func (*Mount) String

func (this *Mount) String() string

func (*Mount) Unmarshal

func (m *Mount) Unmarshal(dAtA []byte) error

type Platform

type Platform struct {
	OS           string `protobuf:"bytes,1,opt,name=os,proto3" json:"os,omitempty"`
	Architecture string `protobuf:"bytes,2,opt,name=architecture,proto3" json:"architecture,omitempty"`
	Variant      string `protobuf:"bytes,3,opt,name=variant,proto3" json:"variant,omitempty"`
}

Platform follows the structure of the OCI platform specification, from descriptors.

func (*Platform) Descriptor

func (*Platform) Descriptor() ([]byte, []int)

func (*Platform) Marshal

func (m *Platform) Marshal() (dAtA []byte, err error)

func (*Platform) MarshalTo

func (m *Platform) MarshalTo(dAtA []byte) (int, error)

func (*Platform) ProtoMessage

func (*Platform) ProtoMessage()

func (*Platform) Reset

func (m *Platform) Reset()

func (*Platform) Size

func (m *Platform) Size() (n int)

func (*Platform) String

func (this *Platform) String() string

func (*Platform) Unmarshal

func (m *Platform) Unmarshal(dAtA []byte) error