Java: import healthimaging step 2 (#5497)

awsdocs · Oct 16, 2023 · 4a5d799 · 4a5d799
1 parent db2731b
commit 4a5d799
Show file tree

Hide file tree

Showing 22 changed files with 1,977 additions and 33 deletions.
diff --git a/.doc_gen/metadata/medical-imaging_metadata.yaml b/.doc_gen/metadata/medical-imaging_metadata.yaml
@@ -43,7 +43,8 @@ medical-imaging_CreateDatastore:
         - sdk_version: 2
           github: javav2/example_code/medicalimaging
           excerpts:
-            - snippet_tags:
+            - description:
+              snippet_tags:
                 - medicalimaging.java2.create_datastore.main
     JavaScript:
       versions:
@@ -123,7 +124,8 @@ medical-imaging_ListDatastores:
         - sdk_version: 2
           github: javav2/example_code/medicalimaging
           excerpts:
-            - snippet_tags:
+            - description:
+              snippet_tags:
                 - medicalimaging.java2.list_datastores.main
     JavaScript:
       versions:
@@ -163,7 +165,8 @@ medical-imaging_GetDatastore:
         - sdk_version: 2
           github: javav2/example_code/medicalimaging
           excerpts:
-            - snippet_tags:
+            - description:
+              snippet_tags:
                 - medicalimaging.java2.get_datastore.main
     JavaScript:
       versions:
@@ -197,6 +200,14 @@ medical-imaging_StartDICOMImportJob:
             - description:
               snippet_tags:
                 - medical-imaging.JavaScript.dicom.startDicomImportJobV3
+    Java:
+      versions:
+        - sdk_version: 2
+          github: javav2/example_code/medicalimaging
+          excerpts:
+            - description:
+              snippet_tags:
+                - medicalimaging.java2.start_dicom_import_job.main
   services:
     medical-imaging: {StartDICOMImportJob}
 medical-imaging_GetDICOMImportJob:
@@ -221,6 +232,14 @@ medical-imaging_GetDICOMImportJob:
             - description:
               snippet_tags:
                 - medical-imaging.JavaScript.dicom.getDICOMImportJobV3
+    Java:
+      versions:
+        - sdk_version: 2
+          github: javav2/example_code/medicalimaging
+          excerpts:
+            - description:
+              snippet_tags:
+                - medicalimaging.java2.get_dicom_import_job.main
   services:
     medical-imaging: {GetDICOMImportJob}
 medical-imaging_ListDICOMImportJobs:
@@ -245,6 +264,14 @@ medical-imaging_ListDICOMImportJobs:
             - description:
               snippet_tags:
                 - medical-imaging.JavaScript.dicom.listDICOMImportJobsV3
+    Java:
+      versions:
+        - sdk_version: 2
+          github: javav2/example_code/medicalimaging
+          excerpts:
+            - description:
+              snippet_tags:
+                - medicalimaging.java2.list_dicom_import_jobs.main
   services:
     medical-imaging: {ListDICOMImportJobs}
 medical-imaging_SearchImageSets:
@@ -281,6 +308,23 @@ medical-imaging_SearchImageSets:
               snippet_tags:
                 - medical-imaging.JavaScript.resource.searchImageSetV3.datastoreID
                 - medical-imaging.JavaScript.resource.searchImageSetV3.betweenFilter2
+    Java:
+      versions:
+        - sdk_version: 2
+          github: javav2/example_code/medicalimaging
+          excerpts:
+            - description: The utility function for searching image sets.
+              snippet_tags:
+                - medicalimaging.java2.search_imagesets.main
+            - description: "Use case #1: EQUAL operator."
+              snippet_tags:
+                - medicalimaging.java2.search_imagesets.use_case1
+            - description: "Use case #2: BETWEEN operator using DICOMStudyDate and DICOMStudyTime."
+              snippet_tags:
+                - medicalimaging.java2.search_imagesets.use_case2
+            - description: "Use case #3: BETWEEN operator using createdAt. Time studies were previously persisted."
+              snippet_tags:
+                - medicalimaging.java2.search_imagesets.use_case3
   services:
     medical-imaging: {SearchImageSets}
 medical-imaging_GetImageSet:
@@ -305,6 +349,14 @@ medical-imaging_GetImageSet:
             - description:
               snippet_tags:
                 - medical-imaging.JavaScript.imageset.getImageSetV3
+    Java:
+      versions:
+        - sdk_version: 2
+          github: javav2/example_code/medicalimaging
+          excerpts:
+            - description:
+              snippet_tags:
+                - medicalimaging.java2.get_imageset.main
   services:
     medical-imaging: {GetImageSet}
 medical-imaging_GetImageSetMetadata:
@@ -335,6 +387,14 @@ medical-imaging_GetImageSetMetadata:
             - description: Get image set metadata with version.
               snippet_tags:
                 - medical-imaging.JavaScript.imageset.getImageSetMetadataV3.withversion
+    Java:
+      versions:
+        - sdk_version: 2
+          github: javav2/example_code/medicalimaging
+          excerpts:
+            - description:
+              snippet_tags:
+                - medicalimaging.java2.get_imageset.main
   services:
     medical-imaging: {GetImageSetMetadata}
 medical-imaging_GetImageFrame:
@@ -359,6 +419,14 @@ medical-imaging_GetImageFrame:
             - description:
               snippet_tags:
                 - medical-imaging.JavaScript.imageset.getImageFrameV3
+    Java:
+      versions:
+        - sdk_version: 2
+          github: javav2/example_code/medicalimaging
+          excerpts:
+            - description:
+              snippet_tags:
+                - medicalimaging.java2.get_image_frame.main
   services:
     medical-imaging: {GetImageFrame}
 medical-imaging_ListImageSetVersions:
@@ -383,6 +451,14 @@ medical-imaging_ListImageSetVersions:
             - description:
               snippet_tags:
                 - medical-imaging.JavaScript.imageset.listImageSetVersionsV3
+    Java:
+      versions:
+        - sdk_version: 2
+          github: javav2/example_code/medicalimaging
+          excerpts:
+            - description:
+              snippet_tags:
+                - medicalimaging.java2.list_imageset_versions.main
   services:
     medical-imaging: {ListImageSetVersions}
 medical-imaging_UpdateImageSetMetadata:
@@ -410,6 +486,14 @@ medical-imaging_UpdateImageSetMetadata:
             - description: Encode the metadata.
               snippet_tags:
                 - medical-imaging.JavaScript.datastore.updateImageSetMetadataV3.main
+    Java:
+      versions:
+        - sdk_version: 2
+          github: javav2/example_code/medicalimaging
+          excerpts:
+            - description:
+              snippet_tags:
+                - medicalimaging.java2.update_image_set_metadata.main
   services:
     medical-imaging: {UpdateImageSetMetadata}
 medical-imaging_CopyImageSet:
@@ -440,6 +524,14 @@ medical-imaging_CopyImageSet:
             - description: Copy an image set with a destination.
               snippet_tags:
                 - medical-imaging.JavaScript.imageset.copyImageSetV3.with_destination
+    Java:
+      versions:
+        - sdk_version: 2
+          github: javav2/example_code/medicalimaging
+          excerpts:
+            - description:
+              snippet_tags:
+                - medicalimaging.java2.copy_imageset.main
   services:
     medical-imaging: {CopyImageSet}
 medical-imaging_DeleteImageSet:
@@ -464,6 +556,14 @@ medical-imaging_DeleteImageSet:
             - description:
               snippet_tags:
                 - medical-imaging.JavaScript.imageset.deleteImageSetV3
+    Java:
+      versions:
+        - sdk_version: 2
+          github: javav2/example_code/medicalimaging
+          excerpts:
+            - description:
+              snippet_tags:
+                - medicalimaging.java2.delete_imageset.main
   services:
     medical-imaging: {DeleteImageSet}
 medical-imaging_TagResource:
@@ -488,6 +588,14 @@ medical-imaging_TagResource:
             - description:
               snippet_tags:
                 - medical-imaging.JavaScript.resource.tagResourceV3
+    Java:
+      versions:
+        - sdk_version: 2
+          github: javav2/example_code/medicalimaging
+          excerpts:
+            - description:
+              snippet_tags:
+                - medicalimaging.java2.tag_resource.main
   services:
     medical-imaging: {TagResource}
 medical-imaging_UntagResource:
@@ -512,6 +620,14 @@ medical-imaging_UntagResource:
             - description:
               snippet_tags:
                 - medical-imaging.JavaScript.resource.unTagResourceV3
+    Java:
+      versions:
+        - sdk_version: 2
+          github: javav2/example_code/medicalimaging
+          excerpts:
+            - description:
+              snippet_tags:
+                - medicalimaging.java2.untag_resource.main
   services:
     medical-imaging: {UntagResource}
 medical-imaging_ListTagsForResource:
@@ -536,6 +652,14 @@ medical-imaging_ListTagsForResource:
             - description:
               snippet_tags:
                 - medical-imaging.JavaScript.resource.listTagsForResourceV3
+    Java:
+      versions:
+        - sdk_version: 2
+          github: javav2/example_code/medicalimaging
+          excerpts:
+            - description:
+              snippet_tags:
+                - medicalimaging.java2.list_tags_for_resource.main
   services:
     medical-imaging: {ListTagsForResource}
 medical-imaging_tagging_datastores:
@@ -567,6 +691,32 @@ medical-imaging_tagging_datastores:
             - description: The utility function for untagging a resource.
               snippet_tags:
                 - medical-imaging.JavaScript.resource.unTagResourceV3
+    Java:
+      versions:
+        - sdk_version: 2
+          github: javav2/example_code/medicalimaging
+          excerpts:
+            - description: To tag a data store.
+              snippet_tags:
+                - medicalimaging.java2.tagging_datastores.datastore_arn
+                - medicalimaging.java2.tagging_datastores.tag
+            - description: The utility function for tagging a resource.
+              snippet_tags:
+                - medicalimaging.java2.tag_resource.main
+            - description: To list tags for a data store.
+              snippet_tags:
+                - medicalimaging.java2.tagging_datastores.datastore_arn
+                - medicalimaging.java2.tagging_datastores.list
+            - description: The utility function for listing a resource's tags.
+              snippet_tags:
+                - medicalimaging.java2.list_tags_for_resource.main
+            - description: To untag a data store.
+              snippet_tags:
+                - medicalimaging.java2.tagging_datastores.datastore_arn
+                - medicalimaging.java2.tagging_datastores.untag
+            - description: The utility function for untagging a resource.
+              snippet_tags:
+                - medicalimaging.java2.untag_resource.main
   services:
     medical-imaging: {TagResource, UntagResource, ListTagsForResource}
 medical-imaging_tagging_imagesets:
@@ -598,5 +748,31 @@ medical-imaging_tagging_imagesets:
             - description: The utility function for untagging a resource.
               snippet_tags:
                 - medical-imaging.JavaScript.resource.unTagResourceV3
+    Java:
+      versions:
+        - sdk_version: 2
+          github: javav2/example_code/medicalimaging
+          excerpts:
+            - description: To tag an image set.
+              snippet_tags:
+                - medicalimaging.java2.tagging_imagesets.datastore_arn
+                - medicalimaging.java2.tagging_imagesets.tag
+            - description: The utility function for tagging a resource.
+              snippet_tags:
+                - medicalimaging.java2.tag_resource.main
+            - description: To list tags for an image set.
+              snippet_tags:
+                - medicalimaging.java2.tagging_imagesets.datastore_arn
+                - medicalimaging.java2.tagging_imagesets.list
+            - description: The utility function for listing a resource's tags.
+              snippet_tags:
+                - medicalimaging.java2.list_tags_for_resource.main
+            - description: To untag an image set.
+              snippet_tags:
+                - medicalimaging.java2.tagging_imagesets.datastore_arn
+                - medicalimaging.java2.tagging_imagesets.untag
+            - description: The utility function for untagging a resource.
+              snippet_tags:
+                - medicalimaging.java2.untag_resource.main
   services:
     medical-imaging: {TagResource, UntagResource, ListTagsForResource}
diff --git a/.doc_gen/readmes/config.py b/.doc_gen/readmes/config.py
@@ -43,6 +43,9 @@
             'base_folder': 'javav2',
             'service_folder': 'javav2/example_code/{{service["name"]}}',
             'sdk_api_ref': 'https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/{{service["name"]}}/package-summary.html',
+            'service_folder_overrides': {
+                'medical-imaging': 'javav2/example_code/medicalimaging',
+            }
         }
     },
     'JavaScript': {