Documentation
¶
Overview ¶
Package statepb contains code generated from proto/pipeline.proto, for Librarian state and config files. This package is likely to be deleted as part of https://github.com/googleapis/librarian/issues/326. No handwritten code should be added to this package.
Index ¶
- Variables
- type AutomationLevel
- func (AutomationLevel) Descriptor() protoreflect.EnumDescriptor
- func (x AutomationLevel) Enum() *AutomationLevel
- func (AutomationLevel) EnumDescriptor() ([]byte, []int)deprecated
- func (x AutomationLevel) Number() protoreflect.EnumNumber
- func (x AutomationLevel) String() string
- func (AutomationLevel) Type() protoreflect.EnumType
- type CommandConfig
- func (*CommandConfig) Descriptor() ([]byte, []int)deprecated
- func (x *CommandConfig) GetEnvironmentVariables() []*CommandEnvironmentVariable
- func (*CommandConfig) ProtoMessage()
- func (x *CommandConfig) ProtoReflect() protoreflect.Message
- func (x *CommandConfig) Reset()
- func (x *CommandConfig) String() string
- type CommandEnvironmentVariable
- func (*CommandEnvironmentVariable) Descriptor() ([]byte, []int)deprecated
- func (x *CommandEnvironmentVariable) GetDefaultValue() string
- func (x *CommandEnvironmentVariable) GetName() string
- func (x *CommandEnvironmentVariable) GetSecretName() string
- func (*CommandEnvironmentVariable) ProtoMessage()
- func (x *CommandEnvironmentVariable) ProtoReflect() protoreflect.Message
- func (x *CommandEnvironmentVariable) Reset()
- func (x *CommandEnvironmentVariable) String() string
- type LibraryState
- func (*LibraryState) Descriptor() ([]byte, []int)deprecated
- func (x *LibraryState) GetApiPaths() []string
- func (x *LibraryState) GetCurrentVersion() string
- func (x *LibraryState) GetGenerationAutomationLevel() AutomationLevel
- func (x *LibraryState) GetId() string
- func (x *LibraryState) GetLastGeneratedCommit() string
- func (x *LibraryState) GetLastReleasedCommit() string
- func (x *LibraryState) GetNextVersion() string
- func (x *LibraryState) GetReleaseAutomationLevel() AutomationLevel
- func (x *LibraryState) GetReleaseTimestamp() *timestamppb.Timestamp
- func (x *LibraryState) GetSourcePaths() []string
- func (*LibraryState) ProtoMessage()
- func (x *LibraryState) ProtoReflect() protoreflect.Message
- func (x *LibraryState) Reset()
- func (x *LibraryState) String() string
- type PipelineConfig
- func (*PipelineConfig) Descriptor() ([]byte, []int)deprecated
- func (x *PipelineConfig) GetCommands() map[string]*CommandConfig
- func (x *PipelineConfig) GetImageName() string
- func (x *PipelineConfig) GetMaxPullRequestCommits() int32
- func (*PipelineConfig) ProtoMessage()
- func (x *PipelineConfig) ProtoReflect() protoreflect.Message
- func (x *PipelineConfig) Reset()
- func (x *PipelineConfig) String() string
- type PipelineState
- func (*PipelineState) Descriptor() ([]byte, []int)deprecated
- func (x *PipelineState) GetCommonLibrarySourcePaths() []string
- func (x *PipelineState) GetIgnoredApiPaths() []string
- func (x *PipelineState) GetImageTag() string
- func (x *PipelineState) GetLibraries() []*LibraryState
- func (*PipelineState) ProtoMessage()
- func (x *PipelineState) ProtoReflect() protoreflect.Message
- func (x *PipelineState) Reset()
- func (x *PipelineState) String() string
Constants ¶
This section is empty.
Variables ¶
var ( AutomationLevel_name = map[int32]string{ 0: "AUTOMATION_LEVEL_NONE", 1: "AUTOMATION_LEVEL_BLOCKED", 2: "AUTOMATION_LEVEL_MANUAL_REVIEW", 3: "AUTOMATION_LEVEL_AUTOMATIC", } AutomationLevel_value = map[string]int32{ "AUTOMATION_LEVEL_NONE": 0, "AUTOMATION_LEVEL_BLOCKED": 1, "AUTOMATION_LEVEL_MANUAL_REVIEW": 2, "AUTOMATION_LEVEL_AUTOMATIC": 3, } )
Enum value maps for AutomationLevel.
var File_pipeline_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type AutomationLevel ¶
type AutomationLevel int32
The degree of automation to use when generating/releasing.
const ( // Not used. AutomationLevel_AUTOMATION_LEVEL_NONE AutomationLevel = 0 // Automation is blocked: this API/library should be skipped AutomationLevel_AUTOMATION_LEVEL_BLOCKED AutomationLevel = 1 // Automation can generate changes/releases, // but they need to be reviewed. AutomationLevel_AUTOMATION_LEVEL_MANUAL_REVIEW AutomationLevel = 2 // Automation can generated changes/releases which can // proceed without further review if all tests pass. AutomationLevel_AUTOMATION_LEVEL_AUTOMATIC AutomationLevel = 3 )
func (AutomationLevel) Descriptor ¶
func (AutomationLevel) Descriptor() protoreflect.EnumDescriptor
func (AutomationLevel) Enum ¶
func (x AutomationLevel) Enum() *AutomationLevel
func (AutomationLevel) EnumDescriptor
deprecated
func (AutomationLevel) EnumDescriptor() ([]byte, []int)
Deprecated: Use AutomationLevel.Descriptor instead.
func (AutomationLevel) Number ¶
func (x AutomationLevel) Number() protoreflect.EnumNumber
func (AutomationLevel) String ¶
func (x AutomationLevel) String() string
func (AutomationLevel) Type ¶
func (AutomationLevel) Type() protoreflect.EnumType
type CommandConfig ¶
type CommandConfig struct {
// The environment variables to populate for this command.
EnvironmentVariables []*CommandEnvironmentVariable `protobuf:"bytes,1,rep,name=environment_variables,json=environmentVariables,proto3" json:"environment_variables,omitempty"`
// contains filtered or unexported fields
}
Configuration for a specific container command.
func (*CommandConfig) Descriptor
deprecated
func (*CommandConfig) Descriptor() ([]byte, []int)
Deprecated: Use CommandConfig.ProtoReflect.Descriptor instead.
func (*CommandConfig) GetEnvironmentVariables ¶
func (x *CommandConfig) GetEnvironmentVariables() []*CommandEnvironmentVariable
func (*CommandConfig) ProtoMessage ¶
func (*CommandConfig) ProtoMessage()
func (*CommandConfig) ProtoReflect ¶
func (x *CommandConfig) ProtoReflect() protoreflect.Message
func (*CommandConfig) Reset ¶
func (x *CommandConfig) Reset()
func (*CommandConfig) String ¶
func (x *CommandConfig) String() string
type CommandEnvironmentVariable ¶
type CommandEnvironmentVariable struct {
// The name of the environment variable (e.g. TEST_PROJECT).
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// The name of the secret to be used to fetch the value of the environment
// variable when it's not present in the host system. If this is not specified,
// or if a Secret Manager project has not been provided to Librarian,
// Secret Manager will not be used as a source for the environment variable.
SecretName string `protobuf:"bytes,2,opt,name=secret_name,json=secretName,proto3" json:"secret_name,omitempty"`
// The default value to specify if no other source is found for the environment
// variable. If this is not provided and no other source is found, the environment
// variable will not be passed to the container at all.
DefaultValue string `protobuf:"bytes,3,opt,name=default_value,json=defaultValue,proto3" json:"default_value,omitempty"`
// contains filtered or unexported fields
}
An environment variable to be provided to a container command.
func (*CommandEnvironmentVariable) Descriptor
deprecated
func (*CommandEnvironmentVariable) Descriptor() ([]byte, []int)
Deprecated: Use CommandEnvironmentVariable.ProtoReflect.Descriptor instead.
func (*CommandEnvironmentVariable) GetDefaultValue ¶
func (x *CommandEnvironmentVariable) GetDefaultValue() string
func (*CommandEnvironmentVariable) GetName ¶
func (x *CommandEnvironmentVariable) GetName() string
func (*CommandEnvironmentVariable) GetSecretName ¶
func (x *CommandEnvironmentVariable) GetSecretName() string
func (*CommandEnvironmentVariable) ProtoMessage ¶
func (*CommandEnvironmentVariable) ProtoMessage()
func (*CommandEnvironmentVariable) ProtoReflect ¶
func (x *CommandEnvironmentVariable) ProtoReflect() protoreflect.Message
func (*CommandEnvironmentVariable) Reset ¶
func (x *CommandEnvironmentVariable) Reset()
func (*CommandEnvironmentVariable) String ¶
func (x *CommandEnvironmentVariable) String() string
type LibraryState ¶
type LibraryState struct {
// The library identifier (language-specific format)
Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
// The last version that was released, if any.
CurrentVersion string `protobuf:"bytes,2,opt,name=current_version,json=currentVersion,proto3" json:"current_version,omitempty"`
// The next version to release (to force a specific version number).
// This should usually be unset.
NextVersion string `protobuf:"bytes,3,opt,name=next_version,json=nextVersion,proto3" json:"next_version,omitempty"`
// The automation level for generation for this library.
GenerationAutomationLevel AutomationLevel `` /* 186-byte string literal not displayed */
// The automation level for releases for this library.
ReleaseAutomationLevel AutomationLevel `` /* 177-byte string literal not displayed */
// The timestamp of the latest release. (This is typically
// some timestamp within the process of generating the release
// PR for the library. Importantly, it's not just a date as
// there may be reasons to release a library multiple times
// within a day.) This is unset if the library has not yet been
// released.
ReleaseTimestamp *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=release_timestamp,json=releaseTimestamp,proto3" json:"release_timestamp,omitempty"`
// The commit hash (within the API definition repo) at which
// the library was last generated. This is empty if the library
// has not yet been generated.
LastGeneratedCommit string `protobuf:"bytes,7,opt,name=last_generated_commit,json=lastGeneratedCommit,proto3" json:"last_generated_commit,omitempty"`
// The last-generated commit hash (within the API definition repo)
// at the point of the last/in-progress release. (This is taken
// from the generation state at the time of the release.) This
// is empty if the library has not yet been released.
LastReleasedCommit string `protobuf:"bytes,8,opt,name=last_released_commit,json=lastReleasedCommit,proto3" json:"last_released_commit,omitempty"`
// The API paths included in this library, relative to the root
// of the API definition repo, e.g. "google/cloud/functions/v2".
ApiPaths []string `protobuf:"bytes,9,rep,name=api_paths,json=apiPaths,proto3" json:"api_paths,omitempty"`
// Paths to files or directories contributing to this library.
SourcePaths []string `protobuf:"bytes,10,rep,name=source_paths,json=sourcePaths,proto3" json:"source_paths,omitempty"`
// contains filtered or unexported fields
}
Generation state of a single library.
func (*LibraryState) Descriptor
deprecated
func (*LibraryState) Descriptor() ([]byte, []int)
Deprecated: Use LibraryState.ProtoReflect.Descriptor instead.
func (*LibraryState) GetApiPaths ¶
func (x *LibraryState) GetApiPaths() []string
func (*LibraryState) GetCurrentVersion ¶
func (x *LibraryState) GetCurrentVersion() string
func (*LibraryState) GetGenerationAutomationLevel ¶
func (x *LibraryState) GetGenerationAutomationLevel() AutomationLevel
func (*LibraryState) GetId ¶
func (x *LibraryState) GetId() string
func (*LibraryState) GetLastGeneratedCommit ¶
func (x *LibraryState) GetLastGeneratedCommit() string
func (*LibraryState) GetLastReleasedCommit ¶
func (x *LibraryState) GetLastReleasedCommit() string
func (*LibraryState) GetNextVersion ¶
func (x *LibraryState) GetNextVersion() string
func (*LibraryState) GetReleaseAutomationLevel ¶
func (x *LibraryState) GetReleaseAutomationLevel() AutomationLevel
func (*LibraryState) GetReleaseTimestamp ¶
func (x *LibraryState) GetReleaseTimestamp() *timestamppb.Timestamp
func (*LibraryState) GetSourcePaths ¶
func (x *LibraryState) GetSourcePaths() []string
func (*LibraryState) ProtoMessage ¶
func (*LibraryState) ProtoMessage()
func (*LibraryState) ProtoReflect ¶
func (x *LibraryState) ProtoReflect() protoreflect.Message
func (*LibraryState) Reset ¶
func (x *LibraryState) Reset()
func (*LibraryState) String ¶
func (x *LibraryState) String() string
type PipelineConfig ¶
type PipelineConfig struct {
// The name of the image to use, where the convention is not
// appropriate. The tag is specified in PipelineState.
ImageName string `protobuf:"bytes,1,opt,name=image_name,json=imageName,proto3" json:"image_name,omitempty"`
// Specific configuration for each individual command.
Commands map[string]*CommandConfig `` /* 143-byte string literal not displayed */
// The maximum number (inclusive) of commits to create
// in a single pull request. If this is non-positive, it is
// ignored. If a process would generate a pull request with more
// commits than this, excess commits are trimmed and the commits
// which *would* have been present are described in the PR.
MaxPullRequestCommits int32 `` /* 129-byte string literal not displayed */
// contains filtered or unexported fields
}
Manually-maintained configuration for the pipeline.
func (*PipelineConfig) Descriptor
deprecated
func (*PipelineConfig) Descriptor() ([]byte, []int)
Deprecated: Use PipelineConfig.ProtoReflect.Descriptor instead.
func (*PipelineConfig) GetCommands ¶
func (x *PipelineConfig) GetCommands() map[string]*CommandConfig
func (*PipelineConfig) GetImageName ¶
func (x *PipelineConfig) GetImageName() string
func (*PipelineConfig) GetMaxPullRequestCommits ¶
func (x *PipelineConfig) GetMaxPullRequestCommits() int32
func (*PipelineConfig) ProtoMessage ¶
func (*PipelineConfig) ProtoMessage()
func (*PipelineConfig) ProtoReflect ¶
func (x *PipelineConfig) ProtoReflect() protoreflect.Message
func (*PipelineConfig) Reset ¶
func (x *PipelineConfig) Reset()
func (*PipelineConfig) String ¶
func (x *PipelineConfig) String() string
type PipelineState ¶
type PipelineState struct {
// The image tag that the CLI should use when invoking the
// language-specific tooling. The image name is assumed by convention, or
// overridden in PipelineConfig.
ImageTag string `protobuf:"bytes,1,opt,name=image_tag,json=imageTag,proto3" json:"image_tag,omitempty"`
// The state of each library which is released within this repository.
Libraries []*LibraryState `protobuf:"bytes,3,rep,name=libraries,proto3" json:"libraries,omitempty"`
// Paths to files/directories which can trigger
// a release in all libraries.
CommonLibrarySourcePaths []string `` /* 137-byte string literal not displayed */
// API paths which are deliberately not configured. (Ideally this would
// be empty for all languages, but there may be temporary reasons not to configure
// an API.)
IgnoredApiPaths []string `protobuf:"bytes,5,rep,name=ignored_api_paths,json=ignoredApiPaths,proto3" json:"ignored_api_paths,omitempty"`
// contains filtered or unexported fields
}
Overall state of the generation and release pipeline. This is expected to be stored in each language repo as generator-input/pipeline-state.json.
func (*PipelineState) Descriptor
deprecated
func (*PipelineState) Descriptor() ([]byte, []int)
Deprecated: Use PipelineState.ProtoReflect.Descriptor instead.
func (*PipelineState) GetCommonLibrarySourcePaths ¶
func (x *PipelineState) GetCommonLibrarySourcePaths() []string
func (*PipelineState) GetIgnoredApiPaths ¶
func (x *PipelineState) GetIgnoredApiPaths() []string
func (*PipelineState) GetImageTag ¶
func (x *PipelineState) GetImageTag() string
func (*PipelineState) GetLibraries ¶
func (x *PipelineState) GetLibraries() []*LibraryState
func (*PipelineState) ProtoMessage ¶
func (*PipelineState) ProtoMessage()
func (*PipelineState) ProtoReflect ¶
func (x *PipelineState) ProtoReflect() protoreflect.Message
func (*PipelineState) Reset ¶
func (x *PipelineState) Reset()
func (*PipelineState) String ¶
func (x *PipelineState) String() string