dmTemplate

Documentation

Overview

Package dmTemplate is a generated protocol buffer package.

It is generated from these files:

github.com/luci/luci-go/dm/api/template/template.proto

It has these top-level messages:

File

Index

• type File
  • func LoadFile(c context.Context, project, ref string) (file *File, vers string, err error)
  • func (*File) Descriptor() ([]byte, []int)
  • func (m *File) GetTemplate() map[string]*File_Template
  • func (f *File) Normalize() error
  • func (*File) ProtoMessage()
  • func (f *File) Render(spec *templateproto.Specifier) (*dm.Quest_Desc, error)
  • func (m *File) Reset()
  • func (m *File) String() string
• type File_Template
  • func (*File_Template) Descriptor() ([]byte, []int)
  • func (m *File_Template) GetDistributorConfigName() string
  • func (m *File_Template) GetDistributorParameters() *templateproto.File_Template
  • func (m *File_Template) GetMeta() *dm1.Quest_Desc_Meta
  • func (m *File_Template) GetParameters() *templateproto.File_Template
  • func (t *File_Template) Normalize() error
  • func (*File_Template) ProtoMessage()
  • func (m *File_Template) Reset()
  • func (m *File_Template) String() string

Types

type File

type File struct {
	Template map[string]*File_Template `` /* 136-byte string literal not displayed */
}

File represents a file full of DM template definitions.

func LoadFile

func LoadFile(c context.Context, project, ref string) (file *File, vers string, err error)

LoadFile loads a File by configSet and path.

func (*File) Descriptor

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

func (*File) GetTemplate

func (m *File) GetTemplate() map[string]*File_Template

func (*File) Normalize

func (f *File) Normalize() error

Normalize will normalize all of the Templates in this message, returning an error if any are invalid.

func (*File) ProtoMessage

func (*File) ProtoMessage()

func (*File) Render

func (f *File) Render(spec *templateproto.Specifier) (*dm.Quest_Desc, error)

Render renders the specified template with the given parameters.

func (*File) Reset

func (m *File) Reset()

func (*File) String

func (m *File) String() string

type File_Template

type File_Template struct {
	DistributorConfigName string                       `protobuf:"bytes,1,opt,name=distributor_config_name,json=distributorConfigName" json:"distributor_config_name,omitempty"`
	Parameters            *templateproto.File_Template `protobuf:"bytes,2,opt,name=parameters" json:"parameters,omitempty"`
	DistributorParameters *templateproto.File_Template `protobuf:"bytes,3,opt,name=distributor_parameters,json=distributorParameters" json:"distributor_parameters,omitempty"`
	Meta                  *dm1.Quest_Desc_Meta         `protobuf:"bytes,4,opt,name=meta" json:"meta,omitempty"`
}

Template defines a single template.

func (*File_Template) Descriptor

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

func (*File_Template) GetDistributorConfigName

func (m *File_Template) GetDistributorConfigName() string

func (*File_Template) GetDistributorParameters

func (m *File_Template) GetDistributorParameters() *templateproto.File_Template

func (*File_Template) GetMeta

func (m *File_Template) GetMeta() *dm1.Quest_Desc_Meta

func (*File_Template) GetParameters

func (m *File_Template) GetParameters() *templateproto.File_Template

func (*File_Template) Normalize

func (t *File_Template) Normalize() error

Normalize will normalize this Template, returning an error if it is invalid.

func (*File_Template) ProtoMessage

func (*File_Template) ProtoMessage()

func (*File_Template) Reset

func (m *File_Template) Reset()

func (*File_Template) String

func (m *File_Template) String() string