Documentation ¶
Overview ¶
Package images is a generated protocol buffer package.
It is generated from these files:
github.com/containerd/containerd/api/services/images/v1/images.proto
It has these top-level messages:
Image GetImageRequest GetImageResponse CreateImageRequest CreateImageResponse UpdateImageRequest UpdateImageResponse ListImagesRequest ListImagesResponse DeleteImageRequest
Index ¶
- Variables
- func RegisterImagesServer(s *grpc.Server, srv ImagesServer)
- type CreateImageRequest
- func (*CreateImageRequest) Descriptor() ([]byte, []int)
- func (m *CreateImageRequest) Marshal() (dAtA []byte, err error)
- func (m *CreateImageRequest) MarshalTo(dAtA []byte) (int, error)
- func (*CreateImageRequest) ProtoMessage()
- func (m *CreateImageRequest) Reset()
- func (m *CreateImageRequest) Size() (n int)
- func (this *CreateImageRequest) String() string
- func (m *CreateImageRequest) Unmarshal(dAtA []byte) error
- type CreateImageResponse
- func (*CreateImageResponse) Descriptor() ([]byte, []int)
- func (m *CreateImageResponse) Marshal() (dAtA []byte, err error)
- func (m *CreateImageResponse) MarshalTo(dAtA []byte) (int, error)
- func (*CreateImageResponse) ProtoMessage()
- func (m *CreateImageResponse) Reset()
- func (m *CreateImageResponse) Size() (n int)
- func (this *CreateImageResponse) String() string
- func (m *CreateImageResponse) Unmarshal(dAtA []byte) error
- type DeleteImageRequest
- func (*DeleteImageRequest) Descriptor() ([]byte, []int)
- func (m *DeleteImageRequest) Marshal() (dAtA []byte, err error)
- func (m *DeleteImageRequest) MarshalTo(dAtA []byte) (int, error)
- func (*DeleteImageRequest) ProtoMessage()
- func (m *DeleteImageRequest) Reset()
- func (m *DeleteImageRequest) Size() (n int)
- func (this *DeleteImageRequest) String() string
- func (m *DeleteImageRequest) Unmarshal(dAtA []byte) error
- type GetImageRequest
- func (*GetImageRequest) Descriptor() ([]byte, []int)
- func (m *GetImageRequest) Marshal() (dAtA []byte, err error)
- func (m *GetImageRequest) MarshalTo(dAtA []byte) (int, error)
- func (*GetImageRequest) ProtoMessage()
- func (m *GetImageRequest) Reset()
- func (m *GetImageRequest) Size() (n int)
- func (this *GetImageRequest) String() string
- func (m *GetImageRequest) Unmarshal(dAtA []byte) error
- type GetImageResponse
- func (*GetImageResponse) Descriptor() ([]byte, []int)
- func (m *GetImageResponse) Marshal() (dAtA []byte, err error)
- func (m *GetImageResponse) MarshalTo(dAtA []byte) (int, error)
- func (*GetImageResponse) ProtoMessage()
- func (m *GetImageResponse) Reset()
- func (m *GetImageResponse) Size() (n int)
- func (this *GetImageResponse) String() string
- func (m *GetImageResponse) Unmarshal(dAtA []byte) error
- type Image
- func (*Image) Descriptor() ([]byte, []int)
- func (m *Image) Marshal() (dAtA []byte, err error)
- func (m *Image) MarshalTo(dAtA []byte) (int, error)
- func (*Image) ProtoMessage()
- func (m *Image) Reset()
- func (m *Image) Size() (n int)
- func (this *Image) String() string
- func (m *Image) Unmarshal(dAtA []byte) error
- type ImagesClient
- type ImagesServer
- type ListImagesRequest
- func (*ListImagesRequest) Descriptor() ([]byte, []int)
- func (m *ListImagesRequest) Marshal() (dAtA []byte, err error)
- func (m *ListImagesRequest) MarshalTo(dAtA []byte) (int, error)
- func (*ListImagesRequest) ProtoMessage()
- func (m *ListImagesRequest) Reset()
- func (m *ListImagesRequest) Size() (n int)
- func (this *ListImagesRequest) String() string
- func (m *ListImagesRequest) Unmarshal(dAtA []byte) error
- type ListImagesResponse
- func (*ListImagesResponse) Descriptor() ([]byte, []int)
- func (m *ListImagesResponse) Marshal() (dAtA []byte, err error)
- func (m *ListImagesResponse) MarshalTo(dAtA []byte) (int, error)
- func (*ListImagesResponse) ProtoMessage()
- func (m *ListImagesResponse) Reset()
- func (m *ListImagesResponse) Size() (n int)
- func (this *ListImagesResponse) String() string
- func (m *ListImagesResponse) Unmarshal(dAtA []byte) error
- type UpdateImageRequest
- func (*UpdateImageRequest) Descriptor() ([]byte, []int)
- func (m *UpdateImageRequest) Marshal() (dAtA []byte, err error)
- func (m *UpdateImageRequest) MarshalTo(dAtA []byte) (int, error)
- func (*UpdateImageRequest) ProtoMessage()
- func (m *UpdateImageRequest) Reset()
- func (m *UpdateImageRequest) Size() (n int)
- func (this *UpdateImageRequest) String() string
- func (m *UpdateImageRequest) Unmarshal(dAtA []byte) error
- type UpdateImageResponse
- func (*UpdateImageResponse) Descriptor() ([]byte, []int)
- func (m *UpdateImageResponse) Marshal() (dAtA []byte, err error)
- func (m *UpdateImageResponse) MarshalTo(dAtA []byte) (int, error)
- func (*UpdateImageResponse) ProtoMessage()
- func (m *UpdateImageResponse) Reset()
- func (m *UpdateImageResponse) Size() (n int)
- func (this *UpdateImageResponse) String() string
- func (m *UpdateImageResponse) Unmarshal(dAtA []byte) error
Constants ¶
This section is empty.
Variables ¶
View Source
var ( ErrInvalidLengthImages = fmt.Errorf("proto: negative length found during unmarshaling") ErrIntOverflowImages = fmt.Errorf("proto: integer overflow") )
Functions ¶
func RegisterImagesServer ¶
func RegisterImagesServer(s *grpc.Server, srv ImagesServer)
Types ¶
type CreateImageRequest ¶
type CreateImageRequest struct {
Image Image `protobuf:"bytes,1,opt,name=image" json:"image"`
}
func (*CreateImageRequest) Descriptor ¶
func (*CreateImageRequest) Descriptor() ([]byte, []int)
func (*CreateImageRequest) Marshal ¶
func (m *CreateImageRequest) Marshal() (dAtA []byte, err error)
func (*CreateImageRequest) MarshalTo ¶
func (m *CreateImageRequest) MarshalTo(dAtA []byte) (int, error)
func (*CreateImageRequest) ProtoMessage ¶
func (*CreateImageRequest) ProtoMessage()
func (*CreateImageRequest) Reset ¶
func (m *CreateImageRequest) Reset()
func (*CreateImageRequest) Size ¶
func (m *CreateImageRequest) Size() (n int)
func (*CreateImageRequest) String ¶
func (this *CreateImageRequest) String() string
func (*CreateImageRequest) Unmarshal ¶
func (m *CreateImageRequest) Unmarshal(dAtA []byte) error
type CreateImageResponse ¶
type CreateImageResponse struct {
Image Image `protobuf:"bytes,1,opt,name=image" json:"image"`
}
func (*CreateImageResponse) Descriptor ¶
func (*CreateImageResponse) Descriptor() ([]byte, []int)
func (*CreateImageResponse) Marshal ¶
func (m *CreateImageResponse) Marshal() (dAtA []byte, err error)
func (*CreateImageResponse) MarshalTo ¶
func (m *CreateImageResponse) MarshalTo(dAtA []byte) (int, error)
func (*CreateImageResponse) ProtoMessage ¶
func (*CreateImageResponse) ProtoMessage()
func (*CreateImageResponse) Reset ¶
func (m *CreateImageResponse) Reset()
func (*CreateImageResponse) Size ¶
func (m *CreateImageResponse) Size() (n int)
func (*CreateImageResponse) String ¶
func (this *CreateImageResponse) String() string
func (*CreateImageResponse) Unmarshal ¶
func (m *CreateImageResponse) Unmarshal(dAtA []byte) error
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"` }
func (*DeleteImageRequest) Descriptor ¶
func (*DeleteImageRequest) Descriptor() ([]byte, []int)
func (*DeleteImageRequest) Marshal ¶
func (m *DeleteImageRequest) Marshal() (dAtA []byte, err error)
func (*DeleteImageRequest) MarshalTo ¶
func (m *DeleteImageRequest) MarshalTo(dAtA []byte) (int, error)
func (*DeleteImageRequest) ProtoMessage ¶
func (*DeleteImageRequest) ProtoMessage()
func (*DeleteImageRequest) Reset ¶
func (m *DeleteImageRequest) Reset()
func (*DeleteImageRequest) Size ¶
func (m *DeleteImageRequest) Size() (n int)
func (*DeleteImageRequest) String ¶
func (this *DeleteImageRequest) String() string
func (*DeleteImageRequest) Unmarshal ¶
func (m *DeleteImageRequest) Unmarshal(dAtA []byte) error
type GetImageRequest ¶
type GetImageRequest struct {
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
}
func (*GetImageRequest) Descriptor ¶
func (*GetImageRequest) Descriptor() ([]byte, []int)
func (*GetImageRequest) Marshal ¶
func (m *GetImageRequest) Marshal() (dAtA []byte, err error)
func (*GetImageRequest) ProtoMessage ¶
func (*GetImageRequest) ProtoMessage()
func (*GetImageRequest) Reset ¶
func (m *GetImageRequest) Reset()
func (*GetImageRequest) Size ¶
func (m *GetImageRequest) Size() (n int)
func (*GetImageRequest) String ¶
func (this *GetImageRequest) String() string
func (*GetImageRequest) Unmarshal ¶
func (m *GetImageRequest) Unmarshal(dAtA []byte) error
type GetImageResponse ¶
type GetImageResponse struct {
Image *Image `protobuf:"bytes,1,opt,name=image" json:"image,omitempty"`
}
func (*GetImageResponse) Descriptor ¶
func (*GetImageResponse) Descriptor() ([]byte, []int)
func (*GetImageResponse) Marshal ¶
func (m *GetImageResponse) Marshal() (dAtA []byte, err error)
func (*GetImageResponse) ProtoMessage ¶
func (*GetImageResponse) ProtoMessage()
func (*GetImageResponse) Reset ¶
func (m *GetImageResponse) Reset()
func (*GetImageResponse) Size ¶
func (m *GetImageResponse) Size() (n int)
func (*GetImageResponse) String ¶
func (this *GetImageResponse) String() string
func (*GetImageResponse) Unmarshal ¶
func (m *GetImageResponse) Unmarshal(dAtA []byte) error
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 `` /* 146-byte string literal not displayed */ // Target describes the content entry point of the image. Target containerd_types.Descriptor `protobuf:"bytes,3,opt,name=target" json:"target"` // CreatedAt is the time the image was first created. CreatedAt time.Time `protobuf:"bytes,7,opt,name=created_at,json=createdAt,stdtime" json:"created_at"` // UpdatedAt is the last time the image was mutated. UpdatedAt time.Time `protobuf:"bytes,8,opt,name=updated_at,json=updatedAt,stdtime" json:"updated_at"` }
func (*Image) Descriptor ¶
func (*Image) ProtoMessage ¶
func (*Image) ProtoMessage()
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) (*google_protobuf1.Empty, error) }
func NewImagesClient ¶
func NewImagesClient(cc *grpc.ClientConn) 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) (*google_protobuf1.Empty, error) }
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" json:"filters,omitempty"` }
func (*ListImagesRequest) Descriptor ¶
func (*ListImagesRequest) Descriptor() ([]byte, []int)
func (*ListImagesRequest) Marshal ¶
func (m *ListImagesRequest) Marshal() (dAtA []byte, err error)
func (*ListImagesRequest) MarshalTo ¶
func (m *ListImagesRequest) MarshalTo(dAtA []byte) (int, error)
func (*ListImagesRequest) ProtoMessage ¶
func (*ListImagesRequest) ProtoMessage()
func (*ListImagesRequest) Reset ¶
func (m *ListImagesRequest) Reset()
func (*ListImagesRequest) Size ¶
func (m *ListImagesRequest) Size() (n int)
func (*ListImagesRequest) String ¶
func (this *ListImagesRequest) String() string
func (*ListImagesRequest) Unmarshal ¶
func (m *ListImagesRequest) Unmarshal(dAtA []byte) error
type ListImagesResponse ¶
type ListImagesResponse struct {
Images []Image `protobuf:"bytes,1,rep,name=images" json:"images"`
}
func (*ListImagesResponse) Descriptor ¶
func (*ListImagesResponse) Descriptor() ([]byte, []int)
func (*ListImagesResponse) Marshal ¶
func (m *ListImagesResponse) Marshal() (dAtA []byte, err error)
func (*ListImagesResponse) MarshalTo ¶
func (m *ListImagesResponse) MarshalTo(dAtA []byte) (int, error)
func (*ListImagesResponse) ProtoMessage ¶
func (*ListImagesResponse) ProtoMessage()
func (*ListImagesResponse) Reset ¶
func (m *ListImagesResponse) Reset()
func (*ListImagesResponse) Size ¶
func (m *ListImagesResponse) Size() (n int)
func (*ListImagesResponse) String ¶
func (this *ListImagesResponse) String() string
func (*ListImagesResponse) Unmarshal ¶
func (m *ListImagesResponse) Unmarshal(dAtA []byte) error
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" json:"image"` // UpdateMask specifies which fields to perform the update on. If empty, // the operation applies to all fields. UpdateMask *google_protobuf2.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask" json:"update_mask,omitempty"` }
func (*UpdateImageRequest) Descriptor ¶
func (*UpdateImageRequest) Descriptor() ([]byte, []int)
func (*UpdateImageRequest) Marshal ¶
func (m *UpdateImageRequest) Marshal() (dAtA []byte, err error)
func (*UpdateImageRequest) MarshalTo ¶
func (m *UpdateImageRequest) MarshalTo(dAtA []byte) (int, error)
func (*UpdateImageRequest) ProtoMessage ¶
func (*UpdateImageRequest) ProtoMessage()
func (*UpdateImageRequest) Reset ¶
func (m *UpdateImageRequest) Reset()
func (*UpdateImageRequest) Size ¶
func (m *UpdateImageRequest) Size() (n int)
func (*UpdateImageRequest) String ¶
func (this *UpdateImageRequest) String() string
func (*UpdateImageRequest) Unmarshal ¶
func (m *UpdateImageRequest) Unmarshal(dAtA []byte) error
type UpdateImageResponse ¶
type UpdateImageResponse struct {
Image Image `protobuf:"bytes,1,opt,name=image" json:"image"`
}
func (*UpdateImageResponse) Descriptor ¶
func (*UpdateImageResponse) Descriptor() ([]byte, []int)
func (*UpdateImageResponse) Marshal ¶
func (m *UpdateImageResponse) Marshal() (dAtA []byte, err error)
func (*UpdateImageResponse) MarshalTo ¶
func (m *UpdateImageResponse) MarshalTo(dAtA []byte) (int, error)
func (*UpdateImageResponse) ProtoMessage ¶
func (*UpdateImageResponse) ProtoMessage()
func (*UpdateImageResponse) Reset ¶
func (m *UpdateImageResponse) Reset()
func (*UpdateImageResponse) Size ¶
func (m *UpdateImageResponse) Size() (n int)
func (*UpdateImageResponse) String ¶
func (this *UpdateImageResponse) String() string
func (*UpdateImageResponse) Unmarshal ¶
func (m *UpdateImageResponse) Unmarshal(dAtA []byte) error
Click to show internal directories.
Click to hide internal directories.