Documentation
¶
Overview ¶
Package transfer defines the transfer types.
Index ¶
- Variables
- type AuthRequest
- func (*AuthRequest) Descriptor() ([]byte, []int)deprecated
- func (x *AuthRequest) GetHost() string
- func (x *AuthRequest) GetReference() string
- func (x *AuthRequest) GetWwwauthenticate() []string
- func (*AuthRequest) ProtoMessage()
- func (x *AuthRequest) ProtoReflect() protoreflect.Message
- func (x *AuthRequest) Reset()
- func (x *AuthRequest) String() string
- type AuthResponse
- func (*AuthResponse) Descriptor() ([]byte, []int)deprecated
- func (x *AuthResponse) GetAuthType() AuthType
- func (x *AuthResponse) GetExpireAt() *timestamppb.Timestamp
- func (x *AuthResponse) GetSecret() string
- func (x *AuthResponse) GetUsername() string
- func (*AuthResponse) ProtoMessage()
- func (x *AuthResponse) ProtoReflect() protoreflect.Message
- func (x *AuthResponse) Reset()
- func (x *AuthResponse) String() string
- type AuthType
- type Data
- type ImageExportStream
- func (*ImageExportStream) Descriptor() ([]byte, []int)deprecated
- func (x *ImageExportStream) GetMediaType() string
- func (x *ImageExportStream) GetStream() string
- func (*ImageExportStream) ProtoMessage()
- func (x *ImageExportStream) ProtoReflect() protoreflect.Message
- func (x *ImageExportStream) Reset()
- func (x *ImageExportStream) String() string
- type ImageImportStream
- func (*ImageImportStream) Descriptor() ([]byte, []int)deprecated
- func (x *ImageImportStream) GetForceCompress() bool
- func (x *ImageImportStream) GetMediaType() string
- func (x *ImageImportStream) GetStream() string
- func (*ImageImportStream) ProtoMessage()
- func (x *ImageImportStream) ProtoReflect() protoreflect.Message
- func (x *ImageImportStream) Reset()
- func (x *ImageImportStream) String() string
- type ImageStore
- func (*ImageStore) Descriptor() ([]byte, []int)deprecated
- func (x *ImageStore) GetAllMetadata() bool
- func (x *ImageStore) GetAlwaysDigest() bool
- func (x *ImageStore) GetCheckPrefix() bool
- func (x *ImageStore) GetDigestRefs() bool
- func (x *ImageStore) GetLabels() map[string]string
- func (x *ImageStore) GetManifestLimit() uint32
- func (x *ImageStore) GetName() string
- func (x *ImageStore) GetPlatforms() []*types.Platform
- func (x *ImageStore) GetPrefix() string
- func (x *ImageStore) GetUnpacks() []*UnpackConfiguration
- func (*ImageStore) ProtoMessage()
- func (x *ImageStore) ProtoReflect() protoreflect.Message
- func (x *ImageStore) Reset()
- func (x *ImageStore) String() string
- type OCIRegistry
- func (*OCIRegistry) Descriptor() ([]byte, []int)deprecated
- func (x *OCIRegistry) GetReference() string
- func (x *OCIRegistry) GetResolver() *RegistryResolver
- func (*OCIRegistry) ProtoMessage()
- func (x *OCIRegistry) ProtoReflect() protoreflect.Message
- func (x *OCIRegistry) Reset()
- func (x *OCIRegistry) String() string
- type Progress
- func (*Progress) Descriptor() ([]byte, []int)deprecated
- func (x *Progress) GetEvent() string
- func (x *Progress) GetName() string
- func (x *Progress) GetParents() []string
- func (x *Progress) GetProgress() int64
- func (x *Progress) GetTotal() int64
- func (*Progress) ProtoMessage()
- func (x *Progress) ProtoReflect() protoreflect.Message
- func (x *Progress) Reset()
- func (x *Progress) String() string
- type RegistryResolver
- func (*RegistryResolver) Descriptor() ([]byte, []int)deprecated
- func (x *RegistryResolver) GetAuthStream() string
- func (x *RegistryResolver) GetHeaders() map[string]string
- func (*RegistryResolver) ProtoMessage()
- func (x *RegistryResolver) ProtoReflect() protoreflect.Message
- func (x *RegistryResolver) Reset()
- func (x *RegistryResolver) String() string
- type UnpackConfiguration
- func (*UnpackConfiguration) Descriptor() ([]byte, []int)deprecated
- func (x *UnpackConfiguration) GetPlatform() *types.Platform
- func (x *UnpackConfiguration) GetSnapshotter() string
- func (*UnpackConfiguration) ProtoMessage()
- func (x *UnpackConfiguration) ProtoReflect() protoreflect.Message
- func (x *UnpackConfiguration) Reset()
- func (x *UnpackConfiguration) String() string
- type WindowUpdate
Constants ¶
This section is empty.
Variables ¶
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.
var File_github_com_containerd_containerd_api_types_transfer_imagestore_proto protoreflect.FileDescriptor
var File_github_com_containerd_containerd_api_types_transfer_importexport_proto protoreflect.FileDescriptor
var File_github_com_containerd_containerd_api_types_transfer_progress_proto protoreflect.FileDescriptor
var File_github_com_containerd_containerd_api_types_transfer_registry_proto protoreflect.FileDescriptor
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) EnumDescriptor
deprecated
func (AuthType) Number ¶
func (x AuthType) Number() protoreflect.EnumNumber
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) ProtoMessage ¶
func (*Data) ProtoMessage()
func (*Data) ProtoReflect ¶
func (x *Data) ProtoReflect() protoreflect.Message
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"`
// contains filtered or unexported fields
}
func (*ImageExportStream) Descriptor
deprecated
func (*ImageExportStream) Descriptor() ([]byte, []int)
Deprecated: Use ImageExportStream.ProtoReflect.Descriptor instead.
func (*ImageExportStream) GetMediaType ¶
func (x *ImageExportStream) GetMediaType() string
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 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"`
// prefix is the intended image name prefix for imported images
Prefix string `protobuf:"bytes,6,opt,name=prefix,proto3" json:"prefix,omitempty"`
// check_prefix only stores images with the prefix
CheckPrefix bool `protobuf:"varint,7,opt,name=check_prefix,json=checkPrefix,proto3" json:"check_prefix,omitempty"`
// digest_refs adds digest references for images using prefix
DigestRefs bool `protobuf:"varint,8,opt,name=digest_refs,json=digestRefs,proto3" json:"digest_refs,omitempty"`
// always_digest includes a digest image even when a non-digest image is stored
AlwaysDigest bool `protobuf:"varint,9,opt,name=always_digest,json=alwaysDigest,proto3" json:"always_digest,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) GetAlwaysDigest ¶
func (x *ImageStore) GetAlwaysDigest() bool
func (*ImageStore) GetCheckPrefix ¶
func (x *ImageStore) GetCheckPrefix() bool
func (*ImageStore) GetDigestRefs ¶
func (x *ImageStore) GetDigestRefs() bool
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) GetPrefix ¶
func (x *ImageStore) GetPrefix() string
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"`
// contains filtered or unexported fields
}
func (*Progress) Descriptor
deprecated
func (*Progress) GetParents ¶
func (*Progress) GetProgress ¶
func (*Progress) ProtoMessage ¶
func (*Progress) ProtoMessage()
func (*Progress) ProtoReflect ¶
func (x *Progress) ProtoReflect() protoreflect.Message
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 */
// 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) GetHeaders ¶
func (x *RegistryResolver) GetHeaders() map[string]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