api

Documentation

Overview

Package api contains CIPD backend API definitions.

Index

• Variables
• type BootstrapConfig
  • func (*BootstrapConfig) Descriptor() ([]byte, []int)
  • func (x *BootstrapConfig) GetPrefix() string
  • func (*BootstrapConfig) ProtoMessage()
  • func (x *BootstrapConfig) ProtoReflect() protoreflect.Message
  • func (x *BootstrapConfig) Reset()
  • func (x *BootstrapConfig) String() string
• type BootstrapConfigFile
  • func (*BootstrapConfigFile) Descriptor() ([]byte, []int)
  • func (x *BootstrapConfigFile) GetBootstrapConfig() []*BootstrapConfig
  • func (*BootstrapConfigFile) ProtoMessage()
  • func (x *BootstrapConfigFile) ProtoReflect() protoreflect.Message
  • func (x *BootstrapConfigFile) Reset()
  • func (x *BootstrapConfigFile) String() string
• type ClientMonitoringConfig
  • func (*ClientMonitoringConfig) Descriptor() ([]byte, []int)
  • func (x *ClientMonitoringConfig) GetIpWhitelist() string
  • func (x *ClientMonitoringConfig) GetLabel() string
  • func (*ClientMonitoringConfig) ProtoMessage()
  • func (x *ClientMonitoringConfig) ProtoReflect() protoreflect.Message
  • func (x *ClientMonitoringConfig) Reset()
  • func (x *ClientMonitoringConfig) String() string
• type ClientMonitoringWhitelist
  • func (*ClientMonitoringWhitelist) Descriptor() ([]byte, []int)
  • func (x *ClientMonitoringWhitelist) GetClientMonitoringConfig() []*ClientMonitoringConfig
  • func (*ClientMonitoringWhitelist) ProtoMessage()
  • func (x *ClientMonitoringWhitelist) ProtoReflect() protoreflect.Message
  • func (x *ClientMonitoringWhitelist) Reset()
  • func (x *ClientMonitoringWhitelist) String() string

Variables

var File_go_chromium_org_luci_cipd_api_config_v1_config_proto protoreflect.FileDescriptor

Types

type BootstrapConfig

type BootstrapConfig struct {

	// The package prefix of matching packages e.g. "infra/tools/my-tool".
	Prefix string `protobuf:"bytes,1,opt,name=prefix,proto3" json:"prefix,omitempty"`
	// contains filtered or unexported fields
}

BootstrapConfig defines a set of bootstrap packages under a single prefix.

Each package should contain exactly one file (presumable an executable). It will be extracted and put into the storage, to allow the CIPD backend to generate direct download URLs to it. This is useful to allow clients to directly download such binaries.

func (*BootstrapConfig) Descriptor

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

Deprecated: Use BootstrapConfig.ProtoReflect.Descriptor instead.

func (*BootstrapConfig) GetPrefix

func (x *BootstrapConfig) GetPrefix() string

func (*BootstrapConfig) ProtoMessage

func (*BootstrapConfig) ProtoMessage()

func (*BootstrapConfig) ProtoReflect

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

func (*BootstrapConfig) Reset

func (x *BootstrapConfig) Reset()

func (*BootstrapConfig) String

func (x *BootstrapConfig) String() string

type BootstrapConfigFile

type BootstrapConfigFile struct {

	// A list of all known bootstrap packages, will be scanned in order.
	BootstrapConfig []*BootstrapConfig `protobuf:"bytes,1,rep,name=bootstrap_config,json=bootstrapConfig,proto3" json:"bootstrap_config,omitempty"`
	// contains filtered or unexported fields
}

A schema for the bootstrap.cfg config file.

It defines a list of packages that contain executables that should be accessible via direct download URLs.

func (*BootstrapConfigFile) Descriptor

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

Deprecated: Use BootstrapConfigFile.ProtoReflect.Descriptor instead.

func (*BootstrapConfigFile) GetBootstrapConfig

func (x *BootstrapConfigFile) GetBootstrapConfig() []*BootstrapConfig

func (*BootstrapConfigFile) ProtoMessage

func (*BootstrapConfigFile) ProtoMessage()

func (*BootstrapConfigFile) ProtoReflect

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

func (*BootstrapConfigFile) Reset

func (x *BootstrapConfigFile) Reset()

func (*BootstrapConfigFile) String

func (x *BootstrapConfigFile) String() string

type ClientMonitoringConfig

type ClientMonitoringConfig struct {

	// Name of an IP whitelist in the auth service. If a request is received from
	// an IP matching this whitelist, it will be reported.
	IpWhitelist string `protobuf:"bytes,1,opt,name=ip_whitelist,json=ipWhitelist,proto3" json:"ip_whitelist,omitempty"`
	// Monitoring label to apply when reporting metrics for this client.
	Label string `protobuf:"bytes,2,opt,name=label,proto3" json:"label,omitempty"`
	// contains filtered or unexported fields
}

Defines a client whose requests should be monitored.

func (*ClientMonitoringConfig) Descriptor

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

Deprecated: Use ClientMonitoringConfig.ProtoReflect.Descriptor instead.

func (*ClientMonitoringConfig) GetIpWhitelist

func (x *ClientMonitoringConfig) GetIpWhitelist() string

func (*ClientMonitoringConfig) GetLabel

func (x *ClientMonitoringConfig) GetLabel() string

func (*ClientMonitoringConfig) ProtoMessage

func (*ClientMonitoringConfig) ProtoMessage()

func (*ClientMonitoringConfig) ProtoReflect

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

func (*ClientMonitoringConfig) Reset

func (x *ClientMonitoringConfig) Reset()

func (*ClientMonitoringConfig) String

func (x *ClientMonitoringConfig) String() string

type ClientMonitoringWhitelist

type ClientMonitoringWhitelist struct {

	// A list of configurations for clients to monitor. When a request is
	// received, the list is traversed in order and the first match is the
	// monitoring config to use. If none of the configs match the request is
	// unmonitored.
	ClientMonitoringConfig []*ClientMonitoringConfig `` /* 129-byte string literal not displayed */
	// contains filtered or unexported fields
}

A schema for the monitoring.cfg config file.

It defines a list of clients whose requests should be monitored.

func (*ClientMonitoringWhitelist) Descriptor

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

Deprecated: Use ClientMonitoringWhitelist.ProtoReflect.Descriptor instead.

func (*ClientMonitoringWhitelist) GetClientMonitoringConfig

func (x *ClientMonitoringWhitelist) GetClientMonitoringConfig() []*ClientMonitoringConfig

func (*ClientMonitoringWhitelist) ProtoMessage

func (*ClientMonitoringWhitelist) ProtoMessage()

func (*ClientMonitoringWhitelist) ProtoReflect

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

func (*ClientMonitoringWhitelist) Reset

func (x *ClientMonitoringWhitelist) Reset()

func (*ClientMonitoringWhitelist) String

func (x *ClientMonitoringWhitelist) String() string