cloudsqlpgupgradeprecheck

package
v0.24.0 Latest Latest
Warning

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

Go to latest
Published: Dec 19, 2025 License: Apache-2.0 Imports: 9 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 {
	Name         string   `yaml:"name" validate:"required"`
	Kind         string   `yaml:"kind" validate:"required"`
	Description  string   `yaml:"description"`
	Source       string   `yaml:"source" validate:"required"`
	AuthRequired []string `yaml:"authRequired"`
}

Config defines the configuration for the precheck-upgrade tool.

func (Config) Initialize

func (cfg Config) Initialize(srcs map[string]sources.Source) (tools.Tool, error)

Initialize initializes the tool from the configuration.

func (Config) ToolConfigKind

func (cfg Config) ToolConfigKind() string

ToolConfigKind returns the kind 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 {
	Name         string   `yaml:"name"`
	Kind         string   `yaml:"kind"`
	Description  string   `yaml:"description"`
	AuthRequired []string `yaml:"authRequired"`

	Source    *cloudsqladmin.Source
	AllParams parameters.Parameters `yaml:"allParams"`

	Config
	// contains filtered or unexported fields
}

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) GetAuthTokenHeaderName

func (t Tool) GetAuthTokenHeaderName() string

func (Tool) Invoke

func (t Tool) Invoke(ctx context.Context, resourceMgr tools.SourceProvider, params parameters.ParamValues, accessToken tools.AccessToken) (any, error)

Invoke executes the tool's logic.

func (Tool) Manifest

func (t Tool) Manifest() tools.Manifest

Manifest returns the tool's manifest.

func (Tool) McpManifest

func (t Tool) McpManifest() tools.McpManifest

McpManifest returns the tool's MCP manifest.

func (Tool) ParseParams

func (t Tool) ParseParams(data map[string]any, claims map[string]map[string]any) (parameters.ParamValues, error)

ParseParams parses the parameters for the tool.

func (Tool) RequiresClientAuthorization

func (t Tool) RequiresClientAuthorization(resourceMgr tools.SourceProvider) bool

func (Tool) ToConfig

func (t Tool) ToConfig() tools.ToolConfig

Jump to

Keyboard shortcuts

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