instance

package
v0.51.0 Latest Latest
Warning

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

Go to latest
Published: Jan 14, 2026 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

View Source
const (
	DisplayNameFlag = "name"        // > displayNameMinimumChars <= displayNameMaximumChars characters + regex displayNameRegex
	DescriptionFlag = "description" // <= descriptionMaxLength characters
	PlanIdFlag      = "plan-id"     // UUID
	InstanceIdFlag  = "id"          // instance id (unique per project)
)

User input flags for instance commands

View Source
const (
	DisplayNameUsage = "The displayed name to distinguish multiple instances."
	DescriptionUsage = "A user chosen description to distinguish multiple instances."
	PlanIdUsage      = "Service Plan configures the size of the Instance."
	InstanceIdUsage  = "The project-unique identifier of this instance."
)

Flag usage texts

View Source
const (
	DisplayNameShorthand = "n"
	DescriptionShorthand = "d"
	InstanceIdShorthand  = "i"
)

Flag shorthands

Variables

This section is empty.

Functions

func ValidateDescription

func ValidateDescription(description string) error

func ValidateDisplayName

func ValidateDisplayName(displayName *string) error

func ValidateInstanceId

func ValidateInstanceId(instanceId *string) error

func ValidatePlanId

func ValidatePlanId(planId *string) error

Types

type RequestModel

type RequestModel struct {
	Value any
}

OpenApi generated code will have different types for by-instance-id and by-display-name API calls, which are currently impl. as separate endpoints. To make the code more flexible, we use a struct to hold the request model.

Jump to

Keyboard shortcuts

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