Documentation
¶
Overview ¶
Package containers is a generated protocol buffer package.
It is generated from these files:
github.com/containerd/containerd/api/services/containers/v1/containers.proto
It has these top-level messages:
Container GetContainerRequest GetContainerResponse ListContainersRequest ListContainersResponse CreateContainerRequest CreateContainerResponse UpdateContainerRequest UpdateContainerResponse DeleteContainerRequest
Index ¶
- Variables
- func RegisterContainersServer(s *grpc.Server, srv ContainersServer)
- type Container
- func (*Container) Descriptor() ([]byte, []int)
- func (m *Container) Marshal() (dAtA []byte, err error)
- func (m *Container) MarshalTo(dAtA []byte) (int, error)
- func (*Container) ProtoMessage()
- func (m *Container) Reset()
- func (m *Container) Size() (n int)
- func (this *Container) String() string
- func (m *Container) Unmarshal(dAtA []byte) error
- type Container_Runtime
- func (*Container_Runtime) Descriptor() ([]byte, []int)
- func (m *Container_Runtime) Marshal() (dAtA []byte, err error)
- func (m *Container_Runtime) MarshalTo(dAtA []byte) (int, error)
- func (*Container_Runtime) ProtoMessage()
- func (m *Container_Runtime) Reset()
- func (m *Container_Runtime) Size() (n int)
- func (this *Container_Runtime) String() string
- func (m *Container_Runtime) Unmarshal(dAtA []byte) error
- type ContainersClient
- type ContainersServer
- type CreateContainerRequest
- func (*CreateContainerRequest) Descriptor() ([]byte, []int)
- func (m *CreateContainerRequest) Marshal() (dAtA []byte, err error)
- func (m *CreateContainerRequest) MarshalTo(dAtA []byte) (int, error)
- func (*CreateContainerRequest) ProtoMessage()
- func (m *CreateContainerRequest) Reset()
- func (m *CreateContainerRequest) Size() (n int)
- func (this *CreateContainerRequest) String() string
- func (m *CreateContainerRequest) Unmarshal(dAtA []byte) error
- type CreateContainerResponse
- func (*CreateContainerResponse) Descriptor() ([]byte, []int)
- func (m *CreateContainerResponse) Marshal() (dAtA []byte, err error)
- func (m *CreateContainerResponse) MarshalTo(dAtA []byte) (int, error)
- func (*CreateContainerResponse) ProtoMessage()
- func (m *CreateContainerResponse) Reset()
- func (m *CreateContainerResponse) Size() (n int)
- func (this *CreateContainerResponse) String() string
- func (m *CreateContainerResponse) Unmarshal(dAtA []byte) error
- type DeleteContainerRequest
- func (*DeleteContainerRequest) Descriptor() ([]byte, []int)
- func (m *DeleteContainerRequest) Marshal() (dAtA []byte, err error)
- func (m *DeleteContainerRequest) MarshalTo(dAtA []byte) (int, error)
- func (*DeleteContainerRequest) ProtoMessage()
- func (m *DeleteContainerRequest) Reset()
- func (m *DeleteContainerRequest) Size() (n int)
- func (this *DeleteContainerRequest) String() string
- func (m *DeleteContainerRequest) Unmarshal(dAtA []byte) error
- type GetContainerRequest
- func (*GetContainerRequest) Descriptor() ([]byte, []int)
- func (m *GetContainerRequest) Marshal() (dAtA []byte, err error)
- func (m *GetContainerRequest) MarshalTo(dAtA []byte) (int, error)
- func (*GetContainerRequest) ProtoMessage()
- func (m *GetContainerRequest) Reset()
- func (m *GetContainerRequest) Size() (n int)
- func (this *GetContainerRequest) String() string
- func (m *GetContainerRequest) Unmarshal(dAtA []byte) error
- type GetContainerResponse
- func (*GetContainerResponse) Descriptor() ([]byte, []int)
- func (m *GetContainerResponse) Marshal() (dAtA []byte, err error)
- func (m *GetContainerResponse) MarshalTo(dAtA []byte) (int, error)
- func (*GetContainerResponse) ProtoMessage()
- func (m *GetContainerResponse) Reset()
- func (m *GetContainerResponse) Size() (n int)
- func (this *GetContainerResponse) String() string
- func (m *GetContainerResponse) Unmarshal(dAtA []byte) error
- type ListContainersRequest
- func (*ListContainersRequest) Descriptor() ([]byte, []int)
- func (m *ListContainersRequest) Marshal() (dAtA []byte, err error)
- func (m *ListContainersRequest) MarshalTo(dAtA []byte) (int, error)
- func (*ListContainersRequest) ProtoMessage()
- func (m *ListContainersRequest) Reset()
- func (m *ListContainersRequest) Size() (n int)
- func (this *ListContainersRequest) String() string
- func (m *ListContainersRequest) Unmarshal(dAtA []byte) error
- type ListContainersResponse
- func (*ListContainersResponse) Descriptor() ([]byte, []int)
- func (m *ListContainersResponse) Marshal() (dAtA []byte, err error)
- func (m *ListContainersResponse) MarshalTo(dAtA []byte) (int, error)
- func (*ListContainersResponse) ProtoMessage()
- func (m *ListContainersResponse) Reset()
- func (m *ListContainersResponse) Size() (n int)
- func (this *ListContainersResponse) String() string
- func (m *ListContainersResponse) Unmarshal(dAtA []byte) error
- type UpdateContainerRequest
- func (*UpdateContainerRequest) Descriptor() ([]byte, []int)
- func (m *UpdateContainerRequest) Marshal() (dAtA []byte, err error)
- func (m *UpdateContainerRequest) MarshalTo(dAtA []byte) (int, error)
- func (*UpdateContainerRequest) ProtoMessage()
- func (m *UpdateContainerRequest) Reset()
- func (m *UpdateContainerRequest) Size() (n int)
- func (this *UpdateContainerRequest) String() string
- func (m *UpdateContainerRequest) Unmarshal(dAtA []byte) error
- type UpdateContainerResponse
- func (*UpdateContainerResponse) Descriptor() ([]byte, []int)
- func (m *UpdateContainerResponse) Marshal() (dAtA []byte, err error)
- func (m *UpdateContainerResponse) MarshalTo(dAtA []byte) (int, error)
- func (*UpdateContainerResponse) ProtoMessage()
- func (m *UpdateContainerResponse) Reset()
- func (m *UpdateContainerResponse) Size() (n int)
- func (this *UpdateContainerResponse) String() string
- func (m *UpdateContainerResponse) Unmarshal(dAtA []byte) error
Constants ¶
This section is empty.
Variables ¶
View Source
var ( ErrInvalidLengthContainers = fmt.Errorf("proto: negative length found during unmarshaling") ErrIntOverflowContainers = fmt.Errorf("proto: integer overflow") )
Functions ¶
func RegisterContainersServer ¶
func RegisterContainersServer(s *grpc.Server, 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 `` /* 146-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" json:"runtime,omitempty"`
// Spec to be used when creating the container. This is runtime specific.
Spec *google_protobuf1.Any `protobuf:"bytes,5,opt,name=spec" 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 time.Time `protobuf:"bytes,8,opt,name=created_at,json=createdAt,stdtime" json:"created_at"`
// UpdatedAt is the last time the container was mutated.
UpdatedAt time.Time `protobuf:"bytes,9,opt,name=updated_at,json=updatedAt,stdtime" json:"updated_at"`
// 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]google_protobuf1.Any `` /* 138-byte string literal not displayed */
}
func (*Container) Descriptor ¶
func (*Container) ProtoMessage ¶
func (*Container) ProtoMessage()
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 *google_protobuf1.Any `protobuf:"bytes,2,opt,name=options" json:"options,omitempty"`
}
func (*Container_Runtime) Descriptor ¶
func (*Container_Runtime) Descriptor() ([]byte, []int)
func (*Container_Runtime) Marshal ¶
func (m *Container_Runtime) Marshal() (dAtA []byte, err error)
func (*Container_Runtime) MarshalTo ¶
func (m *Container_Runtime) MarshalTo(dAtA []byte) (int, error)
func (*Container_Runtime) ProtoMessage ¶
func (*Container_Runtime) ProtoMessage()
func (*Container_Runtime) Reset ¶
func (m *Container_Runtime) Reset()
func (*Container_Runtime) Size ¶
func (m *Container_Runtime) Size() (n int)
func (*Container_Runtime) String ¶
func (this *Container_Runtime) String() string
func (*Container_Runtime) Unmarshal ¶
func (m *Container_Runtime) Unmarshal(dAtA []byte) error
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)
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) (*google_protobuf2.Empty, error)
}
func NewContainersClient ¶
func NewContainersClient(cc *grpc.ClientConn) ContainersClient
type ContainersServer ¶
type ContainersServer interface {
Get(context.Context, *GetContainerRequest) (*GetContainerResponse, error)
List(context.Context, *ListContainersRequest) (*ListContainersResponse, error)
Create(context.Context, *CreateContainerRequest) (*CreateContainerResponse, error)
Update(context.Context, *UpdateContainerRequest) (*UpdateContainerResponse, error)
Delete(context.Context, *DeleteContainerRequest) (*google_protobuf2.Empty, error)
}
type CreateContainerRequest ¶
type CreateContainerRequest struct {
Container Container `protobuf:"bytes,1,opt,name=container" json:"container"`
}
func (*CreateContainerRequest) Descriptor ¶
func (*CreateContainerRequest) Descriptor() ([]byte, []int)
func (*CreateContainerRequest) Marshal ¶
func (m *CreateContainerRequest) Marshal() (dAtA []byte, err error)
func (*CreateContainerRequest) MarshalTo ¶
func (m *CreateContainerRequest) MarshalTo(dAtA []byte) (int, error)
func (*CreateContainerRequest) ProtoMessage ¶
func (*CreateContainerRequest) ProtoMessage()
func (*CreateContainerRequest) Reset ¶
func (m *CreateContainerRequest) Reset()
func (*CreateContainerRequest) Size ¶
func (m *CreateContainerRequest) Size() (n int)
func (*CreateContainerRequest) String ¶
func (this *CreateContainerRequest) String() string
func (*CreateContainerRequest) Unmarshal ¶
func (m *CreateContainerRequest) Unmarshal(dAtA []byte) error
type CreateContainerResponse ¶
type CreateContainerResponse struct {
Container Container `protobuf:"bytes,1,opt,name=container" json:"container"`
}
func (*CreateContainerResponse) Descriptor ¶
func (*CreateContainerResponse) Descriptor() ([]byte, []int)
func (*CreateContainerResponse) Marshal ¶
func (m *CreateContainerResponse) Marshal() (dAtA []byte, err error)
func (*CreateContainerResponse) MarshalTo ¶
func (m *CreateContainerResponse) MarshalTo(dAtA []byte) (int, error)
func (*CreateContainerResponse) ProtoMessage ¶
func (*CreateContainerResponse) ProtoMessage()
func (*CreateContainerResponse) Reset ¶
func (m *CreateContainerResponse) Reset()
func (*CreateContainerResponse) Size ¶
func (m *CreateContainerResponse) Size() (n int)
func (*CreateContainerResponse) String ¶
func (this *CreateContainerResponse) String() string
func (*CreateContainerResponse) Unmarshal ¶
func (m *CreateContainerResponse) Unmarshal(dAtA []byte) error
type DeleteContainerRequest ¶
type DeleteContainerRequest struct {
ID string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
}
func (*DeleteContainerRequest) Descriptor ¶
func (*DeleteContainerRequest) Descriptor() ([]byte, []int)
func (*DeleteContainerRequest) Marshal ¶
func (m *DeleteContainerRequest) Marshal() (dAtA []byte, err error)
func (*DeleteContainerRequest) MarshalTo ¶
func (m *DeleteContainerRequest) MarshalTo(dAtA []byte) (int, error)
func (*DeleteContainerRequest) ProtoMessage ¶
func (*DeleteContainerRequest) ProtoMessage()
func (*DeleteContainerRequest) Reset ¶
func (m *DeleteContainerRequest) Reset()
func (*DeleteContainerRequest) Size ¶
func (m *DeleteContainerRequest) Size() (n int)
func (*DeleteContainerRequest) String ¶
func (this *DeleteContainerRequest) String() string
func (*DeleteContainerRequest) Unmarshal ¶
func (m *DeleteContainerRequest) Unmarshal(dAtA []byte) error
type GetContainerRequest ¶
type GetContainerRequest struct {
ID string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
}
func (*GetContainerRequest) Descriptor ¶
func (*GetContainerRequest) Descriptor() ([]byte, []int)
func (*GetContainerRequest) Marshal ¶
func (m *GetContainerRequest) Marshal() (dAtA []byte, err error)
func (*GetContainerRequest) MarshalTo ¶
func (m *GetContainerRequest) MarshalTo(dAtA []byte) (int, error)
func (*GetContainerRequest) ProtoMessage ¶
func (*GetContainerRequest) ProtoMessage()
func (*GetContainerRequest) Reset ¶
func (m *GetContainerRequest) Reset()
func (*GetContainerRequest) Size ¶
func (m *GetContainerRequest) Size() (n int)
func (*GetContainerRequest) String ¶
func (this *GetContainerRequest) String() string
func (*GetContainerRequest) Unmarshal ¶
func (m *GetContainerRequest) Unmarshal(dAtA []byte) error
type GetContainerResponse ¶
type GetContainerResponse struct {
Container Container `protobuf:"bytes,1,opt,name=container" json:"container"`
}
func (*GetContainerResponse) Descriptor ¶
func (*GetContainerResponse) Descriptor() ([]byte, []int)
func (*GetContainerResponse) Marshal ¶
func (m *GetContainerResponse) Marshal() (dAtA []byte, err error)
func (*GetContainerResponse) MarshalTo ¶
func (m *GetContainerResponse) MarshalTo(dAtA []byte) (int, error)
func (*GetContainerResponse) ProtoMessage ¶
func (*GetContainerResponse) ProtoMessage()
func (*GetContainerResponse) Reset ¶
func (m *GetContainerResponse) Reset()
func (*GetContainerResponse) Size ¶
func (m *GetContainerResponse) Size() (n int)
func (*GetContainerResponse) String ¶
func (this *GetContainerResponse) String() string
func (*GetContainerResponse) Unmarshal ¶
func (m *GetContainerResponse) Unmarshal(dAtA []byte) error
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" json:"filters,omitempty"`
}
func (*ListContainersRequest) Descriptor ¶
func (*ListContainersRequest) Descriptor() ([]byte, []int)
func (*ListContainersRequest) Marshal ¶
func (m *ListContainersRequest) Marshal() (dAtA []byte, err error)
func (*ListContainersRequest) MarshalTo ¶
func (m *ListContainersRequest) MarshalTo(dAtA []byte) (int, error)
func (*ListContainersRequest) ProtoMessage ¶
func (*ListContainersRequest) ProtoMessage()
func (*ListContainersRequest) Reset ¶
func (m *ListContainersRequest) Reset()
func (*ListContainersRequest) Size ¶
func (m *ListContainersRequest) Size() (n int)
func (*ListContainersRequest) String ¶
func (this *ListContainersRequest) String() string
func (*ListContainersRequest) Unmarshal ¶
func (m *ListContainersRequest) Unmarshal(dAtA []byte) error
type ListContainersResponse ¶
type ListContainersResponse struct {
Containers []Container `protobuf:"bytes,1,rep,name=containers" json:"containers"`
}
func (*ListContainersResponse) Descriptor ¶
func (*ListContainersResponse) Descriptor() ([]byte, []int)
func (*ListContainersResponse) Marshal ¶
func (m *ListContainersResponse) Marshal() (dAtA []byte, err error)
func (*ListContainersResponse) MarshalTo ¶
func (m *ListContainersResponse) MarshalTo(dAtA []byte) (int, error)
func (*ListContainersResponse) ProtoMessage ¶
func (*ListContainersResponse) ProtoMessage()
func (*ListContainersResponse) Reset ¶
func (m *ListContainersResponse) Reset()
func (*ListContainersResponse) Size ¶
func (m *ListContainersResponse) Size() (n int)
func (*ListContainersResponse) String ¶
func (this *ListContainersResponse) String() string
func (*ListContainersResponse) Unmarshal ¶
func (m *ListContainersResponse) Unmarshal(dAtA []byte) error
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" json:"container"`
// UpdateMask specifies which fields to perform the update on. If empty,
// the operation applies to all fields.
UpdateMask *google_protobuf3.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask" json:"update_mask,omitempty"`
}
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 ¶
func (*UpdateContainerRequest) Descriptor() ([]byte, []int)
func (*UpdateContainerRequest) Marshal ¶
func (m *UpdateContainerRequest) Marshal() (dAtA []byte, err error)
func (*UpdateContainerRequest) MarshalTo ¶
func (m *UpdateContainerRequest) MarshalTo(dAtA []byte) (int, error)
func (*UpdateContainerRequest) ProtoMessage ¶
func (*UpdateContainerRequest) ProtoMessage()
func (*UpdateContainerRequest) Reset ¶
func (m *UpdateContainerRequest) Reset()
func (*UpdateContainerRequest) Size ¶
func (m *UpdateContainerRequest) Size() (n int)
func (*UpdateContainerRequest) String ¶
func (this *UpdateContainerRequest) String() string
func (*UpdateContainerRequest) Unmarshal ¶
func (m *UpdateContainerRequest) Unmarshal(dAtA []byte) error
type UpdateContainerResponse ¶
type UpdateContainerResponse struct {
Container Container `protobuf:"bytes,1,opt,name=container" json:"container"`
}
func (*UpdateContainerResponse) Descriptor ¶
func (*UpdateContainerResponse) Descriptor() ([]byte, []int)
func (*UpdateContainerResponse) Marshal ¶
func (m *UpdateContainerResponse) Marshal() (dAtA []byte, err error)
func (*UpdateContainerResponse) MarshalTo ¶
func (m *UpdateContainerResponse) MarshalTo(dAtA []byte) (int, error)
func (*UpdateContainerResponse) ProtoMessage ¶
func (*UpdateContainerResponse) ProtoMessage()
func (*UpdateContainerResponse) Reset ¶
func (m *UpdateContainerResponse) Reset()
func (*UpdateContainerResponse) Size ¶
func (m *UpdateContainerResponse) Size() (n int)
func (*UpdateContainerResponse) String ¶
func (this *UpdateContainerResponse) String() string
func (*UpdateContainerResponse) Unmarshal ¶
func (m *UpdateContainerResponse) Unmarshal(dAtA []byte) error
Click to show internal directories.
Click to hide internal directories.