Documentation

Overview

    Package introspection is a generated protocol buffer package.

    It is generated from these files:

    github.com/containerd/containerd/api/services/introspection/v1/introspection.proto
    

    It has these top-level messages:

    Plugin
    PluginsRequest
    PluginsResponse
    

    Index

    Constants

    This section is empty.

    Variables

    View Source
    var (
    	ErrInvalidLengthIntrospection = fmt.Errorf("proto: negative length found during unmarshaling")
    	ErrIntOverflowIntrospection   = fmt.Errorf("proto: integer overflow")
    )

    Functions

    func RegisterIntrospectionServer

    func RegisterIntrospectionServer(s *grpc.Server, srv IntrospectionServer)

    Types

    type IntrospectionClient

    type IntrospectionClient interface {
    	// Plugins returns a list of plugins in containerd.
    	//
    	// Clients can use this to detect features and capabilities when using
    	// containerd.
    	Plugins(ctx context.Context, in *PluginsRequest, opts ...grpc.CallOption) (*PluginsResponse, error)
    }

    func NewIntrospectionClient

    func NewIntrospectionClient(cc *grpc.ClientConn) IntrospectionClient

    type IntrospectionServer

    type IntrospectionServer interface {
    	// Plugins returns a list of plugins in containerd.
    	//
    	// Clients can use this to detect features and capabilities when using
    	// containerd.
    	Plugins(context.Context, *PluginsRequest) (*PluginsResponse, error)
    }

    type Plugin

    type Plugin struct {
    	// Type defines the type of plugin.
    	//
    	// See package plugin for a list of possible values. Non core plugins may
    	// define their own values during registration.
    	Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
    	// ID identifies the plugin uniquely in the system.
    	ID string `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"`
    	// Requires lists the plugin types required by this plugin.
    	Requires []string `protobuf:"bytes,3,rep,name=requires" json:"requires,omitempty"`
    	// Platforms enumerates the platforms this plugin will support.
    	//
    	// If values are provided here, the plugin will only be operable under the
    	// provided platforms.
    	//
    	// If this is empty, the plugin will work across all platforms.
    	//
    	// If the plugin prefers certain platforms over others, they should be
    	// listed from most to least preferred.
    	Platforms []containerd_types.Platform `protobuf:"bytes,4,rep,name=platforms" json:"platforms"`
    	// Exports allows plugins to provide values about state or configuration to
    	// interested parties.
    	//
    	// One example is exposing the configured path of a snapshotter plugin.
    	Exports map[string]string `` /* 148-byte string literal not displayed */
    	// Capabilities allows plugins to communicate feature switches to allow
    	// clients to detect features that may not be on be default or may be
    	// different from version to version.
    	//
    	// Use this sparingly.
    	Capabilities []string `protobuf:"bytes,6,rep,name=capabilities" json:"capabilities,omitempty"`
    	// InitErr will be set if the plugin fails initialization.
    	//
    	// This means the plugin may have been registered but a non-terminal error
    	// was encountered during initialization.
    	//
    	// Plugins that have this value set cannot be used.
    	InitErr *google_rpc.Status `protobuf:"bytes,7,opt,name=init_err,json=initErr" json:"init_err,omitempty"`
    }

    func (*Plugin) Descriptor

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

    func (*Plugin) Marshal

    func (m *Plugin) Marshal() (dAtA []byte, err error)

    func (*Plugin) MarshalTo

    func (m *Plugin) MarshalTo(dAtA []byte) (int, error)

    func (*Plugin) ProtoMessage

    func (*Plugin) ProtoMessage()

    func (*Plugin) Reset

    func (m *Plugin) Reset()

    func (*Plugin) Size

    func (m *Plugin) Size() (n int)

    func (*Plugin) String

    func (this *Plugin) String() string

    func (*Plugin) Unmarshal

    func (m *Plugin) Unmarshal(dAtA []byte) error

    type PluginsRequest

    type PluginsRequest 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, plugins 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 (*PluginsRequest) Descriptor

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

    func (*PluginsRequest) Marshal

    func (m *PluginsRequest) Marshal() (dAtA []byte, err error)

    func (*PluginsRequest) MarshalTo

    func (m *PluginsRequest) MarshalTo(dAtA []byte) (int, error)

    func (*PluginsRequest) ProtoMessage

    func (*PluginsRequest) ProtoMessage()

    func (*PluginsRequest) Reset

    func (m *PluginsRequest) Reset()

    func (*PluginsRequest) Size

    func (m *PluginsRequest) Size() (n int)

    func (*PluginsRequest) String

    func (this *PluginsRequest) String() string

    func (*PluginsRequest) Unmarshal

    func (m *PluginsRequest) Unmarshal(dAtA []byte) error

    type PluginsResponse

    type PluginsResponse struct {
    	Plugins []Plugin `protobuf:"bytes,1,rep,name=plugins" json:"plugins"`
    }

    func (*PluginsResponse) Descriptor

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

    func (*PluginsResponse) Marshal

    func (m *PluginsResponse) Marshal() (dAtA []byte, err error)

    func (*PluginsResponse) MarshalTo

    func (m *PluginsResponse) MarshalTo(dAtA []byte) (int, error)

    func (*PluginsResponse) ProtoMessage

    func (*PluginsResponse) ProtoMessage()

    func (*PluginsResponse) Reset

    func (m *PluginsResponse) Reset()

    func (*PluginsResponse) Size

    func (m *PluginsResponse) Size() (n int)

    func (*PluginsResponse) String

    func (this *PluginsResponse) String() string

    func (*PluginsResponse) Unmarshal

    func (m *PluginsResponse) Unmarshal(dAtA []byte) error