containers

package
v1.7.0-rc.1 Latest Latest
Warning

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

 Go to latest Published: Mar 2, 2023 License: Apache-2.0 Imports: 12 Imported by: 372

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var Containers_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "containerd.services.containers.v1.Containers",
	HandlerType: (*ContainersServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Get",
			Handler:    _Containers_Get_Handler,
		},
		{
			MethodName: "List",
			Handler:    _Containers_List_Handler,
		},
		{
			MethodName: "Create",
			Handler:    _Containers_Create_Handler,
		},
		{
			MethodName: "Update",
			Handler:    _Containers_Update_Handler,
		},
		{
			MethodName: "Delete",
			Handler:    _Containers_Delete_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "ListStream",
			Handler:       _Containers_ListStream_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "github.com/containerd/containerd/api/services/containers/v1/containers.proto",
}

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

View Source 
var File_github_com_containerd_containerd_api_services_containers_v1_containers_proto protoreflect.FileDescriptor

Functions

func RegisterContainersServer 

func RegisterContainersServer(s grpc.ServiceRegistrar, srv ContainersServer)

Types

type Container 

type Container struct {

	// ID is the user-specified identifier.
	//
	// This field may not be updated.
	ID string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Labels provides an area to include arbitrary data on containers.
	//
	// The combined size of a key/value pair cannot exceed 4096 bytes.
	//
	// Note that to add a new value to this field, read the existing set and
	// include the entire result in the update call.
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// Image contains the reference of the image used to build the
	// specification and snapshots for running this container.
	//
	// If this field is updated, the spec and rootfs needed to updated, as well.
	Image string `protobuf:"bytes,3,opt,name=image,proto3" json:"image,omitempty"`
	// Runtime specifies which runtime to use for executing this container.
	Runtime *Container_Runtime `protobuf:"bytes,4,opt,name=runtime,proto3" json:"runtime,omitempty"`
	// Spec to be used when creating the container. This is runtime specific.
	Spec *anypb.Any `protobuf:"bytes,5,opt,name=spec,proto3" json:"spec,omitempty"`
	// Snapshotter specifies the snapshotter name used for rootfs
	Snapshotter string `protobuf:"bytes,6,opt,name=snapshotter,proto3" json:"snapshotter,omitempty"`
	// SnapshotKey specifies the snapshot key to use for the container's root
	// filesystem. When starting a task from this container, a caller should
	// look up the mounts from the snapshot service and include those on the
	// task create request.
	//
	// Snapshots referenced in this field will not be garbage collected.
	//
	// This field is set to empty when the rootfs is not a snapshot.
	//
	// This field may be updated.
	SnapshotKey string `protobuf:"bytes,7,opt,name=snapshot_key,json=snapshotKey,proto3" json:"snapshot_key,omitempty"`
	// CreatedAt is the time the container was first created.
	CreatedAt *timestamppb.Timestamp `protobuf:"bytes,8,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,9,opt,name=updated_at,json=updatedAt,proto3" json:"updated_at,omitempty"`
	// Extensions allow clients to provide zero or more blobs that are directly
	// associated with the container. One may provide protobuf, json, or other
	// encoding formats. The primary use of this is to further decorate the
	// container object with fields that may be specific to a client integration.
	//
	// The key portion of this map should identify a "name" for the extension
	// that should be unique against other extensions. When updating extension
	// data, one should only update the specified extension using field paths
	// to select a specific map key.
	Extensions map[string]*anypb.Any `` /* 162-byte string literal not displayed */
	// Sandbox ID this container belongs to.
	Sandbox string `protobuf:"bytes,11,opt,name=sandbox,proto3" json:"sandbox,omitempty"`
	// contains filtered or unexported fields
}

func (*Container) Descriptor deprecated 

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

Deprecated: Use Container.ProtoReflect.Descriptor instead.

func (*Container) GetCreatedAt added in v1.7.0 

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

func (*Container) GetExtensions added in v1.7.0 

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

func (*Container) GetID added in v1.7.0 

func (x *Container) GetID() string

func (*Container) GetImage added in v1.7.0 

func (x *Container) GetImage() string

func (*Container) GetLabels added in v1.7.0 

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

func (*Container) GetRuntime added in v1.7.0 

func (x *Container) GetRuntime() *Container_Runtime

func (*Container) GetSandbox added in v1.7.0 

func (x *Container) GetSandbox() string

func (*Container) GetSnapshotKey added in v1.7.0 

func (x *Container) GetSnapshotKey() string

func (*Container) GetSnapshotter added in v1.7.0 

func (x *Container) GetSnapshotter() string

func (*Container) GetSpec added in v1.7.0 

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

func (*Container) GetUpdatedAt added in v1.7.0 

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

func (*Container) ProtoMessage 

func (*Container) ProtoMessage()

func (*Container) ProtoReflect added in v1.7.0 

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

func (*Container) Reset 

func (x *Container) Reset()

func (*Container) String 

func (x *Container) String() string

type Container_Runtime 

type Container_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.
	Options *anypb.Any `protobuf:"bytes,2,opt,name=options,proto3" json:"options,omitempty"`
	// contains filtered or unexported fields
}

func (*Container_Runtime) Descriptor deprecated 

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

Deprecated: Use Container_Runtime.ProtoReflect.Descriptor instead.

func (*Container_Runtime) GetName added in v1.7.0 

func (x *Container_Runtime) GetName() string

func (*Container_Runtime) GetOptions added in v1.7.0 

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

func (*Container_Runtime) ProtoMessage 

func (*Container_Runtime) ProtoMessage()

func (*Container_Runtime) ProtoReflect added in v1.7.0 

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

func (*Container_Runtime) Reset 

func (x *Container_Runtime) Reset()

func (*Container_Runtime) String 

func (x *Container_Runtime) String() string

type ContainersClient 

type ContainersClient interface {
	Get(ctx context.Context, in *GetContainerRequest, opts ...grpc.CallOption) (*GetContainerResponse, error)
	List(ctx context.Context, in *ListContainersRequest, opts ...grpc.CallOption) (*ListContainersResponse, error)
	ListStream(ctx context.Context, in *ListContainersRequest, opts ...grpc.CallOption) (Containers_ListStreamClient, error)
	Create(ctx context.Context, in *CreateContainerRequest, opts ...grpc.CallOption) (*CreateContainerResponse, error)
	Update(ctx context.Context, in *UpdateContainerRequest, opts ...grpc.CallOption) (*UpdateContainerResponse, error)
	Delete(ctx context.Context, in *DeleteContainerRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
}

ContainersClient is the client API for Containers 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 NewContainersClient 

func NewContainersClient(cc grpc.ClientConnInterface) ContainersClient

type ContainersServer 

type ContainersServer interface {
	Get(context.Context, *GetContainerRequest) (*GetContainerResponse, error)
	List(context.Context, *ListContainersRequest) (*ListContainersResponse, error)
	ListStream(*ListContainersRequest, Containers_ListStreamServer) error
	Create(context.Context, *CreateContainerRequest) (*CreateContainerResponse, error)
	Update(context.Context, *UpdateContainerRequest) (*UpdateContainerResponse, error)
	Delete(context.Context, *DeleteContainerRequest) (*emptypb.Empty, error)
	// contains filtered or unexported methods
}

ContainersServer is the server API for Containers service. All implementations must embed UnimplementedContainersServer for forward compatibility

type Containers_ListStreamClient added in v1.2.0 

type Containers_ListStreamClient interface {
	Recv() (*ListContainerMessage, error)
	grpc.ClientStream
}

type Containers_ListStreamServer added in v1.2.0 

type Containers_ListStreamServer interface {
	Send(*ListContainerMessage) error
	grpc.ServerStream
}

type CreateContainerRequest 

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

func (*CreateContainerRequest) Descriptor deprecated 

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

Deprecated: Use CreateContainerRequest.ProtoReflect.Descriptor instead.

func (*CreateContainerRequest) GetContainer added in v1.7.0 

func (x *CreateContainerRequest) GetContainer() *Container

func (*CreateContainerRequest) ProtoMessage 

func (*CreateContainerRequest) ProtoMessage()

func (*CreateContainerRequest) ProtoReflect added in v1.7.0 

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

func (*CreateContainerRequest) Reset 

func (x *CreateContainerRequest) Reset()

func (*CreateContainerRequest) String 

func (x *CreateContainerRequest) String() string

type CreateContainerResponse 

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

func (*CreateContainerResponse) Descriptor deprecated 

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

Deprecated: Use CreateContainerResponse.ProtoReflect.Descriptor instead.

func (*CreateContainerResponse) GetContainer added in v1.7.0 

func (x *CreateContainerResponse) GetContainer() *Container

func (*CreateContainerResponse) ProtoMessage 

func (*CreateContainerResponse) ProtoMessage()

func (*CreateContainerResponse) ProtoReflect added in v1.7.0 

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

func (*CreateContainerResponse) Reset 

func (x *CreateContainerResponse) Reset()

func (*CreateContainerResponse) String 

func (x *CreateContainerResponse) String() string

type DeleteContainerRequest 

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

func (*DeleteContainerRequest) Descriptor deprecated 

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

Deprecated: Use DeleteContainerRequest.ProtoReflect.Descriptor instead.

func (*DeleteContainerRequest) GetID added in v1.7.0 

func (x *DeleteContainerRequest) GetID() string

func (*DeleteContainerRequest) ProtoMessage 

func (*DeleteContainerRequest) ProtoMessage()

func (*DeleteContainerRequest) ProtoReflect added in v1.7.0 

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

func (*DeleteContainerRequest) Reset 

func (x *DeleteContainerRequest) Reset()

func (*DeleteContainerRequest) String 

func (x *DeleteContainerRequest) String() string

type GetContainerRequest 

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

func (*GetContainerRequest) Descriptor deprecated 

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

Deprecated: Use GetContainerRequest.ProtoReflect.Descriptor instead.

func (*GetContainerRequest) GetID added in v1.7.0 

func (x *GetContainerRequest) GetID() string

func (*GetContainerRequest) ProtoMessage 

func (*GetContainerRequest) ProtoMessage()

func (*GetContainerRequest) ProtoReflect added in v1.7.0 

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

func (*GetContainerRequest) Reset 

func (x *GetContainerRequest) Reset()

func (*GetContainerRequest) String 

func (x *GetContainerRequest) String() string

type GetContainerResponse 

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

func (*GetContainerResponse) Descriptor deprecated 

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

Deprecated: Use GetContainerResponse.ProtoReflect.Descriptor instead.

func (*GetContainerResponse) GetContainer added in v1.7.0 

func (x *GetContainerResponse) GetContainer() *Container

func (*GetContainerResponse) ProtoMessage 

func (*GetContainerResponse) ProtoMessage()

func (*GetContainerResponse) ProtoReflect added in v1.7.0 

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

func (*GetContainerResponse) Reset 

func (x *GetContainerResponse) Reset()

func (*GetContainerResponse) String 

func (x *GetContainerResponse) String() string

type ListContainerMessage added in v1.2.0 

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

func (*ListContainerMessage) Descriptor deprecated added in v1.2.0 

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

Deprecated: Use ListContainerMessage.ProtoReflect.Descriptor instead.

func (*ListContainerMessage) GetContainer added in v1.7.0 

func (x *ListContainerMessage) GetContainer() *Container

func (*ListContainerMessage) ProtoMessage added in v1.2.0 

func (*ListContainerMessage) ProtoMessage()

func (*ListContainerMessage) ProtoReflect added in v1.7.0 

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

func (*ListContainerMessage) Reset added in v1.2.0 

func (x *ListContainerMessage) Reset()

func (*ListContainerMessage) String added in v1.2.0 

func (x *ListContainerMessage) String() string

type ListContainersRequest 

type ListContainersRequest 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, containers 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 (*ListContainersRequest) Descriptor deprecated 

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

Deprecated: Use ListContainersRequest.ProtoReflect.Descriptor instead.

func (*ListContainersRequest) GetFilters added in v1.7.0 

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

func (*ListContainersRequest) ProtoMessage 

func (*ListContainersRequest) ProtoMessage()

func (*ListContainersRequest) ProtoReflect added in v1.7.0 

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

func (*ListContainersRequest) Reset 

func (x *ListContainersRequest) Reset()

func (*ListContainersRequest) String 

func (x *ListContainersRequest) String() string

type ListContainersResponse 

type ListContainersResponse struct {
	Containers []*Container `protobuf:"bytes,1,rep,name=containers,proto3" json:"containers,omitempty"`
	// contains filtered or unexported fields
}

func (*ListContainersResponse) Descriptor deprecated 

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

Deprecated: Use ListContainersResponse.ProtoReflect.Descriptor instead.

func (*ListContainersResponse) GetContainers added in v1.7.0 

func (x *ListContainersResponse) GetContainers() []*Container

func (*ListContainersResponse) ProtoMessage 

func (*ListContainersResponse) ProtoMessage()

func (*ListContainersResponse) ProtoReflect added in v1.7.0 

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

func (*ListContainersResponse) Reset 

func (x *ListContainersResponse) Reset()

func (*ListContainersResponse) String 

func (x *ListContainersResponse) String() string

type UnimplementedContainersServer added in v1.4.0 

type UnimplementedContainersServer struct {
}

UnimplementedContainersServer must be embedded to have forward compatible implementations.

func (UnimplementedContainersServer) Create added in v1.4.0 

func (UnimplementedContainersServer) Create(context.Context, *CreateContainerRequest) (*CreateContainerResponse, error)

func (UnimplementedContainersServer) Delete added in v1.4.0 

func (UnimplementedContainersServer) Delete(context.Context, *DeleteContainerRequest) (*emptypb.Empty, error)

func (UnimplementedContainersServer) Get added in v1.4.0 

func (UnimplementedContainersServer) Get(context.Context, *GetContainerRequest) (*GetContainerResponse, error)

func (UnimplementedContainersServer) List added in v1.4.0 

func (UnimplementedContainersServer) List(context.Context, *ListContainersRequest) (*ListContainersResponse, error)

func (UnimplementedContainersServer) ListStream added in v1.4.0 

func (UnimplementedContainersServer) ListStream(*ListContainersRequest, Containers_ListStreamServer) error

func (UnimplementedContainersServer) Update added in v1.4.0 

func (UnimplementedContainersServer) Update(context.Context, *UpdateContainerRequest) (*UpdateContainerResponse, error)

type UnsafeContainersServer added in v1.7.0 

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

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

type UpdateContainerRequest 

type UpdateContainerRequest struct {

	// Container provides the target values, as declared by the mask, for the update.
	//
	// The ID field must be set.
	Container *Container `protobuf:"bytes,1,opt,name=container,proto3" json:"container,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"`
	// contains filtered or unexported fields
}

UpdateContainerRequest updates the metadata on one or more container.

The operation should follow semantics described in https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/field-mask, unless otherwise qualified.

func (*UpdateContainerRequest) Descriptor deprecated 

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

Deprecated: Use UpdateContainerRequest.ProtoReflect.Descriptor instead.

func (*UpdateContainerRequest) GetContainer added in v1.7.0 

func (x *UpdateContainerRequest) GetContainer() *Container

func (*UpdateContainerRequest) GetUpdateMask added in v1.7.0 

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

func (*UpdateContainerRequest) ProtoMessage 

func (*UpdateContainerRequest) ProtoMessage()

func (*UpdateContainerRequest) ProtoReflect added in v1.7.0 

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

func (*UpdateContainerRequest) Reset 

func (x *UpdateContainerRequest) Reset()

func (*UpdateContainerRequest) String 

func (x *UpdateContainerRequest) String() string

type UpdateContainerResponse 

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

func (*UpdateContainerResponse) Descriptor deprecated 

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

Deprecated: Use UpdateContainerResponse.ProtoReflect.Descriptor instead.

func (*UpdateContainerResponse) GetContainer added in v1.7.0 

func (x *UpdateContainerResponse) GetContainer() *Container

func (*UpdateContainerResponse) ProtoMessage 

func (*UpdateContainerResponse) ProtoMessage()

func (*UpdateContainerResponse) ProtoReflect added in v1.7.0 

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

func (*UpdateContainerResponse) Reset 

func (x *UpdateContainerResponse) Reset()

func (*UpdateContainerResponse) String 

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