common

Documentation

Overview

hash.go This package contains shared / common hash functions

Index

• func Create[sdkPayloadType any, sdkResponseType any](ctx context.Context, d *schema.ResourceData, meta interface{}, ...) diag.Diagnostics
• func Delete(ctx context.Context, d *schema.ResourceData, meta interface{}, ...) diag.Diagnostics
• func HandleResourceNotFoundError(err error, d *schema.ResourceData, cleanup bool) diag.Diagnostics
• func HashString(s string) string
• func Read[sdkResponseType any](ctx context.Context, d *schema.ResourceData, meta interface{}, ...) diag.Diagnostics
• func SerializeAndRedactJSON(resource interface{}, redactFields []string) (string, error)
• func SerializeAndRedactXML(resource interface{}, redactFields []string) (string, error)
• func Update[sdkPayloadType any, sdkResponseType any](ctx context.Context, d *schema.ResourceData, meta interface{}, ...) diag.Diagnostics

Functions

func Create

func Create[sdkPayloadType any, sdkResponseType any](
	ctx context.Context,
	d *schema.ResourceData,
	meta interface{},
	construct payoadConstructorFunc[sdkPayloadType],
	serverOutcomeFunc sdkCreateUpdateFunc[sdkPayloadType, sdkResponseType],
	reader providerReadFunc,
) diag.Diagnostics

Create Update

func Delete

func Delete(ctx context.Context, d *schema.ResourceData, meta interface{}, serverOutcomeFunc sdkDeleteFunc) diag.Diagnostics

Delete

func HandleResourceNotFoundError

func HandleResourceNotFoundError(err error, d *schema.ResourceData, cleanup bool) diag.Diagnostics

HandleResourceNotFoundError is a helper function to handle 404 and 410 errors and remove the resource from Terraform state

func HashString

func HashString(s string) string

HashString calculates the SHA-256 hash of a string and returns it as a hexadecimal string.

func Read

func Read[sdkResponseType any](
	ctx context.Context,
	d *schema.ResourceData,
	meta interface{},
	removeDeleteResourcesFromState bool,
	serverOutcomeFunc sdkGetFunc[sdkResponseType],
	providerStateFunc providerStateFunc[sdkResponseType],
) diag.Diagnostics

Read

func SerializeAndRedactJSON

func SerializeAndRedactJSON(resource interface{}, redactFields []string) (string, error)

SerializeAndRedactJSON serializes a resource to JSON and redacts specified fields.

func SerializeAndRedactXML

func SerializeAndRedactXML(resource interface{}, redactFields []string) (string, error)

SerializeAndRedactXML serializes a resource to XML and redacts specified fields.

func Update

func Update[sdkPayloadType any, sdkResponseType any](
	ctx context.Context,
	d *schema.ResourceData,
	meta interface{},
	constructor payoadConstructorFunc[sdkPayloadType],
	outcomeFunc sdkUpdateFunc[sdkPayloadType, sdkResponseType],
	reader providerReadFunc,

) diag.Diagnostics