proto

package
v1.3.10 Latest Latest
Warning

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

Go to latest
Published: Dec 12, 2025 License: MIT Imports: 9 Imported by: 0

Documentation

Index

Constants

View Source
const (
	Plugin_GetInfo_FullMethodName  = "/releasepilot.Plugin/GetInfo"
	Plugin_Execute_FullMethodName  = "/releasepilot.Plugin/Execute"
	Plugin_Validate_FullMethodName = "/releasepilot.Plugin/Validate"
)

Variables

View Source
var (
	Hook_name = map[int32]string{
		0:  "HOOK_UNSPECIFIED",
		1:  "HOOK_PRE_INIT",
		2:  "HOOK_POST_INIT",
		3:  "HOOK_PRE_PLAN",
		4:  "HOOK_POST_PLAN",
		5:  "HOOK_PRE_VERSION",
		6:  "HOOK_POST_VERSION",
		7:  "HOOK_PRE_NOTES",
		8:  "HOOK_POST_NOTES",
		9:  "HOOK_PRE_APPROVE",
		10: "HOOK_POST_APPROVE",
		11: "HOOK_PRE_PUBLISH",
		12: "HOOK_POST_PUBLISH",
		13: "HOOK_ON_SUCCESS",
		14: "HOOK_ON_ERROR",
	}
	Hook_value = map[string]int32{
		"HOOK_UNSPECIFIED":  0,
		"HOOK_PRE_INIT":     1,
		"HOOK_POST_INIT":    2,
		"HOOK_PRE_PLAN":     3,
		"HOOK_POST_PLAN":    4,
		"HOOK_PRE_VERSION":  5,
		"HOOK_POST_VERSION": 6,
		"HOOK_PRE_NOTES":    7,
		"HOOK_POST_NOTES":   8,
		"HOOK_PRE_APPROVE":  9,
		"HOOK_POST_APPROVE": 10,
		"HOOK_PRE_PUBLISH":  11,
		"HOOK_POST_PUBLISH": 12,
		"HOOK_ON_SUCCESS":   13,
		"HOOK_ON_ERROR":     14,
	}
)

Enum value maps for Hook.

View Source
var File_internal_plugin_proto_plugin_proto protoreflect.FileDescriptor
View Source
var Plugin_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "releasepilot.Plugin",
	HandlerType: (*PluginServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetInfo",
			Handler:    _Plugin_GetInfo_Handler,
		},
		{
			MethodName: "Execute",
			Handler:    _Plugin_Execute_Handler,
		},
		{
			MethodName: "Validate",
			Handler:    _Plugin_Validate_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "internal/plugin/proto/plugin.proto",
}

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

Functions

func RegisterPluginServer

func RegisterPluginServer(s grpc.ServiceRegistrar, srv PluginServer)

Types

type Artifact

type Artifact struct {

	// name is the artifact name.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// path is the artifact path (local file or URL).
	Path string `protobuf:"bytes,2,opt,name=path,proto3" json:"path,omitempty"`
	// type is the artifact type (file, url, etc.).
	Type string `protobuf:"bytes,3,opt,name=type,proto3" json:"type,omitempty"`
	// size is the artifact size in bytes.
	Size int64 `protobuf:"varint,4,opt,name=size,proto3" json:"size,omitempty"`
	// checksum is the artifact checksum.
	Checksum string `protobuf:"bytes,5,opt,name=checksum,proto3" json:"checksum,omitempty"`
	// contains filtered or unexported fields
}

Artifact represents a file or resource created by a plugin.

func (*Artifact) Descriptor deprecated

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

Deprecated: Use Artifact.ProtoReflect.Descriptor instead.

func (*Artifact) GetChecksum

func (x *Artifact) GetChecksum() string

func (*Artifact) GetName

func (x *Artifact) GetName() string

func (*Artifact) GetPath

func (x *Artifact) GetPath() string

func (*Artifact) GetSize

func (x *Artifact) GetSize() int64

func (*Artifact) GetType

func (x *Artifact) GetType() string

func (*Artifact) ProtoMessage

func (*Artifact) ProtoMessage()

func (*Artifact) ProtoReflect

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

func (*Artifact) Reset

func (x *Artifact) Reset()

func (*Artifact) String

func (x *Artifact) String() string

type CategorizedChanges

type CategorizedChanges struct {

	// features lists feature commits.
	Features []*ConventionalCommit `protobuf:"bytes,1,rep,name=features,proto3" json:"features,omitempty"`
	// fixes lists bug fix commits.
	Fixes []*ConventionalCommit `protobuf:"bytes,2,rep,name=fixes,proto3" json:"fixes,omitempty"`
	// breaking lists breaking change commits.
	Breaking []*ConventionalCommit `protobuf:"bytes,3,rep,name=breaking,proto3" json:"breaking,omitempty"`
	// performance lists performance improvement commits.
	Performance []*ConventionalCommit `protobuf:"bytes,4,rep,name=performance,proto3" json:"performance,omitempty"`
	// refactor lists refactoring commits.
	Refactor []*ConventionalCommit `protobuf:"bytes,5,rep,name=refactor,proto3" json:"refactor,omitempty"`
	// docs lists documentation commits.
	Docs []*ConventionalCommit `protobuf:"bytes,6,rep,name=docs,proto3" json:"docs,omitempty"`
	// other lists other commits.
	Other []*ConventionalCommit `protobuf:"bytes,7,rep,name=other,proto3" json:"other,omitempty"`
	// contains filtered or unexported fields
}

CategorizedChanges contains commits grouped by category.

func (*CategorizedChanges) Descriptor deprecated

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

Deprecated: Use CategorizedChanges.ProtoReflect.Descriptor instead.

func (*CategorizedChanges) GetBreaking

func (x *CategorizedChanges) GetBreaking() []*ConventionalCommit

func (*CategorizedChanges) GetDocs

func (x *CategorizedChanges) GetDocs() []*ConventionalCommit

func (*CategorizedChanges) GetFeatures

func (x *CategorizedChanges) GetFeatures() []*ConventionalCommit

func (*CategorizedChanges) GetFixes

func (x *CategorizedChanges) GetFixes() []*ConventionalCommit

func (*CategorizedChanges) GetOther

func (x *CategorizedChanges) GetOther() []*ConventionalCommit

func (*CategorizedChanges) GetPerformance

func (x *CategorizedChanges) GetPerformance() []*ConventionalCommit

func (*CategorizedChanges) GetRefactor

func (x *CategorizedChanges) GetRefactor() []*ConventionalCommit

func (*CategorizedChanges) ProtoMessage

func (*CategorizedChanges) ProtoMessage()

func (*CategorizedChanges) ProtoReflect

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

func (*CategorizedChanges) Reset

func (x *CategorizedChanges) Reset()

func (*CategorizedChanges) String

func (x *CategorizedChanges) String() string

type ConventionalCommit

type ConventionalCommit struct {

	// hash is the commit hash.
	Hash string `protobuf:"bytes,1,opt,name=hash,proto3" json:"hash,omitempty"`
	// type is the commit type (feat, fix, etc.).
	Type string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"`
	// scope is the optional scope.
	Scope string `protobuf:"bytes,3,opt,name=scope,proto3" json:"scope,omitempty"`
	// description is the commit description.
	Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
	// body is the commit body.
	Body string `protobuf:"bytes,5,opt,name=body,proto3" json:"body,omitempty"`
	// breaking indicates if this is a breaking change.
	Breaking bool `protobuf:"varint,6,opt,name=breaking,proto3" json:"breaking,omitempty"`
	// breaking_description is the breaking change description.
	BreakingDescription string `protobuf:"bytes,7,opt,name=breaking_description,json=breakingDescription,proto3" json:"breaking_description,omitempty"`
	// issues lists referenced issues.
	Issues []string `protobuf:"bytes,8,rep,name=issues,proto3" json:"issues,omitempty"`
	// author is the commit author.
	Author string `protobuf:"bytes,9,opt,name=author,proto3" json:"author,omitempty"`
	// date is the commit date.
	Date string `protobuf:"bytes,10,opt,name=date,proto3" json:"date,omitempty"`
	// contains filtered or unexported fields
}

ConventionalCommit represents a parsed conventional commit.

func (*ConventionalCommit) Descriptor deprecated

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

Deprecated: Use ConventionalCommit.ProtoReflect.Descriptor instead.

func (*ConventionalCommit) GetAuthor

func (x *ConventionalCommit) GetAuthor() string

func (*ConventionalCommit) GetBody

func (x *ConventionalCommit) GetBody() string

func (*ConventionalCommit) GetBreaking

func (x *ConventionalCommit) GetBreaking() bool

func (*ConventionalCommit) GetBreakingDescription

func (x *ConventionalCommit) GetBreakingDescription() string

func (*ConventionalCommit) GetDate

func (x *ConventionalCommit) GetDate() string

func (*ConventionalCommit) GetDescription

func (x *ConventionalCommit) GetDescription() string

func (*ConventionalCommit) GetHash

func (x *ConventionalCommit) GetHash() string

func (*ConventionalCommit) GetIssues

func (x *ConventionalCommit) GetIssues() []string

func (*ConventionalCommit) GetScope

func (x *ConventionalCommit) GetScope() string

func (*ConventionalCommit) GetType

func (x *ConventionalCommit) GetType() string

func (*ConventionalCommit) ProtoMessage

func (*ConventionalCommit) ProtoMessage()

func (*ConventionalCommit) ProtoReflect

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

func (*ConventionalCommit) Reset

func (x *ConventionalCommit) Reset()

func (*ConventionalCommit) String

func (x *ConventionalCommit) String() string

type Empty

type Empty struct {
	// contains filtered or unexported fields
}

Empty is an empty message for requests that don't need input.

func (*Empty) Descriptor deprecated

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

Deprecated: Use Empty.ProtoReflect.Descriptor instead.

func (*Empty) ProtoMessage

func (*Empty) ProtoMessage()

func (*Empty) ProtoReflect

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

func (*Empty) Reset

func (x *Empty) Reset()

func (*Empty) String

func (x *Empty) String() string

type ExecuteRequest

type ExecuteRequest struct {

	// hook is the hook being executed.
	Hook Hook `protobuf:"varint,1,opt,name=hook,proto3,enum=releasepilot.Hook" json:"hook,omitempty"`
	// config is the plugin-specific configuration as JSON.
	Config string `protobuf:"bytes,2,opt,name=config,proto3" json:"config,omitempty"`
	// context contains the release context.
	Context *ReleaseContext `protobuf:"bytes,3,opt,name=context,proto3" json:"context,omitempty"`
	// dry_run indicates if this is a dry run.
	DryRun bool `protobuf:"varint,4,opt,name=dry_run,json=dryRun,proto3" json:"dry_run,omitempty"`
	// contains filtered or unexported fields
}

ExecuteRequest is the request for executing a plugin hook.

func (*ExecuteRequest) Descriptor deprecated

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

Deprecated: Use ExecuteRequest.ProtoReflect.Descriptor instead.

func (*ExecuteRequest) GetConfig

func (x *ExecuteRequest) GetConfig() string

func (*ExecuteRequest) GetContext

func (x *ExecuteRequest) GetContext() *ReleaseContext

func (*ExecuteRequest) GetDryRun

func (x *ExecuteRequest) GetDryRun() bool

func (*ExecuteRequest) GetHook

func (x *ExecuteRequest) GetHook() Hook

func (*ExecuteRequest) ProtoMessage

func (*ExecuteRequest) ProtoMessage()

func (*ExecuteRequest) ProtoReflect

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

func (*ExecuteRequest) Reset

func (x *ExecuteRequest) Reset()

func (*ExecuteRequest) String

func (x *ExecuteRequest) String() string

type ExecuteResponse

type ExecuteResponse struct {

	// success indicates if the execution was successful.
	Success bool `protobuf:"varint,1,opt,name=success,proto3" json:"success,omitempty"`
	// message is an optional message about the execution.
	Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
	// error is the error message if execution failed.
	Error string `protobuf:"bytes,3,opt,name=error,proto3" json:"error,omitempty"`
	// outputs contains any outputs from the plugin as JSON.
	Outputs string `protobuf:"bytes,4,opt,name=outputs,proto3" json:"outputs,omitempty"`
	// artifacts lists any artifacts created by the plugin.
	Artifacts []*Artifact `protobuf:"bytes,5,rep,name=artifacts,proto3" json:"artifacts,omitempty"`
	// contains filtered or unexported fields
}

ExecuteResponse is the response from plugin execution.

func (*ExecuteResponse) Descriptor deprecated

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

Deprecated: Use ExecuteResponse.ProtoReflect.Descriptor instead.

func (*ExecuteResponse) GetArtifacts

func (x *ExecuteResponse) GetArtifacts() []*Artifact

func (*ExecuteResponse) GetError

func (x *ExecuteResponse) GetError() string

func (*ExecuteResponse) GetMessage

func (x *ExecuteResponse) GetMessage() string

func (*ExecuteResponse) GetOutputs

func (x *ExecuteResponse) GetOutputs() string

func (*ExecuteResponse) GetSuccess

func (x *ExecuteResponse) GetSuccess() bool

func (*ExecuteResponse) ProtoMessage

func (*ExecuteResponse) ProtoMessage()

func (*ExecuteResponse) ProtoReflect

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

func (*ExecuteResponse) Reset

func (x *ExecuteResponse) Reset()

func (*ExecuteResponse) String

func (x *ExecuteResponse) String() string

type Hook

type Hook int32

Hook represents a hook type in the release workflow.

const (
	Hook_HOOK_UNSPECIFIED  Hook = 0
	Hook_HOOK_PRE_INIT     Hook = 1
	Hook_HOOK_POST_INIT    Hook = 2
	Hook_HOOK_PRE_PLAN     Hook = 3
	Hook_HOOK_POST_PLAN    Hook = 4
	Hook_HOOK_PRE_VERSION  Hook = 5
	Hook_HOOK_POST_VERSION Hook = 6
	Hook_HOOK_PRE_NOTES    Hook = 7
	Hook_HOOK_POST_NOTES   Hook = 8
	Hook_HOOK_PRE_APPROVE  Hook = 9
	Hook_HOOK_POST_APPROVE Hook = 10
	Hook_HOOK_PRE_PUBLISH  Hook = 11
	Hook_HOOK_POST_PUBLISH Hook = 12
	Hook_HOOK_ON_SUCCESS   Hook = 13
	Hook_HOOK_ON_ERROR     Hook = 14
)

func (Hook) Descriptor

func (Hook) Descriptor() protoreflect.EnumDescriptor

func (Hook) Enum

func (x Hook) Enum() *Hook

func (Hook) EnumDescriptor deprecated

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

Deprecated: Use Hook.Descriptor instead.

func (Hook) Number

func (x Hook) Number() protoreflect.EnumNumber

func (Hook) String

func (x Hook) String() string

func (Hook) Type

func (Hook) Type() protoreflect.EnumType

type PluginClient

type PluginClient interface {
	// GetInfo returns plugin metadata.
	GetInfo(ctx context.Context, in *Empty, opts ...grpc.CallOption) (*PluginInfo, error)
	// Execute runs the plugin for a given hook.
	Execute(ctx context.Context, in *ExecuteRequest, opts ...grpc.CallOption) (*ExecuteResponse, error)
	// Validate validates the plugin configuration.
	Validate(ctx context.Context, in *ValidateRequest, opts ...grpc.CallOption) (*ValidateResponse, error)
}

PluginClient is the client API for Plugin 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.

Plugin is the main plugin service.

func NewPluginClient

func NewPluginClient(cc grpc.ClientConnInterface) PluginClient

type PluginInfo

type PluginInfo struct {

	// name is the plugin name.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// version is the plugin version.
	Version string `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"`
	// description is a short description of the plugin.
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// author is the plugin author.
	Author string `protobuf:"bytes,4,opt,name=author,proto3" json:"author,omitempty"`
	// hooks lists the hooks this plugin supports.
	Hooks []string `protobuf:"bytes,5,rep,name=hooks,proto3" json:"hooks,omitempty"`
	// config_schema is a JSON schema for the plugin configuration.
	ConfigSchema string `protobuf:"bytes,6,opt,name=config_schema,json=configSchema,proto3" json:"config_schema,omitempty"`
	// contains filtered or unexported fields
}

PluginInfo contains metadata about the plugin.

func (*PluginInfo) Descriptor deprecated

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

Deprecated: Use PluginInfo.ProtoReflect.Descriptor instead.

func (*PluginInfo) GetAuthor

func (x *PluginInfo) GetAuthor() string

func (*PluginInfo) GetConfigSchema

func (x *PluginInfo) GetConfigSchema() string

func (*PluginInfo) GetDescription

func (x *PluginInfo) GetDescription() string

func (*PluginInfo) GetHooks

func (x *PluginInfo) GetHooks() []string

func (*PluginInfo) GetName

func (x *PluginInfo) GetName() string

func (*PluginInfo) GetVersion

func (x *PluginInfo) GetVersion() string

func (*PluginInfo) ProtoMessage

func (*PluginInfo) ProtoMessage()

func (*PluginInfo) ProtoReflect

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

func (*PluginInfo) Reset

func (x *PluginInfo) Reset()

func (*PluginInfo) String

func (x *PluginInfo) String() string

type PluginServer

type PluginServer interface {
	// GetInfo returns plugin metadata.
	GetInfo(context.Context, *Empty) (*PluginInfo, error)
	// Execute runs the plugin for a given hook.
	Execute(context.Context, *ExecuteRequest) (*ExecuteResponse, error)
	// Validate validates the plugin configuration.
	Validate(context.Context, *ValidateRequest) (*ValidateResponse, error)
	// contains filtered or unexported methods
}

PluginServer is the server API for Plugin service. All implementations must embed UnimplementedPluginServer for forward compatibility.

Plugin is the main plugin service.

type ReleaseContext

type ReleaseContext struct {

	// version is the release version (e.g., "1.2.3").
	Version string `protobuf:"bytes,1,opt,name=version,proto3" json:"version,omitempty"`
	// previous_version is the previous release version.
	PreviousVersion string `protobuf:"bytes,2,opt,name=previous_version,json=previousVersion,proto3" json:"previous_version,omitempty"`
	// tag_name is the full tag name (e.g., "v1.2.3").
	TagName string `protobuf:"bytes,3,opt,name=tag_name,json=tagName,proto3" json:"tag_name,omitempty"`
	// release_type is the type of release (major, minor, patch).
	ReleaseType string `protobuf:"bytes,4,opt,name=release_type,json=releaseType,proto3" json:"release_type,omitempty"`
	// repository_url is the repository URL.
	RepositoryUrl string `protobuf:"bytes,5,opt,name=repository_url,json=repositoryUrl,proto3" json:"repository_url,omitempty"`
	// repository_owner is the repository owner.
	RepositoryOwner string `protobuf:"bytes,6,opt,name=repository_owner,json=repositoryOwner,proto3" json:"repository_owner,omitempty"`
	// repository_name is the repository name.
	RepositoryName string `protobuf:"bytes,7,opt,name=repository_name,json=repositoryName,proto3" json:"repository_name,omitempty"`
	// branch is the branch being released from.
	Branch string `protobuf:"bytes,8,opt,name=branch,proto3" json:"branch,omitempty"`
	// commit_sha is the HEAD commit SHA.
	CommitSha string `protobuf:"bytes,9,opt,name=commit_sha,json=commitSha,proto3" json:"commit_sha,omitempty"`
	// changelog is the generated changelog content.
	Changelog string `protobuf:"bytes,10,opt,name=changelog,proto3" json:"changelog,omitempty"`
	// release_notes is the generated release notes.
	ReleaseNotes string `protobuf:"bytes,11,opt,name=release_notes,json=releaseNotes,proto3" json:"release_notes,omitempty"`
	// changes contains the categorized changes.
	Changes *CategorizedChanges `protobuf:"bytes,12,opt,name=changes,proto3" json:"changes,omitempty"`
	// environment contains environment variables (filtered for security).
	Environment map[string]string `` /* 150-byte string literal not displayed */
	// contains filtered or unexported fields
}

ReleaseContext contains information about the current release.

func (*ReleaseContext) Descriptor deprecated

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

Deprecated: Use ReleaseContext.ProtoReflect.Descriptor instead.

func (*ReleaseContext) GetBranch

func (x *ReleaseContext) GetBranch() string

func (*ReleaseContext) GetChangelog

func (x *ReleaseContext) GetChangelog() string

func (*ReleaseContext) GetChanges

func (x *ReleaseContext) GetChanges() *CategorizedChanges

func (*ReleaseContext) GetCommitSha

func (x *ReleaseContext) GetCommitSha() string

func (*ReleaseContext) GetEnvironment

func (x *ReleaseContext) GetEnvironment() map[string]string

func (*ReleaseContext) GetPreviousVersion

func (x *ReleaseContext) GetPreviousVersion() string

func (*ReleaseContext) GetReleaseNotes

func (x *ReleaseContext) GetReleaseNotes() string

func (*ReleaseContext) GetReleaseType

func (x *ReleaseContext) GetReleaseType() string

func (*ReleaseContext) GetRepositoryName

func (x *ReleaseContext) GetRepositoryName() string

func (*ReleaseContext) GetRepositoryOwner

func (x *ReleaseContext) GetRepositoryOwner() string

func (*ReleaseContext) GetRepositoryUrl

func (x *ReleaseContext) GetRepositoryUrl() string

func (*ReleaseContext) GetTagName

func (x *ReleaseContext) GetTagName() string

func (*ReleaseContext) GetVersion

func (x *ReleaseContext) GetVersion() string

func (*ReleaseContext) ProtoMessage

func (*ReleaseContext) ProtoMessage()

func (*ReleaseContext) ProtoReflect

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

func (*ReleaseContext) Reset

func (x *ReleaseContext) Reset()

func (*ReleaseContext) String

func (x *ReleaseContext) String() string

type UnimplementedPluginServer

type UnimplementedPluginServer struct{}

UnimplementedPluginServer must be embedded to have forward compatible implementations.

NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.

func (UnimplementedPluginServer) Execute

func (UnimplementedPluginServer) GetInfo

func (UnimplementedPluginServer) Validate

type UnsafePluginServer

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

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

type ValidateRequest

type ValidateRequest struct {

	// config is the plugin configuration as JSON.
	Config string `protobuf:"bytes,1,opt,name=config,proto3" json:"config,omitempty"`
	// contains filtered or unexported fields
}

ValidateRequest is the request for validating plugin configuration.

func (*ValidateRequest) Descriptor deprecated

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

Deprecated: Use ValidateRequest.ProtoReflect.Descriptor instead.

func (*ValidateRequest) GetConfig

func (x *ValidateRequest) GetConfig() string

func (*ValidateRequest) ProtoMessage

func (*ValidateRequest) ProtoMessage()

func (*ValidateRequest) ProtoReflect

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

func (*ValidateRequest) Reset

func (x *ValidateRequest) Reset()

func (*ValidateRequest) String

func (x *ValidateRequest) String() string

type ValidateResponse

type ValidateResponse struct {

	// valid indicates if the configuration is valid.
	Valid bool `protobuf:"varint,1,opt,name=valid,proto3" json:"valid,omitempty"`
	// errors lists validation errors.
	Errors []*ValidationError `protobuf:"bytes,2,rep,name=errors,proto3" json:"errors,omitempty"`
	// contains filtered or unexported fields
}

ValidateResponse is the response from configuration validation.

func (*ValidateResponse) Descriptor deprecated

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

Deprecated: Use ValidateResponse.ProtoReflect.Descriptor instead.

func (*ValidateResponse) GetErrors

func (x *ValidateResponse) GetErrors() []*ValidationError

func (*ValidateResponse) GetValid

func (x *ValidateResponse) GetValid() bool

func (*ValidateResponse) ProtoMessage

func (*ValidateResponse) ProtoMessage()

func (*ValidateResponse) ProtoReflect

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

func (*ValidateResponse) Reset

func (x *ValidateResponse) Reset()

func (*ValidateResponse) String

func (x *ValidateResponse) String() string

type ValidationError

type ValidationError struct {

	// field is the field that failed validation.
	Field string `protobuf:"bytes,1,opt,name=field,proto3" json:"field,omitempty"`
	// message is the error message.
	Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
	// code is an optional error code.
	Code string `protobuf:"bytes,3,opt,name=code,proto3" json:"code,omitempty"`
	// contains filtered or unexported fields
}

ValidationError represents a configuration validation error.

func (*ValidationError) Descriptor deprecated

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

Deprecated: Use ValidationError.ProtoReflect.Descriptor instead.

func (*ValidationError) GetCode

func (x *ValidationError) GetCode() string

func (*ValidationError) GetField

func (x *ValidationError) GetField() string

func (*ValidationError) GetMessage

func (x *ValidationError) GetMessage() string

func (*ValidationError) ProtoMessage

func (*ValidationError) ProtoMessage()

func (*ValidationError) ProtoReflect

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

func (*ValidationError) Reset

func (x *ValidationError) Reset()

func (*ValidationError) String

func (x *ValidationError) String() string

Jump to

Keyboard shortcuts

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