framework

package

v1.27.0 Latest Latest Go to latest Published: Feb 2, 2024 License: MIT Imports: 10 Imported by: 0

Details

This section is empty.

This section is empty.

func GetDataSourceMeta(
	req datasource.ConfigureRequest,
	resp *datasource.ConfigureResponse,
) *config.Config

func GetResourceMeta(
	req resource.ConfigureRequest,
	resp *resource.ConfigureResponse,
) *config.Config

func IDAttribute(description string) schema.StringAttribute

func IDAttributeDefaultDescription() schema.StringAttribute

type BaseDataSource struct {
	Config BaseDataSourceConfig
	Meta   *config.Config
}

BaseDataSource contains various re-usable fields and methods intended for use in data source implementations by composition.

func NewBaseDataSource(cfg BaseDataSourceConfig) BaseDataSource

NewBaseDataSource returns a new instance of the BaseDataSource struct for cleaner initialization.

func (r *BaseDataSource) Configure(
	ctx context.Context,
	req datasource.ConfigureRequest,
	resp *datasource.ConfigureResponse,
)

func (r *BaseDataSource) Metadata(
	ctx context.Context,
	req datasource.MetadataRequest,
	resp *datasource.MetadataResponse,
)

func (r *BaseDataSource) Schema(
	ctx context.Context,
	req datasource.SchemaRequest,
	resp *datasource.SchemaResponse,
)

type BaseDataSourceConfig struct {
	Name string

	// Optional
	Schema *schema.Schema
}

BaseDataSourceConfig contains all configurable base resource fields.

type BaseResource struct {
	Config BaseResourceConfig
	Meta   *config.Config
}

BaseResource contains various re-usable fields and methods intended for use in resource implementations by composition.

func NewBaseResource(cfg BaseResourceConfig) BaseResource

NewBaseResource returns a new instance of the BaseResource struct for cleaner initialization.

func (r *BaseResource) Configure(
	ctx context.Context,
	req resource.ConfigureRequest,
	resp *resource.ConfigureResponse,
)

func (r *BaseResource) ImportState(
	ctx context.Context,
	req resource.ImportStateRequest,
	resp *resource.ImportStateResponse,
)

ImportState should be overridden for resources with complex read logic (e.g. parent ID).

func (r *BaseResource) Metadata(
	ctx context.Context,
	req resource.MetadataRequest,
	resp *resource.MetadataResponse,
)

func (r *BaseResource) Schema(
	ctx context.Context,
	req resource.SchemaRequest,
	resp *resource.SchemaResponse,
)

type BaseResourceConfig struct {
	Name   string
	IDAttr string

	// Optional
	Schema *schema.Schema
}

BaseResourceConfig contains all configurable base resource fields.