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

type ConfigureRequest struct {// ProviderData is the data set in the// [provider.ConfigureResponse.DataSourceData] 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 DataSource.//// 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 DataSource interface {// Metadata should return the full name of the data source, such as// examplecloud_thing.Metadata(context.Context,MetadataRequest, *MetadataResponse)// Schema should return the schema for this data source.Schema(context.Context,SchemaRequest, *SchemaResponse)// Read is called when the provider must read data source values in// order to update state. Config values should be read from the// ReadRequest and new state values set on the ReadResponse.Read(context.Context,ReadRequest, *ReadResponse)}

type DataSourceWithConfigValidators interface {DataSource// ConfigValidators returns a list of ConfigValidators. Each ConfigValidator's Validate method will be called when validating the data source.ConfigValidators(context.Context) []ConfigValidator}

type DataSourceWithConfigure interface {DataSource// Configure enables provider-level data or clients to be set in the// provider-defined DataSource type. It is separately executed for each// ReadDataSource RPC.Configure(context.Context,ConfigureRequest, *ConfigureResponse)}

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

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

type DeferredReasonint32

func (DeferredReason)String¶added inv1.9.0

func (dDeferredReason) String()string

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 DataSource type name// with an underscore in the response.ProviderTypeNamestring}

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

type ReadClientCapabilities 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 ReadRequest struct {// Config is the configuration the user supplied for the data source.//// 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// ProviderMeta is metadata from the provider_meta block of the module.ProviderMetatfsdk.Config// ClientCapabilities defines optionally supported protocol features for the// ReadDataSource RPC, such as forward-compatible Terraform behavior changes.ClientCapabilitiesReadClientCapabilities}

type ReadResponse struct {// State is the state of the data source following the Read operation.// This field should be set during the resource's Read operation.Statetfsdk.State// Diagnostics report errors or warnings related to reading the data// source. An empty slice indicates a successful operation with no// warnings or errors generated.Diagnosticsdiag.Diagnostics// Deferred indicates that Terraform should defer reading this// data source until a followup apply operation.//// This field can only be set if// `(datasource.ReadRequest).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 data source.Schemaschema.Schema// Diagnostics report errors or warnings related to validating the data// source configuration. 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 data source.//// 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 data// source configuration. An empty slice indicates success, with no warnings// or errors generated.Diagnosticsdiag.Diagnostics}