list

type ConfigValidator interface {
	// Description describes the validation in plain text formatting.
	//
	// This information may be automatically added to list resource plain text
	// descriptions by external tooling.
	Description(context.Context) string

	// MarkdownDescription describes the validation in Markdown formatting.
	//
	// This information may be automatically added to list resource Markdown
	// descriptions by external tooling.
	MarkdownDescription(context.Context) string

	// ValidateResource performs the validation.
	//
	// This method name is separate from ConfigValidators in resource and other packages in
	// order to allow generic validators.
	ValidateListResourceConfig(context.Context, ValidateConfigRequest, *ValidateConfigResponse)
}

type ConfigureRequest struct {
	// ProviderData is the data set in the
	// [provider.ConfigureResponse.ListResourceData] 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 ListResource.
	//
	// This data is only set after the ConfigureProvider RPC has been called
	// by Terraform.
	ProviderData any
}

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

type ListRequest struct {
	// Config is the configuration the user supplied for listing resource
	// instances.
	Config tfsdk.Config

	// IncludeResource indicates whether the provider should populate the
	// [ListResult.Resource] field.
	IncludeResource bool

	// Limit specifies the maximum number of results that Terraform is
	// expecting.
	Limit int64

	ResourceSchema         fwschema.Schema
	ResourceIdentitySchema fwschema.Schema
}

type ListResource interface {
	// Metadata should return the full name of the list resource such as
	// examplecloud_thing. This name should match the full name of the managed
	// resource to be listed; otherwise, the GetMetadata RPC will return an
	// error diagnostic.
	//
	// The method signature is intended to be compatible with the Metadata
	// method signature in the Resource interface. One implementation of
	// Metadata can satisfy both interfaces.
	Metadata(context.Context, resource.MetadataRequest, *resource.MetadataResponse)

	// ListResourceConfigSchema should return the schema for list blocks.
	ListResourceConfigSchema(context.Context, ListResourceSchemaRequest, *ListResourceSchemaResponse)

	// List is called when the provider must list instances of a managed
	// resource type that satisfy a user-provided request.
	List(context.Context, ListRequest, *ListResultsStream)
}

type ListResourceSchemaRequest struct{}

type ListResourceSchemaResponse struct {
	// Schema is the schema of the list resource.
	Schema schema.Schema

	// Diagnostics report errors or warnings related to retrieving the list
	// resource schema. An empty slice indicates success, with no warnings
	// or errors generated.
	Diagnostics diag.Diagnostics
}

type ListResourceWithConfigValidators interface {
	ListResource

	// ConfigValidators returns a list of functions which will all be performed during validation.
	ListResourceConfigValidators(context.Context) []ConfigValidator
}

type ListResourceWithConfigure interface {
	ListResource

	// Configure enables provider-level data or clients to be set.  The method
	// signature is intended to be compatible with the Configure method
	// signature in the Resource interface. One implementation of Configure can
	// satisfy both interfaces.
	Configure(context.Context, resource.ConfigureRequest, *resource.ConfigureResponse)
}

type ListResourceWithRawV5Schemas interface {
	ListResource

	// RawV5Schemas is called to provide the ProtoV5 representations of the resource and resource identity schemas.
	RawV5Schemas(context.Context, RawV5SchemaRequest, *RawV5SchemaResponse)
}

type ListResourceWithRawV6Schemas interface {
	ListResource

	// RawV6Schemas is called to provide the ProtoV6 representations of the resource and resource identity schemas.
	RawV6Schemas(context.Context, RawV6SchemaRequest, *RawV6SchemaResponse)
}

type ListResourceWithValidateConfig interface {
	ListResource

	// ValidateListResourceConfig performs the validation.
	ValidateListResourceConfig(context.Context, ValidateConfigRequest, *ValidateConfigResponse)
}

type ListResult struct {
	// Identity is the identity of the managed resource instance.
	//
	// A nil value will raise an error diagnostic.
	Identity *tfsdk.ResourceIdentity

	// Resource is the provider's representation of the attributes of the
	// listed managed resource instance.
	//
	// If [ListRequest.IncludeResource] is true, a nil value will raise
	// a warning diagnostic.
	Resource *tfsdk.Resource

	// DisplayName is a provider-defined human-readable description of the
	// listed managed resource instance, intended for CLI and browser UIs.
	DisplayName string

	// Diagnostics report errors or warnings related to the listed managed
	// resource instance. An empty slice indicates a successful operation with
	// no warnings or errors generated.
	Diagnostics diag.Diagnostics
}

type ListResultsStream struct {
	// Results is a function that emits [ListResult] values via its push
	// function argument.
	//
	// To indicate a fatal processing error, push a [ListResult] that contains
	// a [diag.ErrorDiagnostic].
	Results iter.Seq[ListResult]
}

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 ListResource type name
	// with an underscore in the response.
	ProviderTypeName string
}

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

type RawV5SchemaRequest struct{}

type RawV5SchemaResponse struct {
	// ProtoV5IdentitySchema is the ProtoV5 representation of the resource identity
	// schema. This should only be supplied if framework functionality is being used
	// with a legacy resource. Currently, this only applies to list.
	ProtoV5IdentitySchema *tfprotov5.ResourceIdentitySchema

	// ProtoV5Schema is the ProtoV5 representation of the resource schema
	// This should only be supplied if framework functionality is being used
	// with a legacy resource. Currently, this only applies to list.
	ProtoV5Schema *tfprotov5.Schema
}

type RawV6SchemaRequest struct{}

type RawV6SchemaResponse struct {
	// ProtoV6IdentitySchema is the ProtoV6 representation of the resource identity
	// schema. This should only be supplied if framework functionality is being used
	// with a legacy resource. Currently, this only applies to list.
	ProtoV6IdentitySchema *tfprotov6.ResourceIdentitySchema

	// ProtoV6Schema is the ProtoV6 representation of the resource schema
	// This should only be supplied if framework functionality is being used
	// with a legacy resource. Currently, this only applies to list.
	ProtoV6Schema *tfprotov6.Schema
}

type ValidateConfigRequest struct {
	// Config is the configuration the user supplied for the resource.
	//
	// 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.
	Config tfsdk.Config
}

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