Documentation ¶
Index ¶
- func BuildDataSourceAttributeMap(attributes map[string]AttributeBuilder) map[string]dataschema.Attribute
- func BuildDataSourceBlockMap(attributes map[string]BlockBuilder) map[string]dataschema.Block
- func BuildResourceAttributeMap(attributes map[string]AttributeBuilder) map[string]schema.Attribute
- func BuildResourceBlockMap(attributes map[string]BlockBuilder) map[string]schema.Block
- func DataSourceStructToSchema(v any, customizeSchema func(CustomizableSchema) CustomizableSchema) dataschema.Schema
- func DataSourceStructToSchemaMap(v any, customizeSchema func(CustomizableSchema) CustomizableSchema) (map[string]dataschema.Attribute, map[string]dataschema.Block)
- func ResourceStructToSchema(v any, customizeSchema func(CustomizableSchema) CustomizableSchema) schema.Schema
- func ResourceStructToSchemaMap(v any, customizeSchema func(CustomizableSchema) CustomizableSchema) (map[string]schema.Attribute, map[string]schema.Block)
- type AttributeBuilder
- type BaseSchemaBuilder
- type BlockBuilder
- type BoolAttributeBuilder
- func (a BoolAttributeBuilder) AddPlanModifier(v planmodifier.Bool) BaseSchemaBuilder
- func (a BoolAttributeBuilder) AddValidator(v validator.Bool) BaseSchemaBuilder
- func (a BoolAttributeBuilder) BuildDataSourceAttribute() dataschema.Attribute
- func (a BoolAttributeBuilder) BuildResourceAttribute() schema.Attribute
- func (a BoolAttributeBuilder) SetComputed() BaseSchemaBuilder
- func (a BoolAttributeBuilder) SetDeprecated(msg string) BaseSchemaBuilder
- func (a BoolAttributeBuilder) SetOptional() BaseSchemaBuilder
- func (a BoolAttributeBuilder) SetReadOnly() BaseSchemaBuilder
- func (a BoolAttributeBuilder) SetRequired() BaseSchemaBuilder
- func (a BoolAttributeBuilder) SetSensitive() BaseSchemaBuilder
- type CustomizableSchema
- func (s *CustomizableSchema) AddPlanModifier(v any, path ...string) *CustomizableSchema
- func (s *CustomizableSchema) AddValidator(v any, path ...string) *CustomizableSchema
- func (s *CustomizableSchema) SetComputed(path ...string) *CustomizableSchema
- func (s *CustomizableSchema) SetDeprecated(msg string, path ...string) *CustomizableSchema
- func (s *CustomizableSchema) SetOptional(path ...string) *CustomizableSchema
- func (s *CustomizableSchema) SetReadOnly(path ...string) *CustomizableSchema
- func (s *CustomizableSchema) SetRequired(path ...string) *CustomizableSchema
- func (s *CustomizableSchema) SetSensitive(path ...string) *CustomizableSchema
- func (s *CustomizableSchema) ToNestedBlockObject() NestedBlockObject
- type Float64AttributeBuilder
- func (a Float64AttributeBuilder) AddPlanModifier(v planmodifier.Float64) BaseSchemaBuilder
- func (a Float64AttributeBuilder) AddValidator(v validator.Float64) BaseSchemaBuilder
- func (a Float64AttributeBuilder) BuildDataSourceAttribute() dataschema.Attribute
- func (a Float64AttributeBuilder) BuildResourceAttribute() schema.Attribute
- func (a Float64AttributeBuilder) SetComputed() BaseSchemaBuilder
- func (a Float64AttributeBuilder) SetDeprecated(msg string) BaseSchemaBuilder
- func (a Float64AttributeBuilder) SetOptional() BaseSchemaBuilder
- func (a Float64AttributeBuilder) SetReadOnly() BaseSchemaBuilder
- func (a Float64AttributeBuilder) SetRequired() BaseSchemaBuilder
- func (a Float64AttributeBuilder) SetSensitive() BaseSchemaBuilder
- type Int64AttributeBuilder
- func (a Int64AttributeBuilder) AddPlanModifier(v planmodifier.Int64) BaseSchemaBuilder
- func (a Int64AttributeBuilder) AddValidator(v validator.Int64) BaseSchemaBuilder
- func (a Int64AttributeBuilder) BuildDataSourceAttribute() dataschema.Attribute
- func (a Int64AttributeBuilder) BuildResourceAttribute() schema.Attribute
- func (a Int64AttributeBuilder) SetComputed() BaseSchemaBuilder
- func (a Int64AttributeBuilder) SetDeprecated(msg string) BaseSchemaBuilder
- func (a Int64AttributeBuilder) SetOptional() BaseSchemaBuilder
- func (a Int64AttributeBuilder) SetReadOnly() BaseSchemaBuilder
- func (a Int64AttributeBuilder) SetRequired() BaseSchemaBuilder
- func (a Int64AttributeBuilder) SetSensitive() BaseSchemaBuilder
- type ListAttributeBuilder
- func (a ListAttributeBuilder) AddPlanModifier(v planmodifier.List) BaseSchemaBuilder
- func (a ListAttributeBuilder) AddValidator(v validator.List) BaseSchemaBuilder
- func (a ListAttributeBuilder) BuildDataSourceAttribute() dataschema.Attribute
- func (a ListAttributeBuilder) BuildResourceAttribute() schema.Attribute
- func (a ListAttributeBuilder) SetComputed() BaseSchemaBuilder
- func (a ListAttributeBuilder) SetDeprecated(msg string) BaseSchemaBuilder
- func (a ListAttributeBuilder) SetOptional() BaseSchemaBuilder
- func (a ListAttributeBuilder) SetReadOnly() BaseSchemaBuilder
- func (a ListAttributeBuilder) SetRequired() BaseSchemaBuilder
- func (a ListAttributeBuilder) SetSensitive() BaseSchemaBuilder
- type ListNestedAttributeBuilder
- func (a ListNestedAttributeBuilder) AddPlanModifier(v planmodifier.List) BaseSchemaBuilder
- func (a ListNestedAttributeBuilder) AddValidator(v validator.List) BaseSchemaBuilder
- func (a ListNestedAttributeBuilder) BuildDataSourceAttribute() dataschema.Attribute
- func (a ListNestedAttributeBuilder) BuildResourceAttribute() schema.Attribute
- func (a ListNestedAttributeBuilder) SetComputed() BaseSchemaBuilder
- func (a ListNestedAttributeBuilder) SetDeprecated(msg string) BaseSchemaBuilder
- func (a ListNestedAttributeBuilder) SetOptional() BaseSchemaBuilder
- func (a ListNestedAttributeBuilder) SetReadOnly() BaseSchemaBuilder
- func (a ListNestedAttributeBuilder) SetRequired() BaseSchemaBuilder
- func (a ListNestedAttributeBuilder) SetSensitive() BaseSchemaBuilder
- type ListNestedBlockBuilder
- func (a ListNestedBlockBuilder) AddPlanModifier(v planmodifier.List) BaseSchemaBuilder
- func (a ListNestedBlockBuilder) AddValidator(v validator.List) BaseSchemaBuilder
- func (a ListNestedBlockBuilder) BuildDataSourceBlock() dataschema.Block
- func (a ListNestedBlockBuilder) BuildResourceBlock() schema.Block
- func (a ListNestedBlockBuilder) SetComputed() BaseSchemaBuilder
- func (a ListNestedBlockBuilder) SetDeprecated(msg string) BaseSchemaBuilder
- func (a ListNestedBlockBuilder) SetOptional() BaseSchemaBuilder
- func (a ListNestedBlockBuilder) SetReadOnly() BaseSchemaBuilder
- func (a ListNestedBlockBuilder) SetRequired() BaseSchemaBuilder
- func (a ListNestedBlockBuilder) SetSensitive() BaseSchemaBuilder
- type MapAttributeBuilder
- func (a MapAttributeBuilder) AddPlanModifier(v planmodifier.Map) BaseSchemaBuilder
- func (a MapAttributeBuilder) AddValidator(v validator.Map) BaseSchemaBuilder
- func (a MapAttributeBuilder) BuildDataSourceAttribute() dataschema.Attribute
- func (a MapAttributeBuilder) BuildResourceAttribute() schema.Attribute
- func (a MapAttributeBuilder) SetComputed() BaseSchemaBuilder
- func (a MapAttributeBuilder) SetDeprecated(msg string) BaseSchemaBuilder
- func (a MapAttributeBuilder) SetOptional() BaseSchemaBuilder
- func (a MapAttributeBuilder) SetReadOnly() BaseSchemaBuilder
- func (a MapAttributeBuilder) SetRequired() BaseSchemaBuilder
- func (a MapAttributeBuilder) SetSensitive() BaseSchemaBuilder
- type MapNestedAttributeBuilder
- func (a MapNestedAttributeBuilder) AddPlanModifier(v planmodifier.Map) BaseSchemaBuilder
- func (a MapNestedAttributeBuilder) AddValidator(v validator.Map) BaseSchemaBuilder
- func (a MapNestedAttributeBuilder) BuildDataSourceAttribute() dataschema.Attribute
- func (a MapNestedAttributeBuilder) BuildResourceAttribute() schema.Attribute
- func (a MapNestedAttributeBuilder) SetComputed() BaseSchemaBuilder
- func (a MapNestedAttributeBuilder) SetDeprecated(msg string) BaseSchemaBuilder
- func (a MapNestedAttributeBuilder) SetOptional() BaseSchemaBuilder
- func (a MapNestedAttributeBuilder) SetReadOnly() BaseSchemaBuilder
- func (a MapNestedAttributeBuilder) SetRequired() BaseSchemaBuilder
- func (a MapNestedAttributeBuilder) SetSensitive() BaseSchemaBuilder
- type NestedAttributeObject
- type NestedBlockObject
- type SingleNestedAttributeBuilder
- func (a SingleNestedAttributeBuilder) AddPlanModifier(v planmodifier.Object) BaseSchemaBuilder
- func (a SingleNestedAttributeBuilder) AddValidator(v validator.Object) BaseSchemaBuilder
- func (a SingleNestedAttributeBuilder) BuildDataSourceAttribute() dataschema.Attribute
- func (a SingleNestedAttributeBuilder) BuildResourceAttribute() schema.Attribute
- func (a SingleNestedAttributeBuilder) SetComputed() BaseSchemaBuilder
- func (a SingleNestedAttributeBuilder) SetDeprecated(msg string) BaseSchemaBuilder
- func (a SingleNestedAttributeBuilder) SetOptional() BaseSchemaBuilder
- func (a SingleNestedAttributeBuilder) SetReadOnly() BaseSchemaBuilder
- func (a SingleNestedAttributeBuilder) SetRequired() BaseSchemaBuilder
- func (a SingleNestedAttributeBuilder) SetSensitive() BaseSchemaBuilder
- type SingleNestedBlockBuilder
- func (a SingleNestedBlockBuilder) AddPlanModifier(v planmodifier.Object) BaseSchemaBuilder
- func (a SingleNestedBlockBuilder) AddValidator(v validator.Object) BaseSchemaBuilder
- func (a SingleNestedBlockBuilder) BuildDataSourceAttribute() dataschema.Attribute
- func (a SingleNestedBlockBuilder) BuildDataSourceBlock() dataschema.Block
- func (a SingleNestedBlockBuilder) BuildResourceAttribute() schema.Attribute
- func (a SingleNestedBlockBuilder) BuildResourceBlock() schema.Block
- func (a SingleNestedBlockBuilder) SetComputed() BaseSchemaBuilder
- func (a SingleNestedBlockBuilder) SetDeprecated(msg string) BaseSchemaBuilder
- func (a SingleNestedBlockBuilder) SetOptional() BaseSchemaBuilder
- func (a SingleNestedBlockBuilder) SetReadOnly() BaseSchemaBuilder
- func (a SingleNestedBlockBuilder) SetRequired() BaseSchemaBuilder
- func (a SingleNestedBlockBuilder) SetSensitive() BaseSchemaBuilder
- type StringAttributeBuilder
- func (a StringAttributeBuilder) AddPlanModifier(v planmodifier.String) BaseSchemaBuilder
- func (a StringAttributeBuilder) AddValidator(v validator.String) BaseSchemaBuilder
- func (a StringAttributeBuilder) BuildDataSourceAttribute() dataschema.Attribute
- func (a StringAttributeBuilder) BuildResourceAttribute() schema.Attribute
- func (a StringAttributeBuilder) SetComputed() BaseSchemaBuilder
- func (a StringAttributeBuilder) SetDeprecated(msg string) BaseSchemaBuilder
- func (a StringAttributeBuilder) SetOptional() BaseSchemaBuilder
- func (a StringAttributeBuilder) SetReadOnly() BaseSchemaBuilder
- func (a StringAttributeBuilder) SetRequired() BaseSchemaBuilder
- func (a StringAttributeBuilder) SetSensitive() BaseSchemaBuilder
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func BuildDataSourceAttributeMap ¶
func BuildDataSourceAttributeMap(attributes map[string]AttributeBuilder) map[string]dataschema.Attribute
BuildDataSourceAttributeMap takes a map from string to AttributeBuilder and returns a map from string to datasource.schema.Attribute.
func BuildDataSourceBlockMap ¶ added in v1.54.0
func BuildDataSourceBlockMap(attributes map[string]BlockBuilder) map[string]dataschema.Block
func BuildResourceAttributeMap ¶
func BuildResourceAttributeMap(attributes map[string]AttributeBuilder) map[string]schema.Attribute
BuildResourceAttributeMap takes a map from string to AttributeBuilder and returns a map from string to resource.schema.Attribute.
func BuildResourceBlockMap ¶ added in v1.54.0
func BuildResourceBlockMap(attributes map[string]BlockBuilder) map[string]schema.Block
func DataSourceStructToSchema ¶
func DataSourceStructToSchema(v any, customizeSchema func(CustomizableSchema) CustomizableSchema) dataschema.Schema
DataSourceStructToSchema builds a data source schema from a tfsdk struct, with custoimzations applied.
func DataSourceStructToSchemaMap ¶
func DataSourceStructToSchemaMap(v any, customizeSchema func(CustomizableSchema) CustomizableSchema) (map[string]dataschema.Attribute, map[string]dataschema.Block)
DataSourceStructToSchemaMap returns twp maps from string to data source schema attributes and blocks using a tfsdk struct, with custoimzations applied.
func ResourceStructToSchema ¶
func ResourceStructToSchema(v any, customizeSchema func(CustomizableSchema) CustomizableSchema) schema.Schema
ResourceStructToSchema builds a resource schema from a tfsdk struct, with custoimzations applied.
func ResourceStructToSchemaMap ¶
func ResourceStructToSchemaMap(v any, customizeSchema func(CustomizableSchema) CustomizableSchema) (map[string]schema.Attribute, map[string]schema.Block)
ResourceStructToSchemaMap returns two maps from string to resource schema attributes and blocks using a tfsdk struct, with custoimzations applied.
Types ¶
type AttributeBuilder ¶
type AttributeBuilder interface { BaseSchemaBuilder BuildDataSourceAttribute() dataschema.Attribute BuildResourceAttribute() schema.Attribute }
AttributeBuilder is the common interface for all attributes, it can be used to build data source attribute and resource attribute. We need this because in terraform plugin framework, the datasource schema and resource schema are in two separate packages. This common interface prevents us from keeping two copies of StructToSchema and CustomizableSchema.
type BaseSchemaBuilder ¶ added in v1.54.0
type BaseSchemaBuilder interface { SetOptional() BaseSchemaBuilder SetRequired() BaseSchemaBuilder SetSensitive() BaseSchemaBuilder SetComputed() BaseSchemaBuilder SetReadOnly() BaseSchemaBuilder SetDeprecated(string) BaseSchemaBuilder }
BaseSchemaBuilder is the common interface for all blocks and attributes, it can be used to build data source and resource. Both AttributeBuilder and BlockBuilder extend this interface.
type BlockBuilder ¶ added in v1.54.0
type BlockBuilder interface { BaseSchemaBuilder BuildDataSourceBlock() dataschema.Block BuildResourceBlock() schema.Block }
BlockBuilder is the common interface for all blocks, it can be used to build data source blocks and resource blocks. We need this because in terraform plugin framework, the datasource schema and resource schema are in two separate packages. This common interface prevents us from keeping two copies of StructToSchema and CustomizableSchema.
type BoolAttributeBuilder ¶
type BoolAttributeBuilder struct { Optional bool Required bool Sensitive bool Computed bool DeprecationMessage string Validators []validator.Bool PlanModifiers []planmodifier.Bool }
func (BoolAttributeBuilder) AddPlanModifier ¶
func (a BoolAttributeBuilder) AddPlanModifier(v planmodifier.Bool) BaseSchemaBuilder
func (BoolAttributeBuilder) AddValidator ¶
func (a BoolAttributeBuilder) AddValidator(v validator.Bool) BaseSchemaBuilder
func (BoolAttributeBuilder) BuildDataSourceAttribute ¶
func (a BoolAttributeBuilder) BuildDataSourceAttribute() dataschema.Attribute
func (BoolAttributeBuilder) BuildResourceAttribute ¶
func (a BoolAttributeBuilder) BuildResourceAttribute() schema.Attribute
func (BoolAttributeBuilder) SetComputed ¶
func (a BoolAttributeBuilder) SetComputed() BaseSchemaBuilder
func (BoolAttributeBuilder) SetDeprecated ¶
func (a BoolAttributeBuilder) SetDeprecated(msg string) BaseSchemaBuilder
func (BoolAttributeBuilder) SetOptional ¶
func (a BoolAttributeBuilder) SetOptional() BaseSchemaBuilder
func (BoolAttributeBuilder) SetReadOnly ¶
func (a BoolAttributeBuilder) SetReadOnly() BaseSchemaBuilder
func (BoolAttributeBuilder) SetRequired ¶
func (a BoolAttributeBuilder) SetRequired() BaseSchemaBuilder
func (BoolAttributeBuilder) SetSensitive ¶
func (a BoolAttributeBuilder) SetSensitive() BaseSchemaBuilder
type CustomizableSchema ¶
type CustomizableSchema struct {
// contains filtered or unexported fields
}
CustomizableSchema is a wrapper struct on top of BaseSchemaBuilder that can be used to navigate through nested schema add customizations.
func ConstructCustomizableSchema ¶
func ConstructCustomizableSchema(nestedObject NestedBlockObject) *CustomizableSchema
ConstructCustomizableSchema constructs a CustomizableSchema given a NestedBlockObject.
func (*CustomizableSchema) AddPlanModifier ¶
func (s *CustomizableSchema) AddPlanModifier(v any, path ...string) *CustomizableSchema
func (*CustomizableSchema) AddValidator ¶
func (s *CustomizableSchema) AddValidator(v any, path ...string) *CustomizableSchema
func (*CustomizableSchema) SetComputed ¶
func (s *CustomizableSchema) SetComputed(path ...string) *CustomizableSchema
func (*CustomizableSchema) SetDeprecated ¶
func (s *CustomizableSchema) SetDeprecated(msg string, path ...string) *CustomizableSchema
func (*CustomizableSchema) SetOptional ¶
func (s *CustomizableSchema) SetOptional(path ...string) *CustomizableSchema
func (*CustomizableSchema) SetReadOnly ¶
func (s *CustomizableSchema) SetReadOnly(path ...string) *CustomizableSchema
SetReadOnly sets the schema to be read-only (i.e. computed, non-optional). This should be used for fields that are not user-configurable but are returned by the platform.
func (*CustomizableSchema) SetRequired ¶
func (s *CustomizableSchema) SetRequired(path ...string) *CustomizableSchema
func (*CustomizableSchema) SetSensitive ¶
func (s *CustomizableSchema) SetSensitive(path ...string) *CustomizableSchema
func (*CustomizableSchema) ToNestedBlockObject ¶ added in v1.54.0
func (s *CustomizableSchema) ToNestedBlockObject() NestedBlockObject
ToAttributeMap converts CustomizableSchema into BaseSchemaBuilder.
type Float64AttributeBuilder ¶
type Float64AttributeBuilder struct { Optional bool Required bool Sensitive bool Computed bool DeprecationMessage string Validators []validator.Float64 PlanModifiers []planmodifier.Float64 }
func (Float64AttributeBuilder) AddPlanModifier ¶
func (a Float64AttributeBuilder) AddPlanModifier(v planmodifier.Float64) BaseSchemaBuilder
func (Float64AttributeBuilder) AddValidator ¶
func (a Float64AttributeBuilder) AddValidator(v validator.Float64) BaseSchemaBuilder
func (Float64AttributeBuilder) BuildDataSourceAttribute ¶
func (a Float64AttributeBuilder) BuildDataSourceAttribute() dataschema.Attribute
func (Float64AttributeBuilder) BuildResourceAttribute ¶
func (a Float64AttributeBuilder) BuildResourceAttribute() schema.Attribute
func (Float64AttributeBuilder) SetComputed ¶
func (a Float64AttributeBuilder) SetComputed() BaseSchemaBuilder
func (Float64AttributeBuilder) SetDeprecated ¶
func (a Float64AttributeBuilder) SetDeprecated(msg string) BaseSchemaBuilder
func (Float64AttributeBuilder) SetOptional ¶
func (a Float64AttributeBuilder) SetOptional() BaseSchemaBuilder
func (Float64AttributeBuilder) SetReadOnly ¶
func (a Float64AttributeBuilder) SetReadOnly() BaseSchemaBuilder
func (Float64AttributeBuilder) SetRequired ¶
func (a Float64AttributeBuilder) SetRequired() BaseSchemaBuilder
func (Float64AttributeBuilder) SetSensitive ¶
func (a Float64AttributeBuilder) SetSensitive() BaseSchemaBuilder
type Int64AttributeBuilder ¶
type Int64AttributeBuilder struct { Optional bool Required bool Sensitive bool Computed bool DeprecationMessage string Validators []validator.Int64 PlanModifiers []planmodifier.Int64 }
func (Int64AttributeBuilder) AddPlanModifier ¶
func (a Int64AttributeBuilder) AddPlanModifier(v planmodifier.Int64) BaseSchemaBuilder
func (Int64AttributeBuilder) AddValidator ¶
func (a Int64AttributeBuilder) AddValidator(v validator.Int64) BaseSchemaBuilder
func (Int64AttributeBuilder) BuildDataSourceAttribute ¶
func (a Int64AttributeBuilder) BuildDataSourceAttribute() dataschema.Attribute
func (Int64AttributeBuilder) BuildResourceAttribute ¶
func (a Int64AttributeBuilder) BuildResourceAttribute() schema.Attribute
func (Int64AttributeBuilder) SetComputed ¶
func (a Int64AttributeBuilder) SetComputed() BaseSchemaBuilder
func (Int64AttributeBuilder) SetDeprecated ¶
func (a Int64AttributeBuilder) SetDeprecated(msg string) BaseSchemaBuilder
func (Int64AttributeBuilder) SetOptional ¶
func (a Int64AttributeBuilder) SetOptional() BaseSchemaBuilder
func (Int64AttributeBuilder) SetReadOnly ¶
func (a Int64AttributeBuilder) SetReadOnly() BaseSchemaBuilder
func (Int64AttributeBuilder) SetRequired ¶
func (a Int64AttributeBuilder) SetRequired() BaseSchemaBuilder
func (Int64AttributeBuilder) SetSensitive ¶
func (a Int64AttributeBuilder) SetSensitive() BaseSchemaBuilder
type ListAttributeBuilder ¶
type ListAttributeBuilder struct { ElementType attr.Type Optional bool Required bool Sensitive bool Computed bool DeprecationMessage string Validators []validator.List PlanModifiers []planmodifier.List }
ListAttributteBuilder represents a list of primitive types.
func (ListAttributeBuilder) AddPlanModifier ¶
func (a ListAttributeBuilder) AddPlanModifier(v planmodifier.List) BaseSchemaBuilder
func (ListAttributeBuilder) AddValidator ¶
func (a ListAttributeBuilder) AddValidator(v validator.List) BaseSchemaBuilder
func (ListAttributeBuilder) BuildDataSourceAttribute ¶
func (a ListAttributeBuilder) BuildDataSourceAttribute() dataschema.Attribute
func (ListAttributeBuilder) BuildResourceAttribute ¶
func (a ListAttributeBuilder) BuildResourceAttribute() schema.Attribute
func (ListAttributeBuilder) SetComputed ¶
func (a ListAttributeBuilder) SetComputed() BaseSchemaBuilder
func (ListAttributeBuilder) SetDeprecated ¶
func (a ListAttributeBuilder) SetDeprecated(msg string) BaseSchemaBuilder
func (ListAttributeBuilder) SetOptional ¶
func (a ListAttributeBuilder) SetOptional() BaseSchemaBuilder
func (ListAttributeBuilder) SetReadOnly ¶
func (a ListAttributeBuilder) SetReadOnly() BaseSchemaBuilder
func (ListAttributeBuilder) SetRequired ¶
func (a ListAttributeBuilder) SetRequired() BaseSchemaBuilder
func (ListAttributeBuilder) SetSensitive ¶
func (a ListAttributeBuilder) SetSensitive() BaseSchemaBuilder
type ListNestedAttributeBuilder ¶
type ListNestedAttributeBuilder struct { NestedObject NestedAttributeObject Optional bool Required bool Sensitive bool Computed bool DeprecationMessage string Validators []validator.List PlanModifiers []planmodifier.List }
ListNestedAttributteBuilder represents a list of complex (non-primitive) types.
func (ListNestedAttributeBuilder) AddPlanModifier ¶
func (a ListNestedAttributeBuilder) AddPlanModifier(v planmodifier.List) BaseSchemaBuilder
func (ListNestedAttributeBuilder) AddValidator ¶
func (a ListNestedAttributeBuilder) AddValidator(v validator.List) BaseSchemaBuilder
func (ListNestedAttributeBuilder) BuildDataSourceAttribute ¶
func (a ListNestedAttributeBuilder) BuildDataSourceAttribute() dataschema.Attribute
func (ListNestedAttributeBuilder) BuildResourceAttribute ¶
func (a ListNestedAttributeBuilder) BuildResourceAttribute() schema.Attribute
func (ListNestedAttributeBuilder) SetComputed ¶
func (a ListNestedAttributeBuilder) SetComputed() BaseSchemaBuilder
func (ListNestedAttributeBuilder) SetDeprecated ¶
func (a ListNestedAttributeBuilder) SetDeprecated(msg string) BaseSchemaBuilder
func (ListNestedAttributeBuilder) SetOptional ¶
func (a ListNestedAttributeBuilder) SetOptional() BaseSchemaBuilder
func (ListNestedAttributeBuilder) SetReadOnly ¶
func (a ListNestedAttributeBuilder) SetReadOnly() BaseSchemaBuilder
func (ListNestedAttributeBuilder) SetRequired ¶
func (a ListNestedAttributeBuilder) SetRequired() BaseSchemaBuilder
func (ListNestedAttributeBuilder) SetSensitive ¶
func (a ListNestedAttributeBuilder) SetSensitive() BaseSchemaBuilder
type ListNestedBlockBuilder ¶ added in v1.54.0
type ListNestedBlockBuilder struct { NestedObject NestedBlockObject Optional bool Required bool Sensitive bool Computed bool DeprecationMessage string Validators []validator.List PlanModifiers []planmodifier.List }
ListNestedBlockBuilder represents a list of complex (non-primitive) types. To be compatible with our sdkv2 schema, all struct types in the gosdk are represented with this type.
func (ListNestedBlockBuilder) AddPlanModifier ¶ added in v1.54.0
func (a ListNestedBlockBuilder) AddPlanModifier(v planmodifier.List) BaseSchemaBuilder
func (ListNestedBlockBuilder) AddValidator ¶ added in v1.54.0
func (a ListNestedBlockBuilder) AddValidator(v validator.List) BaseSchemaBuilder
func (ListNestedBlockBuilder) BuildDataSourceBlock ¶ added in v1.54.0
func (a ListNestedBlockBuilder) BuildDataSourceBlock() dataschema.Block
func (ListNestedBlockBuilder) BuildResourceBlock ¶ added in v1.54.0
func (a ListNestedBlockBuilder) BuildResourceBlock() schema.Block
func (ListNestedBlockBuilder) SetComputed ¶ added in v1.54.0
func (a ListNestedBlockBuilder) SetComputed() BaseSchemaBuilder
func (ListNestedBlockBuilder) SetDeprecated ¶ added in v1.54.0
func (a ListNestedBlockBuilder) SetDeprecated(msg string) BaseSchemaBuilder
func (ListNestedBlockBuilder) SetOptional ¶ added in v1.54.0
func (a ListNestedBlockBuilder) SetOptional() BaseSchemaBuilder
func (ListNestedBlockBuilder) SetReadOnly ¶ added in v1.54.0
func (a ListNestedBlockBuilder) SetReadOnly() BaseSchemaBuilder
func (ListNestedBlockBuilder) SetRequired ¶ added in v1.54.0
func (a ListNestedBlockBuilder) SetRequired() BaseSchemaBuilder
func (ListNestedBlockBuilder) SetSensitive ¶ added in v1.54.0
func (a ListNestedBlockBuilder) SetSensitive() BaseSchemaBuilder
type MapAttributeBuilder ¶
type MapAttributeBuilder struct { ElementType attr.Type Optional bool Required bool Sensitive bool Computed bool DeprecationMessage string Validators []validator.Map PlanModifiers []planmodifier.Map }
MapAttributteBuilder represents a map of primitive types.
func (MapAttributeBuilder) AddPlanModifier ¶
func (a MapAttributeBuilder) AddPlanModifier(v planmodifier.Map) BaseSchemaBuilder
func (MapAttributeBuilder) AddValidator ¶
func (a MapAttributeBuilder) AddValidator(v validator.Map) BaseSchemaBuilder
func (MapAttributeBuilder) BuildDataSourceAttribute ¶
func (a MapAttributeBuilder) BuildDataSourceAttribute() dataschema.Attribute
func (MapAttributeBuilder) BuildResourceAttribute ¶
func (a MapAttributeBuilder) BuildResourceAttribute() schema.Attribute
func (MapAttributeBuilder) SetComputed ¶
func (a MapAttributeBuilder) SetComputed() BaseSchemaBuilder
func (MapAttributeBuilder) SetDeprecated ¶
func (a MapAttributeBuilder) SetDeprecated(msg string) BaseSchemaBuilder
func (MapAttributeBuilder) SetOptional ¶
func (a MapAttributeBuilder) SetOptional() BaseSchemaBuilder
func (MapAttributeBuilder) SetReadOnly ¶
func (a MapAttributeBuilder) SetReadOnly() BaseSchemaBuilder
func (MapAttributeBuilder) SetRequired ¶
func (a MapAttributeBuilder) SetRequired() BaseSchemaBuilder
func (MapAttributeBuilder) SetSensitive ¶
func (a MapAttributeBuilder) SetSensitive() BaseSchemaBuilder
type MapNestedAttributeBuilder ¶
type MapNestedAttributeBuilder struct { NestedObject NestedAttributeObject Optional bool Required bool Sensitive bool Computed bool DeprecationMessage string Validators []validator.Map PlanModifiers []planmodifier.Map }
MapNestedAttributteBuilder represents a map of complex (non-primitive) types.
func (MapNestedAttributeBuilder) AddPlanModifier ¶
func (a MapNestedAttributeBuilder) AddPlanModifier(v planmodifier.Map) BaseSchemaBuilder
func (MapNestedAttributeBuilder) AddValidator ¶
func (a MapNestedAttributeBuilder) AddValidator(v validator.Map) BaseSchemaBuilder
func (MapNestedAttributeBuilder) BuildDataSourceAttribute ¶
func (a MapNestedAttributeBuilder) BuildDataSourceAttribute() dataschema.Attribute
func (MapNestedAttributeBuilder) BuildResourceAttribute ¶
func (a MapNestedAttributeBuilder) BuildResourceAttribute() schema.Attribute
func (MapNestedAttributeBuilder) SetComputed ¶
func (a MapNestedAttributeBuilder) SetComputed() BaseSchemaBuilder
func (MapNestedAttributeBuilder) SetDeprecated ¶
func (a MapNestedAttributeBuilder) SetDeprecated(msg string) BaseSchemaBuilder
func (MapNestedAttributeBuilder) SetOptional ¶
func (a MapNestedAttributeBuilder) SetOptional() BaseSchemaBuilder
func (MapNestedAttributeBuilder) SetReadOnly ¶
func (a MapNestedAttributeBuilder) SetReadOnly() BaseSchemaBuilder
func (MapNestedAttributeBuilder) SetRequired ¶
func (a MapNestedAttributeBuilder) SetRequired() BaseSchemaBuilder
func (MapNestedAttributeBuilder) SetSensitive ¶
func (a MapNestedAttributeBuilder) SetSensitive() BaseSchemaBuilder
type NestedAttributeObject ¶
type NestedAttributeObject struct {
Attributes map[string]AttributeBuilder
}
NestedAttributteObject is the intermediate type for nested complex (non-primitive) types.
func (NestedAttributeObject) BuildDataSourceAttribute ¶
func (a NestedAttributeObject) BuildDataSourceAttribute() dataschema.NestedAttributeObject
func (NestedAttributeObject) BuildResourceAttribute ¶
func (a NestedAttributeObject) BuildResourceAttribute() schema.NestedAttributeObject
type NestedBlockObject ¶ added in v1.54.0
type NestedBlockObject struct { Attributes map[string]AttributeBuilder Blocks map[string]BlockBuilder }
NestedAttributteObject is the intermediate type for nested complex (non-primitive) types.
func (NestedBlockObject) BuildDataSourceAttribute ¶ added in v1.54.0
func (a NestedBlockObject) BuildDataSourceAttribute() dataschema.NestedBlockObject
func (NestedBlockObject) BuildResourceAttribute ¶ added in v1.54.0
func (a NestedBlockObject) BuildResourceAttribute() schema.NestedBlockObject
type SingleNestedAttributeBuilder ¶
type SingleNestedAttributeBuilder struct { Attributes map[string]AttributeBuilder Optional bool Required bool Sensitive bool Computed bool DeprecationMessage string Validators []validator.Object PlanModifiers []planmodifier.Object }
SingleNestedAttributteBuilder represents single complex (struct) types.
func (SingleNestedAttributeBuilder) AddPlanModifier ¶
func (a SingleNestedAttributeBuilder) AddPlanModifier(v planmodifier.Object) BaseSchemaBuilder
func (SingleNestedAttributeBuilder) AddValidator ¶
func (a SingleNestedAttributeBuilder) AddValidator(v validator.Object) BaseSchemaBuilder
func (SingleNestedAttributeBuilder) BuildDataSourceAttribute ¶
func (a SingleNestedAttributeBuilder) BuildDataSourceAttribute() dataschema.Attribute
func (SingleNestedAttributeBuilder) BuildResourceAttribute ¶
func (a SingleNestedAttributeBuilder) BuildResourceAttribute() schema.Attribute
func (SingleNestedAttributeBuilder) SetComputed ¶
func (a SingleNestedAttributeBuilder) SetComputed() BaseSchemaBuilder
func (SingleNestedAttributeBuilder) SetDeprecated ¶
func (a SingleNestedAttributeBuilder) SetDeprecated(msg string) BaseSchemaBuilder
func (SingleNestedAttributeBuilder) SetOptional ¶
func (a SingleNestedAttributeBuilder) SetOptional() BaseSchemaBuilder
func (SingleNestedAttributeBuilder) SetReadOnly ¶
func (a SingleNestedAttributeBuilder) SetReadOnly() BaseSchemaBuilder
func (SingleNestedAttributeBuilder) SetRequired ¶
func (a SingleNestedAttributeBuilder) SetRequired() BaseSchemaBuilder
func (SingleNestedAttributeBuilder) SetSensitive ¶
func (a SingleNestedAttributeBuilder) SetSensitive() BaseSchemaBuilder
type SingleNestedBlockBuilder ¶ added in v1.54.0
type SingleNestedBlockBuilder struct { NestedObject NestedBlockObject Optional bool Required bool Sensitive bool Computed bool DeprecationMessage string Validators []validator.Object PlanModifiers []planmodifier.Object }
SingleNestedBlockBuilder represents a single nested complex (non-primitive) type.
func (SingleNestedBlockBuilder) AddPlanModifier ¶ added in v1.54.0
func (a SingleNestedBlockBuilder) AddPlanModifier(v planmodifier.Object) BaseSchemaBuilder
func (SingleNestedBlockBuilder) AddValidator ¶ added in v1.54.0
func (a SingleNestedBlockBuilder) AddValidator(v validator.Object) BaseSchemaBuilder
func (SingleNestedBlockBuilder) BuildDataSourceAttribute ¶ added in v1.54.0
func (a SingleNestedBlockBuilder) BuildDataSourceAttribute() dataschema.Attribute
func (SingleNestedBlockBuilder) BuildDataSourceBlock ¶ added in v1.54.0
func (a SingleNestedBlockBuilder) BuildDataSourceBlock() dataschema.Block
func (SingleNestedBlockBuilder) BuildResourceAttribute ¶ added in v1.54.0
func (a SingleNestedBlockBuilder) BuildResourceAttribute() schema.Attribute
func (SingleNestedBlockBuilder) BuildResourceBlock ¶ added in v1.54.0
func (a SingleNestedBlockBuilder) BuildResourceBlock() schema.Block
func (SingleNestedBlockBuilder) SetComputed ¶ added in v1.54.0
func (a SingleNestedBlockBuilder) SetComputed() BaseSchemaBuilder
func (SingleNestedBlockBuilder) SetDeprecated ¶ added in v1.54.0
func (a SingleNestedBlockBuilder) SetDeprecated(msg string) BaseSchemaBuilder
func (SingleNestedBlockBuilder) SetOptional ¶ added in v1.54.0
func (a SingleNestedBlockBuilder) SetOptional() BaseSchemaBuilder
func (SingleNestedBlockBuilder) SetReadOnly ¶ added in v1.54.0
func (a SingleNestedBlockBuilder) SetReadOnly() BaseSchemaBuilder
func (SingleNestedBlockBuilder) SetRequired ¶ added in v1.54.0
func (a SingleNestedBlockBuilder) SetRequired() BaseSchemaBuilder
func (SingleNestedBlockBuilder) SetSensitive ¶ added in v1.54.0
func (a SingleNestedBlockBuilder) SetSensitive() BaseSchemaBuilder
type StringAttributeBuilder ¶
type StringAttributeBuilder struct { Optional bool Required bool Sensitive bool Computed bool DeprecationMessage string Validators []validator.String PlanModifiers []planmodifier.String }
func (StringAttributeBuilder) AddPlanModifier ¶
func (a StringAttributeBuilder) AddPlanModifier(v planmodifier.String) BaseSchemaBuilder
func (StringAttributeBuilder) AddValidator ¶
func (a StringAttributeBuilder) AddValidator(v validator.String) BaseSchemaBuilder
func (StringAttributeBuilder) BuildDataSourceAttribute ¶
func (a StringAttributeBuilder) BuildDataSourceAttribute() dataschema.Attribute
func (StringAttributeBuilder) BuildResourceAttribute ¶
func (a StringAttributeBuilder) BuildResourceAttribute() schema.Attribute
func (StringAttributeBuilder) SetComputed ¶
func (a StringAttributeBuilder) SetComputed() BaseSchemaBuilder
func (StringAttributeBuilder) SetDeprecated ¶
func (a StringAttributeBuilder) SetDeprecated(msg string) BaseSchemaBuilder
func (StringAttributeBuilder) SetOptional ¶
func (a StringAttributeBuilder) SetOptional() BaseSchemaBuilder
func (StringAttributeBuilder) SetReadOnly ¶
func (a StringAttributeBuilder) SetReadOnly() BaseSchemaBuilder
func (StringAttributeBuilder) SetRequired ¶
func (a StringAttributeBuilder) SetRequired() BaseSchemaBuilder
func (StringAttributeBuilder) SetSensitive ¶
func (a StringAttributeBuilder) SetSensitive() BaseSchemaBuilder
Source Files ¶
- attribute_builder.go
- base_schema_builder.go
- block_builder.go
- bool_attribute.go
- customizable_schema.go
- float64_attribute.go
- int64_attribute.go
- list_attribute.go
- list_nested_attribute.go
- list_nested_block.go
- map_attribute.go
- map_nested_attribute.go
- nested_attribute_object.go
- nested_block_object.go
- single_nested_attribute.go
- single_nested_block.go
- string_attribute.go
- struct_to_schema.go