Package basetypes contains the implementations for framework-defined data types and values, such as boolean, floating point, integer, list, map, object, set, and string. Embed these implementations to create custom types.
This section is empty.
This section is empty.
This section is empty.
BoolTypable extends attr.Type for bool types. Implement this interface to create a custom BoolType type.
BoolType is the base framework type for a boolean. BoolValue is the associated value type.
ApplyTerraform5AttributePathStep applies the given AttributePathStep to the type.
Equal returns true if the given type is equivalent.
String returns a human readable string of the type name.
TerraformType returns the tftypes.Type that should be used to represent this framework type.
ValueFromBool returns a BoolValuable type given a BoolValue.
ValueFromTerraform returns a Value given a tftypes.Value. This is meant to convert the tftypes.Value into a more convenient Go type for the provider to consume the data with.
ValueType returns the Value type.
BoolValuable extends attr.Value for boolean value types. Implement this interface to create a custom Bool value type.
BoolValuableWithSemanticEquals extends BoolValuable with semantic equality logic.
type BoolValue struct {
}
BoolValue represents a boolean value.
NewBoolNull creates a Bool with a null value. Determine whether the value is null via the Bool type IsNull method.
NewBoolPointerValue creates a Bool with a null value if nil or a known value. Access the value via the Bool type ValueBoolPointer method.
NewBoolUnknown creates a Bool with an unknown value. Determine whether the value is unknown via the Bool type IsUnknown method.
NewBoolValue creates a Bool with a known value. Access the value via the Bool type ValueBool method.
Equal returns true if `other` is a *Bool and has the same value as `b`.
IsNull returns true if the Bool represents a null value.
IsUnknown returns true if the Bool represents a currently unknown value.
String returns a human-readable representation of the Bool value. The string returned here is not protected by any compatibility guarantees, and is intended for logging and error reporting.
ToBoolValue returns Bool.
ToTerraformValue returns the data contained in the Bool as a tftypes.Value.
ValueBool returns the known bool value. If Bool is null or unknown, returns false.
ValueBoolPointer returns a pointer to the known bool value, nil for a null value, or a pointer to false for an unknown value.
DynamicTypable extends attr.Type for dynamic types. Implement this interface to create a custom DynamicType type.
type DynamicType struct{}
DynamicType is the base framework type for a dynamic. Static types are always preferable over dynamic types in Terraform as practitioners will receive less helpful configuration assistance from validation error diagnostics and editor integrations.
DynamicValue is the associated value type and, when known, contains a concrete value of another framework type. (StringValue, ListValue, ObjectValue, MapValue, etc.)
ApplyTerraform5AttributePathStep applies the given AttributePathStep to the type.
Equal returns true if the given type is equivalent.
Dynamic types do not contain a reference to the underlying `attr.Value` type, so this equality check only asserts that both types are DynamicType.
String returns a human-friendly description of the DynamicType.
TerraformType returns the tftypes.Type that should be used to represent this type.
ValueFromDynamic returns a DynamicValuable type given a DynamicValue.
ValueFromTerraform returns an attr.Value given a tftypes.Value. This is meant to convert the tftypes.Value into a more convenient Go type for the provider to consume the data with.
ValueType returns the Value type.
DynamicValuable extends attr.Value for dynamic value types. Implement this interface to create a custom Dynamic value type.
DynamicValuableWithSemanticEquals extends DynamicValuable with semantic equality logic.
type DynamicValue struct {
}
DynamicValue represents a dynamic value. Static types are always preferable over dynamic types in Terraform as practitioners will receive less helpful configuration assistance from validation error diagnostics and editor integrations.
NewDynamicNull creates a Dynamic with a null value. The concrete value type returned to Terraform from this value will be tftypes.DynamicPseudoType.
NewDynamicUnknown creates a Dynamic with an unknown value. The concrete value type returned to Terraform from this value will be tftypes.DynamicPseudoType.
NewDynamicValue creates a Dynamic with a known value. Access the value via the Dynamic type UnderlyingValue method. The concrete value type returned to Terraform from this value will be determined by the provided `(attr.Value).ToTerraformValue` function.
Equal returns true if the given attr.Value is also a DynamicValue and contains an equal underlying value as defined by its Equal method.
IsNull returns true if the DynamicValue represents a null value.
IsUnderlyingValueNull is a helper method that return true only in the case where the underlying value has a known type but the value is null. This method will return false if the underlying type is not known.
IsNull should be used to determine if the dynamic value does not have a known type and the value is null.
An example of a known type with a null underlying value would be:
types.DynamicValue(types.StringNull())
IsUnderlyingValueUnknown is a helper method that return true only in the case where the underlying value has a known type but the value is unknown. This method will return false if the underlying type is not known.
IsUnknown should be used to determine if the dynamic value does not have a known type and the value is unknown.
An example of a known type with an unknown underlying value would be:
types.DynamicValue(types.StringUnknown())
IsUnknown returns true if the DynamicValue represents an unknown value.
String returns a human-readable representation of the DynamicValue. The string returned here is not protected by any compatibility guarantees, and is intended for logging and error reporting.
ToDynamicValue returns DynamicValue.
ToTerraformValue returns the equivalent tftypes.Value for the DynamicValue.
Type returns DynamicType.
UnderlyingValue returns the concrete underlying value in the DynamicValue. This will return `nil` if DynamicValue is null or unknown.
A known DynamicValue can have an underlying value that is in null or unknown state in the scenario that the underlying value type has been refined by Terraform.
Float32Typable extends attr.Type for float32 types. Implement this interface to create a custom Float32Type type.
type Float32Type struct{}
Float32Type is the base framework type for a floating point number. Float32Value is the associated value type.
ApplyTerraform5AttributePathStep applies the given AttributePathStep to the type.
Equal returns true if the given type is equivalent.
String returns a human readable string of the type name.
TerraformType returns the tftypes.Type that should be used to represent this framework type.
ValueFromFloat32 returns a Float32Valuable type given a Float32Value.
ValueFromTerraform returns a Value given a tftypes.Value. This is meant to convert the tftypes.Value into a more convenient Go type for the provider to consume the data with.
ValueType returns the Value type.
Float32Valuable extends attr.Value for float32 value types. Implement this interface to create a custom Float32 value type.
Float32ValuableWithSemanticEquals extends Float32Valuable with semantic equality logic.
type Float32Value struct {
}
Float32Value represents a 32-bit floating point value, exposed as a float32.
NewFloat32Null creates a Float32 with a null value. Determine whether the value is null via the Float32 type IsNull method.
NewFloat32PointerValue creates a Float32 with a null value if nil or a known value. Access the value via the Float32 type ValueFloat32Pointer method. Passing a value of `NaN` will result in a panic.
NewFloat32Unknown creates a Float32 with an unknown value. Determine whether the value is unknown via the Float32 type IsUnknown method.
NewFloat32Value creates a Float32 with a known value. Access the value via the Float32 type ValueFloat32 method. Passing a value of `NaN` will result in a panic.
Equal returns true if `other` is a Float32 and has the same value as `f`.
Float32SemanticEquals returns true if the given Float32Value is semantically equal to the current Float32Value. The underlying value *big.Float can store more precise float values then the Go built-in float32 type. This only compares the precision of the value that can be represented as the Go built-in float32, which is 53 bits of precision.
IsNull returns true if the Float32 represents a null value.
IsUnknown returns true if the Float32 represents a currently unknown value.
String returns a human-readable representation of the Float32 value. The string returned here is not protected by any compatibility guarantees, and is intended for logging and error reporting.
ToFloat32Value returns Float32.
ToTerraformValue returns the data contained in the Float32 as a tftypes.Value.
Type returns a Float32Type.
ValueFloat32 returns the known float32 value. If Float32 is null or unknown, returns 0.0.
ValueFloat32Pointer returns a pointer to the known float32 value, nil for a null value, or a pointer to 0.0 for an unknown value.
Float64Typable extends attr.Type for float64 types. Implement this interface to create a custom Float64Type type.
type Float64Type struct{}
Float64Type is the base framework type for a floating point number. Float64Value is the associated value type.
ApplyTerraform5AttributePathStep applies the given AttributePathStep to the type.
Equal returns true if the given type is equivalent.
String returns a human readable string of the type name.
TerraformType returns the tftypes.Type that should be used to represent this framework type.
Validate implements type validation.
ValueFromFloat64 returns a Float64Valuable type given a Float64Value.
ValueFromTerraform returns a Value given a tftypes.Value. This is meant to convert the tftypes.Value into a more convenient Go type for the provider to consume the data with.
ValueType returns the Value type.
Float64Valuable extends attr.Value for float64 value types. Implement this interface to create a custom Float64 value type.
Float64ValuableWithSemanticEquals extends Float64Valuable with semantic equality logic.
type Float64Value struct {
}
Float64Value represents a 64-bit floating point value, exposed as a float64.
Float64Null creates a Float64 with a null value. Determine whether the value is null via the Float64 type IsNull method.
NewFloat64PointerValue creates a Float64 with a null value if nil or a known value. Access the value via the Float64 type ValueFloat64Pointer method. Passing a value of `NaN` will result in a panic.
Float64Unknown creates a Float64 with an unknown value. Determine whether the value is unknown via the Float64 type IsUnknown method.
Setting the deprecated Float64 type Null, Unknown, or Value fields after creating a Float64 with this function has no effect.
Float64Value creates a Float64 with a known value. Access the value via the Float64 type ValueFloat64 method. Passing a value of `NaN` will result in a panic.
Setting the deprecated Float64 type Null, Unknown, or Value fields after creating a Float64 with this function has no effect.
Equal returns true if `other` is a Float64 and has the same value as `f`.
Float64SemanticEquals returns true if the given Float64Value is semantically equal to the current Float64Value. The underlying value *big.Float can store more precise float values then the Go built-in float64 type. This only compares the precision of the value that can be represented as the Go built-in float64, which is 53 bits of precision.
IsNull returns true if the Float64 represents a null value.
IsUnknown returns true if the Float64 represents a currently unknown value.
String returns a human-readable representation of the Float64 value. The string returned here is not protected by any compatibility guarantees, and is intended for logging and error reporting.
ToFloat64Value returns Float64.
ToTerraformValue returns the data contained in the Float64 as a tftypes.Value.
Type returns a Float64Type.
ValueFloat64 returns the known float64 value. If Float64 is null or unknown, returns 0.0.
ValueFloat64Pointer returns a pointer to the known float64 value, nil for a null value, or a pointer to 0.0 for an unknown value.
Int32Typable extends attr.Type for int32 types. Implement this interface to create a custom Int32Type type.
Int32Type is the base framework type for an integer number. Int32Value is the associated value type.
ApplyTerraform5AttributePathStep applies the given AttributePathStep to the type.
Equal returns true if the given type is equivalent.
String returns a human-readable string of the type name.
TerraformType returns the tftypes.Type that should be used to represent this framework type.
ValueFromInt32 returns a Int32Valuable type given a Int32Value.
ValueFromTerraform returns a Value given a tftypes.Value. This is meant to convert the tftypes.Value into a more convenient Go type for the provider to consume the data with.
ValueType returns the Value type.
Int32Valuable extends attr.Value for int32 value types. Implement this interface to create a custom Int32 value type.
Int32ValuableWithSemanticEquals extends Int32Valuable with semantic equality logic.
type Int32Value struct {
}
Int32Value represents a 32-bit integer value, exposed as an int32.
NewInt32Null creates an Int32 with a null value. Determine whether the value is null via the Int32 type IsNull method.
NewInt32PointerValue creates an Int32 with a null value if nil or a known value. Access the value via the Int32 type ValueInt32Pointer method.
NewInt32Unknown creates an Int32 with an unknown value. Determine whether the value is unknown via the Int32 type IsUnknown method.
NewInt32Value creates an Int32 with a known value. Access the value via the Int32 type ValueInt32 method.
Equal returns true if `other` is an Int32 and has the same value as `i`.
IsNull returns true if the Int32 represents a null value.
IsUnknown returns true if the Int32 represents a currently unknown value.
String returns a human-readable representation of the Int32 value. The string returned here is not protected by any compatibility guarantees, and is intended for logging and error reporting.
ToInt32Value returns Int32.
ToTerraformValue returns the data contained in the Int32 as a tftypes.Value.
Type returns a Int32Type.
ValueInt32 returns the known int32 value. If Int32 is null or unknown, returns 0.
ValueInt32Pointer returns a pointer to the known int32 value, nil for a null value, or a pointer to 0 for an unknown value.
Int64Typable extends attr.Type for int64 types. Implement this interface to create a custom Int64Type type.
Int64Type is the base framework type for an integer number. Int64Value is the associated value type.
ApplyTerraform5AttributePathStep applies the given AttributePathStep to the type.
Equal returns true if the given type is equivalent.
String returns a human readable string of the type name.
TerraformType returns the tftypes.Type that should be used to represent this framework type.
Validate implements type validation.
ValueFromInt64 returns a Int64Valuable type given a Int64Value.
ValueFromTerraform returns a Value given a tftypes.Value. This is meant to convert the tftypes.Value into a more convenient Go type for the provider to consume the data with.
ValueType returns the Value type.
Int64Valuable extends attr.Value for int64 value types. Implement this interface to create a custom Int64 value type.
Int64ValuableWithSemanticEquals extends Int64Valuable with semantic equality logic.
type Int64Value struct {
}
Int64Value represents a 64-bit integer value, exposed as an int64.
NewInt64Null creates a Int64 with a null value. Determine whether the value is null via the Int64 type IsNull method.
NewInt64PointerValue creates a Int64 with a null value if nil or a known value. Access the value via the Int64 type ValueInt64Pointer method.
NewInt64Unknown creates a Int64 with an unknown value. Determine whether the value is unknown via the Int64 type IsUnknown method.
NewInt64Value creates a Int64 with a known value. Access the value via the Int64 type ValueInt64 method.
Equal returns true if `other` is an Int64 and has the same value as `i`.
IsNull returns true if the Int64 represents a null value.
IsUnknown returns true if the Int64 represents a currently unknown value.
String returns a human-readable representation of the Int64 value. The string returned here is not protected by any compatibility guarantees, and is intended for logging and error reporting.
ToInt64Value returns Int64.
ToTerraformValue returns the data contained in the Int64 as a tftypes.Value.
Type returns a Int64Type.
ValueInt64 returns the known int64 value. If Int64 is null or unknown, returns 0.
ValueInt64Pointer returns a pointer to the known int64 value, nil for a null value, or a pointer to 0 for an unknown value.
ListTypable extends attr.Type for list types. Implement this interface to create a custom ListType type.
type ListType struct {
ElemType attr.Type
}
ListType is an AttributeType representing a list of values. All values must be of the same type, which the provider must specify as the ElemType property.
ApplyTerraform5AttributePathStep applies the given AttributePathStep to the list.
ElementType returns the attr.Type elements will be created from.
Equal returns true if `o` is also a ListType and has the same ElemType.
String returns a human-friendly description of the ListType.
TerraformType returns the tftypes.Type that should be used to represent this type. This constrains what user input will be accepted and what kind of data can be set in state. The framework will use this to translate the AttributeType to something Terraform can understand.
Validate validates all elements of the list that are of type xattr.TypeWithValidate.
ValueFromList returns a ListValuable type given a List.
ValueFromTerraform returns an attr.Value given a tftypes.Value. This is meant to convert the tftypes.Value into a more convenient Go type for the provider to consume the data with.
ValueType returns the Value type.
WithElementType returns a ListType that is identical to `l`, but with the element type set to `typ`.
ListValuable extends attr.Value for list value types. Implement this interface to create a custom List value type.
ListValuableWithSemanticEquals extends ListValuable with semantic equality logic.
type ListValue struct {
}
ListValue represents a list of attr.Values, all of the same type, indicated by ElemType.
NewListNull creates a List with a null value. Determine whether the value is null via the List type IsNull method.
NewListUnknown creates a List with an unknown value. Determine whether the value is unknown via the List type IsUnknown method.
NewListValue creates a List with a known value. Access the value via the List type Elements or ElementsAs methods.
NewListValueFrom creates a List with a known value, using reflection rules. The elements must be a slice which can convert into the given element type. Access the value via the List type Elements or ElementsAs methods.
NewListValueMust creates a List with a known value, converting any diagnostics into a panic at runtime. Access the value via the List type Elements or ElementsAs methods.
This creation function is only recommended to create List values which will not potentially affect practitioners, such as testing, or exhaustively tested provider logic.
ElementType returns the element type for the List.
Elements returns a copy of the collection of elements for the List.
ElementsAs populates `target` with the elements of the ListValue, throwing an error if the elements cannot be stored in `target`.
Equal returns true if the given attr.Value is also a ListValue, has the same element type, same value state, and contains exactly the element values as defined by the Equal method of the element type.
IsNull returns true if the List represents a null value.
IsUnknown returns true if the List represents a currently unknown value. Returns false if the List has a known number of elements, even if all are unknown values.
String returns a human-readable representation of the List value. The string returned here is not protected by any compatibility guarantees, and is intended for logging and error reporting.
ToListValue returns the List.
ToTerraformValue returns the data contained in the List as a tftypes.Value.
Type returns a ListType with the same element type as `l`.
MapTypable extends attr.Type for map types. Implement this interface to create a custom MapType type.
type MapType struct {
ElemType attr.Type
}
MapType is an AttributeType representing a map of values. All values must be of the same type, which the provider must specify as the ElemType property. Keys will always be strings.
ApplyTerraform5AttributePathStep applies the given AttributePathStep to the map.
ElementType returns the type's element type.
Equal returns true if `o` is also a MapType and has the same ElemType.
String returns a human-friendly description of the MapType.
TerraformType returns the tftypes.Type that should be used to represent this type. This constrains what user input will be accepted and what kind of data can be set in state. The framework will use this to translate the AttributeType to something Terraform can understand.
Validate validates all elements of the map that are of type xattr.TypeWithValidate.
ValueFromMap returns a MapValuable type given a Map.
ValueFromTerraform returns an attr.Value given a tftypes.Value. This is meant to convert the tftypes.Value into a more convenient Go type for the provider to consume the data with.
ValueType returns the Value type.
WithElementType returns a new copy of the type with its element type set.
MapValuable extends attr.Value for map value types. Implement this interface to create a custom Map value type.
MapValuableWithSemanticEquals extends MapValuable with semantic equality logic.
MapValue represents a mapping of string keys to attr.Value values of a single type.
NewMapNull creates a Map with a null value. Determine whether the value is null via the Map type IsNull method.
NewMapUnknown creates a Map with an unknown value. Determine whether the value is unknown via the Map type IsUnknown method.
NewMapValue creates a Map with a known value. Access the value via the Map type Elements or ElementsAs methods.
NewMapValueFrom creates a Map with a known value, using reflection rules. The elements must be a map of string keys to values which can convert into the given element type. Access the value via the Map type Elements or ElementsAs methods.
NewMapValueMust creates a Map with a known value, converting any diagnostics into a panic at runtime. Access the value via the Map type Elements or ElementsAs methods.
This creation function is only recommended to create Map values which will not potentially effect practitioners, such as testing, or exhaustively tested provider logic.
ElementType returns the element type for the Map.
Elements returns a copy of the mapping of elements for the Map.
ElementsAs populates `target` with the elements of the MapValue, throwing an error if the elements cannot be stored in `target`.
Equal returns true if the given attr.Value is also a MapValue, has the same element type, same value state, and contains exactly the element values as defined by the Equal method of the element type.
IsNull returns true if the Map represents a null value.
IsUnknown returns true if the Map represents a currently unknown value. Returns false if the Map has a known number of elements, even if all are unknown values.
String returns a human-readable representation of the Map value. The string returned here is not protected by any compatibility guarantees, and is intended for logging and error reporting.
ToMapValue returns the Map.
ToTerraformValue returns the data contained in the Map as a tftypes.Value.
Type returns a MapType with the same element type as `m`.
NumberTypable extends attr.Type for number types. Implement this interface to create a custom NumberType type.
NumberType is the base framework type for a floating point number. NumberValue is the associated value type.
ApplyTerraform5AttributePathStep applies the given AttributePathStep to the type.
Equal returns true if the given type is equivalent.
String returns a human readable string of the type name.
TerraformType returns the tftypes.Type that should be used to represent this framework type.
ValueFromNumber returns a NumberValuable type given a NumberValue.
ValueFromTerraform returns a Value given a tftypes.Value. This is meant to convert the tftypes.Value into a more convenient Go type for the provider to consume the data with.
ValueType returns the Value type.
NumberValuable extends attr.Value for number value types. Implement this interface to create a custom Number value type.
NumberValuableWithSemanticEquals extends NumberValuable with semantic equality logic.
type NumberValue struct {
}
NumberValue represents a number value, exposed as a *big.Float. Numbers can be floats or integers.
NewNumberNull creates a Number with a null value. Determine whether the value is null via the Number type IsNull method.
NewNumberUnknown creates a Number with an unknown value. Determine whether the value is unknown via the Number type IsUnknown method.
NewNumberValue creates a Number with a known value. Access the value via the Number type ValueBigFloat method. If the given value is nil, a null Number is created.
Equal returns true if `other` is a Number and has the same value as `n`.
IsNull returns true if the Number represents a null value.
IsUnknown returns true if the Number represents a currently unknown value.
String returns a human-readable representation of the Number value. The string returned here is not protected by any compatibility guarantees, and is intended for logging and error reporting.
ToNumberValue returns Number.
ToTerraformValue returns the data contained in the Number as a tftypes.Value.
Type returns a NumberType.
ValueBigFloat returns the known *big.Float value. If Number is null or unknown, returns 0.0.
type ObjectAsOptions struct {
UnhandledNullAsEmpty bool
UnhandledUnknownAsEmpty bool
}
ObjectAsOptions is a collection of toggles to control the behavior of Object.As.
ObjectTypable extends attr.Type for object types. Implement this interface to create a custom ObjectType type.
ObjectType is an AttributeType representing an object.
ApplyTerraform5AttributePathStep applies the given AttributePathStep to the object.
AttributeTypes returns a copy of the type's attribute types.
Equal returns true if `candidate` is also an ObjectType and has the same AttributeTypes.
String returns a human-friendly description of the ObjectType.
TerraformType returns the tftypes.Type that should be used to represent this type. This constrains what user input will be accepted and what kind of data can be set in state. The framework will use this to translate the AttributeType to something Terraform can understand.
ValueFromObject returns an ObjectValuable type given an Object.
ValueFromTerraform returns an attr.Value given a tftypes.Value. This is meant to convert the tftypes.Value into a more convenient Go type for the provider to consume the data with.
ValueType returns the Value type.
WithAttributeTypes returns a new copy of the type with its attribute types set.
ObjectValuable extends attr.Value for object value types. Implement this interface to create a custom Object value type.
ObjectValuableWithSemanticEquals extends ObjectValuable with semantic equality logic.
type ObjectValue struct {
}
ObjectValue represents an object
NewObjectNull creates a Object with a null value. Determine whether the value is null via the Object type IsNull method.
NewObjectUnknown creates a Object with an unknown value. Determine whether the value is unknown via the Object type IsUnknown method.
NewObjectValue creates a Object with a known value. Access the value via the Object type ElementsAs method.
NewObjectValueFrom creates a Object with a known value, using reflection rules. The attributes must be a map of string attribute names to attribute values which can convert into the given attribute type or a struct with tfsdk field tags. Access the value via the Object type Elements or ElementsAs methods.
NewObjectValueMust creates a Object with a known value, converting any diagnostics into a panic at runtime. Access the value via the Object type Elements or ElementsAs methods.
This creation function is only recommended to create Object values which will not potentially effect practitioners, such as testing, or exhaustively tested provider logic.
As populates `target` with the data in the ObjectValue, throwing an error if the data cannot be stored in `target`.
AttributeTypes returns a copy of the mapping of attribute types for the Object.
Attributes returns a copy of the mapping of known attribute values for the Object.
Equal returns true if the given attr.Value is also an ObjectValue, has the same value state, and contains exactly the same attribute types/values as defined by the Equal method of those underlying types/values.
IsNull returns true if the Object represents a null value.
IsUnknown returns true if the Object represents a currently unknown value.
String returns a human-readable representation of the Object value. The string returned here is not protected by any compatibility guarantees, and is intended for logging and error reporting.
ToObjectValue returns the Object.
ToTerraformValue returns the data contained in the attr.Value as a tftypes.Value.
Type returns an ObjectType with the same attribute types as `o`.
SetTypable extends attr.Type for set types. Implement this interface to create a custom SetType type.
type SetType struct {
ElemType attr.Type
}
SetType is an AttributeType representing a set of values. All values must be of the same type, which the provider must specify as the ElemType property.
ApplyTerraform5AttributePathStep applies the given AttributePathStep to the set.
ElementType returns the attr.Type elements will be created from.
Equal returns true if `o` is also a SetType and has the same ElemType.
String returns a human-friendly description of the SetType.
TerraformType returns the tftypes.Type that should be used to represent this type. This constrains what user input will be accepted and what kind of data can be set in state. The framework will use this to translate the AttributeType to something Terraform can understand.
Validate implements type validation. This type requires all elements to be unique.
ValueFromSet returns a SetValuable type given a Set.
ValueFromTerraform returns an attr.Value given a tftypes.Value. This is meant to convert the tftypes.Value into a more convenient Go type for the provider to consume the data with.
ValueType returns the Value type.
WithElementType returns a SetType that is identical to `l`, but with the element type set to `typ`.
SetValuable extends attr.Value for set value types. Implement this interface to create a custom Set value type.
SetValuableWithSemanticEquals extends SetValuable with semantic equality logic.
SetValue represents a set of attr.Value, all of the same type, indicated by ElemType.
NewSetNull creates a Set with a null value. Determine whether the value is null via the Set type IsNull method.
NewSetUnknown creates a Set with an unknown value. Determine whether the value is unknown via the Set type IsUnknown method.
NewSetValue creates a Set with a known value. Access the value via the Set type Elements or ElementsAs methods.
NewSetValueFrom creates a Set with a known value, using reflection rules. The elements must be a slice which can convert into the given element type. Access the value via the Set type Elements or ElementsAs methods.
NewSetValueMust creates a Set with a known value, converting any diagnostics into a panic at runtime. Access the value via the Set type Elements or ElementsAs methods.
This creation function is only recommended to create Set values which will not potentially effect practitioners, such as testing, or exhaustively tested provider logic.
ElementType returns the element type for the Set.
Elements returns a copy of the collection of elements for the Set.
ElementsAs populates `target` with the elements of the SetValue, throwing an error if the elements cannot be stored in `target`.
Equal returns true if the given attr.Value is also a SetValue, has the same element type, same value state, and contains exactly the element values as defined by the Equal method of the element type.
IsNull returns true if the Set represents a null value.
IsUnknown returns true if the Set represents a currently unknown value. Returns false if the Set has a known number of elements, even if all are unknown values.
String returns a human-readable representation of the Set value. The string returned here is not protected by any compatibility guarantees, and is intended for logging and error reporting.
ToSetValue returns the Set.
ToTerraformValue returns the data contained in the Set as a tftypes.Value.
Type returns a SetType with the same element type as `s`.
StringTypable extends attr.Type for string types. Implement this interface to create a custom StringType type.
StringType is the base framework type for a string. StringValue is the associated value type.
ApplyTerraform5AttributePathStep applies the given AttributePathStep to the type.
Equal returns true if the given type is equivalent.
String returns a human readable string of the type name.
TerraformType returns the tftypes.Type that should be used to represent this framework type.
ValueFromString returns a StringValuable type given a StringValue.
ValueFromTerraform returns a Value given a tftypes.Value. This is meant to convert the tftypes.Value into a more convenient Go type for the provider to consume the data with.
ValueType returns the Value type.
StringValuable extends attr.Value for string value types. Implement this interface to create a custom String value type.
StringValuableWithSemanticEquals extends StringValuable with semantic equality logic.
type StringValue struct {
}
StringValue represents a UTF-8 string value.
NewStringNull creates a String with a null value. Determine whether the value is null via the String type IsNull method.
Setting the deprecated String type Null, Unknown, or Value fields after creating a String with this function has no effect.
NewStringPointerValue creates a String with a null value if nil or a known value. Access the value via the String type ValueStringPointer method.
NewStringUnknown creates a String with an unknown value. Determine whether the value is unknown via the String type IsUnknown method.
Setting the deprecated String type Null, Unknown, or Value fields after creating a String with this function has no effect.
NewStringValue creates a String with a known value. Access the value via the String type ValueString method.
Setting the deprecated String type Null, Unknown, or Value fields after creating a String with this function has no effect.
Equal returns true if `other` is a String and has the same value as `s`.
IsNull returns true if the String represents a null value.
IsUnknown returns true if the String represents a currently unknown value.
String returns a human-readable representation of the String value. Use the ValueString method for Terraform data handling instead.
The string returned here is not protected by any compatibility guarantees, and is intended for logging and error reporting.
ToStringValue returns String.
ToTerraformValue returns the data contained in the *String as a tftypes.Value.
Type returns a StringType.
ValueString returns the known string value. If String is null or unknown, returns "".
ValueStringPointer returns a pointer to the known string value, nil for a null value, or a pointer to "" for an unknown value.
type TupleType struct {
ElemTypes []attr.Type
}
TupleType implements a tuple type definition. This type intentionally includes less functionality than other types in the type system as it has limited real world application and therefore is not exposed to provider developers.
ApplyTerraform5AttributePathStep applies the given AttributePathStep to the tuple.
ElementTypes returns the ordered attr.Type slice for the tuple.
Equal returns true if `o` is also a TupleType and has the same ElemTypes in the same order.
String returns a human-friendly description of the TupleType.
TerraformType returns the tftypes.Type that should be used to represent this type.
ValueFromTerraform returns an attr.Value given a tftypes.Value. This is meant to convert the tftypes.Value into a more convenient Go type for the provider to consume the data with.
ValueType returns the Value type.
WithElementTypes returns a TupleType that is identical to `t`, but with the element types set to `types`.
type TupleValue struct {
}
TupleValue represents an ordered list of attr.Value, with an attr.Type for each element. This type intentionally includes less functionality than other types in the type system as it has limited real world application and therefore is not exposed to provider developers.
NewTupleNull creates a Tuple with a null value.
NewTupleUnknown creates a Tuple with an unknown value.
NewTupleValue creates a Tuple with a known value. Access the value via the Tuple type Elements method.
NewTupleValueMust creates a Tuple with a known value, converting any diagnostics into a panic at runtime. Access the value via the Tuple type Elements method.
This creation function is only recommended to create Tuple values which will not potentially affect practitioners, such as testing, or exhaustively tested provider logic.
ElementTypes returns the ordered list of element types for the Tuple.
Elements returns a copy of the ordered list of known values for the Tuple.
Equal returns true if the given attr.Value is also a Tuple, has the same value state, and contains exactly the same element types/values as defined by the Equal method of those underlying types/values.
IsNull returns true if the Tuple represents a null value.
IsUnknown returns true if the Tuple represents an unknown value.
String returns a human-readable representation of the Tuple. The string returned here is not protected by any compatibility guarantees, and is intended for logging and error reporting.
ToTerraformValue returns the equivalent tftypes.Value for the Tuple.
Type returns a TupleType with the elements types for the Tuple.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4