Skip to content

Commit 323003c

Browse files
authored
.NET v4: S3 Basics v4 compatibility (#7742)
1 parent 0b31f08 commit 323003c

22 files changed

Lines changed: 1172 additions & 116 deletions

.doc_gen/metadata/s3_metadata.yaml

Lines changed: 62 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,15 @@ s3_Hello:
44
synopsis: get started using &S3;.
55
category: Hello
66
languages:
7+
.NET:
8+
versions:
9+
- sdk_version: 4
10+
github: dotnetv4/S3
11+
sdkguide:
12+
excerpts:
13+
- description:
14+
snippet_tags:
15+
- S3.dotnetv4.S3_Hello
716
Java:
817
versions:
918
- sdk_version: 2
@@ -83,13 +92,17 @@ s3_CreateBucket:
8392
languages:
8493
.NET:
8594
versions:
86-
- sdk_version: 3
87-
github: dotnetv3/S3
95+
- sdk_version: 4
96+
github: dotnetv4/S3
8897
sdkguide:
8998
excerpts:
9099
- description:
91100
snippet_tags:
92-
- S3.dotnetv3.S3_Basics-CreateBucket
101+
- S3.dotnetv4.S3_Basics-CreateBucket
102+
- sdk_version: 3
103+
github: dotnetv3/S3
104+
sdkguide:
105+
excerpts:
93106
- description: Create a bucket with object lock enabled.
94107
snippet_tags:
95108
- S3LockWorkflow.dotnetv3.CreateBucketWithObjectLock
@@ -230,12 +243,16 @@ s3_CopyObject:
230243
languages:
231244
.NET:
232245
versions:
246+
- sdk_version: 4
247+
github: dotnetv4/S3
248+
sdkguide:
249+
excerpts:
250+
- description:
251+
snippet_tags:
252+
- S3.dotnetv4.S3_Basics-CopyObject
233253
- sdk_version: 3
234254
github: dotnetv3/S3
235255
excerpts:
236-
- description:
237-
snippet_tags:
238-
- S3.dotnet35.CopyObject
239256
- description: Copy an object using a conditional request.
240257
genai: some
241258
snippet_tags:
@@ -610,13 +627,17 @@ s3_DeleteObjects:
610627
languages:
611628
.NET:
612629
versions:
630+
- sdk_version: 4
631+
github: dotnetv4/S3
632+
sdkguide:
633+
excerpts:
634+
- description:
635+
snippet_tags:
636+
- S3.dotnetv4.S3_Basics-DeleteBucketContents
613637
- sdk_version: 3
614638
github: dotnetv3/S3
615639
sdkguide:
616640
excerpts:
617-
- description: Delete all objects in an S3 bucket.
618-
snippet_tags:
619-
- S3.dotnetv3.S3_Basics-DeleteBucketContents
620641
- description: Delete multiple objects in a non-versioned S3 bucket.
621642
snippet_tags:
622643
- S3.dotnetv3.DeleteMultipleObjectsExample
@@ -903,13 +924,17 @@ s3_GetObject:
903924
languages:
904925
.NET:
905926
versions:
906-
- sdk_version: 3
907-
github: dotnetv3/S3
927+
- sdk_version: 4
928+
github: dotnetv4/S3
908929
sdkguide:
909930
excerpts:
910931
- description:
911932
snippet_tags:
912-
- S3.dotnetv3.S3_Basics-DownloadObject
933+
- S3.dotnetv4.S3_Basics-DownloadObject
934+
- sdk_version: 3
935+
github: dotnetv3/S3
936+
sdkguide:
937+
excerpts:
913938
- description: Get an object using a conditional request.
914939
genai: some
915940
snippet_tags:
@@ -1437,13 +1462,17 @@ s3_ListObjectsV2:
14371462
languages:
14381463
.NET:
14391464
versions:
1440-
- sdk_version: 3
1441-
github: dotnetv3/S3
1465+
- sdk_version: 4
1466+
github: dotnetv4/S3
14421467
sdkguide:
14431468
excerpts:
14441469
- description:
14451470
snippet_tags:
1446-
- S3.dotnetv3.S3_Basics-ListBucketContents
1471+
- S3.dotnetv4.S3_Basics-ListBucketContents
1472+
- sdk_version: 3
1473+
github: dotnetv3/S3
1474+
sdkguide:
1475+
excerpts:
14471476
- description: List objects with a paginator.
14481477
snippet_tags:
14491478
- S3.dotnetv3.ListObjectsPaginatorExample
@@ -1601,13 +1630,17 @@ s3_PutObject:
16011630
languages:
16021631
.NET:
16031632
versions:
1604-
- sdk_version: 3
1605-
github: dotnetv3/S3
1633+
- sdk_version: 4
1634+
github: dotnetv4/S3
16061635
sdkguide:
16071636
excerpts:
16081637
- description:
16091638
snippet_tags:
1610-
- S3.dotnetv3.S3_Basics-UploadFile
1639+
- S3.dotnetv4.S3_Basics-UploadFile
1640+
- sdk_version: 3
1641+
github: dotnetv3/S3
1642+
sdkguide:
1643+
excerpts:
16111644
- description: Upload an object with server-side encryption.
16121645
snippet_tags:
16131646
- S3.dotnetv3.ServerSideEncryptionExample
@@ -1790,13 +1823,13 @@ s3_DeleteBucket:
17901823
languages:
17911824
.NET:
17921825
versions:
1793-
- sdk_version: 3
1794-
github: dotnetv3/S3
1826+
- sdk_version: 4
1827+
github: dotnetv4/S3
17951828
sdkguide:
17961829
excerpts:
17971830
- description:
17981831
snippet_tags:
1799-
- S3.dotnetv3.S3_Basics-DeleteBucket
1832+
- S3.dotnetv4.S3_Basics-DeleteBucket
18001833
C++:
18011834
versions:
18021835
- sdk_version: 1
@@ -3189,13 +3222,16 @@ s3_Scenario_GettingStarted:
31893222
languages:
31903223
.NET:
31913224
versions:
3192-
- sdk_version: 3
3193-
github: dotnetv3/S3/S3_Basics
3225+
- sdk_version: 4
3226+
github: dotnetv4/S3
31943227
sdkguide:
31953228
excerpts:
3196-
- description:
3229+
- description: Run an interactive scenario demonstrating &S3; features.
3230+
snippet_tags:
3231+
- S3.dotnetv4.S3_BasicsScenario
3232+
- description: A wrapper class for &S3; SDK methods.
31973233
snippet_tags:
3198-
- S3.dotnetv3.S3_BasicsScenario
3234+
- S3.dotnetv4.S3_BasicsBucket
31993235
Java:
32003236
versions:
32013237
- sdk_version: 2
@@ -3224,7 +3260,7 @@ s3_Scenario_GettingStarted:
32243260
- javascript.v3.utils.dirnameFromMetaUrl
32253261
- javascript.v3.utils.prompter
32263262
- javascript.v3.utils.wrapText
3227-
- description: Objects in S3 are stored in 'buckets'. Let's define a function for creating a new bucket.
3263+
- description: Objects are stored in 'buckets'. Let's define a function for creating a new bucket.
32283264
snippet_tags:
32293265
- javascript.v3.s3.scenarios.basic.CreateBucket
32303266
- description: Buckets contain 'objects'. This function uploads the contents of a directory to your bucket as

dotnetv3/S3/README.md

Lines changed: 6 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -29,36 +29,28 @@ For prerequisites, see the [README](../README.md#Prerequisites) in the `dotnetv3
2929
<!--custom.prerequisites.start-->
3030
<!--custom.prerequisites.end-->
3131

32-
### Basics
33-
34-
Code examples that show you how to perform the essential operations within a service.
35-
36-
- [Learn the basics](S3_Basics/S3_Basics.cs)
37-
38-
3932
### Single actions
4033

4134
Code excerpts that show you how to call individual service functions.
4235

43-
- [CopyObject](CopyObjectExample/CopyObject.cs#L11)
44-
- [CreateBucket](S3_Basics/S3Bucket.cs#L12)
45-
- [DeleteBucket](S3_Basics/S3Bucket.cs#L266)
36+
- [CopyObject](scenarios/S3ConditionalRequestsScenario/S3ConditionalRequests/S3ActionsWrapper.cs#L137)
37+
- [CreateBucket](scenarios/S3ObjectLockScenario/S3ObjectLockWorkflow/S3ActionsWrapper.cs#L29)
4638
- [DeleteBucketCors](s3CORSExample/S3CORS.cs#L147)
4739
- [DeleteBucketLifecycle](LifecycleExample/Lifecycle.cs#L192)
4840
- [DeleteObject](non-versioned-examples/DeleteObjectExample/DeleteObject.cs#L6)
49-
- [DeleteObjects](S3_Basics/S3Bucket.cs#L221)
41+
- [DeleteObjects](non-versioned-examples/DeleteMultipleObjectsExample/DeleteMultipleObjects.cs#L6)
5042
- [GetBucketAcl](BucketACLExample/BucketACL.cs#L75)
5143
- [GetBucketCors](s3CORSExample/S3CORS.cs#L125)
5244
- [GetBucketEncryption](PutBucketEncryption/ServerSideEncryption/ServerSideEncryption.cs#L107)
5345
- [GetBucketLifecycleConfiguration](LifecycleExample/Lifecycle.cs#L169)
5446
- [GetBucketWebsite](WebsiteConfigExample/WebsiteConfig.cs#L72)
55-
- [GetObject](S3_Basics/S3Bucket.cs#L85)
47+
- [GetObject](scenarios/S3ConditionalRequestsScenario/S3ConditionalRequests/S3ActionsWrapper.cs#L32)
5648
- [GetObjectLegalHold](scenarios/S3ObjectLockScenario/S3ObjectLockWorkflow/S3ActionsWrapper.cs#L259)
5749
- [GetObjectLockConfiguration](scenarios/S3ObjectLockScenario/S3ObjectLockWorkflow/S3ActionsWrapper.cs#L290)
5850
- [GetObjectRetention](scenarios/S3ObjectLockScenario/S3ObjectLockWorkflow/S3ActionsWrapper.cs#L193)
5951
- [ListBuckets](ListBucketsExample/ListBuckets.cs#L4)
6052
- [ListObjectVersions](versioned-examples/ListObjectVersionsExample/ListObjectVersions.cs#L6)
61-
- [ListObjectsV2](S3_Basics/S3Bucket.cs#L171)
53+
- [ListObjectsV2](ListObjectsPaginatorExample/ListObjectsPaginator.cs#L6)
6254
- [PutBucketAccelerateConfiguration](TransferAccelerationExample/TransferAcceleration.cs#L6)
6355
- [PutBucketAcl](BucketACLExample/BucketACL.cs#L37)
6456
- [PutBucketCors](s3CORSExample/S3CORS.cs#L104)
@@ -67,7 +59,7 @@ Code excerpts that show you how to call individual service functions.
6759
- [PutBucketLogging](ServerAccessLoggingExample/ServerAccessLogging.cs#L6)
6860
- [PutBucketNotificationConfiguration](EnableNotificationsExample/EnableNotifications.cs#L6)
6961
- [PutBucketWebsite](WebsiteConfigExample/WebsiteConfig.cs#L57)
70-
- [PutObject](S3_Basics/S3Bucket.cs#L43)
62+
- [PutObject](ServerSideEncryptionExample/ServerSideEncryption.cs#L6)
7163
- [PutObjectLegalHold](scenarios/S3ObjectLockScenario/S3ObjectLockWorkflow/S3ActionsWrapper.cs#L224)
7264
- [PutObjectLockConfiguration](scenarios/S3ObjectLockScenario/S3ObjectLockWorkflow/S3ActionsWrapper.cs#L60)
7365
- [PutObjectRetention](scenarios/S3ObjectLockScenario/S3ObjectLockWorkflow/S3ActionsWrapper.cs#L102)
@@ -120,23 +112,6 @@ Alternatively, you can run the example from within your IDE.
120112
<!--custom.instructions.end-->
121113

122114

123-
#### Learn the basics
124-
125-
This example shows you how to do the following:
126-
127-
- Create a bucket and upload a file to it.
128-
- Download an object from a bucket.
129-
- Copy an object to a subfolder in a bucket.
130-
- List the objects in a bucket.
131-
- Delete the bucket objects and the bucket.
132-
133-
<!--custom.basic_prereqs.s3_Scenario_GettingStarted.start-->
134-
<!--custom.basic_prereqs.s3_Scenario_GettingStarted.end-->
135-
136-
137-
<!--custom.basics.s3_Scenario_GettingStarted.start-->
138-
<!--custom.basics.s3_Scenario_GettingStarted.end-->
139-
140115

141116
#### Create a presigned URL
142117

dotnetv4/.editorconfig

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -167,3 +167,5 @@ dotnet_diagnostic.S1104.severity = none
167167
dotnet_diagnostic.S1854.severity = none
168168
# SA1401: Disable encapsulation warnings.
169169
dotnet_diagnostic.SA1401.severity = none
170+
# CS8632: Disable nullable warnings.
171+
dotnet_diagnostic.CS8632.severity = none

dotnetv4/CloudWatchLogs/LargeQuery/Tests/CloudWatchLogsTests.csproj

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@
1414
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.*" />
1515
<PackageReference Include="Moq" Version="4.*" />
1616
<PackageReference Include="xunit" Version="2.*" />
17-
<PackageReference Include="Xunit.Extensions.Ordering" Version="1.*" />
1817
<PackageReference Include="xunit.runner.visualstudio" Version="2.*">
1918
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
2019
<PrivateAssets>all</PrivateAssets>

0 commit comments

Comments
 (0)