helpers

Documentation

Index

• Constants
• Variables
• func DataSourceConfigure(ctx context.Context, req datasource.ConfigureRequest, ...) *readarr.APIClient
• func ErrDataNotFoundError(kind, field, search string) error
• func ImportStatePassthroughIntID(ctx context.Context, attrPath path.Path, req resource.ImportStateRequest, ...)
• func ParseClientError(action, name string, err error) string
• func ReadFields(ctx context.Context, fieldContainer interface{}, fieldLists Fields) []*readarr.Field
• func ResourceConfigure(ctx context.Context, req resource.ConfigureRequest, ...) *readarr.APIClient
• func WriteFields(ctx context.Context, fieldContainer interface{}, fields []*readarr.Field, ...)
• type Fields

Constants

const (
	Create                            = "create"
	Read                              = "read"
	Update                            = "update"
	Delete                            = "delete"
	List                              = "list"
	ClientError                       = "Client Error"
	ResourceError                     = "Resource Error"
	DataSourceError                   = "Data Source Error"
	UnexpectedImportIdentifier        = "Unexpected Import Identifier"
	UnexpectedResourceConfigureType   = "Unexpected Resource Configure Type"
	UnexpectedDataSourceConfigureType = "Unexpected DataSource Configure Type"
)

define constant for error management.

Variables

var ErrDataNotFound = errors.New("data source not found")

Functions

func DataSourceConfigure

func DataSourceConfigure(ctx context.Context, req datasource.ConfigureRequest, resp *datasource.ConfigureResponse) *readarr.APIClient

DataSourceConfigure is a helper function to set the client for a specific data source.

func ErrDataNotFoundError

func ErrDataNotFoundError(kind, field, search string) error

func ImportStatePassthroughIntID

func ImportStatePassthroughIntID(ctx context.Context, attrPath path.Path, req resource.ImportStateRequest, resp *resource.ImportStateResponse)

ImportStatePassthroughIntID is a helper function to set the import identifier to a given state attribute path. The attribute must accept a int value. extends https://github.com/hashicorp/terraform-plugin-framework/blob/main/resource/import_state.go.

func ParseClientError

func ParseClientError(action, name string, err error) string

func ReadFields

func ReadFields(ctx context.Context, fieldContainer interface{}, fieldLists Fields) []*readarr.Field

ReadFields takes in input a field container and populates a readarr.Field slice.

func ResourceConfigure

func ResourceConfigure(ctx context.Context, req resource.ConfigureRequest, resp *resource.ConfigureResponse) *readarr.APIClient

ResourceConfigure is a helper function to set the client for a specific resource.

func WriteFields

func WriteFields(ctx context.Context, fieldContainer interface{}, fields []*readarr.Field, fieldLists Fields)

WriteFields takes in input a readarr.Field slice and populate the relevant container fields.

Types

type Fields

type Fields struct {
	Bools                  []string
	BoolsExceptions        []string
	Ints                   []string
	IntsExceptions         []string
	Strings                []string
	StringsExceptions      []string
	Floats                 []string
	FloatsExceptions       []string
	IntSlices              []string
	IntSlicesExceptions    []string
	StringSlices           []string
	StringSlicesExceptions []string
	Sensitive              []string
}

Fields contains all the field lists of a specific resource per type.