params

package
v0.12.0 Latest Latest
Warning

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

Go to latest
Published: May 5, 2026 License: Apache-2.0 Imports: 1 Imported by: 0

Documentation

Overview

Package params provide common tool parameter types.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Cluster

type Cluster struct {
	LocationRequired
	ClusterName string `json:"cluster_name" jsonschema:"Required. GKE cluster name."`
}

Cluster contains the location and GKE cluster name.

func (*Cluster) ClusterPath

func (c *Cluster) ClusterPath() string

ClusterPath returns the full GKE cluster resource path.

type LocationOptional

type LocationOptional struct {
	Project
	Location string `json:"location,omitempty" jsonschema:"Optional. GCP region or zone."`
}

LocationOptional contains the project and an optional GKE cluster location.

func (*LocationOptional) LocationPath

func (l *LocationOptional) LocationPath() string

LocationPath returns the GKE location resource path, using "-" for all locations if empty.

type LocationRequired

type LocationRequired struct {
	Project
	Location string `json:"location" jsonschema:"Required to be a valid GCP region or zone. MUST NOT be empty."`
}

LocationRequired contains the project and GKE cluster location.

func (*LocationRequired) LocationPath

func (l *LocationRequired) LocationPath() string

LocationPath returns the GKE location resource path.

type NodePool

type NodePool struct {
	Cluster
	NodePoolName string `json:"node_pool_name" jsonschema:"Required. GKE node pool name."`
}

NodePool represents GKE node pool parameters.

func (*NodePool) NodePoolPath

func (n *NodePool) NodePoolPath() string

NodePoolPath returns the full resource path for the node pool.

type Project

type Project struct {
	ProjectID string `json:"project_id" jsonschema:"Required. GCP project ID."`
}

Project contains the GCP project ID.

func (*Project) ProjectIDPath

func (p *Project) ProjectIDPath() string

ProjectIDPath returns the GCP project resource path.

Jump to

Keyboard shortcuts

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