introspect

Documentation

Index

• func FindProperties(r any) (map[string]FieldTag, error)
• func GetToken(pkg tokens.Package, i any) (tokens.Type, error)
• func StructToMap(i any) map[string]interface{}
• type Annotator
  • func NewAnnotator(resource any) Annotator
  • func (a *Annotator) Describe(i any, description string)
  • func (a *Annotator) SetDefault(i any, defaultValue any, env ...string)
• type ExplicitType
• type FieldMatcher
  • func NewFieldMatcher(i any) FieldMatcher
  • func (f *FieldMatcher) GetField(field any) (FieldTag, bool, error)
  • func (f *FieldMatcher) TargetStructFields(t any) ([]FieldTag, bool, error)
• type FieldTag
  • func ParseTag(field reflect.StructField) (FieldTag, error)
• type ToPropertiesOptions

Functions

func FindProperties

func FindProperties(r any) (map[string]FieldTag, error)

func GetToken

func GetToken(pkg tokens.Package, i any) (tokens.Type, error)

Get the token that represents a struct.

func StructToMap

func StructToMap(i any) map[string]interface{}

Types

type Annotator

type Annotator struct {
	Descriptions map[string]string
	Defaults     map[string]any
	DefaultEnvs  map[string][]string
	// contains filtered or unexported fields
}

Implements the Annotator interface as defined in resource/resource.go

func NewAnnotator

func NewAnnotator(resource any) Annotator

func (*Annotator) Describe

func (a *Annotator) Describe(i any, description string)

func (*Annotator) SetDefault

func (a *Annotator) SetDefault(i any, defaultValue any, env ...string)

Annotate a a struct field with a default value. The default value must be a primitive type in the pulumi type system.

type ExplicitType

type ExplicitType struct {
	Pkg     string
	Version string
	Module  string
	Name    string
}

An explicitly specified type ref token.

type FieldMatcher

type FieldMatcher struct {
	// contains filtered or unexported fields
}

func NewFieldMatcher

func NewFieldMatcher(i any) FieldMatcher

func (*FieldMatcher) GetField

func (f *FieldMatcher) GetField(field any) (FieldTag, bool, error)

func (*FieldMatcher) TargetStructFields

func (f *FieldMatcher) TargetStructFields(t any) ([]FieldTag, bool, error)

If `t` is the struct that the field matcher is based on, return all visible fields on the struct. Otherwise `nil, false, nil` is returned.

type FieldTag

type FieldTag struct {
	Name        string        // The name of the field in the Pulumi type system.
	Optional    bool          // If the field is optional in the Pulumi type system.
	Internal    bool          // If the field should exist in the Pulumi type system.
	Secret      bool          // If the field is secret.
	ExplicitRef *ExplicitType // The name and version of the external type consumed in the field.
	// NOTE: ReplaceOnChanges will only be obeyed when the default diff implementation is used.
	ReplaceOnChanges bool // If changes in the field should force a replacement.
}

func ParseTag

func ParseTag(field reflect.StructField) (FieldTag, error)

ParseTag gets tag information out of struct tags. It looks under the `pulumi` and `provider` tag namespaces.

type ToPropertiesOptions

type ToPropertiesOptions struct {
	ComputedKeys []string
}