helpers

Documentation

Overview

Package helpers provides api errors helpers for the CloudAvenue Terraform Provider.

Package helpers provides auth helpers for the CloudAvenue Terraform Provider.

Package helpers provides configuration helpers for Terraform Provider.

Index

• Constants
• func GetAuthContextWithTO(apiCtx, tfCtx context.Context) (context.Context, error)
• type APIError
  • func CheckAPIError(err error, httpR *http.Response) *APIError
  • func (e *APIError) Error() string
  • func (e *APIError) GetDetail() string
  • func (e *APIError) GetStatusCode() int
  • func (e *APIError) GetSummary() string
  • func (e *APIError) GetTerraformDiagnostic() diag.Diagnostic
  • func (e *APIError) IsNotFound() bool
  • func (e *APIError) Unwrap() error

Constants

const (
	// ForceNewDescription is the description for ForceNew.
	ForceNewDescription = "Changes to this field will force a new resource to be created."
)

Functions

func GetAuthContextWithTO

func GetAuthContextWithTO(apiCtx, tfCtx context.Context) (context.Context, error)

GetAuthContextWithTO is a helper function to create the auth context with the token api and the terraform context with timeout.

Types

type APIError

type APIError struct {
	cloudavenue.ApiError
	// contains filtered or unexported fields
}

APIError is an error returned by the CloudAvenue API.

func CheckAPIError

func CheckAPIError(err error, httpR *http.Response) *APIError

CheckAPIError checks the HTTP response for errors and returns an APIError with statusCode and model is the error is a cloudavenue.GenericSwaggerError type or only the error if not.

func (*APIError) Error

func (e *APIError) Error() string

Error returns the error message.

func (*APIError) GetDetail

func (e *APIError) GetDetail() string

GetDetail returns a detailed description of the error.

func (*APIError) GetStatusCode

func (e *APIError) GetStatusCode() int

GetStatusCode returns the HTTP status code.

func (*APIError) GetSummary

func (e *APIError) GetSummary() string

GetSummary returns a summary of the error.

func (*APIError) GetTerraformDiagnostic

func (e *APIError) GetTerraformDiagnostic() diag.Diagnostic

GetTerraformDiagnostic returns a Terraform Diagnostic for the error.

func (*APIError) IsNotFound

func (e *APIError) IsNotFound() bool

IsNotFound returns true if the error is a 404 Not Found error.

func (*APIError) Unwrap

func (e *APIError) Unwrap() error

Unwrap returns the underlying error.