listclient

type Lister interface {
	// GetProviderSchema is the source of the list resource schemas.
	GetProviderSchema(ctx context.Context) providers.GetProviderSchemaResponse

	// ListResourceStream runs the ListResource streaming RPC, calling emit
	// once per result. Returning false from emit ends the stream.
	ListResourceStream(ctx context.Context, req providers.ListResourceRequest, emit func(providers.ListResourceEvent) bool) tfdiags.Diagnostics
}

type Request struct {
	// TypeName is the resource type to enumerate, which must be one of the
	// types reported by [ListSchemas].
	TypeName string

	// Config is the list configuration, conforming to the type's list
	// configuration schema — build it with [TypeSchema.BuildConfig].
	// cty.NilVal means "set nothing", and is filled in from the schema.
	Config cty.Value

	// IncludeResource asks the provider to attach the full resource object
	// to every result. Providers may pay a read per result for this, so
	// leave it false when the identity is all that is wanted.
	IncludeResource bool

	// Limit caps the number of results; zero means no cap. This is a
	// request to the provider, which ends the stream once it is reached —
	// it is not a client-side truncation, so a provider that ignores it
	// will still send everything.
	Limit int64
}

type Result struct {
	// TypeName is the resource type that was listed.
	TypeName string

	// Identity is the resource identity, an object typed by the resource
	// type's identity schema. It is cty.NilVal when the provider sent no
	// identity or serves no identity schema for the type; a caller that
	// needs an identity must check, because a provider is free to send a
	// result without one.
	Identity cty.Value

	// DisplayName is the provider's human-readable label for the result.
	// It is for display only: nothing guarantees it is unique or stable.
	DisplayName string

	// Resource is the full resource object, typed by the resource type's
	// schema. It is cty.NilVal unless the request set IncludeResource.
	Resource cty.Value

	// Diagnostics are the diagnostics the provider attached to this
	// individual result. A result can carry an error diagnostic and still
	// be delivered, because the rest of the stream stays valid; these are
	// not returned as call-level diagnostics for that reason.
	Diagnostics tfdiags.Diagnostics
}

type Schemas struct {
	// contains filtered or unexported fields
}

type TypeSchema struct {
	// TypeName is the resource type name, e.g. "aws_vpc". A list resource
	// type name is the same string as the managed resource type it
	// enumerates.
	TypeName string

	// Config is the schema of the configuration block a list call for this
	// type accepts. It is never nil for a TypeSchema obtained from
	// [ListSchemas]. Its contents are provider-defined; build values for it
	// with [TypeSchema.BuildConfig].
	Config *configschema.Block

	// Identity is the identity schema of the managed resource type, which
	// types the Identity field of every result. It is nil when the provider
	// serves no identity schema for this type, in which case results carry
	// no usable identity.
	Identity *configschema.Object

	// IdentityVersion is the version of Identity, for callers that persist
	// identities and need to detect a schema change.
	IdentityVersion int64

	// Resource is the managed resource type's schema, which types the
	// Resource field of a result when full objects were requested. It is
	// nil when the provider serves a list schema for a type it has no
	// managed resource schema for, which would be a provider bug.
	Resource *configschema.Block
}