cloudsqlpgupgradeprecheck

package
v1.8.0 Latest Latest
Warning

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

Go to latest
Published: Jul 28, 2026 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Config

type Config struct {
	tools.ConfigBase `yaml:",inline"`
	Type             string                 `yaml:"type" validate:"required"`
	Source           string                 `yaml:"source" validate:"required"`
	Annotations      *tools.ToolAnnotations `yaml:"annotations,omitempty"`
}

Config defines the configuration for the precheck-upgrade tool.

func (Config) Initialize

func (cfg Config) Initialize(context.Context) (tools.Tool, error)

Initialize initializes the tool from the configuration.

func (Config) ToolConfigType

func (cfg Config) ToolConfigType() string

ToolConfigType returns the type of the tool.

type PreCheckAPIResponse

type PreCheckAPIResponse struct {
	Items []PreCheckResultItem `json:"preCheckResponse"`
}

PreCheckAPIResponse holds the array of pre-check results.

type PreCheckResultItem

type PreCheckResultItem struct {
	Message         string   `json:"message"`
	MessageType     string   `json:"messageType"` // INFO, WARNING, ERROR
	ActionsRequired []string `json:"actionsRequired"`
}

PreCheckResultItem holds the details of a single check result.

type Tool

type Tool struct {
	tools.BaseTool[Config]
}

Tool represents the precheck-upgrade tool.

func (Tool) Authorized

func (t Tool) Authorized(verifiedAuthServices []string) bool

Authorized checks if the tool is authorized.

func (Tool) GetSourceName added in v1.8.0

func (t Tool) GetSourceName() string

func (Tool) Invoke

func (t Tool) Invoke(ctx context.Context, s sources.Source, params parameters.ParamValues, accessToken tools.AccessToken) (any, util.ToolboxError)

Invoke executes the tool's logic.

func (Tool) RequiresClientAuthorization

func (t Tool) RequiresClientAuthorization(source sources.Source) (bool, error)

func (Tool) ToConfig

func (t Tool) ToConfig() tools.ToolConfig

func (Tool) ValidateSource added in v1.8.0

func (t Tool) ValidateSource(source sources.Source) error

Jump to

Keyboard shortcuts

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