type Action interface {// Schema should return the schema for this action.Schema(context.Context,SchemaRequest, *SchemaResponse)// Metadata should return the full name of the action, such as examplecloud_do_thing.Metadata(context.Context,MetadataRequest, *MetadataResponse)// Invoke is called to run the logic of the action. Config values should be read from the InvokeRequest// and potential diagnostics set in InvokeResponse.//// The [InvokeResponse.SendProgress] function can be called in the Invoke method to immediately// report progress events related to the invocation of the action to Terraform.Invoke(context.Context,InvokeRequest, *InvokeResponse)}

type ActionWithConfigValidators interface {Action// ConfigValidators returns a list of functions which will all be performed during validation.ConfigValidators(context.Context) []ConfigValidator}

type ActionWithConfigure interface {Action// Configure enables provider-level data or clients to be set in the// provider-defined Action type.Configure(context.Context,ConfigureRequest, *ConfigureResponse)}

type ActionWithModifyPlan interface {Action// ModifyPlan is called when the provider has an opportunity to modify// the plan for an action: once during the plan phase, and once// during the apply phase with any unknown values from configuration// filled in with their final values.//// All action schema types can use the plan as an opportunity to raise early// diagnostics to practitioners, such as validation errors.ModifyPlan(context.Context,ModifyPlanRequest, *ModifyPlanResponse)}

type ActionWithValidateConfig interface {Action// ValidateConfig performs the validation.ValidateConfig(context.Context,ValidateConfigRequest, *ValidateConfigResponse)}

type ConfigValidator interface {// Description describes the validation in plain text formatting.//// This information may be automatically added to action plain text// descriptions by external tooling.Description(context.Context)string// MarkdownDescription describes the validation in Markdown formatting.//// This information may be automatically added to action Markdown// descriptions by external tooling.MarkdownDescription(context.Context)string// ValidateAction performs the validation.//// This method name is separate from ConfigValidators in resource and other packages in// order to allow generic validators.ValidateAction(context.Context,ValidateConfigRequest, *ValidateConfigResponse)}

type ConfigureRequest struct {// ProviderData is the data set in the// [provider.ConfigureResponse.ActionData] field. This data is// provider-specifc and therefore can contain any necessary remote system// clients, custom provider data, or anything else pertinent to the// functionality of the Action.//// This data is only set after the ConfigureProvider RPC has been called// by Terraform.ProviderDataany}

type ConfigureResponse struct {// Diagnostics report errors or warnings related to configuring of the// Datasource. An empty slice indicates a successful operation with no// warnings or errors generated.Diagnosticsdiag.Diagnostics}

type Deferred struct {// Reason is the reason for deferring the change.ReasonDeferredReason}

type DeferredReasonint32

func (DeferredReason)String¶

func (dDeferredReason) String()string

type InvokeProgressEvent struct {// Message is the string that will be presented to the practitioner either via the console// or an external system like HCP Terraform.Messagestring}

type InvokeRequest struct {// Config is the configuration the user supplied for the action.Configtfsdk.Config}

type InvokeResponse struct {// Diagnostics report errors or warnings related to invoking the action. Returning an empty slice// indicates a successful invocation with no warnings or errors// generated.Diagnosticsdiag.Diagnostics// SendProgress will immediately send a progress update to Terraform core during action invocation.// This function is provided by the framework and can be called multiple times while action logic is running.SendProgress func(eventInvokeProgressEvent)}

type MetadataRequest struct {// ProviderTypeName is the string returned from// [provider.MetadataResponse.TypeName], if the Provider type implements// the Metadata method. This string should prefix the Action type name// with an underscore in the response.ProviderTypeNamestring}

type MetadataResponse struct {// TypeName should be the full action type, including the provider// type prefix and an underscore. For example, examplecloud_thing.TypeNamestring}

type ModifyPlanClientCapabilities struct {// DeferralAllowed indicates whether the Terraform client initiating// the request allows a deferral response.//// NOTE: This functionality is related to deferred action support, which is currently experimental and is subject// to change or break without warning. It is not protected by version compatibility guarantees.DeferralAllowedbool}

type ModifyPlanRequest struct {// Config is the configuration the user supplied for the action.//// This configuration may contain unknown values if a user uses// interpolation or other functionality that would prevent Terraform// from knowing the value at request time.Configtfsdk.Config// ClientCapabilities defines optionally supported protocol features for the// PlanAction RPC, such as forward-compatible Terraform behavior changes.ClientCapabilitiesModifyPlanClientCapabilities}

type ModifyPlanResponse struct {// Diagnostics report early errors or warnings related action.// Returning an empty slice indicates a successful plan modification// with no warnings or errors generated.Diagnosticsdiag.Diagnostics// Deferred indicates that Terraform should defer planning this// action until a follow-up apply operation.//// This field can only be set if// `(action.ModifyPlanRequest).ClientCapabilities.DeferralAllowed` is true.//// NOTE: This functionality is related to deferred action support, which is currently experimental and is subject// to change or break without warning. It is not protected by version compatibility guarantees.Deferred *Deferred}

type SchemaRequest struct{}

type SchemaResponse struct {// Schema is the schema of the action.Schemaschema.Schema// Diagnostics report errors or warnings related to retrieving the action schema.// An empty slice indicates success, with no warnings or errors generated.Diagnosticsdiag.Diagnostics}

type ValidateConfigRequest struct {// Config is the configuration the user supplied for the action.//// This configuration may contain unknown values if a user uses// interpolation or other functionality that would prevent Terraform// from knowing the value at request time.Configtfsdk.Config}

type ValidateConfigResponse struct {// Diagnostics report errors or warnings related to validating the action// configuration. An empty slice indicates success, with no warnings or// errors generated.Diagnosticsdiag.Diagnostics}