Remove get in getters https://go.dev/doc/effective_go\#Getters

rishav-karanjit · rishav-karanjit · commit 6487e76e013f · 2025-01-03T15:41:57.000-08:00
diff --git a/AwsEncryptionSDK/runtimes/go/examples/cryptographicmaterialsmanager/requiredencryptioncontext/requiredencryptioncontext.go b/AwsEncryptionSDK/runtimes/go/examples/cryptographicmaterialsmanager/requiredencryptioncontext/requiredencryptioncontext.go
@@ -18,7 +18,6 @@ import (
 	mpltypes "github.com/aws/aws-cryptographic-material-providers-library/mpl/awscryptographymaterialproviderssmithygeneratedtypes"
 	client "github.com/aws/aws-encryption-sdk/awscryptographyencryptionsdksmithygenerated"
 	esdktypes "github.com/aws/aws-encryption-sdk/awscryptographyencryptionsdksmithygeneratedtypes"
-	"github.com/aws/aws-encryption-sdk/examples/utils"
 	"github.com/aws/aws-sdk-go-v2/config"
 	"github.com/aws/aws-sdk-go-v2/service/kms"
 )
@@ -30,7 +29,7 @@ func RequiredEncryptionContextExample(exampleText, defaultKMSKeyId, defaultKmsKe
 		panic(err)
 	}
 	kmsClient := kms.NewFromConfig(cfg, func(o *kms.Options) {
-		o.Region = utils.GetDefaultKmsKeyRegion()
+		o.Region = defaultKmsKeyRegion
 	})
 	// Step 2: Initialize the mpl client
 	matProv, err := mpl.NewClient(mpltypes.MaterialProvidersConfig{})
@@ -40,7 +39,7 @@ func RequiredEncryptionContextExample(exampleText, defaultKMSKeyId, defaultKmsKe
 	// Step 3: Create the keyring
 	awsKmsKeyringInput := mpltypes.CreateAwsKmsKeyringInput{
 		KmsClient: kmsClient,
-		KmsKeyId:  utils.GetDefaultKMSKeyId(),
+		KmsKeyId:  defaultKMSKeyId,
 	}
 	awsKmsKeyring, err := matProv.CreateAwsKmsKeyring(context.Background(), awsKmsKeyringInput)
 	if err != nil {
diff --git a/AwsEncryptionSDK/runtimes/go/examples/main.go b/AwsEncryptionSDK/runtimes/go/examples/main.go
@@ -30,132 +30,132 @@ func main() {
 	const stringToEncrypt = "Text To encrypt"
 	clientsupplier.ClientSupplierExample(
 		stringToEncrypt,
-		utils.GetDefaultRegionMrkKeyArn(),
-		utils.GetDefaultKMSKeyAccountID(),
+		utils.DefaultRegionMrkKeyArn(),
+		utils.DefaultKMSKeyAccountID(),
 		[]string{"eu-west-1"})
 	misc.CommitmentPolicyExample(
 		stringToEncrypt,
-		utils.GetDefaultKMSKeyId(),
-		utils.GetDefaultKmsKeyRegion())
+		utils.DefaultKMSKeyId(),
+		utils.DefaultKmsKeyRegion())
 	misc.SetEncryptionAlgorithmSuiteExample(stringToEncrypt)
 	var maxEncryptedDataKeys int64 = 3
 	misc.LimitEncryptedDataKeyExample(
 		stringToEncrypt,
-		utils.GetDefaultKMSKeyId(),
-		utils.GetDefaultKmsKeyRegion(),
+		utils.DefaultKMSKeyId(),
+		utils.DefaultKmsKeyRegion(),
 		maxEncryptedDataKeys)
 	requiredencryptioncontext.RequiredEncryptionContextExample(
 		stringToEncrypt,
-		utils.GetDefaultKMSKeyId(),
-		utils.GetDefaultKmsKeyRegion())
+		utils.DefaultKMSKeyId(),
+		utils.DefaultKmsKeyRegion())
 	restrictalgorithmsuite.SigningOnlyExample(
 		stringToEncrypt,
-		utils.GetDefaultKMSKeyId(),
-		utils.GetDefaultKmsKeyRegion())
+		utils.DefaultKMSKeyId(),
+		utils.DefaultKmsKeyRegion())
 	// keyrings
 	ecdh.PublicKeyRawEcdhDiscoveryKeyringExample(
 		stringToEncrypt,
 		primitivestypes.ECDHCurveSpecEccNistP256,
-		utils.GetEccPublicKeyFileNameRecipient(),
-		utils.GetEccPrivateKeyFileNameRecipient())
+		utils.EccPublicKeyFileNameRecipient(),
+		utils.EccPrivateKeyFileNameRecipient())
 	ecdh.EphemeralRawECDHKeyringExample(
 		stringToEncrypt,
 		primitivestypes.ECDHCurveSpecEccNistP256,
-		utils.GetEccPublicKeyFileNameRecipient())
+		utils.EccPublicKeyFileNameRecipient())
 	ecdh.RawECDHKeyringExample(
 		stringToEncrypt,
 		primitivestypes.ECDHCurveSpecEccNistP256,
-		utils.GetEccPublicKeyFileNameRecipient(),
-		utils.GetEccPrivateKeyFileNameSender())
+		utils.EccPublicKeyFileNameRecipient(),
+		utils.EccPrivateKeyFileNameSender())
 	ecdh.AwsKmsEcdhKeyringExample(
 		stringToEncrypt,
 		primitivestypes.ECDHCurveSpecEccNistP256,
-		utils.GetKmsEcdhKeyIdP256RecipientKeyId(),
-		utils.GetKmsEcdhKeyIdP256SenderKeyId(),
-		utils.GetKmsEccPublicKeyFileNameSender(),
-		utils.GetKmsEccPublicKeyFileNameRecipient())
+		utils.KmsEcdhKeyIdP256RecipientKeyId(),
+		utils.KmsEcdhKeyIdP256SenderKeyId(),
+		utils.KmsEccPublicKeyFileNameSender(),
+		utils.KmsEccPublicKeyFileNameRecipient())
 	ecdh.AwsKmsEcdhDiscoveryKeyringExample(
 		stringToEncrypt,
 		primitivestypes.ECDHCurveSpecEccNistP256,
-		utils.GetKmsEcdhKeyIdP256RecipientKeyId(),
-		utils.GetKmsEcdhKeyIdP256SenderKeyId(),
-		utils.GetKmsEccPublicKeyFileNameSender(),
-		utils.GetKmsEccPublicKeyFileNameRecipient())
+		utils.KmsEcdhKeyIdP256RecipientKeyId(),
+		utils.KmsEcdhKeyIdP256SenderKeyId(),
+		utils.KmsEccPublicKeyFileNameSender(),
+		utils.KmsEccPublicKeyFileNameRecipient())
 	awskmskeyring.AwsKmsKeyringExample(
 		stringToEncrypt,
-		utils.GetDefaultKMSKeyId(),
-		utils.GetDefaultKMSKeyAccountID())
+		utils.DefaultKMSKeyId(),
+		utils.DefaultKMSKeyAccountID())
 	awskmsrsakeyring.AwsKmsRsaExample(
 		stringToEncrypt,
-		utils.GetTestKmsRsaKeyID(),
-		utils.GetKmsRSAPublicKey())
+		utils.TestKmsRsaKeyID(),
+		utils.KmsRSAPublicKey())
 	awskmsmultikeyring.AwsKmsMultiKeyringExample(
 		stringToEncrypt,
-		utils.GetDefaultKMSKeyId(),
-		utils.GetAlternateRegionKMSKeyId(),
-		utils.GetAlternateRegionKMSKeyRegion())
+		utils.DefaultKMSKeyId(),
+		utils.AlternateRegionKMSKeyId(),
+		utils.AlternateRegionKMSKeyRegion())
 	awskmsdiscoverykeyring.AwsKmsDiscoveryKeyringExample(
 		stringToEncrypt,
-		utils.GetDefaultKMSKeyId(),
-		utils.GetDefaultKMSKeyAccountID())
+		utils.DefaultKMSKeyId(),
+		utils.DefaultKMSKeyAccountID())
 	awskmsdiscoverymultikeyring.AwsKmsDiscoveryMultiKeyringExample(
 		stringToEncrypt,
-		utils.GetDefaultKMSKeyId(),
-		utils.GetDefaultKMSKeyAccountID(),
-		utils.GetRegions())
+		utils.DefaultKMSKeyId(),
+		utils.DefaultKMSKeyAccountID(),
+		utils.Regions())
 	rawrsakeyring.RawRsaExample(stringToEncrypt)
 	awskmsmrkkeyring.AwsKmsMrkKeyringExample(
 		stringToEncrypt,
-		utils.GetDefaultRegionMrkKeyArn(),
-		utils.GetAlternateRegionMrkKeyArn(),
-		utils.GetDefaultMRKKeyRegion(),
-		utils.GetAlternateRegionMrkKeyRegion())
+		utils.DefaultRegionMrkKeyArn(),
+		utils.AlternateRegionMrkKeyArn(),
+		utils.DefaultMRKKeyRegion(),
+		utils.AlternateRegionMrkKeyRegion())
 	awskmsmrkmultikeyring.AwsKmsMrkMultiKeyringExample(
 		stringToEncrypt,
-		utils.GetDefaultRegionMrkKeyArn(),
-		utils.GetAlternateRegionMrkKeyArn(),
-		utils.GetDefaultKMSKeyId(),
-		utils.GetAlternateRegionMrkKeyRegion())
+		utils.DefaultRegionMrkKeyArn(),
+		utils.AlternateRegionMrkKeyArn(),
+		utils.DefaultKMSKeyId(),
+		utils.AlternateRegionMrkKeyRegion())
 	awskmsmrkdiscoverykeyring.AwsKmsMrkDiscoveryKeyringExample(
 		stringToEncrypt,
-		utils.GetDefaultRegionMrkKeyArn(),
-		utils.GetDefaultMRKKeyRegion(),
-		utils.GetAlternateRegionMrkKeyRegion(),
-		utils.GetDefaultKMSKeyAccountID())
+		utils.DefaultRegionMrkKeyArn(),
+		utils.DefaultMRKKeyRegion(),
+		utils.AlternateRegionMrkKeyRegion(),
+		utils.DefaultKMSKeyAccountID())
 	awskmsmrkdiscoverymultikeyring.AwsKmsMrkDiscoveryMultiKeyringExample(
 		stringToEncrypt,
-		utils.GetDefaultRegionMrkKeyArn(),
-		utils.GetDefaultMRKKeyRegion(),
-		utils.GetDefaultKMSKeyAccountID(),
-		utils.GetRegionsOfMRKKeys(),
+		utils.DefaultRegionMrkKeyArn(),
+		utils.DefaultMRKKeyRegion(),
+		utils.DefaultKMSKeyAccountID(),
+		utils.RegionsOfMRKKeys(),
 	)
 	awskmshierarchicalkeyring.AwsKmsHKeyExample(
 		stringToEncrypt,
-		utils.GetKeyStoreKMSKeyRegion(),
-		utils.GetKeyStoreRegion(),
-		utils.GetKeyStoreKMSKeyID(),
-		utils.GetKeyStoreName(),
-		utils.GetLogicalKeyStoreName(),
+		utils.KeyStoreKMSKeyRegion(),
+		utils.KeyStoreRegion(),
+		utils.KeyStoreKMSKeyID(),
+		utils.KeyStoreName(),
+		utils.LogicalKeyStoreName(),
 	)
 	awskmshierarchicalkeyring.CreateAndVersionBranchKeyId(
-		utils.GetKeyStoreKMSKeyRegion(),
-		utils.GetKeyStoreRegion(),
-		utils.GetKeyStoreKMSKeyID(),
-		utils.GetKeyStoreName(),
-		utils.GetLogicalKeyStoreName(),
+		utils.KeyStoreKMSKeyRegion(),
+		utils.KeyStoreRegion(),
+		utils.KeyStoreKMSKeyID(),
+		utils.KeyStoreName(),
+		utils.LogicalKeyStoreName(),
 	)
 	awskmshierarchicalkeyring.SharedCacheExample(
 		stringToEncrypt,
-		utils.GetKeyStoreKMSKeyRegion(),
-		utils.GetKeyStoreRegion(),
-		utils.GetKeyStoreKMSKeyID(),
-		utils.GetKeyStoreName(),
-		utils.GetLogicalKeyStoreName(),
+		utils.KeyStoreKMSKeyRegion(),
+		utils.KeyStoreRegion(),
+		utils.KeyStoreKMSKeyID(),
+		utils.KeyStoreName(),
+		utils.LogicalKeyStoreName(),
 	)
 	rawaeskeyring.RawAesExample(stringToEncrypt)
 	multikeyring.MultiKeyringExample(
 		stringToEncrypt,
-		utils.GetDefaultKMSKeyId(),
-		utils.GetDefaultKmsKeyRegion(),
+		utils.DefaultKMSKeyId(),
+		utils.DefaultKmsKeyRegion(),
 	)
 }
diff --git a/AwsEncryptionSDK/runtimes/go/examples/utils/exampleUtils.go b/AwsEncryptionSDK/runtimes/go/examples/utils/exampleUtils.go
@@ -51,103 +51,103 @@ twIDAQAB
 
 // Getter functions
 
-func GetKmsEcdhKeyIdP256SenderKeyId() string {
+func KmsEcdhKeyIdP256SenderKeyId() string {
 	return testKmsEcdhKeyIdP256SenderKeyId
 }
 
-func GetKmsEcdhKeyIdP256RecipientKeyId() string {
+func KmsEcdhKeyIdP256RecipientKeyId() string {
 	return testKmsEcdhKeyIdP256RecipientKeyId
 }
 
-func GetKmsEccPublicKeyFileNameRecipient() string {
+func KmsEccPublicKeyFileNameRecipient() string {
 	return kmsEccPublicKeyFileNameRecipient
 }
 
-func GetKmsEccPublicKeyFileNameSender() string {
+func KmsEccPublicKeyFileNameSender() string {
 	return kmsEccPublicKeyFileNameSender
 }
 
-func GetEccPrivateKeyFileNameSender() string {
+func EccPrivateKeyFileNameSender() string {
 	return eccPrivateKeyFileNameSender
 }
 
-func GetEccPrivateKeyFileNameRecipient() string {
+func EccPrivateKeyFileNameRecipient() string {
 	return eccPrivateKeyFileNameRecipient
 }
 
-func GetEccPublicKeyFileNameRecipient() string {
+func EccPublicKeyFileNameRecipient() string {
 	return eccPublicKeyFileNameRecipient
 }
 
-func GetRegionsOfMRKKeys() []string {
+func RegionsOfMRKKeys() []string {
 	return []string{defaultMRKKeyRegion, alternateRegionMrkKeyRegion}
 }
 
-func GetRegions() []string {
+func Regions() []string {
 	return []string{defaultKmsKeyRegion, testAlternateRegionKMSKeyRegion}
 }
 
-func GetDefaultKmsKeyRegion() string {
+func DefaultKmsKeyRegion() string {
 	return defaultKmsKeyRegion
 }
 
-func GetDefaultMRKKeyRegion() string {
+func DefaultMRKKeyRegion() string {
 	return defaultMRKKeyRegion
 }
 
-func GetAlternateRegionMrkKeyRegion() string {
+func AlternateRegionMrkKeyRegion() string {
 	return alternateRegionMrkKeyRegion
 }
 
-func GetAlternateRegionMrkKeyArn() string {
+func AlternateRegionMrkKeyArn() string {
 	return testAlternateRegionMrkKeyId
 }
 
-func GetDefaultRegionMrkKeyArn() string {
+func DefaultRegionMrkKeyArn() string {
 	return testDefaultMRKKeyId
 }
 
-func GetAlternateRegionKMSKeyRegion() string {
+func AlternateRegionKMSKeyRegion() string {
 	return testAlternateRegionKMSKeyRegion
 }
 
-func GetAlternateRegionKMSKeyId() string {
+func AlternateRegionKMSKeyId() string {
 	return testAlternateRegionKMSKeyId
 }
 
-func GetDefaultKMSKeyAccountID() string {
+func DefaultKMSKeyAccountID() string {
 	return defaultKMSKeyAccountID
 }
 
-func GetDefaultKMSKeyId() string {
+func DefaultKMSKeyId() string {
 	return testDefaultKMSKeyId
 }
 
-func GetTestKmsRsaKeyID() string {
+func TestKmsRsaKeyID() string {
 	return testKmsRsaKeyID
 }
 
-func GetKmsRSAPublicKey() []byte {
+func KmsRSAPublicKey() []byte {
 	return []byte(testKmsRsaPublicKey)
 }
 
-func GetKeyStoreRegion() string {
+func KeyStoreRegion() string {
 	return testKeyStoreRegion
 }
 
-func GetKeyStoreKMSKeyRegion() string {
+func KeyStoreKMSKeyRegion() string {
 	return testKeyStoreKMSKeyRegion
 }
 
-func GetKeyStoreKMSKeyID() string {
+func KeyStoreKMSKeyID() string {
 	return testKeyStoreKMSKeyID
 }
 
-func GetLogicalKeyStoreName() string {
+func LogicalKeyStoreName() string {
 	return testLogicalKeyStoreName
 }
 
-func GetKeyStoreName() string {
+func KeyStoreName() string {
 	return testKeyStoreName
 }
 

Original file line number	Diff line number	Diff line change
`@@ -51,103 +51,103 @@ twIDAQAB`
`51`	`51`
`52`	`52`	`// Getter functions`
`53`	`53`
`54`		`-func GetKmsEcdhKeyIdP256SenderKeyId() string {`
	`54`	`+func KmsEcdhKeyIdP256SenderKeyId() string {`
`55`	`55`	`return testKmsEcdhKeyIdP256SenderKeyId`
`56`	`56`	`}`
`57`	`57`
`58`		`-func GetKmsEcdhKeyIdP256RecipientKeyId() string {`
	`58`	`+func KmsEcdhKeyIdP256RecipientKeyId() string {`
`59`	`59`	`return testKmsEcdhKeyIdP256RecipientKeyId`
`60`	`60`	`}`
`61`	`61`
`62`		`-func GetKmsEccPublicKeyFileNameRecipient() string {`
	`62`	`+func KmsEccPublicKeyFileNameRecipient() string {`
`63`	`63`	`return kmsEccPublicKeyFileNameRecipient`
`64`	`64`	`}`
`65`	`65`
`66`		`-func GetKmsEccPublicKeyFileNameSender() string {`
	`66`	`+func KmsEccPublicKeyFileNameSender() string {`
`67`	`67`	`return kmsEccPublicKeyFileNameSender`
`68`	`68`	`}`
`69`	`69`
`70`		`-func GetEccPrivateKeyFileNameSender() string {`
	`70`	`+func EccPrivateKeyFileNameSender() string {`
`71`	`71`	`return eccPrivateKeyFileNameSender`
`72`	`72`	`}`
`73`	`73`
`74`		`-func GetEccPrivateKeyFileNameRecipient() string {`
	`74`	`+func EccPrivateKeyFileNameRecipient() string {`
`75`	`75`	`return eccPrivateKeyFileNameRecipient`
`76`	`76`	`}`
`77`	`77`
`78`		`-func GetEccPublicKeyFileNameRecipient() string {`
	`78`	`+func EccPublicKeyFileNameRecipient() string {`
`79`	`79`	`return eccPublicKeyFileNameRecipient`
`80`	`80`	`}`
`81`	`81`
`82`		`-func GetRegionsOfMRKKeys() []string {`
	`82`	`+func RegionsOfMRKKeys() []string {`
`83`	`83`	`return []string{defaultMRKKeyRegion, alternateRegionMrkKeyRegion}`
`84`	`84`	`}`
`85`	`85`
`86`		`-func GetRegions() []string {`
	`86`	`+func Regions() []string {`
`87`	`87`	`return []string{defaultKmsKeyRegion, testAlternateRegionKMSKeyRegion}`
`88`	`88`	`}`
`89`	`89`
`90`		`-func GetDefaultKmsKeyRegion() string {`
	`90`	`+func DefaultKmsKeyRegion() string {`
`91`	`91`	`return defaultKmsKeyRegion`
`92`	`92`	`}`
`93`	`93`
`94`		`-func GetDefaultMRKKeyRegion() string {`
	`94`	`+func DefaultMRKKeyRegion() string {`
`95`	`95`	`return defaultMRKKeyRegion`
`96`	`96`	`}`
`97`	`97`
`98`		`-func GetAlternateRegionMrkKeyRegion() string {`
	`98`	`+func AlternateRegionMrkKeyRegion() string {`
`99`	`99`	`return alternateRegionMrkKeyRegion`
`100`	`100`	`}`
`101`	`101`
`102`		`-func GetAlternateRegionMrkKeyArn() string {`
	`102`	`+func AlternateRegionMrkKeyArn() string {`
`103`	`103`	`return testAlternateRegionMrkKeyId`
`104`	`104`	`}`
`105`	`105`
`106`		`-func GetDefaultRegionMrkKeyArn() string {`
	`106`	`+func DefaultRegionMrkKeyArn() string {`
`107`	`107`	`return testDefaultMRKKeyId`
`108`	`108`	`}`
`109`	`109`
`110`		`-func GetAlternateRegionKMSKeyRegion() string {`
	`110`	`+func AlternateRegionKMSKeyRegion() string {`
`111`	`111`	`return testAlternateRegionKMSKeyRegion`
`112`	`112`	`}`
`113`	`113`
`114`		`-func GetAlternateRegionKMSKeyId() string {`
	`114`	`+func AlternateRegionKMSKeyId() string {`
`115`	`115`	`return testAlternateRegionKMSKeyId`
`116`	`116`	`}`
`117`	`117`
`118`		`-func GetDefaultKMSKeyAccountID() string {`
	`118`	`+func DefaultKMSKeyAccountID() string {`
`119`	`119`	`return defaultKMSKeyAccountID`
`120`	`120`	`}`
`121`	`121`
`122`		`-func GetDefaultKMSKeyId() string {`
	`122`	`+func DefaultKMSKeyId() string {`
`123`	`123`	`return testDefaultKMSKeyId`
`124`	`124`	`}`
`125`	`125`
`126`		`-func GetTestKmsRsaKeyID() string {`
	`126`	`+func TestKmsRsaKeyID() string {`
`127`	`127`	`return testKmsRsaKeyID`
`128`	`128`	`}`
`129`	`129`
`130`		`-func GetKmsRSAPublicKey() []byte {`
	`130`	`+func KmsRSAPublicKey() []byte {`
`131`	`131`	`return []byte(testKmsRsaPublicKey)`
`132`	`132`	`}`
`133`	`133`
`134`		`-func GetKeyStoreRegion() string {`
	`134`	`+func KeyStoreRegion() string {`
`135`	`135`	`return testKeyStoreRegion`
`136`	`136`	`}`
`137`	`137`
`138`		`-func GetKeyStoreKMSKeyRegion() string {`
	`138`	`+func KeyStoreKMSKeyRegion() string {`
`139`	`139`	`return testKeyStoreKMSKeyRegion`
`140`	`140`	`}`
`141`	`141`
`142`		`-func GetKeyStoreKMSKeyID() string {`
	`142`	`+func KeyStoreKMSKeyID() string {`
`143`	`143`	`return testKeyStoreKMSKeyID`
`144`	`144`	`}`
`145`	`145`
`146`		`-func GetLogicalKeyStoreName() string {`
	`146`	`+func LogicalKeyStoreName() string {`
`147`	`147`	`return testLogicalKeyStoreName`
`148`	`148`	`}`
`149`	`149`
`150`		`-func GetKeyStoreName() string {`
	`150`	`+func KeyStoreName() string {`
`151`	`151`	`return testKeyStoreName`
`152`	`152`	`}`
`153`	`153`