add tfsdk object

Author: austinvalle

internal/fwschemadata/data_description.go

@@ -19,6 +19,10 @@ const (
 	// DataDescriptionEphemeralResultData is used for Data that represents
 	// the result of an ephemeral operation.
 	DataDescriptionEphemeralResultData DataDescription = "ephemeral result data"
+
+	// DataDescriptionResourceIdentity is used for Data that represents
+	// a managed resource identity.
+	DataDescriptionResourceIdentity DataDescription = "resource identity"
 )
 
 // DataDescription is a human friendly type for Data. Used in error
@@ -46,6 +50,8 @@ func (d DataDescription) Title() string {
 		return "State"
 	case DataDescriptionEphemeralResultData:
 		return "Ephemeral Result Data"
+	case DataDescriptionResourceIdentity:
+		return "Resource Identity"
 	default:
 		return "Data"
 	}

tfsdk/resource_identity.go

@@ -0,0 +1,91 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
+package tfsdk
+
+import (
+	"context"
+
+	"github.com/hashicorp/terraform-plugin-framework/diag"
+	"github.com/hashicorp/terraform-plugin-framework/internal/fwschema"
+	"github.com/hashicorp/terraform-plugin-framework/internal/fwschemadata"
+	"github.com/hashicorp/terraform-plugin-framework/path"
+	"github.com/hashicorp/terraform-plugin-go/tftypes"
+)
+
+// ResourceIdentity represents the identity data for a managed resource.
+type ResourceIdentity struct {
+	Raw    tftypes.Value
+	Schema fwschema.Schema
+}
+
+// Get populates the struct passed as `target` with the entire identity.
+func (s ResourceIdentity) Get(ctx context.Context, target interface{}) diag.Diagnostics {
+	return s.data().Get(ctx, target)
+}
+
+// GetAttribute retrieves the attribute found at `path` and populates
+// the `target` with the value.
+//
+// Elements under null or unknown collections return null values, however this
+// behavior is not protected by compatibility promises.
+func (s ResourceIdentity) GetAttribute(ctx context.Context, path path.Path, target interface{}) diag.Diagnostics {
+	return s.data().GetAtPath(ctx, path, target)
+}
+
+// PathMatches returns all matching path.Paths from the given path.Expression.
+//
+// If a parent path is null or unknown, which would prevent a full expression
+// from matching, the parent path is returned rather than no match to prevent
+// false positives.
+func (s ResourceIdentity) PathMatches(ctx context.Context, pathExpr path.Expression) (path.Paths, diag.Diagnostics) {
+	return s.data().PathMatches(ctx, pathExpr)
+}
+
+// Set populates the entire identity using the supplied Go value. The value `val`
+// should be a struct whose values have one of the attr.Value types. Each field
+// must be tagged with the corresponding schema field.
+func (s *ResourceIdentity) Set(ctx context.Context, val interface{}) diag.Diagnostics {
+	data := s.data()
+	diags := data.Set(ctx, val)
+
+	if diags.HasError() {
+		return diags
+	}
+
+	s.Raw = data.TerraformValue
+
+	return diags
+}
+
+// SetAttribute sets the attribute at `path` using the supplied Go value.
+//
+// The attribute path and value must be valid with the current schema. If the
+// attribute path already has a value, it will be overwritten. If the attribute
+// path does not have a value, it will be added.
+//
+// The value must not be an untyped nil. Use a typed nil or types package null
+// value function instead. For example with a types.StringType attribute,
+// use (*string)(nil) or types.StringNull().
+//
+// Lists can only have the next element added according to the current length.
+func (s *ResourceIdentity) SetAttribute(ctx context.Context, path path.Path, val interface{}) diag.Diagnostics {
+	data := s.data()
+	diags := data.SetAtPath(ctx, path, val)
+
+	if diags.HasError() {
+		return diags
+	}
+
+	s.Raw = data.TerraformValue
+
+	return diags
+}
+
+func (s ResourceIdentity) data() *fwschemadata.Data {
+	return &fwschemadata.Data{
+		Description:    fwschemadata.DataDescriptionResourceIdentity,
+		Schema:         s.Schema,
+		TerraformValue: s.Raw,
+	}
+}