stringvalidator

Documentation

Index

• func IsIP() validator.String
• func IsMacAddress() validator.String
• func IsNetmask() validator.String
• func IsNetwork(networkTypes []NetworkValidatorType, comparatorOR bool) validator.String
• func IsURN() validator.String
• func IsUUID() validator.String
• func Not(valueValidator validator.String) validator.String
• func NullIfAttributeIsOneOf(path path.Expression, exceptedValue []attr.Value) validator.String
• func NullIfAttributeIsSet(path path.Expression) validator.String
• func OneOfWithDescription(values ...OneOfWithDescriptionValues) validator.String
• func PrefixContains(prefix string) validator.String
• func RequireIfAttributeIsOneOf(path path.Expression, exceptedValue []attr.Value) validator.String
• func RequireIfAttributeIsSet(path path.Expression) validator.String
• type NetworkValidatorType
• type OneOfWithDescriptionValues

Functions

func IsIP

func IsIP() validator.String

IsIP returns a validator which ensures that the configured attribute value is a valid IP address with net.ParseIP package.

Null (unconfigured) and unknown (known after apply) values are skipped.

func IsMacAddress

func IsMacAddress() validator.String

IsMacAddress

returns a validator which ensures that the configured attribute value is a valid MacAddress.

Null (unconfigured) and unknown (known after apply) values are skipped.

func IsNetmask

func IsNetmask() validator.String

IsNetmask

returns a validator which ensures that the configured attribute value is a valid Netmask.

Null (unconfigured) and unknown (known after apply) values are skipped.

func IsNetwork

func IsNetwork(networkTypes []NetworkValidatorType, comparatorOR bool) validator.String

IsNetwork returns a validator that validates the string value is a valid network.

Parameters:

• networkTypes : The network types to validate.
• comparatorOR : If true, the value must be at least one of the network types.

func IsURN

func IsURN() validator.String

IsURN returns a validator which ensures that the configured attribute value is a valid URN.

Null (unconfigured) and unknown (known after apply) values are skipped.

func IsUUID

func IsUUID() validator.String

IsUUID returns a validator which ensures that the configured attribute value is a valid (v4) UUID.

Null (unconfigured) and unknown (known after apply) values are skipped.

func Not

func Not(valueValidator validator.String) validator.String

Not returns a validator which ensures that the validators passed as arguments are not met.

func NullIfAttributeIsOneOf

func NullIfAttributeIsOneOf(path path.Expression, exceptedValue []attr.Value) validator.String

NullIfAttributeIsOneOf checks if the path.Path attribute contains one of the exceptedValue attr.Value.

func NullIfAttributeIsSet

func NullIfAttributeIsSet(path path.Expression) validator.String

NullIfAttributeIsSet checks if the path.Path attribute contains one of the exceptedValue attr.Value.

func OneOfWithDescription

func OneOfWithDescription(values ...OneOfWithDescriptionValues) validator.String

OneOfWithDescription checks that the String held in the attribute is one of the given `values`. The description of the value is used to generate advanced Description and MarkdownDescription messages.

func PrefixContains

func PrefixContains(prefix string) validator.String

PrefixContainsValidator is a validator which ensures that the configured attribute value contains the specified prefix.

Null (unconfigured) and unknown (known after apply) values are skipped.

func RequireIfAttributeIsOneOf

func RequireIfAttributeIsOneOf(path path.Expression, exceptedValue []attr.Value) validator.String

RequireIfAttributeIsOneOf checks if the path.Path attribute contains one of the exceptedValue attr.Value.

func RequireIfAttributeIsSet

func RequireIfAttributeIsSet(path path.Expression) validator.String

RequireIfAttributeIsSet checks if the path.Path attribute is set

Types

type NetworkValidatorType

type NetworkValidatorType string

const (
	IPV4            NetworkValidatorType = "ipv4"
	IPV4WithCIDR    NetworkValidatorType = "ipv4_with_cidr"
	IPv4WithNetmask NetworkValidatorType = "ipv4_with_netmask"
	RFC1918         NetworkValidatorType = "rfc1918"
)

type OneOfWithDescriptionValues

type OneOfWithDescriptionValues struct {
	Value       string
	Description string
}