types

package
v1.7.18 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 5, 2024 License: Apache-2.0 Imports: 6 Imported by: 2,191

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var File_github_com_containerd_containerd_api_types_descriptor_proto protoreflect.FileDescriptor
View Source 
var File_github_com_containerd_containerd_api_types_metrics_proto protoreflect.FileDescriptor
View Source 
var File_github_com_containerd_containerd_api_types_mount_proto protoreflect.FileDescriptor
View Source 
var File_github_com_containerd_containerd_api_types_platform_proto protoreflect.FileDescriptor
View Source 
var File_github_com_containerd_containerd_api_types_sandbox_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type Descriptor 

type Descriptor struct {
	MediaType   string            `protobuf:"bytes,1,opt,name=media_type,json=mediaType,proto3" json:"media_type,omitempty"`
	Digest      string            `protobuf:"bytes,2,opt,name=digest,proto3" json:"digest,omitempty"`
	Size        int64             `protobuf:"varint,3,opt,name=size,proto3" json:"size,omitempty"`
	Annotations map[string]string `` /* 163-byte string literal not displayed */
	// contains filtered or unexported fields
}

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 deprecated 

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

Deprecated: Use Descriptor.ProtoReflect.Descriptor instead.

func (*Descriptor) GetAnnotations added in v1.7.0 

func (x *Descriptor) GetAnnotations() map[string]string

func (*Descriptor) GetDigest added in v1.7.0 

func (x *Descriptor) GetDigest() string

func (*Descriptor) GetMediaType added in v1.7.0 

func (x *Descriptor) GetMediaType() string

func (*Descriptor) GetSize added in v1.7.0 

func (x *Descriptor) GetSize() int64

func (*Descriptor) ProtoMessage 

func (*Descriptor) ProtoMessage()

func (*Descriptor) ProtoReflect added in v1.7.0 

func (x *Descriptor) ProtoReflect() protoreflect.Message

func (*Descriptor) Reset 

func (x *Descriptor) Reset()

func (*Descriptor) String 

func (x *Descriptor) String() string

type Metric 

type Metric struct {
	Timestamp *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
	ID        string                 `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"`
	Data      *anypb.Any             `protobuf:"bytes,3,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*Metric) Descriptor deprecated 

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

Deprecated: Use Metric.ProtoReflect.Descriptor instead.

func (*Metric) GetData added in v1.7.0 

func (x *Metric) GetData() *anypb.Any

func (*Metric) GetID added in v1.7.0 

func (x *Metric) GetID() string

func (*Metric) GetTimestamp added in v1.7.0 

func (x *Metric) GetTimestamp() *timestamppb.Timestamp

func (*Metric) ProtoMessage 

func (*Metric) ProtoMessage()

func (*Metric) ProtoReflect added in v1.7.0 

func (x *Metric) ProtoReflect() protoreflect.Message

func (*Metric) Reset 

func (x *Metric) Reset()

func (*Metric) String 

func (x *Metric) String() string

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,proto3" json:"options,omitempty"`
	// contains filtered or unexported fields
}

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 deprecated 

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

Deprecated: Use Mount.ProtoReflect.Descriptor instead.

func (*Mount) GetOptions added in v1.7.0 

func (x *Mount) GetOptions() []string

func (*Mount) GetSource added in v1.7.0 

func (x *Mount) GetSource() string

func (*Mount) GetTarget added in v1.7.0 

func (x *Mount) GetTarget() string

func (*Mount) GetType added in v1.7.0 

func (x *Mount) GetType() string

func (*Mount) ProtoMessage 

func (*Mount) ProtoMessage()

func (*Mount) ProtoReflect added in v1.7.0 

func (x *Mount) ProtoReflect() protoreflect.Message

func (*Mount) Reset 

func (x *Mount) Reset()

func (*Mount) String 

func (x *Mount) String() string

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"`
	// contains filtered or unexported fields
}

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

func (*Platform) Descriptor deprecated 

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

Deprecated: Use Platform.ProtoReflect.Descriptor instead.

func (*Platform) GetArchitecture added in v1.7.0 

func (x *Platform) GetArchitecture() string

func (*Platform) GetOS added in v1.7.0 

func (x *Platform) GetOS() string

func (*Platform) GetVariant added in v1.7.0 

func (x *Platform) GetVariant() string

func (*Platform) ProtoMessage 

func (*Platform) ProtoMessage()

func (*Platform) ProtoReflect added in v1.7.0 

func (x *Platform) ProtoReflect() protoreflect.Message

func (*Platform) Reset 

func (x *Platform) Reset()

func (*Platform) String 

func (x *Platform) String() string

type Sandbox added in v1.7.0 

type Sandbox struct {

	// SandboxID is a unique instance identifier within namespace
	SandboxID string `protobuf:"bytes,1,opt,name=sandbox_id,json=sandboxId,proto3" json:"sandbox_id,omitempty"`
	// Runtime specifies which runtime to use for executing this container.
	Runtime *Sandbox_Runtime `protobuf:"bytes,2,opt,name=runtime,proto3" json:"runtime,omitempty"`
	// Spec is sandbox configuration (kin of OCI runtime spec), spec's data will be written to a config.json file in the
	// bundle directory (similary to OCI spec).
	Spec *anypb.Any `protobuf:"bytes,3,opt,name=spec,proto3" json:"spec,omitempty"`
	// Labels provides an area to include arbitrary data on containers.
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// CreatedAt is the time the container was first created.
	CreatedAt *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"`
	// UpdatedAt is the last time the container was mutated.
	UpdatedAt *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=updated_at,json=updatedAt,proto3" json:"updated_at,omitempty"`
	// Extensions allow clients to provide optional blobs that can be handled by runtime.
	Extensions map[string]*anypb.Any `` /* 161-byte string literal not displayed */
	// contains filtered or unexported fields
}

Sandbox represents a sandbox metadata object that keeps all info required by controller to work with a particular instance.

func (*Sandbox) Descriptor deprecated added in v1.7.0 

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

Deprecated: Use Sandbox.ProtoReflect.Descriptor instead.

func (*Sandbox) GetCreatedAt added in v1.7.0 

func (x *Sandbox) GetCreatedAt() *timestamppb.Timestamp

func (*Sandbox) GetExtensions added in v1.7.0 

func (x *Sandbox) GetExtensions() map[string]*anypb.Any

func (*Sandbox) GetLabels added in v1.7.0 

func (x *Sandbox) GetLabels() map[string]string

func (*Sandbox) GetRuntime added in v1.7.0 

func (x *Sandbox) GetRuntime() *Sandbox_Runtime

func (*Sandbox) GetSandboxID added in v1.7.0 

func (x *Sandbox) GetSandboxID() string

func (*Sandbox) GetSpec added in v1.7.0 

func (x *Sandbox) GetSpec() *anypb.Any

func (*Sandbox) GetUpdatedAt added in v1.7.0 

func (x *Sandbox) GetUpdatedAt() *timestamppb.Timestamp

func (*Sandbox) ProtoMessage added in v1.7.0 

func (*Sandbox) ProtoMessage()

func (*Sandbox) ProtoReflect added in v1.7.0 

func (x *Sandbox) ProtoReflect() protoreflect.Message

func (*Sandbox) Reset added in v1.7.0 

func (x *Sandbox) Reset()

func (*Sandbox) String added in v1.7.0 

func (x *Sandbox) String() string

type Sandbox_Runtime added in v1.7.0 

type Sandbox_Runtime struct {

	// Name is the name of the runtime.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Options specify additional runtime initialization options for the shim (this data will be available in StartShim).
	// Typically this data expected to be runtime shim implementation specific.
	Options *anypb.Any `protobuf:"bytes,2,opt,name=options,proto3" json:"options,omitempty"`
	// contains filtered or unexported fields
}

func (*Sandbox_Runtime) Descriptor deprecated added in v1.7.0 

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

Deprecated: Use Sandbox_Runtime.ProtoReflect.Descriptor instead.

func (*Sandbox_Runtime) GetName added in v1.7.0 

func (x *Sandbox_Runtime) GetName() string

func (*Sandbox_Runtime) GetOptions added in v1.7.0 

func (x *Sandbox_Runtime) GetOptions() *anypb.Any

func (*Sandbox_Runtime) ProtoMessage added in v1.7.0 

func (*Sandbox_Runtime) ProtoMessage()

func (*Sandbox_Runtime) ProtoReflect added in v1.7.0 

func (x *Sandbox_Runtime) ProtoReflect() protoreflect.Message

func (*Sandbox_Runtime) Reset added in v1.7.0 

func (x *Sandbox_Runtime) Reset()

func (*Sandbox_Runtime) String added in v1.7.0 

func (x *Sandbox_Runtime) String() string

Source Files

View all Source files

Directories

Path Synopsis
Package task defines the task service.
 Package task defines the task service.
Package transfer defines the transfer types.
 Package transfer defines the transfer types.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.