Skip to content

Commit 167d9c3

Browse files
kwwarmbeajewellamz
andauthored
fix: Update minor typos in BeaconConfig.cs (#663)
Co-authored-by: Andrew Jewell <[email protected]>
1 parent f003514 commit 167d9c3

File tree

1 file changed

+9
-9
lines changed
  • Examples/runtimes/net/src/searchableencryption/complexexample

1 file changed

+9
-9
lines changed

Examples/runtimes/net/src/searchableencryption/complexexample/BeaconConfig.cs

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ public class BeaconConfig
1111
{
1212
/*
1313
* This file is used in an example to demonstrate complex queries
14-
* you can perform using beacons.
14+
* that you can perform using beacons.
1515
* The example data used is for demonstrative purposes only,
1616
* and might not meet the distribution and correlation uniqueness
1717
* recommendations for beacons.
@@ -26,7 +26,7 @@ public class BeaconConfig
2626
public static AmazonDynamoDBClient SetupBeaconConfig(String ddbTableName, String branchKeyId,
2727
String branchKeyWrappingKmsKeyArn, String branchKeyDdbTableName)
2828
{
29-
// 1. Create Keystore and branch key.
29+
// 1. Create keystore and branch key
3030
// These are the same constructions as in the Basic examples, which describe this in more detail.
3131
KeyStore keyStore = new KeyStore(new KeyStoreConfig
3232
{
@@ -85,7 +85,7 @@ public static AmazonDynamoDBClient SetupBeaconConfig(String ddbTableName, String
8585
};
8686

8787

88-
// 4. Define signed parts.
88+
// 4. Define signed parts
8989
// These are unencrypted attributes we would like to use in beacon queries.
9090
// In this example, all of these represent dates or times.
9191
// Keeping these attributes unencrypted allows us to use them in comparison-based queries. If a signed
@@ -98,7 +98,7 @@ public static AmazonDynamoDBClient SetupBeaconConfig(String ddbTableName, String
9898
new SignedPart { Name = "ProjectStart", Prefix = "PS-" }
9999
};
100100

101-
// 6. Create constructor parts.
101+
// 6. Create constructor parts
102102
// Constructor parts are used to assemble constructors (constructors described more in next step).
103103
// For each attribute that will be used in a constructor, there must be a corresponding constructor part.
104104
// A constructor part must receive:
@@ -216,15 +216,15 @@ public static AmazonDynamoDBClient SetupBeaconConfig(String ddbTableName, String
216216
Parts = new List<ConstructorPart> { buildingConstructorPart, floorConstructorPart, deskConstructorPart }
217217
};
218218

219-
// 5. Add constructors to the compound beacon constructor list in desired construction order.
219+
// 5. Add constructors to the compound beacon constructor list in desired construction order
220220
// In a compound beacon with multiple constructors, the order the constructors are added to
221221
// the constructor list determines their priority.
222222
// The first constructor added to a constructor list will be the first constructor that is executed.
223223
// The client will evaluate constructors until one matches, and will use the first one that matches.
224224
// If no constructors match, an attribute value is not written for that beacon.
225225
// A general strategy is to add constructors with unique conditions at the beginning of the list,
226226
// and add constructors with general conditions at the end of the list. This would allow a given
227-
// item would trigger the constructor most specific to its attributes.
227+
// item to trigger the constructor most specific to its attributes.
228228
var pk0ConstructorList = new List<Constructor>
229229
{
230230
employeeIdConstructor,
@@ -285,7 +285,7 @@ public static AmazonDynamoDBClient SetupBeaconConfig(String ddbTableName, String
285285
new CompoundBeacon { Name = "SK3", Split = "~", Constructors = sk3ConstructorList }
286286
};
287287

288-
// 10. Create BeaconVersion.
288+
// 10. Create BeaconVersion
289289
var beaconVersions = new List<BeaconVersion>
290290
{
291291
new BeaconVersion
@@ -339,7 +339,7 @@ public static AmazonDynamoDBClient SetupBeaconConfig(String ddbTableName, String
339339
// These are not beaconized attributes, but are sensitive data that must be encrypted
340340
["Attendees"] = CryptoAction.ENCRYPT_AND_SIGN,
341341
["Subject"] = CryptoAction.ENCRYPT_AND_SIGN,
342-
// signed parts and unencrypted attributes can be configured as SIGN_ONLY or DO_NOTHING
342+
// Signed parts and unencrypted attributes can be configured as SIGN_ONLY or DO_NOTHING
343343
// For this example, we will set these to SIGN_ONLY to ensure authenticity
344344
["TicketModTime"] = CryptoAction.SIGN_ONLY,
345345
["MeetingStart"] = CryptoAction.SIGN_ONLY,
@@ -374,4 +374,4 @@ public static AmazonDynamoDBClient SetupBeaconConfig(String ddbTableName, String
374374
// 15. Create a new AWS SDK DynamoDb client using the config above
375375
return new Client.DynamoDbClient(new DynamoDbTablesEncryptionConfig { TableEncryptionConfigs = tableConfigs });
376376
}
377-
}
377+
}

0 commit comments

Comments
 (0)