Package fwserver contains the framework provider server implementation. This package should only ever contain framework-native types, while specific protocol version compatible implementations, such as proto6server, are implemented on top of this abstraction.
This section is empty.
This section is empty.
AttributeModifyPlan runs all AttributePlanModifiers
TODO: Clean up this abstraction back into an internal Attribute type method. The extra Attribute parameter is a carry-over of creating the proto6server package from the tfsdk package and not wanting to export the method. Reference: https://github.com/hashicorp/terraform-plugin-framework/issues/365
AttributePlanModifyBool performs all types.Bool plan modification.
AttributePlanModifyDynamic performs all types.Dynamic plan modification.
AttributePlanModifyFloat32 performs all types.Float32 plan modification.
AttributePlanModifyFloat64 performs all types.Float64 plan modification.
AttributePlanModifyInt32 performs all types.Int32 plan modification.
AttributePlanModifyInt64 performs all types.Int64 plan modification.
AttributePlanModifyList performs all types.List plan modification.
AttributePlanModifyMap performs all types.Map plan modification.
AttributePlanModifyNumber performs all types.Number plan modification.
AttributePlanModifyObject performs all types.Object plan modification.
AttributePlanModifySet performs all types.Set plan modification.
AttributePlanModifyString performs all types.String plan modification.
AttributeValidate performs all Attribute validation.
TODO: Clean up this abstraction back into an internal Attribute type method. The extra Attribute parameter is a carry-over of creating the proto6server package from the tfsdk package and not wanting to export the method. Reference: https://github.com/hashicorp/terraform-plugin-framework/issues/365
AttributeValidateBool performs all types.Bool validation.
AttributeValidateDynamic performs all types.Dynamic validation.
AttributeValidateFloat32 performs all types.Float32 validation.
AttributeValidateFloat64 performs all types.Float64 validation.
AttributeValidateInt32 performs all types.Int32 validation.
AttributeValidateInt64 performs all types.Int64 validation.
AttributeValidateList performs all types.List validation.
AttributeValidateMap performs all types.Map validation.
AttributeValidateNestedAttributes performs all nested Attributes validation.
TODO: Clean up this abstraction back into an internal Attribute type method. The extra Attribute parameter is a carry-over of creating the proto6server package from the tfsdk package and not wanting to export the method. Reference: https://github.com/hashicorp/terraform-plugin-framework/issues/365
AttributeValidateNumber performs all types.Number validation.
AttributeValidateObject performs all types.Object validation.
AttributeValidateSet performs all types.Set validation.
AttributeValidateString performs all types.String validation.
BlockModifyPlan performs all Block plan modification.
TODO: Clean up this abstraction back into an internal Block type method. The extra Block parameter is a carry-over of creating the proto6server package from the tfsdk package and not wanting to export the method. Reference: https://github.com/hashicorp/terraform-plugin-framework/issues/365
BlockPlanModifyList performs all types.List plan modification.
BlockPlanModifyObject performs all types.Object plan modification.
BlockPlanModifySet performs all types.Set plan modification.
BlockValidate performs all Block validation.
TODO: Clean up this abstraction back into an internal Block type method. The extra Block parameter is a carry-over of creating the proto6server package from the tfsdk package and not wanting to export the method. Reference: https://github.com/hashicorp/terraform-plugin-framework/issues/365
BlockValidateList performs all types.List validation.
BlockValidateObject performs all types.Object validation.
BlockValidateSet performs all types.Set validation.
NormaliseRequiresReplace sorts and deduplicates the slice of AttributePaths used in the RequiresReplace response field. Sorting is lexical based on the string representation of each AttributePath.
NullifyWriteOnlyAttributes transforms a tftypes.Value, setting all write-only attribute values to null according to the given managed resource schema. This function is called in all managed resource RPCs before a response is sent to Terraform Core. Terraform Core expects all write-only attribute values to be null to prevent data consistency errors. This can technically be done manually by the provider developers, but the Framework is handling it instead for convenience.
SchemaModifyPlan runs all AttributePlanModifiers in all schema attributes and blocks.
TODO: Clean up this abstraction back into an internal Schema type method. The extra Schema parameter is a carry-over of creating the proto6server package from the tfsdk package and not wanting to export the method. Reference: https://github.com/hashicorp/terraform-plugin-framework/issues/365
SchemaSemanticEquality runs semantic equality logic for all schema attributes and blocks.
MAINTAINER NOTE: Since semantic equality is purely value based, where attributes and blocks cannot currently introduce semantic equality logic based on those schema concepts, this logic immediately delegates to value based handling. On the off chance that the framework is enhanced with attribute and block level semantic equality support (not recommended since value types should really be the correct provider developer abstraction, rather than potentially causing confusing or duplicated provider logic), this logic will need to be redesigned similar to the plan modification and validation logic which walks the schema. That schema walk may interfere with the value based recursion for collection and structural types, so additional design may be necessary so that provider developer data handling intentions are kept based on both the value based logic and schema based logic.
SchemaValidate performs all Attribute and Block validation.
TODO: Clean up this abstraction back into an internal Schema type method. The extra Schema parameter is a carry-over of creating the proto6server package from the tfsdk package and not wanting to export the method. Reference: https://github.com/hashicorp/terraform-plugin-framework/issues/365
ApplyResourceChangeRequest is the framework server request for the ApplyResourceChange RPC.
ApplyResourceChangeResponse is the framework server response for the ApplyResourceChange RPC.
CallFunctionRequest is the framework server request for the CallFunction RPC.
CallFunctionResponse is the framework server response for the CallFunction RPC.
CloseEphemeralResourceRequest is the framework server request for the CloseEphemeralResource RPC.
type CloseEphemeralResourceResponse struct {
Diagnostics diag.Diagnostics
}
CloseEphemeralResourceResponse is the framework server response for the CloseEphemeralResource RPC.
CreateResourceRequest is the framework server request for a create request with the ApplyResourceChange RPC.
CreateResourceResponse is the framework server response for a create request with the ApplyResourceChange RPC.
type DataSourceMetadata struct {
TypeName string
}
DataSourceMetadata is the framework server equivalent of the tfprotov5.DataSourceMetadata and tfprotov6.DataSourceMetadata types.
DeleteResourceRequest is the framework server request for a delete request with the ApplyResourceChange RPC.
DeleteResourceResponse is the framework server response for a delete request with the ApplyResourceChange RPC.
type EphemeralResourceMetadata struct {
TypeName string
}
EphemeralResourceMetadata is the framework server equivalent of the tfprotov5.EphemeralResourceMetadata and tfprotov6.EphemeralResourceMetadata types.
type FunctionMetadata struct {
Name string
}
FunctionMetadata is the framework server equivalent of the tfprotov5.FunctionMetadata and tfprotov6.FunctionMetadata types.
type GetFunctionsRequest struct{}
GetFunctionsRequest is the framework server request for the GetFunctions RPC.
GetFunctionsResponse is the framework server response for the GetFunctions RPC.
type GetMetadataRequest struct{}
GetMetadataRequest is the framework server request for the GetMetadata RPC.
GetMetadataResponse is the framework server response for the GetMetadata RPC.
type GetProviderSchemaRequest struct{}
GetProviderSchemaRequest is the framework server request for the GetProviderSchema RPC.
GetProviderSchemaResponse is the framework server response for the GetProviderSchema RPC.
type GetResourceIdentitySchemasRequest struct{}
GetResourceIdentitySchemasRequest is the framework server request for the GetResourceIdentitySchemas RPC.
GetResourceIdentitySchemasResponse is the framework server response for the GetResourceIdentitySchemas RPC.
ImportResourceStateRequest is the framework server request for the ImportResourceState RPC.
Either ID or Identity will be supplied depending on how the resource is being imported.
ImportResourceStateResponse is the framework server response for the ImportResourceState RPC.
ImportedResource represents a resource that was imported.
ModifyAttributePlanRequest represents a request for the provider to modify an attribute value, or mark it as requiring replacement, at plan time. An instance of this request struct is supplied as an argument to the Modify function of an attribute's plan modifier(s).
ModifySchemaPlanRequest represents a request for a schema to run all attribute plan modification functions.
ModifySchemaPlanResponse represents a response to a ModifySchemaPlanRequest.
MoveResourceStateRequest is the framework server request for the MoveResourceState RPC.
MoveResourceStateResponse is the framework server response for the MoveResourceState RPC.
OpenEphemeralResourceRequest is the framework server request for the OpenEphemeralResource RPC.
OpenEphemeralResourceResponse is the framework server response for the OpenEphemeralResource RPC.
PlanResourceChangeRequest is the framework server request for the PlanResourceChange RPC.
PlanResourceChangeResponse is the framework server response for the PlanResourceChange RPC.
ReadDataSourceRequest is the framework server request for the ReadDataSource RPC.
ReadDataSourceResponse is the framework server response for the ReadDataSource RPC.
ReadResourceRequest is the framework server request for the ReadResource RPC.
ReadResourceResponse is the framework server response for the ReadResource RPC.
RenewEphemeralResourceRequest is the framework server request for the RenewEphemeralResource RPC.
RenewEphemeralResourceResponse is the framework server response for the RenewEphemeralResource RPC.
type ResourceMetadata struct {
TypeName string
}
ResourceMetadata is the framework server equivalent of the tfprotov5.ResourceMetadata and tfprotov6.ResourceMetadata types.
SchemaSemanticEqualityRequest represents a request for a schema to run all semantic equality logic.
SchemaSemanticEqualityResponse represents a response to a SchemaSemanticEqualityRequest.
type Server struct {
Provider provider.Provider
DataSourceConfigureData any
ResourceConfigureData any
EphemeralResourceConfigureData any
}
Server implements the framework provider server. Protocol specific implementations wrap this handling along with calling all request and response type conversions.
ApplyResourceChange implements the framework server ApplyResourceChange RPC.
CallFunction implements the framework server CallFunction RPC.
CloseEphemeralResource implements the framework server CloseEphemeralResource RPC.
ConfigureProvider implements the framework server ConfigureProvider RPC.
CreateResource implements the framework server create request logic for the ApplyResourceChange RPC.
DataSource returns the DataSource for a given type name.
DataSourceFuncs returns a map of DataSource functions. The results are cached on first use.
DataSourceMetadatas returns a slice of DataSourceMetadata for the GetMetadata RPC.
DataSourceSchema returns the DataSource Schema for the given type name and caches the result for later DataSource operations.
DataSourceSchemas returns a map of DataSource Schemas for the GetProviderSchema RPC without caching since not all schemas are guaranteed to be necessary for later provider operations. The schema implementations are also validated.
DeleteResource implements the framework server delete request logic for the ApplyResourceChange RPC.
EphemeralResource returns the EphemeralResource for a given type name.
EphemeralResourceFuncs returns a map of EphemeralResource functions. The results are cached on first use.
EphemeralResourceMetadatas returns a slice of EphemeralResourceMetadata for the GetMetadata RPC.
EphemeralResourceSchema returns the EphemeralResource Schema for the given type name and caches the result for later EphemeralResource operations.
EphemeralResourceSchemas returns a map of EphemeralResource Schemas for the GetProviderSchema RPC without caching since not all schemas are guaranteed to be necessary for later provider operations. The schema implementations are also validated.
Function returns the Function for a given name.
FunctionDefinition returns the Function Definition for the given name and caches the result for later Function operations.
FunctionDefinitions returns a map of Function Definitions for the GetProviderSchema RPC without caching since not all definitions are guaranteed to be necessary for later provider operations. The definition implementations are also validated.
FunctionFuncs returns a map of Function functions. The results are cached on first use.
FunctionMetadatas returns a slice of FunctionMetadata for the GetMetadata RPC.
GetFunctions implements the framework server GetFunctions RPC.
GetMetadata implements the framework server GetMetadata RPC.
GetProviderSchema implements the framework server GetProviderSchema RPC.
GetResourceIdentitySchemas implements the framework server GetResourceIdentitySchemas RPC.
ImportResourceState implements the framework server ImportResourceState RPC.
MoveResourceState implements the framework server MoveResourceState RPC.
OpenEphemeralResource implements the framework server OpenEphemeralResource RPC.
PlanResourceChange implements the framework server PlanResourceChange RPC.
ProviderMetaSchema returns the Meta Schema associated with the Provider, if it implements the ProviderWithMetaSchema interface. The Schema and Diagnostics are cached on first use.
ProviderSchema returns the Schema associated with the Provider. The Schema and Diagnostics are cached on first use.
ProviderTypeName returns the TypeName associated with the Provider. The TypeName is cached on first use.
ReadDataSource implements the framework server ReadDataSource RPC.
ReadResource implements the framework server ReadResource RPC.
RenewEphemeralResource implements the framework server RenewEphemeralResource RPC.
Resource returns the Resource for a given type name.
ResourceBehavior returns the ResourceBehavior for a given type name.
ResourceBehaviors returns a map of ResourceBehavior. The results are cached on first use.
ResourceFuncs returns a map of Resource functions. The results are cached on first use.
ResourceIdentitySchema returns the Resource Identity Schema for the given type name and caches the result for later Identity operations. Identity is an optional feature for resources, so this function will return a nil schema with no diagnostics if the resource type doesn't define an identity schema.
ResourceIdentitySchemas returns a map of Resource Identity Schemas for the GetResourceIdentitySchemas RPC without caching since not all schemas are guaranteed to be necessary for later provider operations. The schema implementations are also validated.
ResourceMetadatas returns a slice of ResourceMetadata for the GetMetadata RPC.
ResourceSchema returns the Resource Schema for the given type name and caches the result for later Resource operations.
ResourceSchemas returns a map of Resource Schemas for the GetProviderSchema RPC without caching since not all schemas are guaranteed to be necessary for later provider operations. The schema implementations are also validated.
ServerCapabilities returns the server capabilities.
UpdateResource implements the framework server update request logic for the ApplyResourceChange RPC.
UpgradeResourceIdentity implements the framework server UpgradeResourceIdentity RPC.
UpgradeResourceState implements the framework server UpgradeResourceState RPC.
ValidateDataSourceConfig implements the framework server ValidateDataSourceConfig RPC.
ValidateEphemeralResourceConfig implements the framework server ValidateEphemeralResourceConfig RPC.
ValidateProviderConfig implements the framework server ValidateProviderConfig RPC.
ValidateResourceConfig implements the framework server ValidateResourceConfig RPC.
type ServerCapabilities struct {
GetProviderSchemaOptional bool
MoveResourceState bool
PlanDestroy bool
}
ServerCapabilities is a combination of tfprotov5.ServerCapabilities and tfprotov6.ServerCapabilties, which may diverge over time. If that happens, the toproto5 conversion logic will handle the appropriate filtering and the proto5server/fwserver logic will need to account for missing features.
UpdateResourceRequest is the framework server request for an update request with the ApplyResourceChange RPC.
UpdateResourceResponse is the framework server response for an update request with the ApplyResourceChange RPC.
UpgradeResourceIdentityRequest is the framework server request for the UpgradeResourceIdentity RPC.
UpgradeResourceIdentityResponse is the framework server response for the UpgradeResourceIdentity RPC.
UpgradeResourceStateRequest is the framework server request for the UpgradeResourceState RPC.
UpgradeResourceStateResponse is the framework server response for the UpgradeResourceState RPC.
ValidateAttributeRequest repesents a request for attribute validation.
ValidateAttributeResponse represents a response to a ValidateAttributeRequest. An instance of this response struct is automatically passed through to each AttributeValidator.
ValidateDataSourceConfigRequest is the framework server request for the ValidateDataSourceConfig RPC.
type ValidateDataSourceConfigResponse struct {
Diagnostics diag.Diagnostics
}
ValidateDataSourceConfigResponse is the framework server response for the ValidateDataSourceConfig RPC.
ValidateEphemeralResourceConfigRequest is the framework server request for the ValidateEphemeralResourceConfig RPC.
type ValidateEphemeralResourceConfigResponse struct {
Diagnostics diag.Diagnostics
}
ValidateEphemeralResourceConfigResponse is the framework server response for the ValidateEphemeralResourceConfig RPC.
type ValidateProviderConfigRequest struct {
Config *tfsdk.Config
}
ValidateProviderConfigRequest is the framework server request for the ValidateProviderConfig RPC.
ValidateProviderConfigResponse is the framework server response for the ValidateProviderConfig RPC.
ValidateResourceConfigRequest is the framework server request for the ValidateResourceConfig RPC.
type ValidateResourceConfigResponse struct {
Diagnostics diag.Diagnostics
}
ValidateResourceConfigResponse is the framework server response for the ValidateResourceConfig RPC.
ValidateSchemaRequest repesents a request for validating a Schema.
ValidateSchemaResponse represents a response to a ValidateSchemaRequest.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4