helpers

Documentation

Index

• func Contains(s []string, str string) bool
• func DifferenceStringSet(ctx context.Context, a basetypes.SetValue, b basetypes.SetValue) basetypes.SetValue
• func GetInt64List(result []gjson.Result) types.List
• func GetInt64Set(result []gjson.Result) types.Set
• func GetStringList(result []gjson.Result) types.List
• func GetStringSet(result []gjson.Result) types.Set
• func IsConfigUpdatingAt(ctx context.Context, tfsdkPlan tfsdk.Plan, tfsdkState tfsdk.State, ...) (bool, diag.Diagnostics)
• func IsFlagImporting(ctx context.Context, req resource.ReadRequest) (bool, diag.Diagnostics)
• func SetFlagImporting(ctx context.Context, importing bool, sk SetKeyer, respDiags *diag.Diagnostics)
• func SetGjson(orig gjson.Result, path string, content gjson.Result) gjson.Result
• func ToLower(s basetypes.StringValue) basetypes.StringValue
• type AttributeDescription
  • func NewAttributeDescription(s string) *AttributeDescription
  • func (d *AttributeDescription) AddDefaultValueDescription(defaultValue string) *AttributeDescription
  • func (d *AttributeDescription) AddFloatRangeDescription(min, max float64) *AttributeDescription
  • func (d *AttributeDescription) AddIntegerRangeDescription(min, max int64) *AttributeDescription
  • func (d *AttributeDescription) AddMinimumVersionDescription(minimumVersion string) *AttributeDescription
  • func (d *AttributeDescription) AddStringEnumDescription(values ...string) *AttributeDescription
• type SetKeyer

Functions

func Contains

func Contains(s []string, str string) bool

func DifferenceStringSet

func DifferenceStringSet(ctx context.Context, a basetypes.SetValue, b basetypes.SetValue) basetypes.SetValue

DifferenceStringSet returns the elements that are present in `b`, but not in `a`.

func GetInt64List

func GetInt64List(result []gjson.Result) types.List

func GetInt64Set

func GetInt64Set(result []gjson.Result) types.Set

func GetStringList

func GetStringList(result []gjson.Result) types.List

func GetStringSet

func GetStringSet(result []gjson.Result) types.Set

func IsConfigUpdatingAt

func IsConfigUpdatingAt(ctx context.Context, tfsdkPlan tfsdk.Plan, tfsdkState tfsdk.State, where path.Path) (bool, diag.Diagnostics)

IsConfigUpdatingAt checks whether the attribute given by the Path is not Equal() between plan and state.

func IsFlagImporting

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

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.

func SetGjson

func SetGjson(orig gjson.Result, path string, content gjson.Result) gjson.Result

SetGjson conveniently wraps sjson.SetRaw, so that it acts on gjson.Result directly.

func ToLower

func ToLower(s basetypes.StringValue) basetypes.StringValue

ToLower is the same as strings.ToLower, except it cares to not to convert null/unknown strings into empty strings.

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) AddFloatRangeDescription

func (d *AttributeDescription) AddFloatRangeDescription(min, max float64) *AttributeDescription

func (*AttributeDescription) AddIntegerRangeDescription

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

func (*AttributeDescription) AddMinimumVersionDescription

func (d *AttributeDescription) AddMinimumVersionDescription(minimumVersion string) *AttributeDescription

func (*AttributeDescription) AddStringEnumDescription

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

type SetKeyer

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

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