gcloud

type CLIModel struct {
	// ModulePath is the Go module path used to construct the import path
	// of each surface package, e.g. "cloud.google.com/go/gcloud" yields
	// imports like "cloud.google.com/go/gcloud/internal/generated/parallelstore".
	ModulePath string

	// Surfaces lists every surface registered under the gcloud root
	// command, in the order they should appear in the Commands slice.
	Surfaces []SurfaceRef
}

type ClientCall struct {
	// IsDelete reports whether the method is a standard Delete method.
	IsDelete bool

	// IsLRO reports whether the call returns a long-running operation.
	IsLRO bool

	// Method is the unqualified client method to call on the constructed
	// client, for example "GetInstance". The template invokes it as
	// `client.<Method>(ctx, &<RequestType>{...})`.
	Method string

	// NameField is the field on the request message that takes the
	// composed resource path, for example "Name" for AIP-131 Get requests.
	// The template assigns it from the local path variable.
	NameField string

	// Package is the import alias of the Go client package, for example
	// "parallelstore". The template invokes the constructor as
	// `client, err := <Package>.NewClient(ctx)`.
	Package string

	// Paged reports whether the method returns a paginated iterator (e.g.,
	// AIP-132 List).
	Paged bool

	// RequestType is the qualified request message type, for example
	// "parallelstorepb.GetInstanceRequest". The template composites a
	// literal of this type and passes its address to the method.
	RequestType string
}

type Command struct {
	Args       []string
	ClientCall *ClientCall
	Flags      []Flag
	Name       string
	PathFormat string
	PathLabel  string
	Usage      string
}

type Flag struct {
	// Name is the long flag name without leading dashes (e.g. "project").
	Name string

	// Kind is the urfave/cli flag type (e.g. "String", "Bool").
	Kind string

	// Required reports whether the flag must be set on the command line.
	Required bool

	// Usage is the help text shown next to the flag.
	//
	// TODO(https://github.com/googleapis/librarian/issues/5769):
	// Usage is currently a generic "The <name>." string. Source it from
	// the proto field's documentation when we wire that through.
	Usage string
}

type Group struct {
	Name      string
	Usage     string
	Subgroups []Subgroup
	Commands  []Command
}

type Import struct {
	// Alias is the optional package alias; empty when the import has no
	// alias. For example, "parallelstore" in:
	//
	//	parallelstore "cloud.google.com/go/parallelstore/apiv1"
	Alias string

	// Path is the import path of the package, for example
	// "cloud.google.com/go/parallelstore/apiv1".
	Path string
}

type Subgroup struct {
	Name     string
	Usage    string
	Commands []Command
}

type SurfaceModel struct {
	// PackageName is the Go package name and the directory under
	// internal/generated/.
	PackageName string

	// Imports holds the Go imports rendered into the surface's
	// commands.go, typically the GAPIC client and proto-Go packages used
	// by ClientCall actions. It is empty when no command in the surface
	// has a ClientCall.
	Imports []Import

	// Group is the surface's command tree: the root command for the
	// surface, with its subgroups and commands beneath.
	Group Group
}

type SurfaceRef struct {
	// PackageName is both the Go package name and the directory under
	// internal/generated/, e.g. "parallelstore".
	PackageName string
}