helper

func BoolPointerFromValue ¶

func BoolPointerFromValue(v types.Bool) *bool

BoolPointerFromValue converts a types.Bool back to *bool.

func BoolValueOrNull ¶

func BoolValueOrNull(p *bool) types.Bool

BoolValueOrNull converts a *bool to types.Bool.

func Int64PointerFromValue ¶

func Int64PointerFromValue(v types.Int64) *int64

Int64PointerFromValue converts a types.Int64 back to *int64.

func Int64ValueFromUint ¶

func Int64ValueFromUint(p *uint64) types.Int64

Int64ValueFromUint safely converts the *uint64 fields commonly seen in the TencentCloud SDK to types.Int64.

Note: when the source value exceeds math.MaxInt64 the conversion loses precision; however, business fields in TencentCloud (page size, quota, capacity, etc.) are not expected to surpass that ceiling for the foreseeable future, so this helper does not perform an overflow check. Callers must judge for themselves.

func Int64ValueOrNull ¶

func Int64ValueOrNull(p *int64) types.Int64

Int64ValueOrNull converts an *int64 to types.Int64. Unlike the SDKv2 world, in framework a 0 is often a legal value, so this helper only performs nil handling at the pointer level.

func IsSDKErrorCode ¶

func IsSDKErrorCode(err error, codes ...string) bool

IsSDKErrorCode is the standard retryable predicate template: it returns true when err is a SDK error and its Code is contained in codes. A resource can use it inside RetryFramework like this:

helper.RetryFramework(ctx, timeout,
    func(err error) bool {
        return helper.IsSDKErrorCode(err,
            "InternalError", "ResourceInUse", "FailedOperation")
    },
    func() (T, error) { ... })

func IsTimeoutError ¶

func IsTimeoutError(err error) bool

IsTimeoutError reports whether helper.RetryContext exited because of an overall timeout, so that callers can translate the timeout into a more user-friendly diagnostic.

func RetryFramework ¶

func RetryFramework[T any](
	ctx context.Context,
	timeout time.Duration,
	retryable RetryableErrorFn,
	fn func() (T, error),
) (T, error)

RetryFramework is the framework-flavoured equivalent of helper.Retry in the SDKv2 world.

Differences from SDKv2 helper.Retry:

• Callers no longer need to wrap *resource.RetryError manually; the business logic only returns (T, error) and the retryable predicate decides whether the error is retryable.
• It accepts ctx, so timeout and cancellation are governed by both ctx and the timeout argument.

Typical usage:

out, err := helper.RetryFramework(ctx, 30*time.Second, isResourceTransient,
    func() (*sdk.DescribeFooResponse, error) {
        return client.UseFooClient().DescribeFoo(req)
    })

When err is nil it returns directly; when err is classified as retryable it enters the retry loop, otherwise it terminates immediately.

func StringPointerFromValue ¶

func StringPointerFromValue(v types.String) *string

StringPointerFromValue converts a types.String back to *string:

• Null/Unknown returns nil (which usually means "do not send this field" when invoking the API).
• Otherwise it returns a pointer to the string value.

SDK request structs use *string heavily to express "optional, omitted". This helper keeps Create/Update code paths concise.

func StringPointerValueOrNull ¶

func StringPointerValueOrNull(p *string) types.String

StringPointerValueOrNull converts a *string to types.String:

• A nil pointer returns types.StringNull().
• A non-nil pointer is preserved as types.StringValue("") even when the pointee is the empty string, because the very presence of the pointer means the API explicitly returned the field.

func StringValueOrNull ¶

func StringValueOrNull(s string) types.String

StringValueOrNull safely converts a Go string to the framework's types.String:

• An empty string is treated as "value not present on the business side" and is returned as types.StringNull().
• A non-empty string is wrapped as types.StringValue.

In a resource Read, the common "the API did not return this field" scenario should produce types.StringNull() rather than an empty value; otherwise the plan comparison generates noisy diffs against Optional+Computed fields. If the empty string is itself a legal business value, do not use this helper — construct types.StringValue("") directly.

func WrapSDKError ¶

func WrapSDKError(summary string, err error) diag.Diagnostic

WrapSDKError translates an arbitrary error into a structured framework diag.Diagnostic.

When err is *sdkErrors.TencentCloudSDKError:

• Summary uses the supplied summary (the business-side context, e.g. "Failed to create foo").
• Detail includes Code, Message and RequestId so that troubleshooting and ticket filing are easier.

When err is any other type:

• Falls back to a generic error rendering; Detail contains only err.Error().

summary must not be empty; an empty summary is replaced with "TencentCloud API error" so the framework runtime does not reject the diagnostic as malformed.