resource

Documentation

Overview

Package resource provides testsdk handling of the managed resource concept.

Index

• type CreateRequest
• type CreateResponse
• type DeleteRequest
• type DeleteResponse
• type IdentitySchemaRequest
• type IdentitySchemaResponse
• type ImportStateRequest
• type ImportStateResponse
• type PlanChangeRequest
• type PlanChangeResponse
• type ReadRequest
• type ReadResponse
• type Resource
• type SchemaRequest
• type SchemaResponse
• type UpdateRequest
• type UpdateResponse
• type UpgradeStateRequest
• type UpgradeStateResponse
• type ValidateConfigRequest
• type ValidateConfigResponse

Types

type CreateRequest

type CreateRequest struct {
	Config          tftypes.Value
	PlannedIdentity *tftypes.Value
}

type CreateResponse

type CreateResponse struct {
	Diagnostics []*tfprotov6.Diagnostic
	NewState    tftypes.Value
	NewIdentity *tftypes.Value
}

type DeleteRequest

type DeleteRequest struct {
	PriorState tftypes.Value
}

type DeleteResponse

type DeleteResponse struct {
	Diagnostics []*tfprotov6.Diagnostic
}

type IdentitySchemaRequest

type IdentitySchemaRequest struct{}

type IdentitySchemaResponse

type IdentitySchemaResponse struct {
	Diagnostics []*tfprotov6.Diagnostic
	Schema      *tfprotov6.ResourceIdentitySchema
}

type ImportStateRequest

type ImportStateRequest struct {
	ID       string
	Identity *tftypes.Value
}

type ImportStateResponse

type ImportStateResponse struct {
	Diagnostics []*tfprotov6.Diagnostic
	State       tftypes.Value
	Identity    *tftypes.Value
}

type PlanChangeRequest

type PlanChangeRequest struct {
	Config           tftypes.Value
	PriorState       tftypes.Value
	PriorIdentity    *tftypes.Value
	ProposedNewState tftypes.Value
}

type PlanChangeResponse

type PlanChangeResponse struct {
	Deferred        *tfprotov6.Deferred
	Diagnostics     []*tfprotov6.Diagnostic
	PlannedState    tftypes.Value
	PlannedIdentity *tftypes.Value
	RequiresReplace []*tftypes.AttributePath
}

type ReadRequest

type ReadRequest struct {
	CurrentState    tftypes.Value
	CurrentIdentity *tftypes.Value
}

type ReadResponse

type ReadResponse struct {
	Diagnostics []*tfprotov6.Diagnostic
	NewState    tftypes.Value
	NewIdentity *tftypes.Value
}

type Resource

type Resource interface {
	Create(context.Context, CreateRequest, *CreateResponse)
	Delete(context.Context, DeleteRequest, *DeleteResponse)
	ImportState(context.Context, ImportStateRequest, *ImportStateResponse)
	PlanChange(context.Context, PlanChangeRequest, *PlanChangeResponse)
	Read(context.Context, ReadRequest, *ReadResponse)
	IdentitySchema(context.Context, IdentitySchemaRequest, *IdentitySchemaResponse)
	Schema(context.Context, SchemaRequest, *SchemaResponse)
	Update(context.Context, UpdateRequest, *UpdateResponse)
	UpgradeState(context.Context, UpgradeStateRequest, *UpgradeStateResponse)
	ValidateConfig(context.Context, ValidateConfigRequest, *ValidateConfigResponse)
}

type SchemaRequest

type SchemaRequest struct{}

type SchemaResponse

type SchemaResponse struct {
	Diagnostics []*tfprotov6.Diagnostic
	Schema      *tfprotov6.Schema
}

type UpdateRequest

type UpdateRequest struct {
	Config          tftypes.Value
	PlannedState    tftypes.Value
	PlannedIdentity *tftypes.Value
	PriorState      tftypes.Value
}

type UpdateResponse

type UpdateResponse struct {
	Diagnostics []*tfprotov6.Diagnostic
	NewState    tftypes.Value
	NewIdentity *tftypes.Value
}

type UpgradeStateRequest

type UpgradeStateRequest struct {
	RawState *tfprotov6.RawState
	Version  int64
}

type UpgradeStateResponse

type UpgradeStateResponse struct {
	Diagnostics   []*tfprotov6.Diagnostic
	UpgradedState tftypes.Value
}

type ValidateConfigRequest

type ValidateConfigRequest struct {
	Config tftypes.Value
}

type ValidateConfigResponse

type ValidateConfigResponse struct {
	Diagnostics []*tfprotov6.Diagnostic
}