helpers

Documentation

Index

• func IsFlagImporting(ctx context.Context, req resource.ReadRequest) (bool, diag.Diagnostics)
• func ParseNxosBoolean(s string) bool
• func SetFlagImporting(ctx context.Context, importing bool, sk SetKeyer, respDiags *diag.Diagnostics)
• type AttributeDescription
  • func NewAttributeDescription(s string) *AttributeDescription
  • func (d *AttributeDescription) AddDefaultValueDescription(defaultValue string) *AttributeDescription
  • func (d *AttributeDescription) AddIntegerRangeDescription(min, max int64) *AttributeDescription
  • func (d *AttributeDescription) AddStringEnumDescription(values ...string) *AttributeDescription
• type ResourceDescription
  • func NewResourceDescription(description, className, docPath string) *ResourceDescription
  • func (d *ResourceDescription) AddChildren(values ...string) *ResourceDescription
  • func (d *ResourceDescription) AddParents(values ...string) *ResourceDescription
  • func (d *ResourceDescription) AddReferences(values ...string) *ResourceDescription
• type SetKeyer

Functions

func IsFlagImporting

func IsFlagImporting(ctx context.Context, req resource.ReadRequest) (bool, diag.Diagnostics)

func ParseNxosBoolean

func ParseNxosBoolean(s string) bool

func SetFlagImporting

func SetFlagImporting(ctx context.Context, importing bool, sk SetKeyer, respDiags *diag.Diagnostics)

SetFlagImporting checks the respDiags and if they are error-free it sets the `importing` as a private flag inside SetKeyer. It appends its own results to respDiags.

The caller must include in respDiags the result of state modification in the first place, to ensure consistency. The SetKeyer is something like resp.Private.

Types

type AttributeDescription

type AttributeDescription struct {
	String string
}

func NewAttributeDescription

func NewAttributeDescription(s string) *AttributeDescription

func (*AttributeDescription) AddDefaultValueDescription

func (d *AttributeDescription) AddDefaultValueDescription(defaultValue string) *AttributeDescription

func (*AttributeDescription) AddIntegerRangeDescription

func (d *AttributeDescription) AddIntegerRangeDescription(min, max int64) *AttributeDescription

func (*AttributeDescription) AddStringEnumDescription

func (d *AttributeDescription) AddStringEnumDescription(values ...string) *AttributeDescription

type ResourceDescription

type ResourceDescription struct {
	String string
}

func NewResourceDescription

func NewResourceDescription(description, className, docPath string) *ResourceDescription

func (*ResourceDescription) AddChildren

func (d *ResourceDescription) AddChildren(values ...string) *ResourceDescription

func (*ResourceDescription) AddParents

func (d *ResourceDescription) AddParents(values ...string) *ResourceDescription

func (*ResourceDescription) AddReferences

func (d *ResourceDescription) AddReferences(values ...string) *ResourceDescription

type SetKeyer

type SetKeyer interface {
	SetKey(ctx context.Context, key string, value []byte) diag.Diagnostics
}

SetKeyer is something like ReadResponse.Private or ImportStateResponse.Private.