utils

package
v1.66.3 Latest Latest
Warning

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

 Go to latest Published: Jul 19, 2024 License: MPL-2.0 Imports: 28 Imported by: 22

Documentation

Index

Constants

View Source 
const REPLACE_REG = "(?i)huaweicloud"
View Source 
const SysTagKeyEnterpriseProjectId = "_sys_enterprise_project_id"

Variables

View Source 
var PackageName string
View Source 
var ValidateSubnetV2IPv6Mode = validation.StringInSlice([]string{
	"slaac", "dhcpv6-stateful", "dhcpv6-stateless",
}, false)

Functions

func Base64EncodeString added in v1.44.1 

func Base64EncodeString(str string) string

Base64EncodeString is used to encode a string by base64.

func Bool added in v1.30.0 

func Bool(v bool) *bool

returns a pointer to the bool value

func BuildNewFormatByConfig added in v1.26.0 

func BuildNewFormatByConfig(format string) string

func BuildSysTags added in v1.34.0 

func BuildSysTags(enterpriseProjectID string) (enterpriseProjectTags []tags.ResourceTag)

func CompareJsonTemplateAreEquivalent 

func CompareJsonTemplateAreEquivalent(tem1, tem2 string) (bool, error)

func ConvertMemoryUnit added in v1.58.0 

func ConvertMemoryUnit(memory interface{}, diffLevel int) int

ConvertMemoryUnit is a method that used to convert the memory unit. Parameters: + memory: The memory size of the current unit, only supports int value or string corresponding to int value. + diffLevel: Difference level between units before and after conversion. diffLevel greater than 0 means that the unit is converted to a higher level, and vice versa to a lower level, e.g. the unit of memory input is MB, -2 means it is converted from MB to B, and 2 means it is converted from MB to TB.

func ConvertStructToMap 

func ConvertStructToMap(obj interface{}, nameMap map[string]string) (map[string]interface{}, error)

ConvertStructToMap converts an instance of struct to a map object, and changes each key of fileds to the value of 'nameMap' if the key in it or to its corresponding lowercase.

func ConvertTimeStrToNanoTimestamp added in v1.63.1 

func ConvertTimeStrToNanoTimestamp(timeStr string, customFormat ...string) int64

ConvertTimeStrToNanoTimestamp is a method that used to convert the time string into the corresponding timestamp (in nanosecond), e.g. The supported time formats are as follows:

  • RFC3339 format: 2006-01-02T15:04:05Z (default time format, if you are missing customFormat input) 2006-01-02T15:04:05.000000Z 2006-01-02T15:04:05Z08:00
  • Other time formats: 2006-01-02 15:04:05 2006-01-02 15:04:05+08:00 2006-01-02T15:04:05 ...

Two common uses are shown below: - ConvertTimeStrToNanoTimestamp("2024-01-01T00:00:00Z") - ConvertTimeStrToNanoTimestamp("2024-01-01T00:00:00+08:00", "2006-01-02T15:04:05Z08:00")

func CreateResourceTags added in v1.46.0 

func CreateResourceTags(client *golangsdk.ServiceClient, d *schema.ResourceData, resourceType, id string) error

CreateResourceTags is a helper to create the tags for a resource. It expects the schema name must be "tags"

func DecodeHashAndHexEncode added in v1.31.1 

func DecodeHashAndHexEncode(v interface{}) string

DecodeHashAndHexEncode is one of the implementations of SchemaStateFunc. The function tries to decode v if it is in base64 format, then gets the hash of decode string and returns the hexadecimal encoding string. If the type of v is not string, just returns an empty string.

func DeleteResourceTagsWithKeys added in v1.46.0 

func DeleteResourceTagsWithKeys(client *golangsdk.ServiceClient, tagKeys []string, resourceType, id string) error

DeleteResourceTagsWithKeys is a helper to delete the tags with tagKeys for a resource.

func ExpandResourceTags 

func ExpandResourceTags(tagmap map[string]interface{}) []tags.ResourceTag

ExpandResourceTags returns the tags for the given map of data.

func ExpandResourceTagsMap added in v1.44.0 

func ExpandResourceTagsMap(tagmap map[string]interface{}) []map[string]interface{}

ExpandResourceTagsMap returns the tags in format of list of maps for the given map of data.

func ExpandToInt32List added in v1.38.0 

func ExpandToInt32List(v []interface{}) []int32

ExpandToInt32List takes the result for an array of intgers and returns a []int32

func ExpandToInt32ListPointer added in v1.38.0 

func ExpandToInt32ListPointer(v []interface{}) *[]int32

ExpandToInt32ListPointer takes the result for an array of in32 and returns a pointer of the array

func ExpandToIntList added in v1.29.0 

func ExpandToIntList(v []interface{}) []int

ExpandToIntList takes the result for an array of intgers and returns a []int

func ExpandToStringList 

func ExpandToStringList(v []interface{}) []string

ExpandToStringList takes the result for an array of strings and returns a []string

func ExpandToStringListBySet added in v1.29.0 

func ExpandToStringListBySet(v *schema.Set) []string

ExpandToStringListBySet takes the result for a set of strings and returns a []string

func ExpandToStringListPointer added in v1.36.0 

func ExpandToStringListPointer(v []interface{}) *[]string

ExpandToStringListPointer takes the result for an array of strings and returns a pointer of the array

func ExpandToStringMap added in v1.53.0 

func ExpandToStringMap(v map[string]interface{}) map[string]string

ExpandToStringMap takes the result for a map of string and returns a map[string]string

func FilterSliceWithField added in v1.30.0 

func FilterSliceWithField(all interface{}, filter map[string]interface{}) ([]interface{}, error)

FilterSliceWithField can filter the slice all through a map filter. If the field is a nested value, using dot(.) to split them, e.g. "SubBlock.SubField". If value in the map is zero, it will be ignored.

func FilterSliceWithZeroField added in v1.30.0 

func FilterSliceWithZeroField(all interface{}, filter map[string]interface{}) ([]interface{}, error)

FilterSliceWithZeroField can filter the slice all through a map filter.

func FlattenResponse added in v1.39.0 

func FlattenResponse(resp *http.Response) (interface{}, error)

FlattenResponse returns the api response body if it's not empty

func FlattenTagsToMap added in v1.41.0 

func FlattenTagsToMap(tags interface{}) map[string]interface{}

FlattenTagsToMap returns the list of tags into a map.

func Float64 added in v1.37.0 

func Float64(v float64) *float64

Float64 returns a pointer to the float64 value

func FormatTimeStampRFC3339 added in v1.26.0 

func FormatTimeStampRFC3339(timestamp int64, isUTC bool, customFormat ...string) string

FormatTimeStampRFC3339 is used to unify the time format to RFC-3339 and return a time string. We can use "isUTC" parameter to reset the timezone. If omitted, the method will return local time. Parameter "customFormat" allows you to use a custom RFC3339 format, such as: "2006-01-02T15:04:05.000Z", this parameter can be omitted.

func FormatTimeStampUTC added in v1.35.0 

func FormatTimeStampUTC(timestamp int64) string

FormatTimeStampUTC is used to unify the unix second time to UTC time string, format: YYYY-MM-DD HH:MM:SS.

func FormatUTCTimeStamp added in v1.38.0 

func FormatUTCTimeStamp(utcTime string) (int64, error)

FormatTimeStampUTC is used to unify the unix second time to UTC time string, format: YYYY-MM-DD HH:MM:SS.

func GetDNSRecordSetTagType 

func GetDNSRecordSetTagType(zoneType string) (string, error)

GetDNSRecordSetTagType returns resource tag type of DNS record set by zoneType

func GetDNSZoneTagType 

func GetDNSZoneTagType(zoneType string) (string, error)

GetDNSZoneTagType returns resource tag type of DNS zone by zoneType

func GetTimezoneCode added in v1.42.0 

func GetTimezoneCode() int

GetTimezoneCode calculates the time zone code and returns a signed number. For example, the time zone code for 'Asia/Shanghai' is 8, and the time zone code for 'America/Alaska' is -4.

func Green added in v1.64.2 

func Green(str interface{}) string

func HasMapContains added in v1.32.0 

func HasMapContains(rawMap map[string]string, filterMap map[string]interface{}) bool

This function compares whether there is a containment relationship between two maps, that is, whether map A (rawMap) contains map B (filterMap). 

Map A is {'foo': 'bar'} and filter map B is {'foo': 'bar'} or {'foo': 'bar,dor'} will return true.
Map A is {'foo': 'bar'} and filter map B is {'foo': 'dor'} or {'foo1': 'bar'} will return false.
Map A is {'foo': 'bar'} and filter map B is {'foo': ''} will return true.
Map A is {'foo': 'bar'} and filter map B is {'': 'bar'} or {'': ''} will return false.

The value of filter map 'bar,for' means that the object value can be either 'bar' or 'dor'. Note: There is no spaces before and after the delimiter (,).

func HashAndHexEncode added in v1.31.1 

func HashAndHexEncode(v interface{}) string

HashAndHexEncode is one of the implementations of SchemaStateFunc. The function gets the hash of v then returns the hexadecimal encoding string. If the type of v is not string, just returns an empty string.

func Int added in v1.38.0 

func Int(v int) *int

Int returns a pointer to the int value

func Int32 added in v1.36.0 

func Int32(v int32) *int32

Int32 returns a pointer to the int32 value

func Int32IgnoreEmpty added in v1.38.0 

func Int32IgnoreEmpty(v int32) *int32

Int32 returns a pointer to the int32 value. if v is empty, return nil

func Int64IgnoreEmpty added in v1.38.0 

func Int64IgnoreEmpty(v int64) *int64

Int32 returns a pointer to the int32 value

func IntIgnoreEmpty added in v1.39.0 

func IntIgnoreEmpty(v int) *int

Int returns a pointer to the int value. if v is empty, return nil

func IsDebugOrHigher added in v1.39.0 

func IsDebugOrHigher() bool

func IsIPv4Address added in v1.32.0 

func IsIPv4Address(addr string) bool

IsIPv4Address is used to check whether the addr string is IPv4 format

func IsResourceNotFound 

func IsResourceNotFound(err error) bool

func IsSliceContainsAnyAnotherSliceElement added in v1.64.2 

func IsSliceContainsAnyAnotherSliceElement(sl, another []string, ignoreCase, isExcat bool) bool

IsSliceContainsAnyAnotherSliceElement is a method that used to determine whether a list contains any element of another list (including its fragments belonging to the current string), returns true if it contains. sl: The slice body used to determine the inclusion relationship. another: The included slice object used to determine the inclusion relationship. ignoreCase: Whether to ignore case. isExcat: Whether the inclusion relationship of string objects applies exact matching rules.

func IsStrContainsSliceElement added in v1.38.0 

func IsStrContainsSliceElement(str string, sl []string, ignoreCase, isExcat bool) bool

IsStrContainsSliceElement returns true if the string exists in given slice or contains in one of slice elements when open exact flag. Also you can ignore case for this check.

func IsUUID added in v1.61.0 

func IsUUID(uuid string) bool

IsUUID is a method used to determine whether a string is in UUID format.

func JSONStringsEqual added in v1.49.0 

func JSONStringsEqual(s1, s2 string) bool

JSONStringsEqual is the function for comparing the contents of two json strings regardless of their formatting. Tabs (\r \n \t) and the order of elements are not included in the comparison. These json strings are same: + "{\n\"key1\":\"value1\",\n\"key2\":\"value2\"\n}" + "{\"key1\":\"value1\",\"key2\":\"value2\"}" + "{\"key2\":\"value2\",\"key1\":\"value1\"}"

func JsonMarshal 

func JsonMarshal(t interface{}) ([]byte, error)

func MarshalValue added in v1.37.0 

func MarshalValue(i interface{}) string

MarshalValue is used to marshal the value of struct in huaweicloud-sdk-go-v3, like this: type Xxxx struct { value string }

func NormalizeJsonString 

func NormalizeJsonString(jsonString interface{}) (string, error)

Takes a value containing JSON string and passes it through the JSON parser to normalize it, returns either a parsing error or normalized JSON string.

func ParseEnterpriseProjectIdFromSysTags added in v1.34.0 

func ParseEnterpriseProjectIdFromSysTags(value []tags.ResourceTag) (enterpriseProjectId string)

func PasswordEncrypt added in v1.33.0 

func PasswordEncrypt(password string) (string, error)

PasswordEncrypt encrypts given password with sha512

func PathSearch added in v1.39.0 

func PathSearch(expression string, obj interface{}, defaultValue interface{}) interface{}

PathSearch evaluates a JMESPath expression against input data and returns the result.

func Power added in v1.58.0 

func Power(base int, exponent int) int

Power is a method for calculating powers of exponents. The result is base^exponent (^ is the exponential operator).

func RandomString added in v1.38.0 

func RandomString(n int, allowedChars ...[]rune) (result string)

RandomString returns a random string with a fixed length. You can also define a custom random character set. Note: make sure the number is not a negative integer or a big integer.

func RemoveDuplicateElem 

func RemoveDuplicateElem(s []string) []string

RemoveDuplicateElem removes duplicate elements from slice

func RemoveNil 

func RemoveNil(data map[string]interface{}) map[string]interface{}

func Reverse added in v1.48.0 

func Reverse(s string) string

Reverse is a function that used to reverse the order of the characters in the given string.

func Salt added in v1.33.0 

func Salt(size int) ([]byte, error)

Salt generates a random salt according to given size

func SchemaDesc added in v1.56.0 

func SchemaDesc(description string, schemaDescInput SchemaDescInput) string

func SetResourceTagsToState added in v1.29.0 

func SetResourceTagsToState(d *schema.ResourceData, client *golangsdk.ServiceClient, resourceType, id string) error

SetResourceTagsToState is a helper to query tags of resource, then set to state. The schema argument name must be: tags

func StrSliceContains 

func StrSliceContains(haystack []string, needle string) bool

StrSliceContains checks if a given string is contained in a slice When anybody asks why Go needs generics, here you go.

func StrSliceContainsAnother added in v1.38.1 

func StrSliceContainsAnother(b []string, s []string) bool

StrSliceContainsAnother checks whether a string slice (b) contains another string slice (s).

func String added in v1.35.0 

func String(v string) *string

returns a pointer to the string value

func StringIgnoreEmpty added in v1.37.0 

func StringIgnoreEmpty(v string) *string

returns a pointer to the string value. if v is empty, return nil

func StringToBool added in v1.50.0 

func StringToBool(v interface{}) *bool

StringToBool convert the string to boolean, and return the pointer of boolean value

func StringToInt added in v1.37.0 

func StringToInt(i *string) *int

StringToInt convert the string to int, and return the pointer of int value

func StringValue added in v1.38.0 

func StringValue(v *string) string

StringValue returns the string value

func SuppressCaseDiffs 

func SuppressCaseDiffs(k, old, new string, d *schema.ResourceData) bool

Suppress changes if we get a string with or without cases

func SuppressDiffAll 

func SuppressDiffAll(k, old, new string, d *schema.ResourceData) bool

Suppress all changes

func SuppressEquivalentAwsPolicyDiffs 

func SuppressEquivalentAwsPolicyDiffs(k, old, new string, d *schema.ResourceData) bool

func SuppressEquivilentTimeDiffs 

func SuppressEquivilentTimeDiffs(k, old, new string, d *schema.ResourceData) bool

func SuppressLBWhitelistDiffs 

func SuppressLBWhitelistDiffs(k, old, new string, d *schema.ResourceData) bool

func SuppressMinDisk 

func SuppressMinDisk(k, old, new string, d *schema.ResourceData) bool

Suppress changes if we get a computed min_disk_gb if value is unspecified (default 0)

func SuppressNewLineDiffs 

func SuppressNewLineDiffs(k, old, new string, d *schema.ResourceData) bool

Suppress changes if we get a string with or without new line

func SuppressSnatFiplistDiffs 

func SuppressSnatFiplistDiffs(k, old, new string, d *schema.ResourceData) bool

func SuppressStringSepratedByCommaDiffs added in v1.61.1 

func SuppressStringSepratedByCommaDiffs(_, old, new string, _ *schema.ResourceData) bool

func SuppressTrimSpace added in v1.57.0 

func SuppressTrimSpace(_, old, new string, _ *schema.ResourceData) bool

func SuppressUserData added in v1.43.0 

func SuppressUserData(k, old, new string, d *schema.ResourceData) bool

Suppress changes if we get a base64 format or plaint text user_data

func SuppressVersionDiffs added in v1.35.0 

func SuppressVersionDiffs(k, old, new string, d *schema.ResourceData) bool

func TagsToMap 

func TagsToMap(tags []tags.ResourceTag) map[string]string

TagsToMap returns the list of tags into a map.

func TryBase64EncodeString added in v1.44.1 

func TryBase64EncodeString(str string) string

TryBase64EncodeString will encode a string with base64. If the string is already base64 encoded, returns it directly.

func TryPasswordEncrypt added in v1.33.0 

func TryPasswordEncrypt(password string) (string, error)

TryPasswordEncrypt tries to encrypt given password if it's not encrypted

func UpdateResourceTags 

func UpdateResourceTags(conn *golangsdk.ServiceClient, d *schema.ResourceData, resourceType, id string) error

UpdateResourceTags is a helper to update the tags for a resource. It expects the tags field to be named "tags"

func ValidateCIDR 

func ValidateCIDR(v interface{}, k string) (ws []string, errors []error)

func ValidateIP 

func ValidateIP(v interface{}, k string) (ws []string, errors []error)

func ValidateIPRange 

func ValidateIPRange(v interface{}, k string) (ws []string, errors []error)

func ValidateJsonString 

func ValidateJsonString(v interface{}, k string) (ws []string, errors []error)

func ValidateName 

func ValidateName(v interface{}, k string) (ws []string, errors []error)

lintignore:V001

func ValidateString64WithChinese 

func ValidateString64WithChinese(v interface{}, k string) (ws []string, errors []error)

lintignore:V001

func ValidateTrueOnly 

func ValidateTrueOnly(v interface{}, k string) (ws []string, errors []error)

func ValidateVBSBackupDescription 

func ValidateVBSBackupDescription(v interface{}, k string) (ws []string, errors []error)

lintignore:V001

func ValidateVBSBackupName 

func ValidateVBSBackupName(v interface{}, k string) (ws []string, errors []error)

lintignore:V001

func ValidateVBSPolicyName 

func ValidateVBSPolicyName(v interface{}, k string) (ws []string, errors []error)

lintignore:V001

func ValidateVBSTagKey 

func ValidateVBSTagKey(v interface{}, k string) (ws []string, errors []error)

lintignore:V001

func ValidateVBSTagValue 

func ValidateVBSTagValue(v interface{}, k string) (ws []string, errors []error)

lintignore:V001

func ValueIgnoreEmpty added in v1.65.1 

func ValueIgnoreEmpty(v interface{}) interface{}

ValueIgnoreEmpty returns to the string value. if v is empty, return nil

func WriteToPemFile added in v1.37.0 

func WriteToPemFile(path, privateKey string) (err error)

WriteToPemFile is used to write the keypair to Pem file.

func Yellow added in v1.64.2 

func Yellow(str interface{}) string

Types

type SchemaDescInput added in v1.56.0 

type SchemaDescInput struct {
	Internal   bool     `json:"Internal,omitempty"`
	Deprecated bool     `json:"Deprecated,omitempty"`
	Required   bool     `json:"Required,omitempty"`
	Computed   bool     `json:"Computed,omitempty"`
	ForceNew   bool     `json:"ForceNew,omitempty"`
	Unscope    []string `json:"Unscope,omitempty"`
	UsedBy     []string `json:"UsedBy,omitempty"`
}

Source Files

View all Source files

Directories

Path Synopsis

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.