This is an automated email from the ASF dual-hosted git repository.
yhu pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/beam.git
The following commit(s) were added to refs/heads/master by this push:
new 231ee2f380d Improve Documentation on DicomClient (#27783)
231ee2f380d is described below
commit 231ee2f380d86d5cb14d692bb606e4024501b7c8
Author: Svetak Sundhar <svetaksund...@google.com>
AuthorDate: Tue Aug 1 18:20:11 2023 -0400
Improve Documentation on DicomClient (#27783)
---
sdks/python/apache_beam/io/gcp/healthcare/dicomclient.py | 11 +++++++----
1 file changed, 7 insertions(+), 4 deletions(-)
diff --git a/sdks/python/apache_beam/io/gcp/healthcare/dicomclient.py
b/sdks/python/apache_beam/io/gcp/healthcare/dicomclient.py
index cbe951a0c74..6efb26b7c89 100644
--- a/sdks/python/apache_beam/io/gcp/healthcare/dicomclient.py
+++ b/sdks/python/apache_beam/io/gcp/healthcare/dicomclient.py
@@ -22,7 +22,10 @@ from google.auth.transport import requests
class DicomApiHttpClient:
- """DICOM api client that talk to api via http request"""
+ """Creates a client that communicates with the GCP Healthcare API
+ (https://cloud.google.com/healthcare-api), over HTTP.
+ Note that this client strictly uses v1 of this API."""
+
healthcare_base_url = "https://healthcare.googleapis.com/v1";
session = None
@@ -46,9 +49,9 @@ class DicomApiHttpClient:
search_type,
params=None,
credential=None):
- """function for searching a DICOM store"""
+ """Function for searching a DICOM store"""
- # sending request to the REST healthcare api.
+ # Sends a request to the GCP HCLS API v1.
api_endpoint = "{}/projects/{}/locations/{}".format(
self.healthcare_base_url, project_id, region)
@@ -105,7 +108,7 @@ class DicomApiHttpClient:
dicom_store_id,
dcm_file,
credential=None):
- """function for storing an instance."""
+ """Function for storing a DICOM instance."""
api_endpoint = "{}/projects/{}/locations/{}".format(
self.healthcare_base_url, project_id, region)
