proto

package
v0.0.0-...-e560ebb Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 13, 2021 License: BSD-3-Clause Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	TelemetryBenchmark_Statistic_name = map[int32]string{
		0: "STATISTIC_UNSPECIFIED",
		1: "NONE",
		2: "MIN",
		3: "MAX",
		4: "MEAN",
		5: "STD_DEV",
		6: "MEDIAN",
		7: "PCT90",
		8: "PCT99",
	}
	TelemetryBenchmark_Statistic_value = map[string]int32{
		"STATISTIC_UNSPECIFIED": 0,
		"NONE":                  1,
		"MIN":                   2,
		"MAX":                   3,
		"MEAN":                  4,
		"STD_DEV":               5,
		"MEDIAN":                6,
		"PCT90":                 7,
		"PCT99":                 8,
	}
)

Enum value maps for TelemetryBenchmark_Statistic.

View Source
var (
	JobSpec_ComparisonMode_name = map[int32]string{
		0: "COMPARISON_MODE_UNSPECIFIED",
		1: "PERFORMANCE",
		2: "FUNCTIONAL",
	}
	JobSpec_ComparisonMode_value = map[string]int32{
		"COMPARISON_MODE_UNSPECIFIED": 0,
		"PERFORMANCE":                 1,
		"FUNCTIONAL":                  2,
	}
)

Enum value maps for JobSpec_ComparisonMode.

View Source
var (
	Job_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "PENDING",
		2: "RUNNING",
		3: "SUCCEEDED",
		4: "FAILED",
		5: "CANCELLED",
	}
	Job_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"PENDING":           1,
		"RUNNING":           2,
		"SUCCEEDED":         3,
		"FAILED":            4,
		"CANCELLED":         5,
	}
)

Enum value maps for Job_State.

View Source
var File_infra_chromeperf_pinpoint_pinpoint_proto protoreflect.FileDescriptor
View Source
var Pinpoint_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "pinpoint.Pinpoint",
	HandlerType: (*PinpointServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "ScheduleJob",
			Handler:    _Pinpoint_ScheduleJob_Handler,
		},
		{
			MethodName: "GetJob",
			Handler:    _Pinpoint_GetJob_Handler,
		},
		{
			MethodName: "ListJobs",
			Handler:    _Pinpoint_ListJobs_Handler,
		},
		{
			MethodName: "CancelJob",
			Handler:    _Pinpoint_CancelJob_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "infra/chromeperf/pinpoint/pinpoint.proto",
}

Pinpoint_ServiceDesc is the grpc.ServiceDesc for Pinpoint service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterPinpointServer

func RegisterPinpointServer(s grpc.ServiceRegistrar, srv PinpointServer)

Types

type ABExperimentResults

type ABExperimentResults struct {
	AChangeResult *ChangeResult `protobuf:"bytes,1,opt,name=a_change_result,json=aChangeResult,proto3" json:"a_change_result,omitempty"`
	BChangeResult *ChangeResult `protobuf:"bytes,2,opt,name=b_change_result,json=bChangeResult,proto3" json:"b_change_result,omitempty"`
	// contains filtered or unexported fields
}

func (*ABExperimentResults) Descriptor deprecated

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

Deprecated: Use ABExperimentResults.ProtoReflect.Descriptor instead.

func (*ABExperimentResults) GetAChangeResult

func (x *ABExperimentResults) GetAChangeResult() *ChangeResult

func (*ABExperimentResults) GetBChangeResult

func (x *ABExperimentResults) GetBChangeResult() *ChangeResult

func (*ABExperimentResults) ProtoMessage

func (*ABExperimentResults) ProtoMessage()

func (*ABExperimentResults) ProtoReflect

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

func (*ABExperimentResults) Reset

func (x *ABExperimentResults) Reset()

func (*ABExperimentResults) String

func (x *ABExperimentResults) String() string

type Attempt

type Attempt struct {
	Executions []*Execution `protobuf:"bytes,1,rep,name=executions,proto3" json:"executions,omitempty"`
	// contains filtered or unexported fields
}

func (*Attempt) Descriptor deprecated

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

Deprecated: Use Attempt.ProtoReflect.Descriptor instead.

func (*Attempt) GetExecutions

func (x *Attempt) GetExecutions() []*Execution

func (*Attempt) ProtoMessage

func (*Attempt) ProtoMessage()

func (*Attempt) ProtoReflect

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

func (*Attempt) Reset

func (x *Attempt) Reset()

func (*Attempt) String

func (x *Attempt) String() string

type Bisection

type Bisection struct {

	// A commit range through which the bisection will be performed.
	CommitRange *GitilesCommitRange `protobuf:"bytes,1,opt,name=commit_range,json=commitRange,proto3" json:"commit_range,omitempty"`
	// A patch to apply to all commits in the range before building. This is
	// useful if you want to apply a patch that fixes the build in a range where
	// the bisection might encounter broken builds.
	Patch *GerritChange `protobuf:"bytes,3,opt,name=patch,proto3" json:"patch,omitempty"`
	// contains filtered or unexported fields
}

A Bisection specifies a range through which Pinpoint will perform builds/runs against to find potential culprits.

func (*Bisection) Descriptor deprecated

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

Deprecated: Use Bisection.ProtoReflect.Descriptor instead.

func (*Bisection) GetCommitRange

func (x *Bisection) GetCommitRange() *GitilesCommitRange

func (*Bisection) GetPatch

func (x *Bisection) GetPatch() *GerritChange

func (*Bisection) ProtoMessage

func (*Bisection) ProtoMessage()

func (*Bisection) ProtoReflect

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

func (*Bisection) Reset

func (x *Bisection) Reset()

func (*Bisection) String

func (x *Bisection) String() string

type BisectionResults

type BisectionResults struct {
	Results []*ChangeResult `protobuf:"bytes,1,rep,name=results,proto3" json:"results,omitempty"`
	// contains filtered or unexported fields
}

func (*BisectionResults) Descriptor deprecated

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

Deprecated: Use BisectionResults.ProtoReflect.Descriptor instead.

func (*BisectionResults) GetResults

func (x *BisectionResults) GetResults() []*ChangeResult

func (*BisectionResults) ProtoMessage

func (*BisectionResults) ProtoMessage()

func (*BisectionResults) ProtoReflect

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

func (*BisectionResults) Reset

func (x *BisectionResults) Reset()

func (*BisectionResults) String

func (x *BisectionResults) String() string

type CancelJobRequest

type CancelJobRequest struct {
	Name   string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Reason string `protobuf:"bytes,2,opt,name=reason,proto3" json:"reason,omitempty"`
	// contains filtered or unexported fields
}

func (*CancelJobRequest) Descriptor deprecated

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

Deprecated: Use CancelJobRequest.ProtoReflect.Descriptor instead.

func (*CancelJobRequest) GetName

func (x *CancelJobRequest) GetName() string

func (*CancelJobRequest) GetReason

func (x *CancelJobRequest) GetReason() string

func (*CancelJobRequest) ProtoMessage

func (*CancelJobRequest) ProtoMessage()

func (*CancelJobRequest) ProtoReflect

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

func (*CancelJobRequest) Reset

func (x *CancelJobRequest) Reset()

func (*CancelJobRequest) String

func (x *CancelJobRequest) String() string

type Change

type Change struct {
	Commit *GitilesCommit `protobuf:"bytes,1,opt,name=commit,proto3" json:"commit,omitempty"`
	Patch  *GerritChange  `protobuf:"bytes,2,opt,name=patch,proto3" json:"patch,omitempty"`
	// contains filtered or unexported fields
}

==== LEGACY RESULTS PROTOS Everything within this section is a translation of the schema used by the legacy API to represent results for a given job.

func (*Change) Descriptor deprecated

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

Deprecated: Use Change.ProtoReflect.Descriptor instead.

func (*Change) GetCommit

func (x *Change) GetCommit() *GitilesCommit

func (*Change) GetPatch

func (x *Change) GetPatch() *GerritChange

func (*Change) ProtoMessage

func (*Change) ProtoMessage()

func (*Change) ProtoReflect

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

func (*Change) Reset

func (x *Change) Reset()

func (*Change) String

func (x *Change) String() string

type ChangeResult

type ChangeResult struct {
	Attempts     []*Attempt `protobuf:"bytes,1,rep,name=attempts,proto3" json:"attempts,omitempty"`
	Change       *Change    `protobuf:"bytes,2,opt,name=change,proto3" json:"change,omitempty"`
	ResultValues []float64  `protobuf:"fixed64,3,rep,packed,name=result_values,json=resultValues,proto3" json:"result_values,omitempty"`
	// contains filtered or unexported fields
}

Results associated with a Change.

func (*ChangeResult) Descriptor deprecated

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

Deprecated: Use ChangeResult.ProtoReflect.Descriptor instead.

func (*ChangeResult) GetAttempts

func (x *ChangeResult) GetAttempts() []*Attempt

func (*ChangeResult) GetChange

func (x *ChangeResult) GetChange() *Change

func (*ChangeResult) GetResultValues

func (x *ChangeResult) GetResultValues() []float64

func (*ChangeResult) ProtoMessage

func (*ChangeResult) ProtoMessage()

func (*ChangeResult) ProtoReflect

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

func (*ChangeResult) Reset

func (x *ChangeResult) Reset()

func (*ChangeResult) String

func (x *ChangeResult) String() string

type Execution

type Execution struct {
	Completed bool                `protobuf:"varint,1,opt,name=completed,proto3" json:"completed,omitempty"`
	Label     string              `protobuf:"bytes,4,opt,name=label,proto3" json:"label,omitempty"`
	Details   []*ExecutionDetails `protobuf:"bytes,2,rep,name=details,proto3" json:"details,omitempty"`
	Exception *structpb.Struct    `protobuf:"bytes,3,opt,name=exception,proto3" json:"exception,omitempty"`
	// contains filtered or unexported fields
}

func (*Execution) Descriptor deprecated

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

Deprecated: Use Execution.ProtoReflect.Descriptor instead.

func (*Execution) GetCompleted

func (x *Execution) GetCompleted() bool

func (*Execution) GetDetails

func (x *Execution) GetDetails() []*ExecutionDetails

func (*Execution) GetException

func (x *Execution) GetException() *structpb.Struct

func (*Execution) GetLabel

func (x *Execution) GetLabel() string

func (*Execution) ProtoMessage

func (*Execution) ProtoMessage()

func (*Execution) ProtoReflect

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

func (*Execution) Reset

func (x *Execution) Reset()

func (*Execution) String

func (x *Execution) String() string

type ExecutionDetails

type ExecutionDetails struct {
	Key   string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	Url   string `protobuf:"bytes,3,opt,name=url,proto3" json:"url,omitempty"`
	// contains filtered or unexported fields
}

func (*ExecutionDetails) Descriptor deprecated

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

Deprecated: Use ExecutionDetails.ProtoReflect.Descriptor instead.

func (*ExecutionDetails) GetKey

func (x *ExecutionDetails) GetKey() string

func (*ExecutionDetails) GetUrl

func (x *ExecutionDetails) GetUrl() string

func (*ExecutionDetails) GetValue

func (x *ExecutionDetails) GetValue() string

func (*ExecutionDetails) ProtoMessage

func (*ExecutionDetails) ProtoMessage()

func (*ExecutionDetails) ProtoReflect

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

func (*ExecutionDetails) Reset

func (x *ExecutionDetails) Reset()

func (*ExecutionDetails) String

func (x *ExecutionDetails) String() string

type Experiment

type Experiment struct {

	// The commit and optional patch from which we'd perform the A/B Test.
	BaseCommit *GitilesCommit `protobuf:"bytes,1,opt,name=base_commit,json=baseCommit,proto3" json:"base_commit,omitempty"`
	BasePatch  *GerritChange  `protobuf:"bytes,2,opt,name=base_patch,json=basePatch,proto3" json:"base_patch,omitempty"`
	// The commit and required patch which we'll compare against the base and
	// optional patch. If the experiment_commit is empty, we use the base_commit
	// instead.
	ExperimentCommit *GitilesCommit `protobuf:"bytes,3,opt,name=experiment_commit,json=experimentCommit,proto3" json:"experiment_commit,omitempty"`
	ExperimentPatch  *GerritChange  `protobuf:"bytes,4,opt,name=experiment_patch,json=experimentPatch,proto3" json:"experiment_patch,omitempty"`
	// The alpha and histogram_filter are used for deciding whether the
	// experiment is statistic significante enough as a difference. We check the
	// alpah_value on filtered histograms
	// https://en.wikipedia.org/wiki/Statistical_significance
	Alpha            float64 `protobuf:"fixed64,5,opt,name=alpha,proto3" json:"alpha,omitempty"`
	MeasurementRegex string  `protobuf:"bytes,6,opt,name=measurement_regex,json=measurementRegex,proto3" json:"measurement_regex,omitempty"`
	// contains filtered or unexported fields
}

An Experiment defines an A/B test between a base build (with an optional patch) and an experimental build. This is also referred to as a "tryjob" in Pinpoint.

func (*Experiment) Descriptor deprecated

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

Deprecated: Use Experiment.ProtoReflect.Descriptor instead.

func (*Experiment) GetAlpha

func (x *Experiment) GetAlpha() float64

func (*Experiment) GetBaseCommit

func (x *Experiment) GetBaseCommit() *GitilesCommit

func (*Experiment) GetBasePatch

func (x *Experiment) GetBasePatch() *GerritChange

func (*Experiment) GetExperimentCommit

func (x *Experiment) GetExperimentCommit() *GitilesCommit

func (*Experiment) GetExperimentPatch

func (x *Experiment) GetExperimentPatch() *GerritChange

func (*Experiment) GetMeasurementRegex

func (x *Experiment) GetMeasurementRegex() string

func (*Experiment) ProtoMessage

func (*Experiment) ProtoMessage()

func (*Experiment) ProtoReflect

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

func (*Experiment) Reset

func (x *Experiment) Reset()

func (*Experiment) String

func (x *Experiment) String() string

type GTestBenchmark

type GTestBenchmark struct {

	// Name of the benchmark. This is provided to the GTest benchmark through the
	// '--gtest-benchmark-name' flag, to identify which benchmark in the `target`
	// (provided in the JobSpec) will be run.
	Benchmark string `protobuf:"bytes,1,opt,name=benchmark,proto3" json:"benchmark,omitempty"`
	// Name of the measurement that shows up as a chart in the Dashboard.
	Measurement string `protobuf:"bytes,2,opt,name=measurement,proto3" json:"measurement,omitempty"`
	// Name of the testcase in the benchmark, supplied as a filter to the GTest.
	Test string `protobuf:"bytes,3,opt,name=test,proto3" json:"test,omitempty"`
	// contains filtered or unexported fields
}

Specify the details for data generated by a GTest benchmark.

func (*GTestBenchmark) Descriptor deprecated

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

Deprecated: Use GTestBenchmark.ProtoReflect.Descriptor instead.

func (*GTestBenchmark) GetBenchmark

func (x *GTestBenchmark) GetBenchmark() string

func (*GTestBenchmark) GetMeasurement

func (x *GTestBenchmark) GetMeasurement() string

func (*GTestBenchmark) GetTest

func (x *GTestBenchmark) GetTest() string

func (*GTestBenchmark) ProtoMessage

func (*GTestBenchmark) ProtoMessage()

func (*GTestBenchmark) ProtoReflect

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

func (*GTestBenchmark) Reset

func (x *GTestBenchmark) Reset()

func (*GTestBenchmark) String

func (x *GTestBenchmark) String() string

type GerritChange

type GerritChange struct {

	// Gerrit hostname.
	Host string `protobuf:"bytes,1,opt,name=host,proto3" json:"host,omitempty"`
	// Gerrit project in the host.
	Project string `protobuf:"bytes,2,opt,name=project,proto3" json:"project,omitempty"`
	// A change ID against the project in the host.
	Change int64 `protobuf:"varint,3,opt,name=change,proto3" json:"change,omitempty"`
	// A reference to the patch set. If unspecified this will always be the
	// latest.
	Patchset int64 `protobuf:"varint,4,opt,name=patchset,proto3" json:"patchset,omitempty"`
	// contains filtered or unexported fields
}

A Gerrit change review, to refer to patches to apply in builds.

func (*GerritChange) Descriptor deprecated

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

Deprecated: Use GerritChange.ProtoReflect.Descriptor instead.

func (*GerritChange) GetChange

func (x *GerritChange) GetChange() int64

func (*GerritChange) GetHost

func (x *GerritChange) GetHost() string

func (*GerritChange) GetPatchset

func (x *GerritChange) GetPatchset() int64

func (*GerritChange) GetProject

func (x *GerritChange) GetProject() string

func (*GerritChange) ProtoMessage

func (*GerritChange) ProtoMessage()

func (*GerritChange) ProtoReflect

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

func (*GerritChange) Reset

func (x *GerritChange) Reset()

func (*GerritChange) String

func (x *GerritChange) String() string

type GetJobRequest

type GetJobRequest struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

func (*GetJobRequest) Descriptor deprecated

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

Deprecated: Use GetJobRequest.ProtoReflect.Descriptor instead.

func (*GetJobRequest) GetName

func (x *GetJobRequest) GetName() string

func (*GetJobRequest) ProtoMessage

func (*GetJobRequest) ProtoMessage()

func (*GetJobRequest) ProtoReflect

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

func (*GetJobRequest) Reset

func (x *GetJobRequest) Reset()

func (*GetJobRequest) String

func (x *GetJobRequest) String() string

type GitilesCommit

type GitilesCommit struct {

	// The gitiles host to query for commits.
	Host string `protobuf:"bytes,1,opt,name=host,proto3" json:"host,omitempty"`
	// The gitiles project to query for commits.
	Project string `protobuf:"bytes,2,opt,name=project,proto3" json:"project,omitempty"`
	// The hash for the specific Git commit.
	GitHash string `protobuf:"bytes,3,opt,name=git_hash,json=gitHash,proto3" json:"git_hash,omitempty"`
	// contains filtered or unexported fields
}

A commit in a Gitiles repostory.

func (*GitilesCommit) Descriptor deprecated

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

Deprecated: Use GitilesCommit.ProtoReflect.Descriptor instead.

func (*GitilesCommit) GetGitHash

func (x *GitilesCommit) GetGitHash() string

func (*GitilesCommit) GetHost

func (x *GitilesCommit) GetHost() string

func (*GitilesCommit) GetProject

func (x *GitilesCommit) GetProject() string

func (*GitilesCommit) ProtoMessage

func (*GitilesCommit) ProtoMessage()

func (*GitilesCommit) ProtoReflect

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

func (*GitilesCommit) Reset

func (x *GitilesCommit) Reset()

func (*GitilesCommit) String

func (x *GitilesCommit) String() string

type GitilesCommitRange

type GitilesCommitRange struct {

	// The gitiles host to query for commits.
	Host string `protobuf:"bytes,1,opt,name=host,proto3" json:"host,omitempty"`
	// The gitiles project to query for commits.
	Project string `protobuf:"bytes,2,opt,name=project,proto3" json:"project,omitempty"`
	// The start of the commit range.
	StartGitHash string `protobuf:"bytes,3,opt,name=start_git_hash,json=startGitHash,proto3" json:"start_git_hash,omitempty"`
	// The end of the commit range.
	EndGitHash string `protobuf:"bytes,4,opt,name=end_git_hash,json=endGitHash,proto3" json:"end_git_hash,omitempty"`
	// contains filtered or unexported fields
}

A CommitRange consists of two git commit hashes from the same project that the end commit must be reachable from the start commit.

func (*GitilesCommitRange) Descriptor deprecated

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

Deprecated: Use GitilesCommitRange.ProtoReflect.Descriptor instead.

func (*GitilesCommitRange) GetEndGitHash

func (x *GitilesCommitRange) GetEndGitHash() string

func (*GitilesCommitRange) GetHost

func (x *GitilesCommitRange) GetHost() string

func (*GitilesCommitRange) GetProject

func (x *GitilesCommitRange) GetProject() string

func (*GitilesCommitRange) GetStartGitHash

func (x *GitilesCommitRange) GetStartGitHash() string

func (*GitilesCommitRange) ProtoMessage

func (*GitilesCommitRange) ProtoMessage()

func (*GitilesCommitRange) ProtoReflect

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

func (*GitilesCommitRange) Reset

func (x *GitilesCommitRange) Reset()

func (*GitilesCommitRange) String

func (x *GitilesCommitRange) String() string

type Job

type Job struct {

	// The resource name of the job.
	// Format: jobs/{job}
	//
	// Name must follow either of the following formats:
	//   - 'legacy-<hex>' where <hex> is a non-prefixed hexadecimal string
	//   - a canonical textual representation of a UUID
	Name  string    `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	State Job_State `protobuf:"varint,2,opt,name=state,proto3,enum=pinpoint.Job_State" json:"state,omitempty"`
	// The user that created this Job, referred to by email address.
	CreatedBy      string                 `protobuf:"bytes,3,opt,name=created_by,json=createdBy,proto3" json:"created_by,omitempty"`
	CreateTime     *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	LastUpdateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=last_update_time,json=lastUpdateTime,proto3" json:"last_update_time,omitempty"`
	// Specification provided when the Job was created.
	JobSpec *JobSpec `protobuf:"bytes,6,opt,name=job_spec,json=jobSpec,proto3" json:"job_spec,omitempty"`
	// If present, the reason provided for when a job is cancelled.
	CancellationReason string `protobuf:"bytes,7,opt,name=cancellation_reason,json=cancellationReason,proto3" json:"cancellation_reason,omitempty"`
	// Types that are assignable to Results:
	//	*Job_BisectionResults
	//	*Job_AbExperimentResults
	Results isJob_Results `protobuf_oneof:"results"`
	// A list of files representing results for the associated Job, for example
	// an HTML summary page. This field will only be set if state==SUCCEEDED.
	ResultFiles []*ResultFile `protobuf:"bytes,10,rep,name=result_files,json=resultFiles,proto3" json:"result_files,omitempty"`
	// contains filtered or unexported fields
}

A representation of a Pinpoint Job.

func (*Job) Descriptor deprecated

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

Deprecated: Use Job.ProtoReflect.Descriptor instead.

func (*Job) GetAbExperimentResults

func (x *Job) GetAbExperimentResults() *ABExperimentResults

func (*Job) GetBisectionResults

func (x *Job) GetBisectionResults() *BisectionResults

func (*Job) GetCancellationReason

func (x *Job) GetCancellationReason() string

func (*Job) GetCreateTime

func (x *Job) GetCreateTime() *timestamppb.Timestamp

func (*Job) GetCreatedBy

func (x *Job) GetCreatedBy() string

func (*Job) GetJobSpec

func (x *Job) GetJobSpec() *JobSpec

func (*Job) GetLastUpdateTime

func (x *Job) GetLastUpdateTime() *timestamppb.Timestamp

func (*Job) GetName

func (x *Job) GetName() string

func (*Job) GetResultFiles

func (x *Job) GetResultFiles() []*ResultFile

func (*Job) GetResults

func (m *Job) GetResults() isJob_Results

func (*Job) GetState

func (x *Job) GetState() Job_State

func (*Job) ProtoMessage

func (*Job) ProtoMessage()

func (*Job) ProtoReflect

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

func (*Job) Reset

func (x *Job) Reset()

func (*Job) String

func (x *Job) String() string

type JobSpec

type JobSpec struct {

	// The comparison mode to perform. Defaults to 'PERFORMANCE' if unspecified.
	ComparisonMode JobSpec_ComparisonMode `` /* 141-byte string literal not displayed */
	// A threshold value which determines how sensitive the comparison algorithm
	// should be. This is typically a multiple of the inter-quartile range for
	// the measurements, indicating how "tight" the bounds for differences must
	// be when considering statistical significance.
	//
	// If unspecified, the service will determine a default comparison magnitude
	// based on the empirically measured inter-quartile range.
	ComparisonMagnitude float64 `protobuf:"fixed64,2,opt,name=comparison_magnitude,json=comparisonMagnitude,proto3" json:"comparison_magnitude,omitempty"`
	// A named configuration, representing a "bot pool" in Pinpoint.
	//
	// These are managed through the administration console on the Chromeperf UI.
	//
	// TODO(dberris): Add a reference to the luci-config files when these have
	// been migrated.
	Config string `protobuf:"bytes,3,opt,name=config,proto3" json:"config,omitempty"`
	// The target representing a build target that will be built/run by Pinpoint.
	Target string `protobuf:"bytes,4,opt,name=target,proto3" json:"target,omitempty"`
	// Types that are assignable to JobKind:
	//	*JobSpec_Bisection
	//	*JobSpec_Experiment
	JobKind isJobSpec_JobKind `protobuf_oneof:"job_kind"`
	// Types that are assignable to Arguments:
	//	*JobSpec_TelemetryBenchmark
	//	*JobSpec_GtestBenchmark
	Arguments isJobSpec_Arguments `protobuf_oneof:"arguments"`
	// The associated Monorail issue.
	MonorailIssue *MonorailIssue `protobuf:"bytes,9,opt,name=monorail_issue,json=monorailIssue,proto3" json:"monorail_issue,omitempty"`
	// A client can associate an agent identifier (similar to an HTTP User Agent).
	// This is purely metadata.
	UserAgent string `protobuf:"bytes,10,opt,name=user_agent,json=userAgent,proto3" json:"user_agent,omitempty"`
	// A batch identifier links multiple jobs together.
	BatchId string `protobuf:"bytes,11,opt,name=batch_id,json=batchId,proto3" json:"batch_id,omitempty"`
	// contains filtered or unexported fields
}

A JobSpec defines inputs for Pinpoint to configure a job being created and managed by the service.

func (*JobSpec) Descriptor deprecated

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

Deprecated: Use JobSpec.ProtoReflect.Descriptor instead.

func (*JobSpec) GetArguments

func (m *JobSpec) GetArguments() isJobSpec_Arguments

func (*JobSpec) GetBatchId

func (x *JobSpec) GetBatchId() string

func (*JobSpec) GetBisection

func (x *JobSpec) GetBisection() *Bisection

func (*JobSpec) GetComparisonMagnitude

func (x *JobSpec) GetComparisonMagnitude() float64

func (*JobSpec) GetComparisonMode

func (x *JobSpec) GetComparisonMode() JobSpec_ComparisonMode

func (*JobSpec) GetConfig

func (x *JobSpec) GetConfig() string

func (*JobSpec) GetExperiment

func (x *JobSpec) GetExperiment() *Experiment

func (*JobSpec) GetGtestBenchmark

func (x *JobSpec) GetGtestBenchmark() *GTestBenchmark

func (*JobSpec) GetJobKind

func (m *JobSpec) GetJobKind() isJobSpec_JobKind

func (*JobSpec) GetMonorailIssue

func (x *JobSpec) GetMonorailIssue() *MonorailIssue

func (*JobSpec) GetTarget

func (x *JobSpec) GetTarget() string

func (*JobSpec) GetTelemetryBenchmark

func (x *JobSpec) GetTelemetryBenchmark() *TelemetryBenchmark

func (*JobSpec) GetUserAgent

func (x *JobSpec) GetUserAgent() string

func (*JobSpec) ProtoMessage

func (*JobSpec) ProtoMessage()

func (*JobSpec) ProtoReflect

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

func (*JobSpec) Reset

func (x *JobSpec) Reset()

func (*JobSpec) String

func (x *JobSpec) String() string

type JobSpec_Bisection

type JobSpec_Bisection struct {
	Bisection *Bisection `protobuf:"bytes,5,opt,name=bisection,proto3,oneof"`
}

type JobSpec_ComparisonMode

type JobSpec_ComparisonMode int32

The comparison mode used by Pinpoint in this job.

const (
	// If unspecified, it's as if 'PERFORMANCE' was specified.
	JobSpec_COMPARISON_MODE_UNSPECIFIED JobSpec_ComparisonMode = 0
	// Performs statistical tests appropriate for performance measurements.
	JobSpec_PERFORMANCE JobSpec_ComparisonMode = 1
	// Performs statistical tests appropriate for functional success/failure
	// measurements. This is used in determining whether a benchmark has failed
	// or started to become flaky in a bisection or to try out whether a patch
	// will cause failures for specific benchmarks/stories in experiments.
	JobSpec_FUNCTIONAL JobSpec_ComparisonMode = 2
)

func (JobSpec_ComparisonMode) Descriptor

func (JobSpec_ComparisonMode) Enum

func (JobSpec_ComparisonMode) EnumDescriptor deprecated

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

Deprecated: Use JobSpec_ComparisonMode.Descriptor instead.

func (JobSpec_ComparisonMode) Number

func (JobSpec_ComparisonMode) String

func (x JobSpec_ComparisonMode) String() string

func (JobSpec_ComparisonMode) Type

type JobSpec_Experiment

type JobSpec_Experiment struct {
	Experiment *Experiment `protobuf:"bytes,6,opt,name=experiment,proto3,oneof"`
}

type JobSpec_GtestBenchmark

type JobSpec_GtestBenchmark struct {
	GtestBenchmark *GTestBenchmark `protobuf:"bytes,8,opt,name=gtest_benchmark,json=gtestBenchmark,proto3,oneof"`
}

type JobSpec_TelemetryBenchmark

type JobSpec_TelemetryBenchmark struct {
	TelemetryBenchmark *TelemetryBenchmark `protobuf:"bytes,7,opt,name=telemetry_benchmark,json=telemetryBenchmark,proto3,oneof"`
}

type Job_AbExperimentResults

type Job_AbExperimentResults struct {
	AbExperimentResults *ABExperimentResults `protobuf:"bytes,9,opt,name=ab_experiment_results,json=abExperimentResults,proto3,oneof"`
}

type Job_BisectionResults

type Job_BisectionResults struct {
	BisectionResults *BisectionResults `protobuf:"bytes,8,opt,name=bisection_results,json=bisectionResults,proto3,oneof"`
}

type Job_State

type Job_State int32
const (
	Job_STATE_UNSPECIFIED Job_State = 0
	Job_PENDING           Job_State = 1
	Job_RUNNING           Job_State = 2
	Job_SUCCEEDED         Job_State = 3
	Job_FAILED            Job_State = 4
	Job_CANCELLED         Job_State = 5
)

func (Job_State) Descriptor

func (Job_State) Descriptor() protoreflect.EnumDescriptor

func (Job_State) Enum

func (x Job_State) Enum() *Job_State

func (Job_State) EnumDescriptor deprecated

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

Deprecated: Use Job_State.Descriptor instead.

func (Job_State) Number

func (x Job_State) Number() protoreflect.EnumNumber

func (Job_State) String

func (x Job_State) String() string

func (Job_State) Type

type ListJobsRequest

type ListJobsRequest struct {

	// If unspecified, at most 100 Jobs will be returned.
	// Max is 1000, any values above will be capped to 1000.
	PageSize int32 `protobuf:"varint,1,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A page token, received from a previous `ListJobs` call.
	// Provide this to retrieve the subsequent page.
	// When paginating, all other parameters provided must match previous
	// requests.
	PageToken string `protobuf:"bytes,2,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// A structured string specifying a filter on Job properties.
	// TODO(dberris): Document this, see https://aip.dev/160 for details.
	Filter string `protobuf:"bytes,3,opt,name=filter,proto3" json:"filter,omitempty"`
	// contains filtered or unexported fields
}

func (*ListJobsRequest) Descriptor deprecated

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

Deprecated: Use ListJobsRequest.ProtoReflect.Descriptor instead.

func (*ListJobsRequest) GetFilter

func (x *ListJobsRequest) GetFilter() string

func (*ListJobsRequest) GetPageSize

func (x *ListJobsRequest) GetPageSize() int32

func (*ListJobsRequest) GetPageToken

func (x *ListJobsRequest) GetPageToken() string

func (*ListJobsRequest) ProtoMessage

func (*ListJobsRequest) ProtoMessage()

func (*ListJobsRequest) ProtoReflect

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

func (*ListJobsRequest) Reset

func (x *ListJobsRequest) Reset()

func (*ListJobsRequest) String

func (x *ListJobsRequest) String() string

type ListJobsResponse

type ListJobsResponse struct {
	Jobs          []*Job `protobuf:"bytes,1,rep,name=jobs,proto3" json:"jobs,omitempty"`
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

func (*ListJobsResponse) Descriptor deprecated

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

Deprecated: Use ListJobsResponse.ProtoReflect.Descriptor instead.

func (*ListJobsResponse) GetJobs

func (x *ListJobsResponse) GetJobs() []*Job

func (*ListJobsResponse) GetNextPageToken

func (x *ListJobsResponse) GetNextPageToken() string

func (*ListJobsResponse) ProtoMessage

func (*ListJobsResponse) ProtoMessage()

func (*ListJobsResponse) ProtoReflect

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

func (*ListJobsResponse) Reset

func (x *ListJobsResponse) Reset()

func (*ListJobsResponse) String

func (x *ListJobsResponse) String() string

type MonorailIssue

type MonorailIssue struct {

	// Name of the Monorail project.
	Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	// The Issue ID in the provided project.
	IssueId int64 `protobuf:"varint,2,opt,name=issue_id,json=issueId,proto3" json:"issue_id,omitempty"`
	// contains filtered or unexported fields
}

func (*MonorailIssue) Descriptor deprecated

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

Deprecated: Use MonorailIssue.ProtoReflect.Descriptor instead.

func (*MonorailIssue) GetIssueId

func (x *MonorailIssue) GetIssueId() int64

func (*MonorailIssue) GetProject

func (x *MonorailIssue) GetProject() string

func (*MonorailIssue) ProtoMessage

func (*MonorailIssue) ProtoMessage()

func (*MonorailIssue) ProtoReflect

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

func (*MonorailIssue) Reset

func (x *MonorailIssue) Reset()

func (*MonorailIssue) String

func (x *MonorailIssue) String() string

type PinpointClient

type PinpointClient interface {
	// Schedules a Pinpoint Job for execution.
	ScheduleJob(ctx context.Context, in *ScheduleJobRequest, opts ...grpc.CallOption) (*Job, error)
	// Retrieves details about a Pinpoint Job.
	GetJob(ctx context.Context, in *GetJobRequest, opts ...grpc.CallOption) (*Job, error)
	// Lists jobs with filters.
	ListJobs(ctx context.Context, in *ListJobsRequest, opts ...grpc.CallOption) (*ListJobsResponse, error)
	// Cancels an ongoing job.
	CancelJob(ctx context.Context, in *CancelJobRequest, opts ...grpc.CallOption) (*Job, error)
}

PinpointClient is the client API for Pinpoint service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewPinpointClient

func NewPinpointClient(cc grpc.ClientConnInterface) PinpointClient

type PinpointServer

type PinpointServer interface {
	// Schedules a Pinpoint Job for execution.
	ScheduleJob(context.Context, *ScheduleJobRequest) (*Job, error)
	// Retrieves details about a Pinpoint Job.
	GetJob(context.Context, *GetJobRequest) (*Job, error)
	// Lists jobs with filters.
	ListJobs(context.Context, *ListJobsRequest) (*ListJobsResponse, error)
	// Cancels an ongoing job.
	CancelJob(context.Context, *CancelJobRequest) (*Job, error)
	// contains filtered or unexported methods
}

PinpointServer is the server API for Pinpoint service. All implementations must embed UnimplementedPinpointServer for forward compatibility

type ResultFile

type ResultFile struct {
	GcsBucket string `protobuf:"bytes,1,opt,name=gcs_bucket,json=gcsBucket,proto3" json:"gcs_bucket,omitempty"`
	Path      string `protobuf:"bytes,2,opt,name=path,proto3" json:"path,omitempty"`
	// contains filtered or unexported fields
}

ResultFile represents a result for a Pinpoint Job; the file is stored in Google Cloud Storage (GCS).

func (*ResultFile) Descriptor deprecated

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

Deprecated: Use ResultFile.ProtoReflect.Descriptor instead.

func (*ResultFile) GetGcsBucket

func (x *ResultFile) GetGcsBucket() string

func (*ResultFile) GetPath

func (x *ResultFile) GetPath() string

func (*ResultFile) ProtoMessage

func (*ResultFile) ProtoMessage()

func (*ResultFile) ProtoReflect

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

func (*ResultFile) Reset

func (x *ResultFile) Reset()

func (*ResultFile) String

func (x *ResultFile) String() string

type ScheduleJobRequest

type ScheduleJobRequest struct {
	Job *JobSpec `protobuf:"bytes,1,opt,name=job,proto3" json:"job,omitempty"`
	// contains filtered or unexported fields
}

Contains the required information for creating a Job represented in the datastore.

func (*ScheduleJobRequest) Descriptor deprecated

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

Deprecated: Use ScheduleJobRequest.ProtoReflect.Descriptor instead.

func (*ScheduleJobRequest) GetJob

func (x *ScheduleJobRequest) GetJob() *JobSpec

func (*ScheduleJobRequest) ProtoMessage

func (*ScheduleJobRequest) ProtoMessage()

func (*ScheduleJobRequest) ProtoReflect

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

func (*ScheduleJobRequest) Reset

func (x *ScheduleJobRequest) Reset()

func (*ScheduleJobRequest) String

func (x *ScheduleJobRequest) String() string

type TelemetryBenchmark

type TelemetryBenchmark struct {

	// The name of the benchmark.
	Benchmark string `protobuf:"bytes,1,opt,name=benchmark,proto3" json:"benchmark,omitempty"`
	// Types that are assignable to StorySelection:
	//	*TelemetryBenchmark_Story
	//	*TelemetryBenchmark_StoryTags
	StorySelection isTelemetryBenchmark_StorySelection `protobuf_oneof:"story_selection"`
	// The name of the measurement to extract. This refers to the name of the
	// histogram in a HistogramSet which we'll be making statistical analysis
	// decisions on.
	//
	// See
	// https://chromium.googlesource.com/catapult.git/+/HEAD/docs/how-to-write-metrics.md#histograms
	// and
	// https://chromium.googlesource.com/catapult/+/HEAD/docs/histogram-set-json-format.md
	// for details on what metric names can be and how to select those from
	// histograms produced by Telemetry benchmarks.
	Measurement string `protobuf:"bytes,4,opt,name=measurement,proto3" json:"measurement,omitempty"`
	// The optional grouping label, as described in
	// https://chromium.googlesource.com/catapult.git/+/HEAD/docs/how-to-write-metrics.md#reserved-names
	// (as `labels`, passed as a flag to Telemetry via the --results-label flag).
	GroupingLabel string `protobuf:"bytes,5,opt,name=grouping_label,json=groupingLabel,proto3" json:"grouping_label,omitempty"`
	// The statistic to extract. If unspecified defaults to "NONE", i.e. use all
	// the sample values instead of computing a statistic.
	Statistic TelemetryBenchmark_Statistic `protobuf:"varint,6,opt,name=statistic,proto3,enum=pinpoint.TelemetryBenchmark_Statistic" json:"statistic,omitempty"`
	// List of extra arguments passed to the Telemetry runner.
	ExtraArgs []string `protobuf:"bytes,7,rep,name=extra_args,json=extraArgs,proto3" json:"extra_args,omitempty"`
	// contains filtered or unexported fields
}

Specifies the details for data generated by a Telemetry benchmark.

func (*TelemetryBenchmark) Descriptor deprecated

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

Deprecated: Use TelemetryBenchmark.ProtoReflect.Descriptor instead.

func (*TelemetryBenchmark) GetBenchmark

func (x *TelemetryBenchmark) GetBenchmark() string

func (*TelemetryBenchmark) GetExtraArgs

func (x *TelemetryBenchmark) GetExtraArgs() []string

func (*TelemetryBenchmark) GetGroupingLabel

func (x *TelemetryBenchmark) GetGroupingLabel() string

func (*TelemetryBenchmark) GetMeasurement

func (x *TelemetryBenchmark) GetMeasurement() string

func (*TelemetryBenchmark) GetStatistic

func (*TelemetryBenchmark) GetStory

func (x *TelemetryBenchmark) GetStory() string

func (*TelemetryBenchmark) GetStorySelection

func (m *TelemetryBenchmark) GetStorySelection() isTelemetryBenchmark_StorySelection

func (*TelemetryBenchmark) GetStoryTags

func (*TelemetryBenchmark) ProtoMessage

func (*TelemetryBenchmark) ProtoMessage()

func (*TelemetryBenchmark) ProtoReflect

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

func (*TelemetryBenchmark) Reset

func (x *TelemetryBenchmark) Reset()

func (*TelemetryBenchmark) String

func (x *TelemetryBenchmark) String() string

type TelemetryBenchmark_Statistic

type TelemetryBenchmark_Statistic int32

Supported statistics for when performing statistical analysis/comparisons.

const (
	// If unspecified, lets Pinpoint determine the default statistic to use
	// depending on the mode.
	TelemetryBenchmark_STATISTIC_UNSPECIFIED TelemetryBenchmark_Statistic = 0
	// Use all the sample values when performing statistical
	// analysis/comparisons.
	TelemetryBenchmark_NONE TelemetryBenchmark_Statistic = 1
	// All the following values select the appropriate statistic across
	// multiple attempts, and performs statistical analysis on these values,
	// instead of the raw sample values.
	TelemetryBenchmark_MIN     TelemetryBenchmark_Statistic = 2
	TelemetryBenchmark_MAX     TelemetryBenchmark_Statistic = 3
	TelemetryBenchmark_MEAN    TelemetryBenchmark_Statistic = 4
	TelemetryBenchmark_STD_DEV TelemetryBenchmark_Statistic = 5
	TelemetryBenchmark_MEDIAN  TelemetryBenchmark_Statistic = 6
	TelemetryBenchmark_PCT90   TelemetryBenchmark_Statistic = 7
	TelemetryBenchmark_PCT99   TelemetryBenchmark_Statistic = 8
)

func (TelemetryBenchmark_Statistic) Descriptor

func (TelemetryBenchmark_Statistic) Enum

func (TelemetryBenchmark_Statistic) EnumDescriptor deprecated

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

Deprecated: Use TelemetryBenchmark_Statistic.Descriptor instead.

func (TelemetryBenchmark_Statistic) Number

func (TelemetryBenchmark_Statistic) String

func (TelemetryBenchmark_Statistic) Type

type TelemetryBenchmark_Story

type TelemetryBenchmark_Story struct {
	// A story to run.
	Story string `protobuf:"bytes,2,opt,name=story,proto3,oneof"`
}

type TelemetryBenchmark_StoryTagList

type TelemetryBenchmark_StoryTagList struct {

	// A list of story tags which specify stories that will be run. All stories
	// that match any of the specified tags will be collected (unioned) in the
	// run.
	StoryTags []string `protobuf:"bytes,1,rep,name=story_tags,json=storyTags,proto3" json:"story_tags,omitempty"`
	// contains filtered or unexported fields
}

func (*TelemetryBenchmark_StoryTagList) Descriptor deprecated

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

Deprecated: Use TelemetryBenchmark_StoryTagList.ProtoReflect.Descriptor instead.

func (*TelemetryBenchmark_StoryTagList) GetStoryTags

func (x *TelemetryBenchmark_StoryTagList) GetStoryTags() []string

func (*TelemetryBenchmark_StoryTagList) ProtoMessage

func (*TelemetryBenchmark_StoryTagList) ProtoMessage()

func (*TelemetryBenchmark_StoryTagList) ProtoReflect

func (*TelemetryBenchmark_StoryTagList) Reset

func (*TelemetryBenchmark_StoryTagList) String

type TelemetryBenchmark_StoryTags

type TelemetryBenchmark_StoryTags struct {
	// NOTE: We use a nested message in this proto oneof because it cannot
	// include repeated fields.
	StoryTags *TelemetryBenchmark_StoryTagList `protobuf:"bytes,3,opt,name=story_tags,json=storyTags,proto3,oneof"`
}

type UnimplementedPinpointServer

type UnimplementedPinpointServer struct {
}

UnimplementedPinpointServer must be embedded to have forward compatible implementations.

func (UnimplementedPinpointServer) CancelJob

func (UnimplementedPinpointServer) GetJob

func (UnimplementedPinpointServer) ListJobs

func (UnimplementedPinpointServer) ScheduleJob

type UnsafePinpointServer

type UnsafePinpointServer interface {
	// contains filtered or unexported methods
}

UnsafePinpointServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to PinpointServer will result in compilation errors.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL