generate

Documentation

Index

• Variables
• type Generator
  • func New(SDKAPI *ackmodel.SDKAPI, apiVersion string, configPath string, ...) (*Generator, error)
  • func (g *Generator) ApplyShapeIgnoreRules()
  • func (g *Generator) GetCRDs() ([]*ackmodel.CRD, error)
  • func (g *Generator) GetEnumDefs() ([]*ackmodel.EnumDef, error)
  • func (g *Generator) GetTypeDefs() ([]*ackmodel.TypeDef, map[string]string, error)
  • func (g *Generator) IsShapeUsedInCRDs(shapeName string) bool
  • func (g *Generator) MetaVars() templateset.MetaVars
  • func (g *Generator) RemoveIgnoredOperations(ops *ackmodel.Ops)

Variables

var (
	// ErrNilShapePointer indicates an unexpected nil Shape pointer
	ErrNilShapePointer = errors.New("found nil Shape pointer")
)

Types

type Generator

type Generator struct {
	SDKAPI *ackmodel.SDKAPI
	// contains filtered or unexported fields
}

Generator contains the ACK model for the generator to process and apply templates against

func New

func New(
	SDKAPI *ackmodel.SDKAPI,
	apiVersion string,
	configPath string,
	defaultConfig ackgenconfig.Config,
) (*Generator, error)

New returns a new Generator struct for a supplied API model. Optionally, pass a file path to a generator config file that can be used to instruct the code generator how to handle the API properly

func (*Generator) ApplyShapeIgnoreRules

func (g *Generator) ApplyShapeIgnoreRules()

ApplyShapeIgnoreRules removes the ignored shapes and fields from the API object so that they are not considered in any of the calculations of code generator.

func (*Generator) GetCRDs

func (g *Generator) GetCRDs() ([]*ackmodel.CRD, error)

GetCRDs returns a slice of `ackmodel.CRD` structs that describe the top-level resources discovered by the code generator for an AWS service API

func (*Generator) GetEnumDefs

func (g *Generator) GetEnumDefs() ([]*ackmodel.EnumDef, error)

GetEnumDefs returns a slice of pointers to `ackmodel.EnumDef` structs which represent string fields whose value is constrained to one or more specific string values.

func (*Generator) GetTypeDefs

func (g *Generator) GetTypeDefs() ([]*ackmodel.TypeDef, map[string]string, error)

GetTypeDefs returns a slice of `ackmodel.TypeDef` pointers and a map of package import information

func (*Generator) IsShapeUsedInCRDs

func (g *Generator) IsShapeUsedInCRDs(shapeName string) bool

IsShapeUsedInCRDs returns true if the supplied shape name is a member of amy CRD's payloads or those payloads sub-member shapes

func (*Generator) MetaVars

func (g *Generator) MetaVars() templateset.MetaVars

MetaVars returns a MetaVars struct populated with metadata about the AWS service API

func (*Generator) RemoveIgnoredOperations

func (g *Generator) RemoveIgnoredOperations(ops *ackmodel.Ops)

RemoveIgnoredOperations updates Ops argument by setting those operations to nil that are configured to be ignored in generator config for the AWS service