[
https://issues.apache.org/jira/browse/BEAM-11073?focusedWorklogId=508476&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-508476
]
ASF GitHub Bot logged work on BEAM-11073:
-----------------------------------------
Author: ASF GitHub Bot
Created on: 06/Nov/20 14:03
Start Date: 06/Nov/20 14:03
Worklog Time Spent: 10m
Work Description: Aliraza-N commented on a change in pull request #13137:
URL: https://github.com/apache/beam/pull/13137#discussion_r518770361
##########
File path:
sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/healthcare/DicomIO.java
##########
@@ -37,9 +36,27 @@
/**
* The DicomIO connectors allows Beam pipelines to make calls to the Dicom API
of the Google Cloud
* Healthcare API
(https://cloud.google.com/healthcare/docs/how-tos#dicom-guide).
+ *
+ * <h3>Reading Study-Level Metadata</h3>
+ *
+ * The study-level metadata for a dicom instance can be read with {@link
ReadDicomStudyMetadata}.
+ * Retrieve the metadata of a dicom instance given its store path as a string.
This will return a
+ * {@link ReadDicomStudyMetadata.Result}. You can fetch the successful calls
using
+ * getReadResponse(), and any failed reads using getFailedReads().
+ *
+ * <h3>Example</h3>
+ *
+ * {@code Pipeline p = ... String webPath = ...
DicomIO.ReadDicomStudyMetadata.Result
+ * readMetadataResult = p .apply(Create.of(webPath)) PCollection<String>
goodRead =
+ * readMetadataResult.getReadResponse() PCollection<String> failRead =
+ * readMetadataResult.getFailedReads() }
*/
public class DicomIO {
+ public static ReadDicomStudyMetadata readDicomStudyMetadata() {
Review comment:
Makes sense to me
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
Issue Time Tracking
-------------------
Worklog Id: (was: 508476)
Time Spent: 3h 20m (was: 3h 10m)
> GCP HCLS Api - Dicom IO Connector for Java
> ------------------------------------------
>
> Key: BEAM-11073
> URL: https://issues.apache.org/jira/browse/BEAM-11073
> Project: Beam
> Issue Type: New Feature
> Components: io-java-gcp
> Reporter: Aliraza Nagamia
> Assignee: Aliraza Nagamia
> Priority: P2
> Time Spent: 3h 20m
> Remaining Estimate: 0h
>
> We are looking to create a new Java Pipeline Connector to help facilitate
> Reading data from the Imaging API in GCP. Initially, this connector will be
> used to read study level metadata of Dicom instances.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
