schema

package
v0.3.0 Latest Latest
Warning

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

 Go to latest Published: Jan 23, 2025 License: MPL-2.0 Imports: 5 Imported by: 0

Documentation

Overview

Package schema contains types associated with generic code handling within the specification, such as validation.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AssociatedExternalType 

type AssociatedExternalType struct {
	//Import defines a code import path, and optional alias.
	Import *code.Import `json:"import,omitempty"`

	// Type defines the AssociatedExternalType type.
	Type string `json:"type"`
}

AssociatedExternalType type represents a type used by an external API SDK that represents the schema type.

func (*AssociatedExternalType) Equal 

func (a *AssociatedExternalType) Equal(other *AssociatedExternalType) bool

Equal returns true if all fields of the given AssociatedExternalType are equal.

func (*AssociatedExternalType) HasImport 

func (a *AssociatedExternalType) HasImport() bool

HasImport returns true if the AssociatedExternalType has a non-empty import path.

type BoolDefault 

type BoolDefault struct {
	// Custom defines a schema definition, and optional imports.
	Custom *CustomDefault `json:"custom,omitempty"`

	// Static defines a specific boolean value.
	Static *bool `json:"static,omitempty"`
}

BoolDefault defines a value, or a custom type for a default boolean value.

func (*BoolDefault) Equal 

func (d *BoolDefault) Equal(other *BoolDefault) bool

Equal returns true if all fields of the given BoolDefault are equal.

type BoolPlanModifier 

type BoolPlanModifier struct {
	// Custom defines a schema definition, and optional imports.
	Custom *CustomPlanModifier `json:"custom,omitempty"`
}

BoolPlanModifier type defines type and function that provides plan modification functionality.

func (BoolPlanModifier) Equal 

func (v BoolPlanModifier) Equal(other BoolPlanModifier) bool

Equal returns true if the fields of the given BoolPlanModifier are equal.

type BoolPlanModifiers 

type BoolPlanModifiers []BoolPlanModifier

BoolPlanModifiers type defines BoolPlanModifier types

func (BoolPlanModifiers) CustomPlanModifiers 

func (v BoolPlanModifiers) CustomPlanModifiers() CustomPlanModifiers

CustomPlanModifiers returns CustomPlanModifier for each BoolPlanModifier.

func (BoolPlanModifiers) Equal 

func (v BoolPlanModifiers) Equal(other BoolPlanModifiers) bool

Equal returns true if the given BoolPlanModifiers is the same length, and each of the BoolPlanModifier entries is equal.

type BoolType 

type BoolType struct {
	// CustomType is a customization of the BoolType.
	CustomType *CustomType `json:"custom_type,omitempty"`
}

BoolType is a representation of a boolean.

type BoolValidator 

type BoolValidator struct {
	// Custom defines a schema definition, and optional imports.
	Custom *CustomValidator `json:"custom,omitempty"`
}

BoolValidator type defines type and function that provides validation functionality.

func (BoolValidator) Equal 

func (v BoolValidator) Equal(other BoolValidator) bool

Equal returns true if the fields of the given BoolValidator equal.

type BoolValidators 

type BoolValidators []BoolValidator

BoolValidators type is a slice of BoolValidator.

func (BoolValidators) CustomValidators 

func (v BoolValidators) CustomValidators() CustomValidators

CustomValidators returns CustomValidator for each BoolValidator.

func (BoolValidators) Equal 

func (v BoolValidators) Equal(other BoolValidators) bool

Equal returns true if the given BoolValidators is the same length, and each of the BoolValidator entries is equal.

type ComputedOptionalRequired 

type ComputedOptionalRequired string
const (
	Computed         ComputedOptionalRequired = "computed"
	ComputedOptional ComputedOptionalRequired = "computed_optional"
	Optional         ComputedOptionalRequired = "optional"
	Required         ComputedOptionalRequired = "required"
)

func (ComputedOptionalRequired) Equal 

func (c ComputedOptionalRequired) Equal(other ComputedOptionalRequired) bool

type CustomDefault 

type CustomDefault struct {
	// Imports defines paths, and optional aliases for imported code.
	Imports []code.Import `json:"imports,omitempty"`

	// SchemaDefinition defines the default for use in the schema.
	SchemaDefinition string `json:"schema_definition"`
}

CustomDefault defines a custom type for a default schema value.

func (*CustomDefault) Equal 

func (c *CustomDefault) Equal(other *CustomDefault) bool

Equal returns true if all fields of the given CustomDefault are equal.

func (*CustomDefault) HasImport 

func (c *CustomDefault) HasImport() bool

HasImport returns true if the CustomDefault has defined imports.

type CustomPlanModifier 

type CustomPlanModifier struct {
	// Imports defines paths, and optional aliases for imported code.
	Imports []code.Import `json:"imports,omitempty"`

	// SchemaDefinition defines the plan modifier for use in the schema.
	SchemaDefinition string `json:"schema_definition"`
}

CustomPlanModifier defines a custom type for a schema plan modifier.

func (*CustomPlanModifier) Equal 

func (c *CustomPlanModifier) Equal(other *CustomPlanModifier) bool

Equal returns true if all fields of the given CustomPlanModifier are equal.

func (*CustomPlanModifier) HasImport 

func (c *CustomPlanModifier) HasImport() bool

HasImport returns true if the CustomPlanModifier has defined imports.

type CustomPlanModifiers 

type CustomPlanModifiers []*CustomPlanModifier

CustomPlanModifiers type is a slice of *CustomPlanModifier.

func (CustomPlanModifiers) Sort 

func (c CustomPlanModifiers) Sort()

Sort will order on the basis of CustomPlanModifier.SchemaDefinition.

type CustomType 

type CustomType struct {
	// Import defines a path, and optional alias for imported code.
	Import *code.Import `json:"import,omitempty"`

	// Type defines the type for use in the schema.
	Type string `json:"type"`

	// ValueType defines the type for use with the value associated
	// with the schema type.
	ValueType string `json:"value_type"`
}

CustomType defines a custom type, and value type for a schema type, and associated value.

func (*CustomType) Equal 

func (c *CustomType) Equal(other *CustomType) bool

Equal returns true if all fields of the given CustomType are equal.

func (*CustomType) HasImport 

func (c *CustomType) HasImport() bool

HasImport returns true if the CustomType has a non-empty import path.

type CustomValidator 

type CustomValidator struct {
	// Imports defines paths, and optional aliases for imported code.
	Imports []code.Import `json:"imports,omitempty"`

	// SchemaDefinition defines the plan modifier for use in the schema.
	SchemaDefinition string `json:"schema_definition"`
}

CustomValidator defines a custom type for a schema validator.

func (*CustomValidator) Equal 

func (c *CustomValidator) Equal(other *CustomValidator) bool

Equal returns true if all fields of the given CustomValidator are equal.

func (*CustomValidator) HasImport 

func (c *CustomValidator) HasImport() bool

HasImport returns true if the CustomValidator has defined imports.

type CustomValidators 

type CustomValidators []*CustomValidator

CustomValidators type is a slice of *CustomValidator.

func (CustomValidators) Sort 

func (c CustomValidators) Sort()

Sort will order on the basis of CustomValidator.SchemaDefinition.

type DynamicDefault 

type DynamicDefault struct {
	// Custom defines a schema definition, and optional imports.
	Custom *CustomDefault `json:"custom,omitempty"`
}

DynamicDefault defines a default dynamic value.

func (*DynamicDefault) Equal 

func (d *DynamicDefault) Equal(other *DynamicDefault) bool

Equal returns true if all fields of the given DynamicDefault are equal.

type DynamicPlanModifier 

type DynamicPlanModifier struct {
	// Custom defines a schema definition, and optional imports.
	Custom *CustomPlanModifier `json:"custom,omitempty"`
}

DynamicPlanModifier type defines type and function that provides plan modification functionality.

func (DynamicPlanModifier) Equal 

func (v DynamicPlanModifier) Equal(other DynamicPlanModifier) bool

Equal returns true if the fields of the given DynamicPlanModifier are equal.

type DynamicPlanModifiers 

type DynamicPlanModifiers []DynamicPlanModifier

DynamicPlanModifiers type defines DynamicPlanModifier types

func (DynamicPlanModifiers) CustomPlanModifiers 

func (v DynamicPlanModifiers) CustomPlanModifiers() CustomPlanModifiers

CustomPlanModifiers returns CustomPlanModifier for each DynamicPlanModifier.

func (DynamicPlanModifiers) Equal 

func (v DynamicPlanModifiers) Equal(other DynamicPlanModifiers) bool

Equal returns true if the given DynamicPlanModifiers is the same length, and each of the DynamicPlanModifier entries is equal.

type DynamicType 

type DynamicType struct {
	// CustomType is a customization of the DynamicType.
	CustomType *CustomType `json:"custom_type,omitempty"`
}

DynamicType is a representation of dynamic type.

type DynamicValidator 

type DynamicValidator struct {
	// Custom defines a schema definition, and optional imports.
	Custom *CustomValidator `json:"custom,omitempty"`
}

DynamicValidator type defines type and function that provides validation functionality.

func (DynamicValidator) Equal 

func (v DynamicValidator) Equal(other DynamicValidator) bool

Equal returns true if the fields of the given DynamicValidator equal.

type DynamicValidators 

type DynamicValidators []DynamicValidator

DynamicValidators type is a slice of DynamicValidator.

func (DynamicValidators) CustomValidators 

func (v DynamicValidators) CustomValidators() CustomValidators

CustomValidators returns CustomValidator for each DynamicValidator.

func (DynamicValidators) Equal 

func (v DynamicValidators) Equal(other DynamicValidators) bool

Equal returns true if the given DynamicValidators is the same length, and each of the DynamicValidator entries is equal.

type ElementType 

type ElementType struct {
	Bool    *BoolType    `json:"bool,omitempty"`
	Float32 *Float32Type `json:"float32,omitempty"`
	Float64 *Float64Type `json:"float64,omitempty"`
	Int32   *Int32Type   `json:"int32,omitempty"`
	Int64   *Int64Type   `json:"int64,omitempty"`
	List    *ListType    `json:"list,omitempty"`
	Map     *MapType     `json:"map,omitempty"`
	Number  *NumberType  `json:"number,omitempty"`
	Object  *ObjectType  `json:"object,omitempty"`
	Set     *SetType     `json:"set,omitempty"`
	String  *StringType  `json:"string,omitempty"`
}

ElementType defines the type within a list, map, or set.

DynamicType is intentionally not supported as it can cause confusing behavior or unavoidable errors for practitioners if elements cannot be conformed into a single element type.

func (ElementType) Equal 

func (e ElementType) Equal(other ElementType) bool

Equal returns true if all fields of the given ElementType are equal.

type Float32Default added in v0.3.0 

type Float32Default struct {
	// Custom defines a schema definition, and optional imports.
	Custom *CustomDefault `json:"custom,omitempty"`

	// Static defines a specific 32-bit floating point value.
	Static *float32 `json:"static,omitempty"`
}

Float32Default defines a value, or a custom type for a default 32-bit floating point value.

func (*Float32Default) Equal added in v0.3.0 

func (d *Float32Default) Equal(other *Float32Default) bool

Equal returns true if all fields of the given Float32Default are equal.

type Float32PlanModifier added in v0.3.0 

type Float32PlanModifier struct {
	Custom *CustomPlanModifier `json:"custom,omitempty"`
}

Float32PlanModifier type defines type and function that provides plan modification functionality.

func (Float32PlanModifier) Equal added in v0.3.0 

func (v Float32PlanModifier) Equal(other Float32PlanModifier) bool

Equal returns true if the fields of the given Float32PlanModifier are equal.

type Float32PlanModifiers added in v0.3.0 

type Float32PlanModifiers []Float32PlanModifier

Float32PlanModifiers type defines Float32PlanModifier types

func (Float32PlanModifiers) CustomPlanModifiers added in v0.3.0 

func (v Float32PlanModifiers) CustomPlanModifiers() CustomPlanModifiers

CustomPlanModifiers returns CustomPlanModifier for each Float32PlanModifier.

func (Float32PlanModifiers) Equal added in v0.3.0 

func (v Float32PlanModifiers) Equal(other Float32PlanModifiers) bool

Equal returns true if the given Float32PlanModifiers is the same length, and each of the Float32PlanModifier entries is equal.

type Float32Type added in v0.3.0 

type Float32Type struct {
	// CustomType is a customization of the Float32Type.
	CustomType *CustomType `json:"custom_type,omitempty"`
}

Float32Type is a representation of a 32-bit floating point number.

type Float32Validator added in v0.3.0 

type Float32Validator struct {
	Custom *CustomValidator `json:"custom,omitempty"`
}

Float32Validator type defines type and function that provides validation functionality.

func (Float32Validator) Equal added in v0.3.0 

func (v Float32Validator) Equal(other Float32Validator) bool

Equal returns true if the fields of the given Float32Validator equal.

type Float32Validators added in v0.3.0 

type Float32Validators []Float32Validator

Float32Validators type defines Float32Validator types

func (Float32Validators) CustomValidators added in v0.3.0 

func (v Float32Validators) CustomValidators() CustomValidators

CustomValidators returns CustomValidator for each Float32Validator.

func (Float32Validators) Equal added in v0.3.0 

func (v Float32Validators) Equal(other Float32Validators) bool

Equal returns true if the given Float32Validators is the same length, and each of the Float32Validator entries is equal.

type Float64Default 

type Float64Default struct {
	// Custom defines a schema definition, and optional imports.
	Custom *CustomDefault `json:"custom,omitempty"`

	// Static defines a specific 64-bit floating point value.
	Static *float64 `json:"static,omitempty"`
}

Float64Default defines a value, or a custom type for a default 64-bit floating point value.

func (*Float64Default) Equal 

func (d *Float64Default) Equal(other *Float64Default) bool

Equal returns true if all fields of the given Float64Default are equal.

type Float64PlanModifier 

type Float64PlanModifier struct {
	Custom *CustomPlanModifier `json:"custom,omitempty"`
}

Float64PlanModifier type defines type and function that provides plan modification functionality.

func (Float64PlanModifier) Equal 

func (v Float64PlanModifier) Equal(other Float64PlanModifier) bool

Equal returns true if the fields of the given Float64PlanModifier are equal.

type Float64PlanModifiers 

type Float64PlanModifiers []Float64PlanModifier

Float64PlanModifiers type defines Float64PlanModifier types

func (Float64PlanModifiers) CustomPlanModifiers 

func (v Float64PlanModifiers) CustomPlanModifiers() CustomPlanModifiers

CustomPlanModifiers returns CustomPlanModifier for each Float64PlanModifier.

func (Float64PlanModifiers) Equal 

func (v Float64PlanModifiers) Equal(other Float64PlanModifiers) bool

Equal returns true if the given Float64PlanModifiers is the same length, and each of the Float64PlanModifier entries is equal.

type Float64Type 

type Float64Type struct {
	// CustomType is a customization of the Float64Type.
	CustomType *CustomType `json:"custom_type,omitempty"`
}

Float64Type is a representation of a 64-bit floating point number.

type Float64Validator 

type Float64Validator struct {
	Custom *CustomValidator `json:"custom,omitempty"`
}

Float64Validator type defines type and function that provides validation functionality.

func (Float64Validator) Equal 

func (v Float64Validator) Equal(other Float64Validator) bool

Equal returns true if the fields of the given Float64Validator equal.

type Float64Validators 

type Float64Validators []Float64Validator

Float64Validators type defines Float64Validator types

func (Float64Validators) CustomValidators 

func (v Float64Validators) CustomValidators() CustomValidators

CustomValidators returns CustomValidator for each Float64Validator.

func (Float64Validators) Equal 

func (v Float64Validators) Equal(other Float64Validators) bool

Equal returns true if the given Float64Validators is the same length, and each of the Float64Validator entries is equal.

type Int32Default added in v0.3.0 

type Int32Default struct {
	// Custom defines a schema definition, and optional imports.
	Custom *CustomDefault `json:"custom,omitempty"`

	// Static defines a specific 32-bit integer value.
	Static *int32 `json:"static,omitempty"`
}

Int32Default defines a value, or a custom type for a default 32-bit integer value.

func (*Int32Default) Equal added in v0.3.0 

func (d *Int32Default) Equal(other *Int32Default) bool

Equal returns true if all fields of the given Int32Default are equal.

type Int32PlanModifier added in v0.3.0 

type Int32PlanModifier struct {
	Custom *CustomPlanModifier `json:"custom,omitempty"`
}

Int32PlanModifier type defines type and function that provides plan modification functionality.

func (Int32PlanModifier) Equal added in v0.3.0 

func (v Int32PlanModifier) Equal(other Int32PlanModifier) bool

Equal returns true if the fields of the given Int32PlanModifier are equal.

type Int32PlanModifiers added in v0.3.0 

type Int32PlanModifiers []Int32PlanModifier

Int32PlanModifiers type defines Int32PlanModifier types

func (Int32PlanModifiers) CustomPlanModifiers added in v0.3.0 

func (v Int32PlanModifiers) CustomPlanModifiers() CustomPlanModifiers

CustomPlanModifiers returns CustomPlanModifier for each Int32PlanModifier.

func (Int32PlanModifiers) Equal added in v0.3.0 

func (v Int32PlanModifiers) Equal(other Int32PlanModifiers) bool

Equal returns true if the given Int32PlanModifiers is the same length, and each of the Int32PlanModifier entries is equal.

type Int32Type added in v0.3.0 

type Int32Type struct {
	// CustomType is a customization of the Int32Type.
	CustomType *CustomType `json:"custom_type,omitempty"`
}

Int32Type is a representation of a 32-bit integer.

type Int32Validator added in v0.3.0 

type Int32Validator struct {
	Custom *CustomValidator `json:"custom,omitempty"`
}

Int32Validator type defines type and function that provides validation functionality.

func (Int32Validator) Equal added in v0.3.0 

func (v Int32Validator) Equal(other Int32Validator) bool

Equal returns true if the fields of the given Int32Validator equal.

type Int32Validators added in v0.3.0 

type Int32Validators []Int32Validator

Int32Validators type defines Int32Validator types

func (Int32Validators) CustomValidators added in v0.3.0 

func (v Int32Validators) CustomValidators() CustomValidators

CustomValidators returns CustomValidator for each Primitive Type Validator.

func (Int32Validators) Equal added in v0.3.0 

func (v Int32Validators) Equal(other Int32Validators) bool

Equal returns true if the given Int32Validators is the same length, and each of the Int32Validator entries is equal.

type Int64Default 

type Int64Default struct {
	// Custom defines a schema definition, and optional imports.
	Custom *CustomDefault `json:"custom,omitempty"`

	// Static defines a specific 64-bit integer value.
	Static *int64 `json:"static,omitempty"`
}

Int64Default defines a value, or a custom type for a default 64-bit integer value.

func (*Int64Default) Equal 

func (d *Int64Default) Equal(other *Int64Default) bool

Equal returns true if all fields of the given Int64Default are equal.

type Int64PlanModifier 

type Int64PlanModifier struct {
	Custom *CustomPlanModifier `json:"custom,omitempty"`
}

Int64PlanModifier type defines type and function that provides plan modification functionality.

func (Int64PlanModifier) Equal 

func (v Int64PlanModifier) Equal(other Int64PlanModifier) bool

Equal returns true if the fields of the given Int64PlanModifier are equal.

type Int64PlanModifiers 

type Int64PlanModifiers []Int64PlanModifier

Int64PlanModifiers type defines Int64PlanModifier types

func (Int64PlanModifiers) CustomPlanModifiers 

func (v Int64PlanModifiers) CustomPlanModifiers() CustomPlanModifiers

CustomPlanModifiers returns CustomPlanModifier for each Int64PlanModifier.

func (Int64PlanModifiers) Equal 

func (v Int64PlanModifiers) Equal(other Int64PlanModifiers) bool

Equal returns true if the given Int64PlanModifiers is the same length, and each of the Int64PlanModifier entries is equal.

type Int64Type 

type Int64Type struct {
	// CustomType is a customization of the Int64Type.
	CustomType *CustomType `json:"custom_type,omitempty"`
}

Int64Type is a representation of a 64-bit integer.

type Int64Validator 

type Int64Validator struct {
	Custom *CustomValidator `json:"custom,omitempty"`
}

Int64Validator type defines type and function that provides validation functionality.

func (Int64Validator) Equal 

func (v Int64Validator) Equal(other Int64Validator) bool

Equal returns true if the fields of the given Int64Validator equal.

type Int64Validators 

type Int64Validators []Int64Validator

Int64Validators type defines Int64Validator types

func (Int64Validators) CustomValidators 

func (v Int64Validators) CustomValidators() CustomValidators

CustomValidators returns CustomValidator for each Primitive Type Validator.

func (Int64Validators) Equal 

func (v Int64Validators) Equal(other Int64Validators) bool

Equal returns true if the given Int64Validators is the same length, and each of the Int64Validator entries is equal.

type ListDefault 

type ListDefault struct {
	// Custom defines a schema definition, and optional imports.
	Custom *CustomDefault `json:"custom,omitempty"`
}

ListDefault defines a custom type for a default list value.

func (*ListDefault) CustomDefault 

func (d *ListDefault) CustomDefault() *CustomDefault

CustomDefault returns *CustomDefault.

func (*ListDefault) Equal 

func (d *ListDefault) Equal(other *ListDefault) bool

Equal returns true if all fields of the given ListDefault are equal.

type ListPlanModifier 

type ListPlanModifier struct {
	Custom *CustomPlanModifier `json:"custom,omitempty"`
}

ListPlanModifier type defines type and function that provides plan modification functionality.

func (ListPlanModifier) Equal 

func (v ListPlanModifier) Equal(other ListPlanModifier) bool

Equal returns true if the fields of the given ListPlanModifier are equal.

type ListPlanModifiers 

type ListPlanModifiers []ListPlanModifier

ListPlanModifiers type defines ListPlanModifier types

func (ListPlanModifiers) CustomPlanModifiers 

func (v ListPlanModifiers) CustomPlanModifiers() CustomPlanModifiers

CustomPlanModifiers returns CustomPlanModifier for each ListPlanModifier.

func (ListPlanModifiers) Equal 

func (v ListPlanModifiers) Equal(other ListPlanModifiers) bool

Equal returns true if the given ListPlanModifiers is the same length, and each of the ListPlanModifier entries is equal.

type ListType 

type ListType struct {
	// ElementType defines the type of the elements within
	// the list.
	ElementType ElementType `json:"element_type"`

	// CustomType is a customization of the ListType.
	CustomType *CustomType `json:"custom_type,omitempty"`
}

ListType is a representation of a list.

type ListValidator 

type ListValidator struct {
	Custom *CustomValidator `json:"custom,omitempty"`
}

ListValidator type defines type and function that provides validation functionality.

func (ListValidator) Equal 

func (v ListValidator) Equal(other ListValidator) bool

Equal returns true if the fields of the given ListValidator equal.

type ListValidators 

type ListValidators []ListValidator

ListValidators type defines ListValidator types

func (ListValidators) CustomValidators 

func (v ListValidators) CustomValidators() CustomValidators

CustomValidators returns CustomValidator for each ListValidator.

func (ListValidators) Equal 

func (v ListValidators) Equal(other ListValidators) bool

Equal returns true if the given ListValidators is the same length, and each of the ListValidator entries is equal.

type MapDefault 

type MapDefault struct {
	// Custom defines a schema definition, and optional imports.
	Custom *CustomDefault `json:"custom,omitempty"`
}

MapDefault defines a custom type for a default map value.

func (*MapDefault) CustomDefault 

func (d *MapDefault) CustomDefault() *CustomDefault

CustomDefault returns *CustomDefault.

func (*MapDefault) Equal 

func (d *MapDefault) Equal(other *MapDefault) bool

Equal returns true if all fields of the given MapDefault are equal.

type MapPlanModifier 

type MapPlanModifier struct {
	Custom *CustomPlanModifier `json:"custom,omitempty"`
}

MapPlanModifier type defines type and function that provides plan modification functionality.

func (MapPlanModifier) Equal 

func (v MapPlanModifier) Equal(other MapPlanModifier) bool

Equal returns true if the fields of the given MapPlanModifier are equal.

type MapPlanModifiers 

type MapPlanModifiers []MapPlanModifier

MapPlanModifiers type defines MapPlanModifier types

func (MapPlanModifiers) CustomPlanModifiers 

func (v MapPlanModifiers) CustomPlanModifiers() CustomPlanModifiers

CustomPlanModifiers returns CustomPlanModifier for each MapPlanModifier.

func (MapPlanModifiers) Equal 

func (v MapPlanModifiers) Equal(other MapPlanModifiers) bool

Equal returns true if the given MapPlanModifiers is the same length, and each of the MapPlanModifier entries is equal.

type MapType 

type MapType struct {
	// ElementType defines the type of the elements within
	// the map.
	ElementType ElementType `json:"element_type"`

	// CustomType is a customization of the MapType.
	CustomType *CustomType `json:"custom_type,omitempty"`
}

MapType is a representation of a map.

type MapValidator 

type MapValidator struct {
	Custom *CustomValidator `json:"custom,omitempty"`
}

MapValidator type defines type and function that provides validation functionality.

func (MapValidator) Equal 

func (v MapValidator) Equal(other MapValidator) bool

Equal returns true if the fields of the given MapValidator equal.

type MapValidators 

type MapValidators []MapValidator

MapValidators type defines MapValidator types

func (MapValidators) CustomValidators 

func (v MapValidators) CustomValidators() CustomValidators

CustomValidators returns CustomValidator for each MapValidator.

func (MapValidators) Equal 

func (v MapValidators) Equal(other MapValidators) bool

Equal returns true if the given MapValidators is the same length, and each of the MapValidator entries is equal.

type NumberDefault 

type NumberDefault struct {
	// Custom defines a schema definition, and optional imports.
	Custom *CustomDefault `json:"custom,omitempty"`
}

NumberDefault defines a custom type for a default generic number with up to 512 bits of floating point or integer precision.

func (*NumberDefault) CustomDefault 

func (d *NumberDefault) CustomDefault() *CustomDefault

CustomDefault returns *CustomDefault.

func (*NumberDefault) Equal 

func (d *NumberDefault) Equal(other *NumberDefault) bool

Equal returns true if all fields of the given Int64Default are equal.

type NumberPlanModifier 

type NumberPlanModifier struct {
	Custom *CustomPlanModifier `json:"custom,omitempty"`
}

NumberPlanModifier type defines type and function that provides plan modification functionality.

func (NumberPlanModifier) Equal 

func (v NumberPlanModifier) Equal(other NumberPlanModifier) bool

Equal returns true if the fields of the given NumberPlanModifier are equal.

type NumberPlanModifiers 

type NumberPlanModifiers []NumberPlanModifier

NumberPlanModifiers type defines NumberPlanModifier types

func (NumberPlanModifiers) CustomPlanModifiers 

func (v NumberPlanModifiers) CustomPlanModifiers() CustomPlanModifiers

CustomPlanModifiers returns CustomPlanModifier for each NumberPlanModifier.

func (NumberPlanModifiers) Equal 

func (v NumberPlanModifiers) Equal(other NumberPlanModifiers) bool

Equal returns true if the given NumberPlanModifiers is the same length, and each of the NumberPlanModifier entries is equal.

type NumberType 

type NumberType struct {
	// CustomType is a customization of the NumberType.
	CustomType *CustomType `json:"custom_type,omitempty"`
}

NumberType is a representation of a generic number with up to 512 bits of floating point or integer precision.

type NumberValidator 

type NumberValidator struct {
	Custom *CustomValidator `json:"custom,omitempty"`
}

NumberValidator type defines type and function that provides validation functionality.

func (NumberValidator) Equal 

func (v NumberValidator) Equal(other NumberValidator) bool

Equal returns true if the fields of the given NumberValidator equal.

type NumberValidators 

type NumberValidators []NumberValidator

NumberValidators type defines NumberValidator types

func (NumberValidators) CustomValidators 

func (v NumberValidators) CustomValidators() CustomValidators

CustomValidators returns CustomValidator for each NumberValidator.

func (NumberValidators) Equal 

func (v NumberValidators) Equal(other NumberValidators) bool

Equal returns true if the given NumberValidators is the same length, and each of the NumberValidator entries is equal.

type ObjectAttributeType 

type ObjectAttributeType struct {
	Name string `json:"name"`

	Bool    *BoolType    `json:"bool,omitempty"`
	Dynamic *DynamicType `json:"dynamic,omitempty"`
	Float32 *Float32Type `json:"float32,omitempty"`
	Float64 *Float64Type `json:"float64,omitempty"`
	Int32   *Int32Type   `json:"int32,omitempty"`
	Int64   *Int64Type   `json:"int64,omitempty"`
	List    *ListType    `json:"list,omitempty"`
	Map     *MapType     `json:"map,omitempty"`
	Number  *NumberType  `json:"number,omitempty"`
	Object  *ObjectType  `json:"object,omitempty"`
	Set     *SetType     `json:"set,omitempty"`
	String  *StringType  `json:"string,omitempty"`
}

ObjectAttributeType defines the types within an object.

func (ObjectAttributeType) Equal 

func (o ObjectAttributeType) Equal(other ObjectAttributeType) bool

Equal returns true if all fields of the given ObjectAttributeType are equal.

type ObjectAttributeTypes 

type ObjectAttributeTypes []ObjectAttributeType

ObjectAttributeTypes type defines ObjectAttributeType types

func (ObjectAttributeTypes) Equal 

func (o ObjectAttributeTypes) Equal(other ObjectAttributeTypes) bool

func (ObjectAttributeTypes) Validate 

func (o ObjectAttributeTypes) Validate(ctx context.Context, req ObjectValidateRequest) error

Validate returns true if each of the object attribute names is unique within the object.

type ObjectDefault 

type ObjectDefault struct {
	// Custom defines a schema definition, and optional imports.
	Custom *CustomDefault `json:"custom,omitempty"`
}

ObjectDefault defines a custom type for a default object value.

func (*ObjectDefault) CustomDefault 

func (d *ObjectDefault) CustomDefault() *CustomDefault

CustomDefault returns *CustomDefault.

func (*ObjectDefault) Equal 

func (d *ObjectDefault) Equal(other *ObjectDefault) bool

Equal returns true if all fields of the given ObjectDefault are equal.

type ObjectPlanModifier 

type ObjectPlanModifier struct {
	Custom *CustomPlanModifier `json:"custom,omitempty"`
}

ObjectPlanModifier type defines type and function that provides plan modification functionality.

func (ObjectPlanModifier) Equal 

func (v ObjectPlanModifier) Equal(other ObjectPlanModifier) bool

Equal returns true if the fields of the given ObjectPlanModifier are equal.

type ObjectPlanModifiers 

type ObjectPlanModifiers []ObjectPlanModifier

ObjectPlanModifiers type defines ObjectPlanModifier types

func (ObjectPlanModifiers) CustomPlanModifiers 

func (v ObjectPlanModifiers) CustomPlanModifiers() CustomPlanModifiers

CustomPlanModifiers returns CustomPlanModifier for each ObjectPlanModifier.

func (ObjectPlanModifiers) Equal 

func (v ObjectPlanModifiers) Equal(other ObjectPlanModifiers) bool

Equal returns true if the given ObjectPlanModifiers is the same length, and each of the ObjectPlanModifier entries is equal.

type ObjectType 

type ObjectType struct {
	// AttributeTypes defines the types of the attributes
	// within the object.
	AttributeTypes ObjectAttributeTypes `json:"attribute_types"`

	// CustomType is a customization of the ObjectType.
	CustomType *CustomType `json:"custom_type,omitempty"`
}

ObjectType is a representation of an object.

func (*ObjectType) Equal 

func (o *ObjectType) Equal(other *ObjectType) bool

Equal returns true if the fields of the given ObjectType are equal.

type ObjectValidateRequest 

type ObjectValidateRequest struct {
	Path string
}

type ObjectValidator 

type ObjectValidator struct {
	Custom *CustomValidator `json:"custom,omitempty"`
}

ObjectValidator type defines type and function that provides validation functionality.

func (ObjectValidator) Equal 

func (v ObjectValidator) Equal(other ObjectValidator) bool

Equal returns true if the fields of the given ObjectValidator equal.

type ObjectValidators 

type ObjectValidators []ObjectValidator

ObjectValidators type defines ObjectValidator types

func (ObjectValidators) CustomValidators 

func (v ObjectValidators) CustomValidators() CustomValidators

CustomValidators returns CustomValidator for each ObjectValidator.

func (ObjectValidators) Equal 

func (v ObjectValidators) Equal(other ObjectValidators) bool

Equal returns true if the given ObjectValidators is the same length, and each of the ObjectValidator entries is equal.

type OptionalRequired 

type OptionalRequired = ComputedOptionalRequired

type SetDefault 

type SetDefault struct {
	// Custom defines a schema definition, and optional imports.
	Custom *CustomDefault `json:"custom,omitempty"`
}

SetDefault defines a custom type for a default set value.

func (*SetDefault) CustomDefault 

func (d *SetDefault) CustomDefault() *CustomDefault

CustomDefault returns *CustomDefault.

func (*SetDefault) Equal 

func (d *SetDefault) Equal(other *SetDefault) bool

Equal returns true if all fields of the given SetDefault are equal.

type SetPlanModifier 

type SetPlanModifier struct {
	Custom *CustomPlanModifier `json:"custom,omitempty"`
}

SetPlanModifier type defines type and function that provides plan modification functionality.

func (SetPlanModifier) Equal 

func (v SetPlanModifier) Equal(other SetPlanModifier) bool

Equal returns true if the fields of the given SetPlanModifier are equal.

type SetPlanModifiers 

type SetPlanModifiers []SetPlanModifier

SetPlanModifiers type defines SetPlanModifier types

func (SetPlanModifiers) CustomPlanModifiers 

func (v SetPlanModifiers) CustomPlanModifiers() CustomPlanModifiers

CustomPlanModifiers returns CustomPlanModifier for each SetPlanModifier.

func (SetPlanModifiers) Equal 

func (v SetPlanModifiers) Equal(other SetPlanModifiers) bool

Equal returns true if the given SetPlanModifiers is the same length, and each of the SetPlanModifier entries is equal.

type SetType 

type SetType struct {
	// ElementType defines the type of the elements within
	// the set.
	ElementType ElementType `json:"element_type"`

	// CustomType is a customization of the SetType.
	CustomType *CustomType `json:"custom_type,omitempty"`
}

SetType is a representation of a set.

type SetValidator 

type SetValidator struct {
	Custom *CustomValidator `json:"custom,omitempty"`
}

SetValidator type defines type and function that provides validation functionality.

func (SetValidator) Equal 

func (v SetValidator) Equal(other SetValidator) bool

Equal returns true if the fields of the given SetValidator equal.

type SetValidators 

type SetValidators []SetValidator

SetValidators type defines SetValidator types

func (SetValidators) CustomValidators 

func (v SetValidators) CustomValidators() CustomValidators

CustomValidators returns CustomValidator for each SetValidator.

func (SetValidators) Equal 

func (v SetValidators) Equal(other SetValidators) bool

Equal returns true if the given SetValidators is the same length, and each of the SetValidator entries is equal.

type StringDefault 

type StringDefault struct {
	// Custom defines a schema definition, and optional imports.
	Custom *CustomDefault `json:"custom,omitempty"`

	// Static defines a specific string value.
	Static *string `json:"static,omitempty"`
}

StringDefault defines a value, or a custom type for a default string value.

func (*StringDefault) Equal 

func (d *StringDefault) Equal(other *StringDefault) bool

Equal returns true if all fields of the given StringDefault are equal.

type StringPlanModifier 

type StringPlanModifier struct {
	Custom *CustomPlanModifier `json:"custom,omitempty"`
}

StringPlanModifier type defines type and function that provides plan modification functionality.

func (StringPlanModifier) Equal 

func (v StringPlanModifier) Equal(other StringPlanModifier) bool

Equal returns true if the fields of the given StringPlanModifier are equal.

type StringPlanModifiers 

type StringPlanModifiers []StringPlanModifier

StringPlanModifiers type defines StringPlanModifier types

func (StringPlanModifiers) CustomPlanModifiers 

func (v StringPlanModifiers) CustomPlanModifiers() CustomPlanModifiers

CustomPlanModifiers returns CustomPlanModifier for each StringPlanModifier.

func (StringPlanModifiers) Equal 

func (v StringPlanModifiers) Equal(other StringPlanModifiers) bool

Equal returns true if the given StringPlanModifiers is the same length, and each of the StringPlanModifier entries is equal.

type StringType 

type StringType struct {
	// CustomType is a customization of the StringType.
	CustomType *CustomType `json:"custom_type,omitempty"`
}

StringType is a representation of a string.

type StringValidator 

type StringValidator struct {
	Custom *CustomValidator `json:"custom,omitempty"`
}

StringValidator type defines type and function that provides validation functionality.

func (StringValidator) Equal 

func (v StringValidator) Equal(other StringValidator) bool

Equal returns true if the fields of the given StringValidator equal.

type StringValidators 

type StringValidators []StringValidator

StringValidators type defines StringValidator types

func (StringValidators) CustomValidators 

func (v StringValidators) CustomValidators() CustomValidators

CustomValidators returns CustomValidator for each StringValidator.

func (StringValidators) Equal 

func (v StringValidators) Equal(other StringValidators) bool

Equal returns true if the given StringValidators is the same length, and each of the StringValidator entries is equal.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.