Back to godoc.org

Package api

v0.0.0-...-1557bcf
Latest Go to latest

The latest major version is .

Published: Aug 13, 2020 | License: Apache-2.0 | Module: github.com/luci/luci-go

Overview

Package api contains CIPD backend API definitions.

Index

Variables

var (
	MapperKind_name = map[int32]string{
		0: "MAPPER_KIND_UNSPECIFIED",
		1: "ENUMERATE_PACKAGES",
		2: "FIND_MALFORMED_TAGS",
		3: "EXPORT_TAGS_TO_BQ",
	}
	MapperKind_value = map[string]int32{
		"MAPPER_KIND_UNSPECIFIED": 0,
		"ENUMERATE_PACKAGES":      1,
		"FIND_MALFORMED_TAGS":     2,
		"EXPORT_TAGS_TO_BQ":       3,
	}
)

Enum value maps for MapperKind.

var File_go_chromium_org_luci_cipd_api_admin_v1_admin_proto protoreflect.FileDescriptor

func FileDescriptorSet

func FileDescriptorSet() *descriptor.FileDescriptorSet

FileDescriptorSet returns a descriptor set for this proto package, which includes all defined services, and all transitive dependencies.

Will not return nil.

Do NOT modify the returned descriptor.

func RegisterAdminServer

func RegisterAdminServer(s prpc.Registrar, srv AdminServer)

type AdminClient

type AdminClient interface {
	// Launches a mapping job that examines and/or fixes datastore entities.
	LaunchJob(ctx context.Context, in *JobConfig, opts ...grpc.CallOption) (*JobID, error)
	// Initiates an abort of a mapping job.
	AbortJob(ctx context.Context, in *JobID, opts ...grpc.CallOption) (*empty.Empty, error)
	// Returns state of a mapping job.
	GetJobState(ctx context.Context, in *JobID, opts ...grpc.CallOption) (*JobState, error)
	// Fixes (right inside the handler) tags marked by the given mapper job.
	FixMarkedTags(ctx context.Context, in *JobID, opts ...grpc.CallOption) (*TagFixReport, error)
}

AdminClient is the client API for Admin service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewAdminClient

func NewAdminClient(cc grpc.ClientConnInterface) AdminClient

func NewAdminPRPCClient

func NewAdminPRPCClient(client *prpc.Client) AdminClient

type AdminServer

type AdminServer interface {
	// Launches a mapping job that examines and/or fixes datastore entities.
	LaunchJob(context.Context, *JobConfig) (*JobID, error)
	// Initiates an abort of a mapping job.
	AbortJob(context.Context, *JobID) (*empty.Empty, error)
	// Returns state of a mapping job.
	GetJobState(context.Context, *JobID) (*JobState, error)
	// Fixes (right inside the handler) tags marked by the given mapper job.
	FixMarkedTags(context.Context, *JobID) (*TagFixReport, error)
}

AdminServer is the server API for Admin service.

type DecoratedAdmin

type DecoratedAdmin struct {
	// Service is the service to decorate.
	Service AdminServer
	// Prelude is called for each method before forwarding the call to Service.
	// If Prelude returns an error, then the call is skipped and the error is
	// processed via the Postlude (if one is defined), or it is returned directly.
	Prelude func(ctx context.Context, methodName string, req proto.Message) (context.Context, error)
	// Postlude is called for each method after Service has processed the call, or
	// after the Prelude has returned an error. This takes the the Service's
	// response proto (which may be nil) and/or any error. The decorated
	// service will return the response (possibly mutated) and error that Postlude
	// returns.
	Postlude func(ctx context.Context, methodName string, rsp proto.Message, err error) error
}

func (*DecoratedAdmin) AbortJob

func (s *DecoratedAdmin) AbortJob(ctx context.Context, req *JobID) (rsp *empty.Empty, err error)

func (*DecoratedAdmin) FixMarkedTags

func (s *DecoratedAdmin) FixMarkedTags(ctx context.Context, req *JobID) (rsp *TagFixReport, err error)

func (*DecoratedAdmin) GetJobState

func (s *DecoratedAdmin) GetJobState(ctx context.Context, req *JobID) (rsp *JobState, err error)

func (*DecoratedAdmin) LaunchJob

func (s *DecoratedAdmin) LaunchJob(ctx context.Context, req *JobConfig) (rsp *JobID, err error)

type JobConfig

type JobConfig struct {
	Kind    MapperKind `protobuf:"varint,1,opt,name=kind,proto3,enum=cipd.MapperKind" json:"kind,omitempty"`
	Comment string     `protobuf:"bytes,2,opt,name=comment,proto3" json:"comment,omitempty"` // arbitrary human readable string
	DryRun  bool       `protobuf:"varint,3,opt,name=dry_run,json=dryRun,proto3" json:"dry_run,omitempty"`
	// contains filtered or unexported fields
}

Defines what a mapping job should do.

func (*JobConfig) Descriptor

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

Deprecated: Use JobConfig.ProtoReflect.Descriptor instead.

func (*JobConfig) GetComment

func (x *JobConfig) GetComment() string

func (*JobConfig) GetDryRun

func (x *JobConfig) GetDryRun() bool

func (*JobConfig) GetKind

func (x *JobConfig) GetKind() MapperKind

func (*JobConfig) ProtoMessage

func (*JobConfig) ProtoMessage()

func (*JobConfig) ProtoReflect

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

func (*JobConfig) Reset

func (x *JobConfig) Reset()

func (*JobConfig) String

func (x *JobConfig) String() string

type JobID

type JobID struct {
	JobId int64 `protobuf:"varint,1,opt,name=job_id,json=jobId,proto3" json:"job_id,omitempty"`
	// contains filtered or unexported fields
}

Identifies an instance of a mapping job.

func (*JobID) Descriptor

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

Deprecated: Use JobID.ProtoReflect.Descriptor instead.

func (*JobID) GetJobId

func (x *JobID) GetJobId() int64

func (*JobID) ProtoMessage

func (*JobID) ProtoMessage()

func (*JobID) ProtoReflect

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

func (*JobID) Reset

func (x *JobID) Reset()

func (*JobID) String

func (x *JobID) String() string

type JobState

type JobState struct {

	// Original job config, exactly as it was submitted to LaunchJob.
	Config *JobConfig `protobuf:"bytes,1,opt,name=config,proto3" json:"config,omitempty"`
	// Current state of the job and all its shards.
	Info *mapper.JobInfo `protobuf:"bytes,2,opt,name=info,proto3" json:"info,omitempty"`
	// contains filtered or unexported fields
}

Details about a mapping job.

func (*JobState) Descriptor

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

Deprecated: Use JobState.ProtoReflect.Descriptor instead.

func (*JobState) GetConfig

func (x *JobState) GetConfig() *JobConfig

func (*JobState) GetInfo

func (x *JobState) GetInfo() *mapper.JobInfo

func (*JobState) ProtoMessage

func (*JobState) ProtoMessage()

func (*JobState) ProtoReflect

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

func (*JobState) Reset

func (x *JobState) Reset()

func (*JobState) String

func (x *JobState) String() string

type MapperKind

type MapperKind int32

Supported mapping jobs.

const (
	MapperKind_MAPPER_KIND_UNSPECIFIED MapperKind = 0
	// Dump names of all packages to GAE logs, to test mapping jobs framework.
	MapperKind_ENUMERATE_PACKAGES MapperKind = 1
	// Find tags that don't pass ValidateInstanceTag and marks them.
	MapperKind_FIND_MALFORMED_TAGS MapperKind = 2
	// Exports all tags into a BigQuery table 'exported_tags'.
	MapperKind_EXPORT_TAGS_TO_BQ MapperKind = 3
)

func (MapperKind) Descriptor

func (MapperKind) Descriptor() protoreflect.EnumDescriptor

func (MapperKind) Enum

func (x MapperKind) Enum() *MapperKind

func (MapperKind) EnumDescriptor

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

Deprecated: Use MapperKind.Descriptor instead.

func (MapperKind) Number

func (x MapperKind) Number() protoreflect.EnumNumber

func (MapperKind) String

func (x MapperKind) String() string

func (MapperKind) Type

func (MapperKind) Type() protoreflect.EnumType

type TagFixReport

type TagFixReport struct {
	Fixed []*TagFixReport_Tag `protobuf:"bytes,1,rep,name=fixed,proto3" json:"fixed,omitempty"`
	// contains filtered or unexported fields
}

Result of running FixMarkedTags.

func (*TagFixReport) Descriptor

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

Deprecated: Use TagFixReport.ProtoReflect.Descriptor instead.

func (*TagFixReport) GetFixed

func (x *TagFixReport) GetFixed() []*TagFixReport_Tag

func (*TagFixReport) ProtoMessage

func (*TagFixReport) ProtoMessage()

func (*TagFixReport) ProtoReflect

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

func (*TagFixReport) Reset

func (x *TagFixReport) Reset()

func (*TagFixReport) String

func (x *TagFixReport) String() string

type TagFixReport_Tag

type TagFixReport_Tag struct {
	Pkg       string `protobuf:"bytes,1,opt,name=pkg,proto3" json:"pkg,omitempty"`
	Instance  string `protobuf:"bytes,2,opt,name=instance,proto3" json:"instance,omitempty"`
	BrokenTag string `protobuf:"bytes,3,opt,name=broken_tag,json=brokenTag,proto3" json:"broken_tag,omitempty"`
	FixedTag  string `protobuf:"bytes,4,opt,name=fixed_tag,json=fixedTag,proto3" json:"fixed_tag,omitempty"` // or "" if it was deleted
	// contains filtered or unexported fields
}

func (*TagFixReport_Tag) Descriptor

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

Deprecated: Use TagFixReport_Tag.ProtoReflect.Descriptor instead.

func (*TagFixReport_Tag) GetBrokenTag

func (x *TagFixReport_Tag) GetBrokenTag() string

func (*TagFixReport_Tag) GetFixedTag

func (x *TagFixReport_Tag) GetFixedTag() string

func (*TagFixReport_Tag) GetInstance

func (x *TagFixReport_Tag) GetInstance() string

func (*TagFixReport_Tag) GetPkg

func (x *TagFixReport_Tag) GetPkg() string

func (*TagFixReport_Tag) ProtoMessage

func (*TagFixReport_Tag) ProtoMessage()

func (*TagFixReport_Tag) ProtoReflect

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

func (*TagFixReport_Tag) Reset

func (x *TagFixReport_Tag) Reset()

func (*TagFixReport_Tag) String

func (x *TagFixReport_Tag) String() string

type UnimplementedAdminServer

type UnimplementedAdminServer struct {
}

UnimplementedAdminServer can be embedded to have forward compatible implementations.

func (*UnimplementedAdminServer) AbortJob

func (*UnimplementedAdminServer) AbortJob(context.Context, *JobID) (*empty.Empty, error)

func (*UnimplementedAdminServer) FixMarkedTags

func (*UnimplementedAdminServer) FixMarkedTags(context.Context, *JobID) (*TagFixReport, error)

func (*UnimplementedAdminServer) GetJobState

func (*UnimplementedAdminServer) GetJobState(context.Context, *JobID) (*JobState, error)

func (*UnimplementedAdminServer) LaunchJob

func (*UnimplementedAdminServer) LaunchJob(context.Context, *JobConfig) (*JobID, error)

Package Files

Documentation was rendered with GOOS=linux and GOARCH=amd64.

Jump to identifier

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to identifier