list

package
v1.14.0-beta.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 18, 2025 License: MPL-2.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ListRequest

type ListRequest struct {
	TypeName string
	// Config is the configuration the user supplied for listing resource
	// instances.
	Config tftypes.Value

	// 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         *tfprotov6.Schema
	ResourceIdentitySchema *tfprotov6.ResourceIdentitySchema
}

type ListResource

type ListResource interface {
	Schema(context.Context, SchemaRequest, *SchemaResponse)
	List(context.Context, ListRequest, *ListResultsStream)
}

type ListResult

type ListResult struct {
	DisplayName string
	Identity    *tftypes.Value
	Resource    *tftypes.Value
	Diagnostics []*tfprotov6.Diagnostic
}

type ListResultsStream

type ListResultsStream struct {
	Results iter.Seq[ListResult]
}

type SchemaRequest

type SchemaRequest struct{}

type SchemaResponse

type SchemaResponse struct {
	Diagnostics []*tfprotov6.Diagnostic
	Schema      *tfprotov6.Schema
}

type ValidateListConfigResponse

type ValidateListConfigResponse struct {
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL