images

package
v1.7.14 Latest Latest
Warning

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

 Go to latest Published: Mar 11, 2024 License: Apache-2.0 Imports: 12 Imported by: 333

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var File_github_com_containerd_containerd_api_services_images_v1_images_proto protoreflect.FileDescriptor
View Source 
var Images_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "containerd.services.images.v1.Images",
	HandlerType: (*ImagesServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Get",
			Handler:    _Images_Get_Handler,
		},
		{
			MethodName: "List",
			Handler:    _Images_List_Handler,
		},
		{
			MethodName: "Create",
			Handler:    _Images_Create_Handler,
		},
		{
			MethodName: "Update",
			Handler:    _Images_Update_Handler,
		},
		{
			MethodName: "Delete",
			Handler:    _Images_Delete_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "github.com/containerd/containerd/api/services/images/v1/images.proto",
}

Images_ServiceDesc is the grpc.ServiceDesc for Images service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterImagesServer 

func RegisterImagesServer(s grpc.ServiceRegistrar, srv ImagesServer)

Types

type CreateImageRequest 

type CreateImageRequest struct {
	Image           *Image                 `protobuf:"bytes,1,opt,name=image,proto3" json:"image,omitempty"`
	SourceDateEpoch *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=source_date_epoch,json=sourceDateEpoch,proto3" json:"source_date_epoch,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateImageRequest) Descriptor deprecated 

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

Deprecated: Use CreateImageRequest.ProtoReflect.Descriptor instead.

func (*CreateImageRequest) GetImage added in v1.7.0 

func (x *CreateImageRequest) GetImage() *Image

func (*CreateImageRequest) GetSourceDateEpoch added in v1.7.0 

func (x *CreateImageRequest) GetSourceDateEpoch() *timestamppb.Timestamp

func (*CreateImageRequest) ProtoMessage 

func (*CreateImageRequest) ProtoMessage()

func (*CreateImageRequest) ProtoReflect added in v1.7.0 

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

func (*CreateImageRequest) Reset 

func (x *CreateImageRequest) Reset()

func (*CreateImageRequest) String 

func (x *CreateImageRequest) String() string

type CreateImageResponse 

type CreateImageResponse struct {
	Image *Image `protobuf:"bytes,1,opt,name=image,proto3" json:"image,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateImageResponse) Descriptor deprecated 

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

Deprecated: Use CreateImageResponse.ProtoReflect.Descriptor instead.

func (*CreateImageResponse) GetImage added in v1.7.0 

func (x *CreateImageResponse) GetImage() *Image

func (*CreateImageResponse) ProtoMessage 

func (*CreateImageResponse) ProtoMessage()

func (*CreateImageResponse) ProtoReflect added in v1.7.0 

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

func (*CreateImageResponse) Reset 

func (x *CreateImageResponse) Reset()

func (*CreateImageResponse) String 

func (x *CreateImageResponse) String() string

type DeleteImageRequest 

type DeleteImageRequest struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Sync indicates that the delete and cleanup should be done
	// synchronously before returning to the caller
	//
	// Default is false
	Sync bool `protobuf:"varint,2,opt,name=sync,proto3" json:"sync,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteImageRequest) Descriptor deprecated 

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

Deprecated: Use DeleteImageRequest.ProtoReflect.Descriptor instead.

func (*DeleteImageRequest) GetName added in v1.7.0 

func (x *DeleteImageRequest) GetName() string

func (*DeleteImageRequest) GetSync added in v1.7.0 

func (x *DeleteImageRequest) GetSync() bool

func (*DeleteImageRequest) ProtoMessage 

func (*DeleteImageRequest) ProtoMessage()

func (*DeleteImageRequest) ProtoReflect added in v1.7.0 

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

func (*DeleteImageRequest) Reset 

func (x *DeleteImageRequest) Reset()

func (*DeleteImageRequest) String 

func (x *DeleteImageRequest) String() string

type GetImageRequest 

type GetImageRequest struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

func (*GetImageRequest) Descriptor deprecated 

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

Deprecated: Use GetImageRequest.ProtoReflect.Descriptor instead.

func (*GetImageRequest) GetName added in v1.7.0 

func (x *GetImageRequest) GetName() string

func (*GetImageRequest) ProtoMessage 

func (*GetImageRequest) ProtoMessage()

func (*GetImageRequest) ProtoReflect added in v1.7.0 

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

func (*GetImageRequest) Reset 

func (x *GetImageRequest) Reset()

func (*GetImageRequest) String 

func (x *GetImageRequest) String() string

type GetImageResponse 

type GetImageResponse struct {
	Image *Image `protobuf:"bytes,1,opt,name=image,proto3" json:"image,omitempty"`
	// contains filtered or unexported fields
}

func (*GetImageResponse) Descriptor deprecated 

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

Deprecated: Use GetImageResponse.ProtoReflect.Descriptor instead.

func (*GetImageResponse) GetImage added in v1.7.0 

func (x *GetImageResponse) GetImage() *Image

func (*GetImageResponse) ProtoMessage 

func (*GetImageResponse) ProtoMessage()

func (*GetImageResponse) ProtoReflect added in v1.7.0 

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

func (*GetImageResponse) Reset 

func (x *GetImageResponse) Reset()

func (*GetImageResponse) String 

func (x *GetImageResponse) String() string

type Image 

type Image struct {

	// Name provides a unique name for the image.
	//
	// Containerd treats this as the primary identifier.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Labels provides free form labels for the image. These are runtime only
	// and do not get inherited into the package image in any way.
	//
	// Labels may be updated using the field mask.
	// The combined size of a key/value pair cannot exceed 4096 bytes.
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// Target describes the content entry point of the image.
	Target *types.Descriptor `protobuf:"bytes,3,opt,name=target,proto3" json:"target,omitempty"`
	// CreatedAt is the time the image was first created.
	CreatedAt *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"`
	// UpdatedAt is the last time the image was mutated.
	UpdatedAt *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=updated_at,json=updatedAt,proto3" json:"updated_at,omitempty"`
	// contains filtered or unexported fields
}

func (*Image) Descriptor deprecated 

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

Deprecated: Use Image.ProtoReflect.Descriptor instead.

func (*Image) GetCreatedAt added in v1.7.0 

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

func (*Image) GetLabels added in v1.7.0 

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

func (*Image) GetName added in v1.7.0 

func (x *Image) GetName() string

func (*Image) GetTarget added in v1.7.0 

func (x *Image) GetTarget() *types.Descriptor

func (*Image) GetUpdatedAt added in v1.7.0 

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

func (*Image) ProtoMessage 

func (*Image) ProtoMessage()

func (*Image) ProtoReflect added in v1.7.0 

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

func (*Image) Reset 

func (x *Image) Reset()

func (*Image) String 

func (x *Image) String() string

type ImagesClient 

type ImagesClient interface {
	// Get returns an image by name.
	Get(ctx context.Context, in *GetImageRequest, opts ...grpc.CallOption) (*GetImageResponse, error)
	// List returns a list of all images known to containerd.
	List(ctx context.Context, in *ListImagesRequest, opts ...grpc.CallOption) (*ListImagesResponse, error)
	// Create an image record in the metadata store.
	//
	// The name of the image must be unique.
	Create(ctx context.Context, in *CreateImageRequest, opts ...grpc.CallOption) (*CreateImageResponse, error)
	// Update assigns the name to a given target image based on the provided
	// image.
	Update(ctx context.Context, in *UpdateImageRequest, opts ...grpc.CallOption) (*UpdateImageResponse, error)
	// Delete deletes the image by name.
	Delete(ctx context.Context, in *DeleteImageRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
}

ImagesClient is the client API for Images service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewImagesClient 

func NewImagesClient(cc grpc.ClientConnInterface) ImagesClient

type ImagesServer 

type ImagesServer interface {
	// Get returns an image by name.
	Get(context.Context, *GetImageRequest) (*GetImageResponse, error)
	// List returns a list of all images known to containerd.
	List(context.Context, *ListImagesRequest) (*ListImagesResponse, error)
	// Create an image record in the metadata store.
	//
	// The name of the image must be unique.
	Create(context.Context, *CreateImageRequest) (*CreateImageResponse, error)
	// Update assigns the name to a given target image based on the provided
	// image.
	Update(context.Context, *UpdateImageRequest) (*UpdateImageResponse, error)
	// Delete deletes the image by name.
	Delete(context.Context, *DeleteImageRequest) (*emptypb.Empty, error)
	// contains filtered or unexported methods
}

ImagesServer is the server API for Images service. All implementations must embed UnimplementedImagesServer for forward compatibility

type ListImagesRequest 

type ListImagesRequest struct {

	// Filters contains one or more filters using the syntax defined in the
	// containerd filter package.
	//
	// The returned result will be those that match any of the provided
	// filters. Expanded, images that match the following will be
	// returned:
	//
	//	filters[0] or filters[1] or ... or filters[n-1] or filters[n]
	//
	// If filters is zero-length or nil, all items will be returned.
	Filters []string `protobuf:"bytes,1,rep,name=filters,proto3" json:"filters,omitempty"`
	// contains filtered or unexported fields
}

func (*ListImagesRequest) Descriptor deprecated 

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

Deprecated: Use ListImagesRequest.ProtoReflect.Descriptor instead.

func (*ListImagesRequest) GetFilters added in v1.7.0 

func (x *ListImagesRequest) GetFilters() []string

func (*ListImagesRequest) ProtoMessage 

func (*ListImagesRequest) ProtoMessage()

func (*ListImagesRequest) ProtoReflect added in v1.7.0 

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

func (*ListImagesRequest) Reset 

func (x *ListImagesRequest) Reset()

func (*ListImagesRequest) String 

func (x *ListImagesRequest) String() string

type ListImagesResponse 

type ListImagesResponse struct {
	Images []*Image `protobuf:"bytes,1,rep,name=images,proto3" json:"images,omitempty"`
	// contains filtered or unexported fields
}

func (*ListImagesResponse) Descriptor deprecated 

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

Deprecated: Use ListImagesResponse.ProtoReflect.Descriptor instead.

func (*ListImagesResponse) GetImages added in v1.7.0 

func (x *ListImagesResponse) GetImages() []*Image

func (*ListImagesResponse) ProtoMessage 

func (*ListImagesResponse) ProtoMessage()

func (*ListImagesResponse) ProtoReflect added in v1.7.0 

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

func (*ListImagesResponse) Reset 

func (x *ListImagesResponse) Reset()

func (*ListImagesResponse) String 

func (x *ListImagesResponse) String() string

type UnimplementedImagesServer added in v1.4.0 

type UnimplementedImagesServer struct {
}

UnimplementedImagesServer must be embedded to have forward compatible implementations.

func (UnimplementedImagesServer) Create added in v1.4.0 

func (UnimplementedImagesServer) Create(context.Context, *CreateImageRequest) (*CreateImageResponse, error)

func (UnimplementedImagesServer) Delete added in v1.4.0 

func (UnimplementedImagesServer) Delete(context.Context, *DeleteImageRequest) (*emptypb.Empty, error)

func (UnimplementedImagesServer) Get added in v1.4.0 

func (UnimplementedImagesServer) Get(context.Context, *GetImageRequest) (*GetImageResponse, error)

func (UnimplementedImagesServer) List added in v1.4.0 

func (UnimplementedImagesServer) List(context.Context, *ListImagesRequest) (*ListImagesResponse, error)

func (UnimplementedImagesServer) Update added in v1.4.0 

func (UnimplementedImagesServer) Update(context.Context, *UpdateImageRequest) (*UpdateImageResponse, error)

type UnsafeImagesServer added in v1.7.0 

type UnsafeImagesServer interface {
	// contains filtered or unexported methods
}

UnsafeImagesServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to ImagesServer will result in compilation errors.

type UpdateImageRequest 

type UpdateImageRequest struct {

	// Image provides a full or partial image for update.
	//
	// The name field must be set or an error will be returned.
	Image *Image `protobuf:"bytes,1,opt,name=image,proto3" json:"image,omitempty"`
	// UpdateMask specifies which fields to perform the update on. If empty,
	// the operation applies to all fields.
	UpdateMask      *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	SourceDateEpoch *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=source_date_epoch,json=sourceDateEpoch,proto3" json:"source_date_epoch,omitempty"`
	// contains filtered or unexported fields
}

func (*UpdateImageRequest) Descriptor deprecated 

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

Deprecated: Use UpdateImageRequest.ProtoReflect.Descriptor instead.

func (*UpdateImageRequest) GetImage added in v1.7.0 

func (x *UpdateImageRequest) GetImage() *Image

func (*UpdateImageRequest) GetSourceDateEpoch added in v1.7.0 

func (x *UpdateImageRequest) GetSourceDateEpoch() *timestamppb.Timestamp

func (*UpdateImageRequest) GetUpdateMask added in v1.7.0 

func (x *UpdateImageRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateImageRequest) ProtoMessage 

func (*UpdateImageRequest) ProtoMessage()

func (*UpdateImageRequest) ProtoReflect added in v1.7.0 

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

func (*UpdateImageRequest) Reset 

func (x *UpdateImageRequest) Reset()

func (*UpdateImageRequest) String 

func (x *UpdateImageRequest) String() string

type UpdateImageResponse 

type UpdateImageResponse struct {
	Image *Image `protobuf:"bytes,1,opt,name=image,proto3" json:"image,omitempty"`
	// contains filtered or unexported fields
}

func (*UpdateImageResponse) Descriptor deprecated 

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

Deprecated: Use UpdateImageResponse.ProtoReflect.Descriptor instead.

func (*UpdateImageResponse) GetImage added in v1.7.0 

func (x *UpdateImageResponse) GetImage() *Image

func (*UpdateImageResponse) ProtoMessage 

func (*UpdateImageResponse) ProtoMessage()

func (*UpdateImageResponse) ProtoReflect added in v1.7.0 

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

func (*UpdateImageResponse) Reset 

func (x *UpdateImageResponse) Reset()

func (*UpdateImageResponse) String 

func (x *UpdateImageResponse) 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.