describe

Documentation

Index

• Constants
• func GetDevfile(devfileComponent catalog.DevfileComponentType) (parser.DevfileObj, error)
• func NewCmdCatalogDescribe(name, fullName string) *cobra.Command
• func NewCmdCatalogDescribeComponent(name, fullName string) *cobra.Command
• func NewCmdCatalogDescribeService(name, fullName string) *cobra.Command
• type DescribeComponentOptions
  • func NewDescribeComponentOptions() *DescribeComponentOptions
  • func (o *DescribeComponentOptions) Complete(name string, cmd *cobra.Command, args []string) (err error)
  • func (o *DescribeComponentOptions) GetDevfileComponentsByName(catalogDevfileList catalog.DevfileComponentTypeList)
  • func (o *DescribeComponentOptions) PrintDevfileStarterProjects(w *tabwriter.Writer, projects []common.DevfileStarterProject, ...) error
  • func (o *DescribeComponentOptions) Run() (err error)
  • func (o *DescribeComponentOptions) Validate() (err error)
• type DescribeServiceOptions
  • func NewDescribeServiceOptions() *DescribeServiceOptions
  • func (o *DescribeServiceOptions) Complete(name string, cmd *cobra.Command, args []string) (err error)
  • func (o *DescribeServiceOptions) Run() (err error)
  • func (o *DescribeServiceOptions) Validate() (err error)

Constants

const RecommendedCommandName = "describe"

RecommendedCommandName is the recommended command name

Functions

func GetDevfile

func GetDevfile(devfileComponent catalog.DevfileComponentType) (parser.DevfileObj, error)

GetDevfile downloads the devfile in memory and return the devfile object

func NewCmdCatalogDescribe

func NewCmdCatalogDescribe(name, fullName string) *cobra.Command

NewCmdCatalogDescribe implements the odo catalog describe command

func NewCmdCatalogDescribeComponent

func NewCmdCatalogDescribeComponent(name, fullName string) *cobra.Command

NewCmdCatalogDescribeComponent implements the odo catalog describe component command

func NewCmdCatalogDescribeService

func NewCmdCatalogDescribeService(name, fullName string) *cobra.Command

NewCmdCatalogDescribeService implements the odo catalog describe service command

Types

type DescribeComponentOptions

type DescribeComponentOptions struct {

	// generic context options common to all commands
	*genericclioptions.Context
	// contains filtered or unexported fields
}

DescribeComponentOptions encapsulates the options for the odo catalog describe component command

func NewDescribeComponentOptions

func NewDescribeComponentOptions() *DescribeComponentOptions

NewDescribeComponentOptions creates a new DescribeComponentOptions instance

func (*DescribeComponentOptions) Complete

func (o *DescribeComponentOptions) Complete(name string, cmd *cobra.Command, args []string) (err error)

Complete completes DescribeComponentOptions after they've been created

func (*DescribeComponentOptions) GetDevfileComponentsByName

func (o *DescribeComponentOptions) GetDevfileComponentsByName(catalogDevfileList catalog.DevfileComponentTypeList)

GetDevfileComponentsByName gets all the devfiles that have the same name as the specified components

func (*DescribeComponentOptions) PrintDevfileStarterProjects

func (o *DescribeComponentOptions) PrintDevfileStarterProjects(w *tabwriter.Writer, projects []common.DevfileStarterProject, devObj parser.DevfileObj) error

PrintDevfileStarterProjects prints all the starter projects in a devfile If no starter projects exists in the devfile, it prints the whole devfile

func (*DescribeComponentOptions) Run

func (o *DescribeComponentOptions) Run() (err error)

Run contains the logic for the command associated with DescribeComponentOptions

func (*DescribeComponentOptions) Validate

func (o *DescribeComponentOptions) Validate() (err error)

Validate validates the DescribeComponentOptions based on completed values

type DescribeServiceOptions

type DescribeServiceOptions struct {

	// generic context options common to all commands
	*genericclioptions.Context
	// contains filtered or unexported fields
}

DescribeServiceOptions encapsulates the options for the odo catalog describe service command

func NewDescribeServiceOptions

func NewDescribeServiceOptions() *DescribeServiceOptions

NewDescribeServiceOptions creates a new DescribeServiceOptions instance

func (*DescribeServiceOptions) Complete

func (o *DescribeServiceOptions) Complete(name string, cmd *cobra.Command, args []string) (err error)

Complete completes DescribeServiceOptions after they've been created

func (*DescribeServiceOptions) Run

func (o *DescribeServiceOptions) Run() (err error)

Run contains the logic for the command associated with DescribeServiceOptions

func (*DescribeServiceOptions) Validate

func (o *DescribeServiceOptions) Validate() (err error)

Validate validates the DescribeServiceOptions based on completed values