transfer

package
v1.9.0 Latest Latest
Warning

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

 Go to latest Published: May 7, 2025 License: Apache-2.0 Imports: 6 Imported by: 12

Documentation

Overview

Package transfer defines the transfer types.

Index

Constants

This section is empty.

Variables

View Source 
var (
	HTTPDebug_name = map[int32]string{
		0: "DISABLED",
		1: "DEBUG",
		2: "TRACE",
		3: "BOTH",
	}
	HTTPDebug_value = map[string]int32{
		"DISABLED": 0,
		"DEBUG":    1,
		"TRACE":    2,
		"BOTH":     3,
	}
)

Enum value maps for HTTPDebug.

View Source 
var (
	AuthType_name = map[int32]string{
		0: "NONE",
		1: "CREDENTIALS",
		2: "REFRESH",
		3: "HEADER",
	}
	AuthType_value = map[string]int32{
		"NONE":        0,
		"CREDENTIALS": 1,
		"REFRESH":     2,
		"HEADER":      3,
	}
)

Enum value maps for AuthType.

View Source 
var File_github_com_containerd_containerd_api_types_transfer_imagestore_proto protoreflect.FileDescriptor
View Source 
var File_github_com_containerd_containerd_api_types_transfer_importexport_proto protoreflect.FileDescriptor
View Source 
var File_github_com_containerd_containerd_api_types_transfer_progress_proto protoreflect.FileDescriptor
View Source 
var File_github_com_containerd_containerd_api_types_transfer_registry_proto protoreflect.FileDescriptor
View Source 
var File_github_com_containerd_containerd_api_types_transfer_streaming_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type AuthRequest 

type AuthRequest struct {

	// host is the registry host
	Host string `protobuf:"bytes,1,opt,name=host,proto3" json:"host,omitempty"`
	// reference is the namespace and repository name requested from the registry
	Reference string `protobuf:"bytes,2,opt,name=reference,proto3" json:"reference,omitempty"`
	// wwwauthenticate is the HTTP WWW-Authenticate header values returned from the registry
	Wwwauthenticate []string `protobuf:"bytes,3,rep,name=wwwauthenticate,proto3" json:"wwwauthenticate,omitempty"`
	// contains filtered or unexported fields
}

AuthRequest is sent as a callback on a stream

func (*AuthRequest) Descriptor deprecated 

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

Deprecated: Use AuthRequest.ProtoReflect.Descriptor instead.

func (*AuthRequest) GetHost 

func (x *AuthRequest) GetHost() string

func (*AuthRequest) GetReference 

func (x *AuthRequest) GetReference() string

func (*AuthRequest) GetWwwauthenticate 

func (x *AuthRequest) GetWwwauthenticate() []string

func (*AuthRequest) ProtoMessage 

func (*AuthRequest) ProtoMessage()

func (*AuthRequest) ProtoReflect 

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

func (*AuthRequest) Reset 

func (x *AuthRequest) Reset()

func (*AuthRequest) String 

func (x *AuthRequest) String() string

type AuthResponse 

type AuthResponse struct {
	AuthType AuthType               `protobuf:"varint,1,opt,name=authType,proto3,enum=containerd.types.transfer.AuthType" json:"authType,omitempty"`
	Secret   string                 `protobuf:"bytes,2,opt,name=secret,proto3" json:"secret,omitempty"`
	Username string                 `protobuf:"bytes,3,opt,name=username,proto3" json:"username,omitempty"`
	ExpireAt *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=expire_at,json=expireAt,proto3" json:"expire_at,omitempty"` // TODO: Stream error
	// contains filtered or unexported fields
}

func (*AuthResponse) Descriptor deprecated 

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

Deprecated: Use AuthResponse.ProtoReflect.Descriptor instead.

func (*AuthResponse) GetAuthType 

func (x *AuthResponse) GetAuthType() AuthType

func (*AuthResponse) GetExpireAt 

func (x *AuthResponse) GetExpireAt() *timestamppb.Timestamp

func (*AuthResponse) GetSecret 

func (x *AuthResponse) GetSecret() string

func (*AuthResponse) GetUsername 

func (x *AuthResponse) GetUsername() string

func (*AuthResponse) ProtoMessage 

func (*AuthResponse) ProtoMessage()

func (*AuthResponse) ProtoReflect 

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

func (*AuthResponse) Reset 

func (x *AuthResponse) Reset()

func (*AuthResponse) String 

func (x *AuthResponse) String() string

type AuthType 

type AuthType int32
const (
	AuthType_NONE AuthType = 0
	// CREDENTIALS is used to exchange username/password for access token
	// using an oauth or "Docker Registry Token" server
	AuthType_CREDENTIALS AuthType = 1
	// REFRESH is used to exchange secret for access token using an oauth
	// or "Docker Registry Token" server
	AuthType_REFRESH AuthType = 2
	// HEADER is used to set the HTTP Authorization header to secret
	// directly for the registry.
	// Value should be `<auth-scheme> <authorization-parameters>`
	AuthType_HEADER AuthType = 3
)

func (AuthType) Descriptor 

func (AuthType) Descriptor() protoreflect.EnumDescriptor

func (AuthType) Enum 

func (x AuthType) Enum() *AuthType

func (AuthType) EnumDescriptor deprecated 

func (AuthType) EnumDescriptor() ([]byte, []int)

Deprecated: Use AuthType.Descriptor instead.

func (AuthType) Number 

func (x AuthType) Number() protoreflect.EnumNumber

func (AuthType) String 

func (x AuthType) String() string

func (AuthType) Type 

func (AuthType) Type() protoreflect.EnumType

type Data 

type Data struct {
	Data []byte `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*Data) Descriptor deprecated 

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

Deprecated: Use Data.ProtoReflect.Descriptor instead.

func (*Data) GetData 

func (x *Data) GetData() []byte

func (*Data) ProtoMessage 

func (*Data) ProtoMessage()

func (*Data) ProtoReflect 

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

func (*Data) Reset 

func (x *Data) Reset()

func (*Data) String 

func (x *Data) String() string

type HTTPDebug added in v1.9.0 

type HTTPDebug int32
const (
	HTTPDebug_DISABLED HTTPDebug = 0
	// Enable HTTP debugging
	HTTPDebug_DEBUG HTTPDebug = 1
	// Enable HTTP requests tracing
	HTTPDebug_TRACE HTTPDebug = 2
	// Enable both HTTP debugging and requests tracing
	HTTPDebug_BOTH HTTPDebug = 3
)

func (HTTPDebug) Descriptor added in v1.9.0 

func (HTTPDebug) Descriptor() protoreflect.EnumDescriptor

func (HTTPDebug) Enum added in v1.9.0 

func (x HTTPDebug) Enum() *HTTPDebug

func (HTTPDebug) EnumDescriptor deprecated added in v1.9.0 

func (HTTPDebug) EnumDescriptor() ([]byte, []int)

Deprecated: Use HTTPDebug.Descriptor instead.

func (HTTPDebug) Number added in v1.9.0 

func (x HTTPDebug) Number() protoreflect.EnumNumber

func (HTTPDebug) String added in v1.9.0 

func (x HTTPDebug) String() string

func (HTTPDebug) Type added in v1.9.0 

func (HTTPDebug) Type() protoreflect.EnumType

type ImageExportStream 

type ImageExportStream struct {

	// Stream is used to identify the binary output stream for the export operation.
	// The stream uses the transfer binary stream protocol with the server as the sender.
	// The binary data is expected to be a raw tar stream.
	Stream    string `protobuf:"bytes,1,opt,name=stream,proto3" json:"stream,omitempty"`
	MediaType string `protobuf:"bytes,2,opt,name=media_type,json=mediaType,proto3" json:"media_type,omitempty"`
	// The specified platforms
	Platforms []*types.Platform `protobuf:"bytes,3,rep,name=platforms,proto3" json:"platforms,omitempty"`
	// Whether to include all platforms
	AllPlatforms bool `protobuf:"varint,4,opt,name=all_platforms,json=allPlatforms,proto3" json:"all_platforms,omitempty"`
	// Skips the creation of the Docker compatible manifest.json file
	SkipCompatibilityManifest bool `` /* 139-byte string literal not displayed */
	// Excludes non-distributable blobs such as Windows base layers.
	SkipNonDistributable bool `protobuf:"varint,6,opt,name=skip_non_distributable,json=skipNonDistributable,proto3" json:"skip_non_distributable,omitempty"`
	// contains filtered or unexported fields
}

func (*ImageExportStream) Descriptor deprecated 

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

Deprecated: Use ImageExportStream.ProtoReflect.Descriptor instead.

func (*ImageExportStream) GetAllPlatforms 

func (x *ImageExportStream) GetAllPlatforms() bool

func (*ImageExportStream) GetMediaType 

func (x *ImageExportStream) GetMediaType() string

func (*ImageExportStream) GetPlatforms 

func (x *ImageExportStream) GetPlatforms() []*types.Platform

func (*ImageExportStream) GetSkipCompatibilityManifest 

func (x *ImageExportStream) GetSkipCompatibilityManifest() bool

func (*ImageExportStream) GetSkipNonDistributable 

func (x *ImageExportStream) GetSkipNonDistributable() bool

func (*ImageExportStream) GetStream 

func (x *ImageExportStream) GetStream() string

func (*ImageExportStream) ProtoMessage 

func (*ImageExportStream) ProtoMessage()

func (*ImageExportStream) ProtoReflect 

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

func (*ImageExportStream) Reset 

func (x *ImageExportStream) Reset()

func (*ImageExportStream) String 

func (x *ImageExportStream) String() string

type ImageImportStream 

type ImageImportStream struct {

	// Stream is used to identify the binary input stream for the import operation.
	// The stream uses the transfer binary stream protocol with the client as the sender.
	// The binary data is expected to be a raw tar stream.
	Stream        string `protobuf:"bytes,1,opt,name=stream,proto3" json:"stream,omitempty"`
	MediaType     string `protobuf:"bytes,2,opt,name=media_type,json=mediaType,proto3" json:"media_type,omitempty"`
	ForceCompress bool   `protobuf:"varint,3,opt,name=force_compress,json=forceCompress,proto3" json:"force_compress,omitempty"`
	// contains filtered or unexported fields
}

func (*ImageImportStream) Descriptor deprecated 

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

Deprecated: Use ImageImportStream.ProtoReflect.Descriptor instead.

func (*ImageImportStream) GetForceCompress 

func (x *ImageImportStream) GetForceCompress() bool

func (*ImageImportStream) GetMediaType 

func (x *ImageImportStream) GetMediaType() string

func (*ImageImportStream) GetStream 

func (x *ImageImportStream) GetStream() string

func (*ImageImportStream) ProtoMessage 

func (*ImageImportStream) ProtoMessage()

func (*ImageImportStream) ProtoReflect 

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

func (*ImageImportStream) Reset 

func (x *ImageImportStream) Reset()

func (*ImageImportStream) String 

func (x *ImageImportStream) String() string

type ImageReference 

type ImageReference struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// is_prefix determines whether the Name should be considered
	// a prefix (without tag or digest).
	// For lookup, this may allow matching multiple tags.
	// For store, this must have a tag or digest added.
	IsPrefix bool `protobuf:"varint,2,opt,name=is_prefix,json=isPrefix,proto3" json:"is_prefix,omitempty"`
	// allow_overwrite allows overwriting or ignoring the name if
	// another reference is provided (such as through an annotation).
	// Only used if IsPrefix is true.
	AllowOverwrite bool `protobuf:"varint,3,opt,name=allow_overwrite,json=allowOverwrite,proto3" json:"allow_overwrite,omitempty"`
	// add_digest adds the manifest digest to the reference.
	// For lookup, this allows matching tags with any digest.
	// For store, this allows adding the digest to the name.
	// Only used if IsPrefix is true.
	AddDigest bool `protobuf:"varint,4,opt,name=add_digest,json=addDigest,proto3" json:"add_digest,omitempty"`
	// skip_named_digest only considers digest references which do not
	// have a non-digested named reference.
	// For lookup, this will deduplicate digest references when there is a named match.
	// For store, this only adds this digest reference when there is no matching full
	// name reference from the prefix.
	// Only used if IsPrefix is true.
	SkipNamedDigest bool `protobuf:"varint,5,opt,name=skip_named_digest,json=skipNamedDigest,proto3" json:"skip_named_digest,omitempty"`
	// contains filtered or unexported fields
}

ImageReference is used to create or find a reference for an image

func (*ImageReference) Descriptor deprecated 

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

Deprecated: Use ImageReference.ProtoReflect.Descriptor instead.

func (*ImageReference) GetAddDigest 

func (x *ImageReference) GetAddDigest() bool

func (*ImageReference) GetAllowOverwrite 

func (x *ImageReference) GetAllowOverwrite() bool

func (*ImageReference) GetIsPrefix 

func (x *ImageReference) GetIsPrefix() bool

func (*ImageReference) GetName 

func (x *ImageReference) GetName() string

func (*ImageReference) GetSkipNamedDigest 

func (x *ImageReference) GetSkipNamedDigest() bool

func (*ImageReference) ProtoMessage 

func (*ImageReference) ProtoMessage()

func (*ImageReference) ProtoReflect 

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

func (*ImageReference) Reset 

func (x *ImageReference) Reset()

func (*ImageReference) String 

func (x *ImageReference) String() string

type ImageStore 

type ImageStore struct {
	Name          string            `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Labels        map[string]string `` /* 153-byte string literal not displayed */
	Platforms     []*types.Platform `protobuf:"bytes,3,rep,name=platforms,proto3" json:"platforms,omitempty"`
	AllMetadata   bool              `protobuf:"varint,4,opt,name=all_metadata,json=allMetadata,proto3" json:"all_metadata,omitempty"`
	ManifestLimit uint32            `protobuf:"varint,5,opt,name=manifest_limit,json=manifestLimit,proto3" json:"manifest_limit,omitempty"`
	// extra_references are used to set image names on imports of sub-images from the index
	ExtraReferences []*ImageReference      `protobuf:"bytes,6,rep,name=extra_references,json=extraReferences,proto3" json:"extra_references,omitempty"`
	Unpacks         []*UnpackConfiguration `protobuf:"bytes,10,rep,name=unpacks,proto3" json:"unpacks,omitempty"`
	// contains filtered or unexported fields
}

func (*ImageStore) Descriptor deprecated 

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

Deprecated: Use ImageStore.ProtoReflect.Descriptor instead.

func (*ImageStore) GetAllMetadata 

func (x *ImageStore) GetAllMetadata() bool

func (*ImageStore) GetExtraReferences 

func (x *ImageStore) GetExtraReferences() []*ImageReference

func (*ImageStore) GetLabels 

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

func (*ImageStore) GetManifestLimit 

func (x *ImageStore) GetManifestLimit() uint32

func (*ImageStore) GetName 

func (x *ImageStore) GetName() string

func (*ImageStore) GetPlatforms 

func (x *ImageStore) GetPlatforms() []*types.Platform

func (*ImageStore) GetUnpacks 

func (x *ImageStore) GetUnpacks() []*UnpackConfiguration

func (*ImageStore) ProtoMessage 

func (*ImageStore) ProtoMessage()

func (*ImageStore) ProtoReflect 

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

func (*ImageStore) Reset 

func (x *ImageStore) Reset()

func (*ImageStore) String 

func (x *ImageStore) String() string

type OCIRegistry 

type OCIRegistry struct {
	Reference string            `protobuf:"bytes,1,opt,name=reference,proto3" json:"reference,omitempty"`
	Resolver  *RegistryResolver `protobuf:"bytes,2,opt,name=resolver,proto3" json:"resolver,omitempty"`
	// contains filtered or unexported fields
}

func (*OCIRegistry) Descriptor deprecated 

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

Deprecated: Use OCIRegistry.ProtoReflect.Descriptor instead.

func (*OCIRegistry) GetReference 

func (x *OCIRegistry) GetReference() string

func (*OCIRegistry) GetResolver 

func (x *OCIRegistry) GetResolver() *RegistryResolver

func (*OCIRegistry) ProtoMessage 

func (*OCIRegistry) ProtoMessage()

func (*OCIRegistry) ProtoReflect 

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

func (*OCIRegistry) Reset 

func (x *OCIRegistry) Reset()

func (*OCIRegistry) String 

func (x *OCIRegistry) String() string

type Progress 

type Progress struct {
	Event    string            `protobuf:"bytes,1,opt,name=event,proto3" json:"event,omitempty"`
	Name     string            `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	Parents  []string          `protobuf:"bytes,3,rep,name=parents,proto3" json:"parents,omitempty"`
	Progress int64             `protobuf:"varint,4,opt,name=progress,proto3" json:"progress,omitempty"`
	Total    int64             `protobuf:"varint,5,opt,name=total,proto3" json:"total,omitempty"`
	Desc     *types.Descriptor `protobuf:"bytes,6,opt,name=desc,proto3" json:"desc,omitempty"`
	// contains filtered or unexported fields
}

func (*Progress) Descriptor deprecated 

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

Deprecated: Use Progress.ProtoReflect.Descriptor instead.

func (*Progress) GetDesc added in v1.8.0 

func (x *Progress) GetDesc() *types.Descriptor

func (*Progress) GetEvent 

func (x *Progress) GetEvent() string

func (*Progress) GetName 

func (x *Progress) GetName() string

func (*Progress) GetParents 

func (x *Progress) GetParents() []string

func (*Progress) GetProgress 

func (x *Progress) GetProgress() int64

func (*Progress) GetTotal 

func (x *Progress) GetTotal() int64

func (*Progress) ProtoMessage 

func (*Progress) ProtoMessage()

func (*Progress) ProtoReflect 

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

func (*Progress) Reset 

func (x *Progress) Reset()

func (*Progress) String 

func (x *Progress) String() string

type RegistryResolver 

type RegistryResolver struct {

	// auth_stream is used to refer to a stream which auth callbacks may be
	// made on.
	AuthStream string `protobuf:"bytes,1,opt,name=auth_stream,json=authStream,proto3" json:"auth_stream,omitempty"`
	// Headers
	Headers       map[string]string `` /* 155-byte string literal not displayed */
	HostDir       string            `protobuf:"bytes,3,opt,name=host_dir,json=hostDir,proto3" json:"host_dir,omitempty"`
	DefaultScheme string            `protobuf:"bytes,4,opt,name=default_scheme,json=defaultScheme,proto3" json:"default_scheme,omitempty"`
	// Whether to debug/trace HTTP requests to OCI registry.
	HttpDebug HTTPDebug `` /* 130-byte string literal not displayed */
	// Stream ID to use for HTTP logs (when logs are streamed to client).
	// When empty, logs are written to containerd logs.
	LogsStream string `protobuf:"bytes,6,opt,name=logs_stream,json=logsStream,proto3" json:"logs_stream,omitempty"`
	// contains filtered or unexported fields
}

func (*RegistryResolver) Descriptor deprecated 

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

Deprecated: Use RegistryResolver.ProtoReflect.Descriptor instead.

func (*RegistryResolver) GetAuthStream 

func (x *RegistryResolver) GetAuthStream() string

func (*RegistryResolver) GetDefaultScheme added in v1.8.0 

func (x *RegistryResolver) GetDefaultScheme() string

func (*RegistryResolver) GetHeaders 

func (x *RegistryResolver) GetHeaders() map[string]string

func (*RegistryResolver) GetHostDir added in v1.8.0 

func (x *RegistryResolver) GetHostDir() string

func (*RegistryResolver) GetHttpDebug added in v1.9.0 

func (x *RegistryResolver) GetHttpDebug() HTTPDebug

func (*RegistryResolver) GetLogsStream added in v1.9.0 

func (x *RegistryResolver) GetLogsStream() string

func (*RegistryResolver) ProtoMessage 

func (*RegistryResolver) ProtoMessage()

func (*RegistryResolver) ProtoReflect 

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

func (*RegistryResolver) Reset 

func (x *RegistryResolver) Reset()

func (*RegistryResolver) String 

func (x *RegistryResolver) String() string

type UnpackConfiguration 

type UnpackConfiguration struct {

	// platform is the platform to unpack for, used for resolving manifest and snapshotter
	// if not provided
	Platform *types.Platform `protobuf:"bytes,1,opt,name=platform,proto3" json:"platform,omitempty"`
	// snapshotter to unpack to, if not provided default for platform shoudl be used
	Snapshotter string `protobuf:"bytes,2,opt,name=snapshotter,proto3" json:"snapshotter,omitempty"`
	// contains filtered or unexported fields
}

func (*UnpackConfiguration) Descriptor deprecated 

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

Deprecated: Use UnpackConfiguration.ProtoReflect.Descriptor instead.

func (*UnpackConfiguration) GetPlatform 

func (x *UnpackConfiguration) GetPlatform() *types.Platform

func (*UnpackConfiguration) GetSnapshotter 

func (x *UnpackConfiguration) GetSnapshotter() string

func (*UnpackConfiguration) ProtoMessage 

func (*UnpackConfiguration) ProtoMessage()

func (*UnpackConfiguration) ProtoReflect 

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

func (*UnpackConfiguration) Reset 

func (x *UnpackConfiguration) Reset()

func (*UnpackConfiguration) String 

func (x *UnpackConfiguration) String() string

type WindowUpdate 

type WindowUpdate struct {
	Update int32 `protobuf:"varint,1,opt,name=update,proto3" json:"update,omitempty"`
	// contains filtered or unexported fields
}

func (*WindowUpdate) Descriptor deprecated 

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

Deprecated: Use WindowUpdate.ProtoReflect.Descriptor instead.

func (*WindowUpdate) GetUpdate 

func (x *WindowUpdate) GetUpdate() int32

func (*WindowUpdate) ProtoMessage 

func (*WindowUpdate) ProtoMessage()

func (*WindowUpdate) ProtoReflect 

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

func (*WindowUpdate) Reset 

func (x *WindowUpdate) Reset()

func (*WindowUpdate) String 

func (x *WindowUpdate) String() string

Source Files

View all Source files

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.