luci-go: github.com/luci/luci-go/common/proto/config Index | Files

package config

import "github.com/luci/luci-go/common/proto/config"

Package config contains luci-config protobuf definitions.

Copied from:

Repo: https://chromium.googlesource.com/infra/luci/luci-py/ Revision: cf81dfcd9a7db0fb2e8c224f283ebe2cbbe76133 Path: appengine/components/components/config/proto/*.proto

Modification: added luci.file_metadata annotation.

Index

Package Files

generate.go project_config.pb.go service_config.pb.go

Variables

var (
    ConfigSetLocation_StorageType_name = map[int32]string{
        0:  "UNSET",
        1:  "GITILES",
    }
    ConfigSetLocation_StorageType_value = map[string]int32{
        "UNSET":   0,
        "GITILES": 1,
    }
)

Enum value maps for ConfigSetLocation_StorageType.

var (
    ValidationResponseMessage_Severity_name = map[int32]string{
        0:  "UNKNOWN",
        10: "DEBUG",
        20: "INFO",
        30: "WARNING",
        40: "ERROR",
        50: "CRITICAL",
    }
    ValidationResponseMessage_Severity_value = map[string]int32{
        "UNKNOWN":  0,
        "DEBUG":    10,
        "INFO":     20,
        "WARNING":  30,
        "ERROR":    40,
        "CRITICAL": 50,
    }
)

Enum value maps for ValidationResponseMessage_Severity.

var File_go_chromium_org_luci_common_proto_config_project_config_proto protoreflect.FileDescriptor
var File_go_chromium_org_luci_common_proto_config_service_config_proto protoreflect.FileDescriptor

type AclCfg Uses

type AclCfg struct {

    // Name of the group that has access to all projects/* config sets.
    // Only trusted services should be in this group.
    ProjectAccessGroup string `protobuf:"bytes,2,opt,name=project_access_group,json=projectAccessGroup,proto3" json:"project_access_group,omitempty"`
    // Name of the group that has access to all services/* config sets.
    // Only trusted services should be in this group.
    ServiceAccessGroup string `protobuf:"bytes,7,opt,name=service_access_group,json=serviceAccessGroup,proto3" json:"service_access_group,omitempty"`
    // Name of the group that has admin access to the app.
    AdminGroup string `protobuf:"bytes,3,opt,name=admin_group,json=adminGroup,proto3" json:"admin_group,omitempty"`
    // Name of the group that may call validation API.
    ValidationGroup string `protobuf:"bytes,5,opt,name=validation_group,json=validationGroup,proto3" json:"validation_group,omitempty"`
    // Name of the group that may call reimport API.
    ReimportGroup string `protobuf:"bytes,6,opt,name=reimport_group,json=reimportGroup,proto3" json:"reimport_group,omitempty"`
    // contains filtered or unexported fields
}

Schema of acl.cfg file. Next tag: 8.

func (*AclCfg) Descriptor Uses

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

Deprecated: Use AclCfg.ProtoReflect.Descriptor instead.

func (*AclCfg) GetAdminGroup Uses

func (x *AclCfg) GetAdminGroup() string

func (*AclCfg) GetProjectAccessGroup Uses

func (x *AclCfg) GetProjectAccessGroup() string

func (*AclCfg) GetReimportGroup Uses

func (x *AclCfg) GetReimportGroup() string

func (*AclCfg) GetServiceAccessGroup Uses

func (x *AclCfg) GetServiceAccessGroup() string

func (*AclCfg) GetValidationGroup Uses

func (x *AclCfg) GetValidationGroup() string

func (*AclCfg) ProtoMessage Uses

func (*AclCfg) ProtoMessage()

func (*AclCfg) ProtoReflect Uses

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

func (*AclCfg) Reset Uses

func (x *AclCfg) Reset()

func (*AclCfg) String Uses

func (x *AclCfg) String() string

type ConfigPattern Uses

type ConfigPattern struct {

    // A string pattern for config_set.
    ConfigSet string `protobuf:"bytes,1,opt,name=config_set,json=configSet,proto3" json:"config_set,omitempty"`
    // A string pattern for config file path.
    Path string `protobuf:"bytes,2,opt,name=path,proto3" json:"path,omitempty"`
    // contains filtered or unexported fields
}

Defines a pattern of a config identity. Both config_set and path must match.

func (*ConfigPattern) Descriptor Uses

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

Deprecated: Use ConfigPattern.ProtoReflect.Descriptor instead.

func (*ConfigPattern) GetConfigSet Uses

func (x *ConfigPattern) GetConfigSet() string

func (*ConfigPattern) GetPath Uses

func (x *ConfigPattern) GetPath() string

func (*ConfigPattern) ProtoMessage Uses

func (*ConfigPattern) ProtoMessage()

func (*ConfigPattern) ProtoReflect Uses

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

func (*ConfigPattern) Reset Uses

func (x *ConfigPattern) Reset()

func (*ConfigPattern) String Uses

func (x *ConfigPattern) String() string

type ConfigSetLocation Uses

type ConfigSetLocation struct {

    // URL of the repository where project-wide configurations are stored.
    Url string `protobuf:"bytes,1,opt,name=url,proto3" json:"url,omitempty"`
    // Optional. Type of the configuration repository, e.g. GITILES.
    StorageType ConfigSetLocation_StorageType `protobuf:"varint,2,opt,name=storage_type,json=storageType,proto3,enum=config.ConfigSetLocation_StorageType" json:"storage_type,omitempty"`
    // contains filtered or unexported fields
}

DEPRECATED. DO NOT USE because the Gitiles URL is ambiguous due to lack of separation between the Git's ref and the location within the Git repo. Used to specify project/service configuration location.

func (*ConfigSetLocation) Descriptor Uses

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

Deprecated: Use ConfigSetLocation.ProtoReflect.Descriptor instead.

func (*ConfigSetLocation) GetStorageType Uses

func (x *ConfigSetLocation) GetStorageType() ConfigSetLocation_StorageType

func (*ConfigSetLocation) GetUrl Uses

func (x *ConfigSetLocation) GetUrl() string

func (*ConfigSetLocation) ProtoMessage Uses

func (*ConfigSetLocation) ProtoMessage()

func (*ConfigSetLocation) ProtoReflect Uses

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

func (*ConfigSetLocation) Reset Uses

func (x *ConfigSetLocation) Reset()

func (*ConfigSetLocation) String Uses

func (x *ConfigSetLocation) String() string

type ConfigSetLocation_StorageType Uses

type ConfigSetLocation_StorageType int32

Depending on repository type, config service imports configuration files differently.

const (
    // Will be used if storage_type is not set.
    ConfigSetLocation_UNSET ConfigSetLocation_StorageType = 0
    // Gitiles REST API is used to fetch config files.
    ConfigSetLocation_GITILES ConfigSetLocation_StorageType = 1
)

func (ConfigSetLocation_StorageType) Descriptor Uses

func (ConfigSetLocation_StorageType) Descriptor() protoreflect.EnumDescriptor

func (ConfigSetLocation_StorageType) Enum Uses

func (x ConfigSetLocation_StorageType) Enum() *ConfigSetLocation_StorageType

func (ConfigSetLocation_StorageType) EnumDescriptor Uses

func (ConfigSetLocation_StorageType) EnumDescriptor() ([]byte, []int)

Deprecated: Use ConfigSetLocation_StorageType.Descriptor instead.

func (ConfigSetLocation_StorageType) Number Uses

func (x ConfigSetLocation_StorageType) Number() protoreflect.EnumNumber

func (ConfigSetLocation_StorageType) String Uses

func (x ConfigSetLocation_StorageType) String() string

func (ConfigSetLocation_StorageType) Type Uses

func (ConfigSetLocation_StorageType) Type() protoreflect.EnumType

type GitilesLocation Uses

type GitilesLocation struct {

    // URL of the Git repository.
    // Must not end with "/".
    // Must not end with ".git".
    // Must not have "/a/" prefix of a path component.
    //
    // Example:
    //   OK:
    //     https://chromium.googlesource.com/infra/infra
    //   Not OK:
    //     https://chromium.googlesource.com/a/infra/infra
    //     https://chromium.googlesource.com/infra/infra/
    //     https://chromium.googlesource.com/infra/infra.git
    Repo string `protobuf:"bytes,1,opt,name=repo,proto3" json:"repo,omitempty"`
    // Ref of the Git repository.
    // Must be a fully qualifed ref starting with "refs/".
    //
    // Example:
    //   OK:
    //     refs/heads/branch
    //     refs/heads/infra/config
    //     refs/branch-heads/beta
    //   Not OK:
    //     master
    //     HEAD
    //     origin/main
    //     tags/123
    Ref string `protobuf:"bytes,2,opt,name=ref,proto3" json:"ref,omitempty"`
    // Path to the directory inside Git repository where configurations are stored.
    // Optional. If not specified, defaults to top-level folder of the git repo.
    // Must not start or end with "/".
    //
    // Example:
    //   OK:
    //     infra/config/generated
    //       (empty string)
    //   NOT OK:
    //     /
    //     /config
    //     infra/config/
    Path string `protobuf:"bytes,3,opt,name=path,proto3" json:"path,omitempty"`
    // contains filtered or unexported fields
}

Use to specify configuration stored in Git repository importable via Gitiles API.

func (*GitilesLocation) Descriptor Uses

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

Deprecated: Use GitilesLocation.ProtoReflect.Descriptor instead.

func (*GitilesLocation) GetPath Uses

func (x *GitilesLocation) GetPath() string

func (*GitilesLocation) GetRef Uses

func (x *GitilesLocation) GetRef() string

func (*GitilesLocation) GetRepo Uses

func (x *GitilesLocation) GetRepo() string

func (*GitilesLocation) ProtoMessage Uses

func (*GitilesLocation) ProtoMessage()

func (*GitilesLocation) ProtoReflect Uses

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

func (*GitilesLocation) Reset Uses

func (x *GitilesLocation) Reset()

func (*GitilesLocation) String Uses

func (x *GitilesLocation) String() string

type IdentityConfig Uses

type IdentityConfig struct {

    // ServiceAccountEmail is the full service account email to use when
    // LUCI acts on behalf of the project.
    //
    // Note: Due to token caching, it takes ~15 minutes for a config change
    // to become effective. Keep this in mind when migrating projects to a
    // new identity.
    ServiceAccountEmail string `protobuf:"bytes,1,opt,name=service_account_email,json=serviceAccountEmail,proto3" json:"service_account_email,omitempty"`
    // contains filtered or unexported fields
}

Used to define project specific identities for LUCI to act on behalf when interacting with external systems. This allows projects to use exclusive and isolated identities to not be accidentally affected by other projects.

func (*IdentityConfig) Descriptor Uses

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

Deprecated: Use IdentityConfig.ProtoReflect.Descriptor instead.

func (*IdentityConfig) GetServiceAccountEmail Uses

func (x *IdentityConfig) GetServiceAccountEmail() string

func (*IdentityConfig) ProtoMessage Uses

func (*IdentityConfig) ProtoMessage()

func (*IdentityConfig) ProtoReflect Uses

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

func (*IdentityConfig) Reset Uses

func (x *IdentityConfig) Reset()

func (*IdentityConfig) String Uses

func (x *IdentityConfig) String() string

type ImportCfg Uses

type ImportCfg struct {

    // Configuration of import from Gitiles repositories.
    Gitiles *ImportCfg_Gitiles `protobuf:"bytes,1,opt,name=gitiles,proto3" json:"gitiles,omitempty"`
    // contains filtered or unexported fields
}

Schema for import.cfg. It specified how to import configuration files from external sources.

func (*ImportCfg) Descriptor Uses

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

Deprecated: Use ImportCfg.ProtoReflect.Descriptor instead.

func (*ImportCfg) GetGitiles Uses

func (x *ImportCfg) GetGitiles() *ImportCfg_Gitiles

func (*ImportCfg) ProtoMessage Uses

func (*ImportCfg) ProtoMessage()

func (*ImportCfg) ProtoReflect Uses

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

func (*ImportCfg) Reset Uses

func (x *ImportCfg) Reset()

func (*ImportCfg) String Uses

func (x *ImportCfg) String() string

type ImportCfg_Gitiles Uses

type ImportCfg_Gitiles struct {

    // Request timeout in seconds when requesting commit log.
    FetchLogDeadline int32 `protobuf:"varint,1,opt,name=fetch_log_deadline,json=fetchLogDeadline,proto3" json:"fetch_log_deadline,omitempty"`
    // Request timeout in seconds when requesting directory archive.
    FetchArchiveDeadline int32 `protobuf:"varint,2,opt,name=fetch_archive_deadline,json=fetchArchiveDeadline,proto3" json:"fetch_archive_deadline,omitempty"`
    // DEPRECATED, ignored. TODO(nodir): remove.
    // Default ref for project configs.
    ProjectConfigDefaultRef string `protobuf:"bytes,3,opt,name=project_config_default_ref,json=projectConfigDefaultRef,proto3" json:"project_config_default_ref,omitempty"`
    // DEPRECATED, ignored. TODO(nodir): remove.
    // Default directory for project configs.
    ProjectConfigDefaultPath string `protobuf:"bytes,4,opt,name=project_config_default_path,json=projectConfigDefaultPath,proto3" json:"project_config_default_path,omitempty"`
    // Default directory for ref configs.
    RefConfigDefaultPath string `protobuf:"bytes,5,opt,name=ref_config_default_path,json=refConfigDefaultPath,proto3" json:"ref_config_default_path,omitempty"`
    // contains filtered or unexported fields
}

func (*ImportCfg_Gitiles) Descriptor Uses

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

Deprecated: Use ImportCfg_Gitiles.ProtoReflect.Descriptor instead.

func (*ImportCfg_Gitiles) GetFetchArchiveDeadline Uses

func (x *ImportCfg_Gitiles) GetFetchArchiveDeadline() int32

func (*ImportCfg_Gitiles) GetFetchLogDeadline Uses

func (x *ImportCfg_Gitiles) GetFetchLogDeadline() int32

func (*ImportCfg_Gitiles) GetProjectConfigDefaultPath Uses

func (x *ImportCfg_Gitiles) GetProjectConfigDefaultPath() string

func (*ImportCfg_Gitiles) GetProjectConfigDefaultRef Uses

func (x *ImportCfg_Gitiles) GetProjectConfigDefaultRef() string

func (*ImportCfg_Gitiles) GetRefConfigDefaultPath Uses

func (x *ImportCfg_Gitiles) GetRefConfigDefaultPath() string

func (*ImportCfg_Gitiles) ProtoMessage Uses

func (*ImportCfg_Gitiles) ProtoMessage()

func (*ImportCfg_Gitiles) ProtoReflect Uses

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

func (*ImportCfg_Gitiles) Reset Uses

func (x *ImportCfg_Gitiles) Reset()

func (*ImportCfg_Gitiles) String Uses

func (x *ImportCfg_Gitiles) String() string

type Project Uses

type Project struct {

    // Globally unique id of the project.
    Id  string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
    // Where to import "projects/<id>" config set from.
    //
    // Types that are assignable to Location:
    //	*Project_ConfigLocation
    //	*Project_GitilesLocation
    Location isProject_Location `protobuf_oneof:"location"`
    // IdentityConfig determines what identities are used when LUCI acts on
    // behalf of the project towards external services.
    IdentityConfig *IdentityConfig `protobuf:"bytes,3,opt,name=identity_config,json=identityConfig,proto3" json:"identity_config,omitempty"`
    // contains filtered or unexported fields
}

A tenant of a service. Defined in projects.cfg.

func (*Project) Descriptor Uses

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

Deprecated: Use Project.ProtoReflect.Descriptor instead.

func (*Project) GetConfigLocation Uses

func (x *Project) GetConfigLocation() *ConfigSetLocation

func (*Project) GetGitilesLocation Uses

func (x *Project) GetGitilesLocation() *GitilesLocation

func (*Project) GetId Uses

func (x *Project) GetId() string

func (*Project) GetIdentityConfig Uses

func (x *Project) GetIdentityConfig() *IdentityConfig

func (*Project) GetLocation Uses

func (m *Project) GetLocation() isProject_Location

func (*Project) ProtoMessage Uses

func (*Project) ProtoMessage()

func (*Project) ProtoReflect Uses

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

func (*Project) Reset Uses

func (x *Project) Reset()

func (*Project) String Uses

func (x *Project) String() string

type ProjectCfg Uses

type ProjectCfg struct {

    // Full name of the project.
    Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
    // A list of identities that have read-only access to the project.
    //
    // An element is one of:
    // * "group:<group>", where group is defined on auth server.
    // * "<email>"
    // * "<kind>:<value>" (for non-email identities)
    //
    // If not specified, only admins and trusted services have access.
    // Talk to admins to determine the group name appropriate for your project.
    Access []string `protobuf:"bytes,2,rep,name=access,proto3" json:"access,omitempty"`
    // contains filtered or unexported fields
}

Schema for project.cfg

func (*ProjectCfg) Descriptor Uses

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

Deprecated: Use ProjectCfg.ProtoReflect.Descriptor instead.

func (*ProjectCfg) GetAccess Uses

func (x *ProjectCfg) GetAccess() []string

func (*ProjectCfg) GetName Uses

func (x *ProjectCfg) GetName() string

func (*ProjectCfg) ProtoMessage Uses

func (*ProjectCfg) ProtoMessage()

func (*ProjectCfg) ProtoReflect Uses

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

func (*ProjectCfg) Reset Uses

func (x *ProjectCfg) Reset()

func (*ProjectCfg) String Uses

func (x *ProjectCfg) String() string

type Project_ConfigLocation Uses

type Project_ConfigLocation struct {
    // DEPRECATED. Use `gitiles_location` instead.
    // Where to import "projects/<id>" config set from.
    ConfigLocation *ConfigSetLocation `protobuf:"bytes,2,opt,name=config_location,json=configLocation,proto3,oneof"`
}

type Project_GitilesLocation Uses

type Project_GitilesLocation struct {
    GitilesLocation *GitilesLocation `protobuf:"bytes,4,opt,name=gitiles_location,json=gitilesLocation,proto3,oneof"`
}

type ProjectsCfg Uses

type ProjectsCfg struct {

    // All projects served by this instance of Luci.
    Projects []*Project `protobuf:"bytes,1,rep,name=projects,proto3" json:"projects,omitempty"`
    // contains filtered or unexported fields
}

Schema of projects.cfg file. Represents luci tenants registry.

func (*ProjectsCfg) Descriptor Uses

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

Deprecated: Use ProjectsCfg.ProtoReflect.Descriptor instead.

func (*ProjectsCfg) GetProjects Uses

func (x *ProjectsCfg) GetProjects() []*Project

func (*ProjectsCfg) ProtoMessage Uses

func (*ProjectsCfg) ProtoMessage()

func (*ProjectsCfg) ProtoReflect Uses

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

func (*ProjectsCfg) Reset Uses

func (x *ProjectsCfg) Reset()

func (*ProjectsCfg) String Uses

func (x *ProjectsCfg) String() string

type RefsCfg Uses

type RefsCfg struct {

    // List of refs that have configuration files and need to be fetched into
    // luci-config. Refs are accessible through get_refs() API endpoint.
    // A CI service can read all refs of all projects and build them.
    Refs []*RefsCfg_Ref `protobuf:"bytes,1,rep,name=refs,proto3" json:"refs,omitempty"`
    // contains filtered or unexported fields
}

DEPRECATED. DO NOT USE in your project. Contact luci-team@ if you have a need for this.

Schema of refs.cfg.

func (*RefsCfg) Descriptor Uses

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

Deprecated: Use RefsCfg.ProtoReflect.Descriptor instead.

func (*RefsCfg) GetRefs Uses

func (x *RefsCfg) GetRefs() []*RefsCfg_Ref

func (*RefsCfg) ProtoMessage Uses

func (*RefsCfg) ProtoMessage()

func (*RefsCfg) ProtoReflect Uses

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

func (*RefsCfg) Reset Uses

func (x *RefsCfg) Reset()

func (*RefsCfg) String Uses

func (x *RefsCfg) String() string

type RefsCfg_Ref Uses

type RefsCfg_Ref struct {

    // Name of the ref. Must start with "refs/".
    Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
    // Path to config directory for the ref. Defaults to "infra/config".
    ConfigPath string `protobuf:"bytes,3,opt,name=config_path,json=configPath,proto3" json:"config_path,omitempty"`
    // contains filtered or unexported fields
}

func (*RefsCfg_Ref) Descriptor Uses

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

Deprecated: Use RefsCfg_Ref.ProtoReflect.Descriptor instead.

func (*RefsCfg_Ref) GetConfigPath Uses

func (x *RefsCfg_Ref) GetConfigPath() string

func (*RefsCfg_Ref) GetName Uses

func (x *RefsCfg_Ref) GetName() string

func (*RefsCfg_Ref) ProtoMessage Uses

func (*RefsCfg_Ref) ProtoMessage()

func (*RefsCfg_Ref) ProtoReflect Uses

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

func (*RefsCfg_Ref) Reset Uses

func (x *RefsCfg_Ref) Reset()

func (*RefsCfg_Ref) String Uses

func (x *RefsCfg_Ref) String() string

type SchemasCfg Uses

type SchemasCfg struct {

    // List of known schemas. They are available at /schemas/<name> as a short
    // mutable link.
    Schemas []*SchemasCfg_Schema `protobuf:"bytes,1,rep,name=schemas,proto3" json:"schemas,omitempty"`
    // contains filtered or unexported fields
}

Schema of schemas.cfg

func (*SchemasCfg) Descriptor Uses

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

Deprecated: Use SchemasCfg.ProtoReflect.Descriptor instead.

func (*SchemasCfg) GetSchemas Uses

func (x *SchemasCfg) GetSchemas() []*SchemasCfg_Schema

func (*SchemasCfg) ProtoMessage Uses

func (*SchemasCfg) ProtoMessage()

func (*SchemasCfg) ProtoReflect Uses

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

func (*SchemasCfg) Reset Uses

func (x *SchemasCfg) Reset()

func (*SchemasCfg) String Uses

func (x *SchemasCfg) String() string

type SchemasCfg_Schema Uses

type SchemasCfg_Schema struct {

    // Name of schema.
    // For service configs, "<config_set>:<path>"
    // For project configs, "projects:<path>"
    // For ref configs, "projects/refs:<path>"
    Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
    // URL to the schema definition, e.g. to a .proto file in a repository.
    Url string `protobuf:"bytes,2,opt,name=url,proto3" json:"url,omitempty"`
    // contains filtered or unexported fields
}

func (*SchemasCfg_Schema) Descriptor Uses

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

Deprecated: Use SchemasCfg_Schema.ProtoReflect.Descriptor instead.

func (*SchemasCfg_Schema) GetName Uses

func (x *SchemasCfg_Schema) GetName() string

func (*SchemasCfg_Schema) GetUrl Uses

func (x *SchemasCfg_Schema) GetUrl() string

func (*SchemasCfg_Schema) ProtoMessage Uses

func (*SchemasCfg_Schema) ProtoMessage()

func (*SchemasCfg_Schema) ProtoReflect Uses

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

func (*SchemasCfg_Schema) Reset Uses

func (x *SchemasCfg_Schema) Reset()

func (*SchemasCfg_Schema) String Uses

func (x *SchemasCfg_Schema) String() string

type Service Uses

type Service struct {

    // Globally unique id of the service. Required.
    // Used in "services/<service_id>" config set name.
    Id  string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
    // Email addresses of responsible and point-of-contacts for the service.
    Owners []string `protobuf:"bytes,2,rep,name=owners,proto3" json:"owners,omitempty"`
    // An HTTPS endpoint that returns JSON-encoded ServiceDynamicMetadata in body.
    MetadataUrl string `protobuf:"bytes,4,opt,name=metadata_url,json=metadataUrl,proto3" json:"metadata_url,omitempty"`
    // A list of identities that have access to this service's configs.
    // of:
    // * "group:<group>", where group is defined on auth server.
    // * "<email>"
    // * "<kind>:<value>" (for non-email identities)
    //
    // If not specified, only admins and trusted services have access.
    Access []string `protobuf:"bytes,5,rep,name=access,proto3" json:"access,omitempty"`
    // If set, use JWT auth in requests to services. This is usually used for
    // Cloud Endpoints v2 support.
    JwtAuth *Service_JWTAuth `protobuf:"bytes,6,opt,name=jwt_auth,json=jwtAuth,proto3" json:"jwt_auth,omitempty"`
    // contains filtered or unexported fields
}

Describes one luci service.

func (*Service) Descriptor Uses

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

Deprecated: Use Service.ProtoReflect.Descriptor instead.

func (*Service) GetAccess Uses

func (x *Service) GetAccess() []string

func (*Service) GetId Uses

func (x *Service) GetId() string

func (*Service) GetJwtAuth Uses

func (x *Service) GetJwtAuth() *Service_JWTAuth

func (*Service) GetMetadataUrl Uses

func (x *Service) GetMetadataUrl() string

func (*Service) GetOwners Uses

func (x *Service) GetOwners() []string

func (*Service) ProtoMessage Uses

func (*Service) ProtoMessage()

func (*Service) ProtoReflect Uses

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

func (*Service) Reset Uses

func (x *Service) Reset()

func (*Service) String Uses

func (x *Service) String() string

type ServiceDynamicMetadata Uses

type ServiceDynamicMetadata struct {

    // Format version. Supported versions: 1.0.
    Version string `protobuf:"bytes,1,opt,name=version,proto3" json:"version,omitempty"`
    // What configs this service can validate and how to validate them.
    Validation *Validator `protobuf:"bytes,2,opt,name=validation,proto3" json:"validation,omitempty"`
    // contains filtered or unexported fields
}

Machine-generated service metadata, exposed by a service endpoint. Typically implemented by config component, embedded in an app: see appengine/components/components/config/endpoint.py

If you add a field here, also add it to ServiceDynamicMetadata in endpoint.py

func (*ServiceDynamicMetadata) Descriptor Uses

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

Deprecated: Use ServiceDynamicMetadata.ProtoReflect.Descriptor instead.

func (*ServiceDynamicMetadata) GetValidation Uses

func (x *ServiceDynamicMetadata) GetValidation() *Validator

func (*ServiceDynamicMetadata) GetVersion Uses

func (x *ServiceDynamicMetadata) GetVersion() string

func (*ServiceDynamicMetadata) ProtoMessage Uses

func (*ServiceDynamicMetadata) ProtoMessage()

func (*ServiceDynamicMetadata) ProtoReflect Uses

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

func (*ServiceDynamicMetadata) Reset Uses

func (x *ServiceDynamicMetadata) Reset()

func (*ServiceDynamicMetadata) String Uses

func (x *ServiceDynamicMetadata) String() string

type Service_JWTAuth Uses

type Service_JWTAuth struct {

    // Value for the 'aud' field in the JSON Web Token claim.
    Audience string `protobuf:"bytes,1,opt,name=audience,proto3" json:"audience,omitempty"`
    // contains filtered or unexported fields
}

func (*Service_JWTAuth) Descriptor Uses

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

Deprecated: Use Service_JWTAuth.ProtoReflect.Descriptor instead.

func (*Service_JWTAuth) GetAudience Uses

func (x *Service_JWTAuth) GetAudience() string

func (*Service_JWTAuth) ProtoMessage Uses

func (*Service_JWTAuth) ProtoMessage()

func (*Service_JWTAuth) ProtoReflect Uses

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

func (*Service_JWTAuth) Reset Uses

func (x *Service_JWTAuth) Reset()

func (*Service_JWTAuth) String Uses

func (x *Service_JWTAuth) String() string

type ServicesCfg Uses

type ServicesCfg struct {

    // A list of all luci services. Should be sorted by id.
    Services []*Service `protobuf:"bytes,1,rep,name=services,proto3" json:"services,omitempty"`
    // contains filtered or unexported fields
}

Schema of services.cfg

func (*ServicesCfg) Descriptor Uses

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

Deprecated: Use ServicesCfg.ProtoReflect.Descriptor instead.

func (*ServicesCfg) GetServices Uses

func (x *ServicesCfg) GetServices() []*Service

func (*ServicesCfg) ProtoMessage Uses

func (*ServicesCfg) ProtoMessage()

func (*ServicesCfg) ProtoReflect Uses

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

func (*ServicesCfg) Reset Uses

func (x *ServicesCfg) Reset()

func (*ServicesCfg) String Uses

func (x *ServicesCfg) String() string

type ValidationRequestMessage Uses

type ValidationRequestMessage struct {

    // Config set of the config file to validate.
    ConfigSet string `protobuf:"bytes,1,opt,name=config_set,json=configSet,proto3" json:"config_set,omitempty"`
    // Path of the config file to validate.
    Path string `protobuf:"bytes,2,opt,name=path,proto3" json:"path,omitempty"`
    // Contents of the file.
    Content []byte `protobuf:"bytes,3,opt,name=content,proto3" json:"content,omitempty"`
    // contains filtered or unexported fields
}

This message is used only in JSON form. It is sent as request body to an external validation endpoint in order to validate a config.

func (*ValidationRequestMessage) Descriptor Uses

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

Deprecated: Use ValidationRequestMessage.ProtoReflect.Descriptor instead.

func (*ValidationRequestMessage) GetConfigSet Uses

func (x *ValidationRequestMessage) GetConfigSet() string

func (*ValidationRequestMessage) GetContent Uses

func (x *ValidationRequestMessage) GetContent() []byte

func (*ValidationRequestMessage) GetPath Uses

func (x *ValidationRequestMessage) GetPath() string

func (*ValidationRequestMessage) ProtoMessage Uses

func (*ValidationRequestMessage) ProtoMessage()

func (*ValidationRequestMessage) ProtoReflect Uses

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

func (*ValidationRequestMessage) Reset Uses

func (x *ValidationRequestMessage) Reset()

func (*ValidationRequestMessage) String Uses

func (x *ValidationRequestMessage) String() string

type ValidationResponseMessage Uses

type ValidationResponseMessage struct {

    // Errors, warnings and other information found during validation.
    // If at least one error is found, the config is considered invalid.
    Messages []*ValidationResponseMessage_Message `protobuf:"bytes,1,rep,name=messages,proto3" json:"messages,omitempty"`
    // contains filtered or unexported fields
}

This message is used only in JSON form. It is expected from an external validation endpoint that validates a config.

func (*ValidationResponseMessage) Descriptor Uses

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

Deprecated: Use ValidationResponseMessage.ProtoReflect.Descriptor instead.

func (*ValidationResponseMessage) GetMessages Uses

func (x *ValidationResponseMessage) GetMessages() []*ValidationResponseMessage_Message

func (*ValidationResponseMessage) ProtoMessage Uses

func (*ValidationResponseMessage) ProtoMessage()

func (*ValidationResponseMessage) ProtoReflect Uses

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

func (*ValidationResponseMessage) Reset Uses

func (x *ValidationResponseMessage) Reset()

func (*ValidationResponseMessage) String Uses

func (x *ValidationResponseMessage) String() string

type ValidationResponseMessage_Message Uses

type ValidationResponseMessage_Message struct {

    // Path of the config file that has an error.
    Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
    // If an error, a config is considered invalid. Defaults to INFO.
    Severity ValidationResponseMessage_Severity `protobuf:"varint,2,opt,name=severity,proto3,enum=config.ValidationResponseMessage_Severity" json:"severity,omitempty"`
    // Textual representation of the message.
    Text string `protobuf:"bytes,3,opt,name=text,proto3" json:"text,omitempty"`
    // contains filtered or unexported fields
}

A message that explains why a config is valid or not.

func (*ValidationResponseMessage_Message) Descriptor Uses

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

Deprecated: Use ValidationResponseMessage_Message.ProtoReflect.Descriptor instead.

func (*ValidationResponseMessage_Message) GetPath Uses

func (x *ValidationResponseMessage_Message) GetPath() string

func (*ValidationResponseMessage_Message) GetSeverity Uses

func (x *ValidationResponseMessage_Message) GetSeverity() ValidationResponseMessage_Severity

func (*ValidationResponseMessage_Message) GetText Uses

func (x *ValidationResponseMessage_Message) GetText() string

func (*ValidationResponseMessage_Message) ProtoMessage Uses

func (*ValidationResponseMessage_Message) ProtoMessage()

func (*ValidationResponseMessage_Message) ProtoReflect Uses

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

func (*ValidationResponseMessage_Message) Reset Uses

func (x *ValidationResponseMessage_Message) Reset()

func (*ValidationResponseMessage_Message) String Uses

func (x *ValidationResponseMessage_Message) String() string

type ValidationResponseMessage_Severity Uses

type ValidationResponseMessage_Severity int32

Severity of a validation response message. In JSON encoded as a string.

const (
    ValidationResponseMessage_UNKNOWN  ValidationResponseMessage_Severity = 0
    ValidationResponseMessage_DEBUG    ValidationResponseMessage_Severity = 10
    ValidationResponseMessage_INFO     ValidationResponseMessage_Severity = 20
    ValidationResponseMessage_WARNING  ValidationResponseMessage_Severity = 30
    ValidationResponseMessage_ERROR    ValidationResponseMessage_Severity = 40
    ValidationResponseMessage_CRITICAL ValidationResponseMessage_Severity = 50
)

func (ValidationResponseMessage_Severity) Descriptor Uses

func (ValidationResponseMessage_Severity) Descriptor() protoreflect.EnumDescriptor

func (ValidationResponseMessage_Severity) Enum Uses

func (x ValidationResponseMessage_Severity) Enum() *ValidationResponseMessage_Severity

func (ValidationResponseMessage_Severity) EnumDescriptor Uses

func (ValidationResponseMessage_Severity) EnumDescriptor() ([]byte, []int)

Deprecated: Use ValidationResponseMessage_Severity.Descriptor instead.

func (ValidationResponseMessage_Severity) Number Uses

func (x ValidationResponseMessage_Severity) Number() protoreflect.EnumNumber

func (ValidationResponseMessage_Severity) String Uses

func (x ValidationResponseMessage_Severity) String() string

func (ValidationResponseMessage_Severity) Type Uses

func (ValidationResponseMessage_Severity) Type() protoreflect.EnumType

type Validator Uses

type Validator struct {

    // A list of configuration patterns that this validator can validate.
    Patterns []*ConfigPattern `protobuf:"bytes,1,rep,name=patterns,proto3" json:"patterns,omitempty"`
    // URL of a validation endpoint. The config service will send an HTTP POST
    // request to the endpoint, where body is JSON-encoded
    // ValidationRequestMessage. The endpoint is expected to respond with
    // HTTP status 200 and JSON-encoded ValidationResponseMessage.
    Url string `protobuf:"bytes,2,opt,name=url,proto3" json:"url,omitempty"`
    // contains filtered or unexported fields
}

Describes what configuration can be validated and how to validate them.

func (*Validator) Descriptor Uses

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

Deprecated: Use Validator.ProtoReflect.Descriptor instead.

func (*Validator) GetPatterns Uses

func (x *Validator) GetPatterns() []*ConfigPattern

func (*Validator) GetUrl Uses

func (x *Validator) GetUrl() string

func (*Validator) ProtoMessage Uses

func (*Validator) ProtoMessage()

func (*Validator) ProtoReflect Uses

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

func (*Validator) Reset Uses

func (x *Validator) Reset()

func (*Validator) String Uses

func (x *Validator) String() string

Package config imports 6 packages (graph). Updated 2020-07-11. Refresh now. Tools for package owners.