cbi_plugin_v1

Documentation

Overview

Package cbi_plugin_v1 is a generated protocol buffer package.

It is generated from these files:

plugin.proto

It has these top-level messages:

InfoRequest
InfoResponse
SpecRequest
SpecResponse

Index

• Constants
• Variables
• func LContext(k crd.ContextKind) string
• func LLanguage(k crd.LanguageKind) string
• func RegisterPluginServer(s *grpc.Server, srv PluginServer)
• type InfoRequest
  • func (*InfoRequest) Descriptor() ([]byte, []int)
  • func (m *InfoRequest) Marshal() (dAtA []byte, err error)
  • func (m *InfoRequest) MarshalTo(dAtA []byte) (int, error)
  • func (*InfoRequest) ProtoMessage()
  • func (m *InfoRequest) Reset()
  • func (m *InfoRequest) Size() (n int)
  • func (m *InfoRequest) String() string
  • func (m *InfoRequest) Unmarshal(dAtA []byte) error
• type InfoResponse
  • func (*InfoResponse) Descriptor() ([]byte, []int)
  • func (m *InfoResponse) GetLabels() map[string]string
  • func (m *InfoResponse) Marshal() (dAtA []byte, err error)
  • func (m *InfoResponse) MarshalTo(dAtA []byte) (int, error)
  • func (*InfoResponse) ProtoMessage()
  • func (m *InfoResponse) Reset()
  • func (m *InfoResponse) Size() (n int)
  • func (m *InfoResponse) String() string
  • func (m *InfoResponse) Unmarshal(dAtA []byte) error
• type PluginClient
  • func NewPluginClient(cc *grpc.ClientConn) PluginClient
• type PluginServer
• type SpecRequest
  • func (*SpecRequest) Descriptor() ([]byte, []int)
  • func (m *SpecRequest) GetBuildJobJson() []byte
  • func (m *SpecRequest) Marshal() (dAtA []byte, err error)
  • func (m *SpecRequest) MarshalTo(dAtA []byte) (int, error)
  • func (*SpecRequest) ProtoMessage()
  • func (m *SpecRequest) Reset()
  • func (m *SpecRequest) Size() (n int)
  • func (m *SpecRequest) String() string
  • func (m *SpecRequest) Unmarshal(dAtA []byte) error
• type SpecResponse
  • func (*SpecResponse) Descriptor() ([]byte, []int)
  • func (m *SpecResponse) GetPodTemplateSpecJson() []byte
  • func (m *SpecResponse) Marshal() (dAtA []byte, err error)
  • func (m *SpecResponse) MarshalTo(dAtA []byte) (int, error)
  • func (*SpecResponse) ProtoMessage()
  • func (m *SpecResponse) Reset()
  • func (m *SpecResponse) Size() (n int)
  • func (m *SpecResponse) String() string
  • func (m *SpecResponse) Unmarshal(dAtA []byte) error

Constants

const (
	// LPluginName is the NON-UNIQUE name of the plugin.
	// LPluginName MUST be always present.
	//
	// Example values: "buildkit", "buildah", ...
	LPluginName = "plugin.name"
)

Variables

var (
	ErrInvalidLengthPlugin = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowPlugin   = fmt.Errorf("proto: integer overflow")
)

var (
	// PredefinedLabelPrefixes is the set of predefined plugin label prefixes.
	// Although plugin labels are decoupled from k8s object labels,
	// we try to follow the k8s convention.
	//
	// At the moment, we don't use long prefix such as "plugin.cbi.containerbuilding.github.io".
	// However, the convention might change in v1 GA.
	PredefinedLabelPrefixes = []string{
		"plugin.",
		"language.",
		"context.",
	}
)

Functions

func LContext

func LContext(k crd.ContextKind) string

func LLanguage

func LLanguage(k crd.LanguageKind) string

func RegisterPluginServer

func RegisterPluginServer(s *grpc.Server, srv PluginServer)

Types

type InfoRequest

type InfoRequest struct {
}

func (*InfoRequest) Descriptor

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

func (*InfoRequest) Marshal

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

func (*InfoRequest) MarshalTo

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

func (*InfoRequest) ProtoMessage

func (*InfoRequest) ProtoMessage()

func (*InfoRequest) Reset

func (m *InfoRequest) Reset()

func (*InfoRequest) Size

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

func (*InfoRequest) String

func (m *InfoRequest) String() string

func (*InfoRequest) Unmarshal

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

type InfoResponse

type InfoResponse struct {
	// Plugin labels.
	// This has nothing to do the labels of k8s objects of the pod.
	// e.g. pods, deployments, and services.
	//
	// However, it is still valid to implement a plugin that loads its labels from
	// k8s objects.
	//
	// See labels.go for the predefined labels.
	Labels map[string]string `` /* 146-byte string literal not displayed */
}

func (*InfoResponse) Descriptor

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

func (*InfoResponse) GetLabels

func (m *InfoResponse) GetLabels() map[string]string

func (*InfoResponse) Marshal

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

func (*InfoResponse) MarshalTo

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

func (*InfoResponse) ProtoMessage

func (*InfoResponse) ProtoMessage()

func (*InfoResponse) Reset

func (m *InfoResponse) Reset()

func (*InfoResponse) Size

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

func (*InfoResponse) String

func (m *InfoResponse) String() string

func (*InfoResponse) Unmarshal

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

type PluginClient

type PluginClient interface {
	Info(ctx context.Context, in *InfoRequest, opts ...grpc.CallOption) (*InfoResponse, error)
	Spec(ctx context.Context, in *SpecRequest, opts ...grpc.CallOption) (*SpecResponse, error)
}

func NewPluginClient

func NewPluginClient(cc *grpc.ClientConn) PluginClient

type PluginServer

type PluginServer interface {
	Info(context.Context, *InfoRequest) (*InfoResponse, error)
	Spec(context.Context, *SpecRequest) (*SpecResponse, error)
}

type SpecRequest

type SpecRequest struct {
	// JSON representation of CBI CRD BuildJob
	BuildJobJson []byte `protobuf:"bytes,1,opt,name=build_job_json,json=buildJobJson,proto3" json:"build_job_json,omitempty"`
}

func (*SpecRequest) Descriptor

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

func (*SpecRequest) GetBuildJobJson

func (m *SpecRequest) GetBuildJobJson() []byte

func (*SpecRequest) Marshal

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

func (*SpecRequest) MarshalTo

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

func (*SpecRequest) ProtoMessage

func (*SpecRequest) ProtoMessage()

func (*SpecRequest) Reset

func (m *SpecRequest) Reset()

func (*SpecRequest) Size

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

func (*SpecRequest) String

func (m *SpecRequest) String() string

func (*SpecRequest) Unmarshal

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

type SpecResponse

type SpecResponse struct {
	// JSON representation of Kubernetes PodTemplateSpec
	PodTemplateSpecJson []byte `protobuf:"bytes,1,opt,name=pod_template_spec_json,json=podTemplateSpecJson,proto3" json:"pod_template_spec_json,omitempty"`
}

func (*SpecResponse) Descriptor

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

func (*SpecResponse) GetPodTemplateSpecJson

func (m *SpecResponse) GetPodTemplateSpecJson() []byte

func (*SpecResponse) Marshal

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

func (*SpecResponse) MarshalTo

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

func (*SpecResponse) ProtoMessage

func (*SpecResponse) ProtoMessage()

func (*SpecResponse) Reset

func (m *SpecResponse) Reset()

func (*SpecResponse) Size

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

func (*SpecResponse) String

func (m *SpecResponse) String() string

func (*SpecResponse) Unmarshal

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