Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Document]: HealthcareApiClient methods. #28482

Merged
merged 8 commits into from
Sep 19, 2023

Conversation

svetakvsundhar
Copy link
Contributor

Fixes #28415.

Several methods are undocumented in the HealthcareApiClient. We should document these parameters for better user experience, given that the user will not have access to the client libraries being used under the hood.


Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:

  • Mention the appropriate issue in your description (for example: addresses #123), if applicable. This will automatically add a link to the pull request in the issue. If you would like the issue to automatically close on merging the pull request, comment fixes #<ISSUE NUMBER> instead.
  • Update CHANGES.md with noteworthy changes.
  • If this contribution is large, please file an Apache Individual Contributor License Agreement.

See the Contributor Guide for more tips on how to make review process smoother.

To check the build health, please visit https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md

GitHub Actions Tests Status (on master branch)

Build python source distribution and wheels
Python tests
Java tests
Go tests

See CI.md for more information about GitHub Actions CI or the workflows README to see a list of phrases to trigger workflows.

@svetakvsundhar
Copy link
Contributor Author

R: @Abacn for committer review
R: @rachelgagnon for domain review

@github-actions
Copy link
Contributor

Stopping reviewer notifications for this pull request: review requested by someone other than the bot, ceding control

@github-actions
Copy link
Contributor

github-actions bot commented Sep 15, 2023

Test Results

1 750 tests  +1 708   1 580 ✔️ +1 538   13m 28s ⏱️ + 9m 17s
   154 suites +   147      170 💤 +   170 
   154 files   +   147          0 ±       0 

Results for commit 6990f02. ± Comparison against base commit ec422db.

This pull request removes 42 and adds 1750 tests. Note that renamed tests count towards both.
org.apache.beam.sdk.io.hbase.HBaseCoderProviderRegistrarTest ‑ testMutationCoderIsRegistered
org.apache.beam.sdk.io.hbase.HBaseCoderProviderRegistrarTest ‑ testResultCoderIsRegistered
org.apache.beam.sdk.io.hbase.HBaseCoderProviderRegistrarTest ‑ testRowMutationsCoderIsRegistered
org.apache.beam.sdk.io.hbase.HBaseIOTest ‑ testReadBuildsCorrectly
org.apache.beam.sdk.io.hbase.HBaseIOTest ‑ testReadBuildsCorrectlyInDifferentOrder
org.apache.beam.sdk.io.hbase.HBaseIOTest ‑ testReading
org.apache.beam.sdk.io.hbase.HBaseIOTest ‑ testReadingDisplayData
org.apache.beam.sdk.io.hbase.HBaseIOTest ‑ testReadingEmptyTable
org.apache.beam.sdk.io.hbase.HBaseIOTest ‑ testReadingFailsTableDoesNotExist
org.apache.beam.sdk.io.hbase.HBaseIOTest ‑ testReadingKeyRangeMiddle
…
org.apache.beam.sdk.io.gcp.GcpApiSurfaceTest ‑ testGcpApiSurface
org.apache.beam.sdk.io.gcp.bigquery.AvroGenericRecordToStorageApiProtoTest ‑ testCdcFields
org.apache.beam.sdk.io.gcp.bigquery.AvroGenericRecordToStorageApiProtoTest ‑ testDescriptorFromSchema
org.apache.beam.sdk.io.gcp.bigquery.AvroGenericRecordToStorageApiProtoTest ‑ testDescriptorFromSchemaLogicalTypes
org.apache.beam.sdk.io.gcp.bigquery.AvroGenericRecordToStorageApiProtoTest ‑ testMessageFromGenericRecord
org.apache.beam.sdk.io.gcp.bigquery.AvroGenericRecordToStorageApiProtoTest ‑ testMessageFromGenericRecordLogicalTypes
org.apache.beam.sdk.io.gcp.bigquery.AvroGenericRecordToStorageApiProtoTest ‑ testNestedFromSchema
org.apache.beam.sdk.io.gcp.bigquery.BeamRowToStorageApiProtoTest ‑ testCdcFields
org.apache.beam.sdk.io.gcp.bigquery.BeamRowToStorageApiProtoTest ‑ testDescriptorFromSchema
org.apache.beam.sdk.io.gcp.bigquery.BeamRowToStorageApiProtoTest ‑ testMessageFromTableRow
…

♻️ This comment has been updated with latest results.

@Abacn
Copy link
Contributor

Abacn commented Sep 15, 2023

Spotless error: Error: eckstyle] [ERROR] /runner/_work/beam/beam/sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/healthcare/HealthcareApiClient.java:194:6: Unused @param tag for 'fhirStore'. [JavadocMethod]

@svetakvsundhar
Copy link
Contributor Author

Spotless error: Error: eckstyle] [ERROR] /runner/_work/beam/beam/sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/healthcare/HealthcareApiClient.java:194:6: Unused @param tag for 'fhirStore'. [JavadocMethod]

whoops. should be fixed in new commit.

@svetakvsundhar
Copy link
Contributor Author

Run Java_GCP_IO_Direct PreCommit

Copy link

@rachelgagnon rachelgagnon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

Copy link

@rachelgagnon rachelgagnon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@Abacn Abacn merged commit 3915c85 into apache:master Sep 19, 2023
22 of 23 checks passed
@svetakvsundhar svetakvsundhar deleted the dicom_client_documentation branch September 19, 2023 17:49
m-trieu pushed a commit to m-trieu/beam that referenced this pull request Sep 22, 2023
* Create HealthcareUtils file with shared resources

* revert

* Document methods in HealthcareApiClient

* fix spotless

* caps
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Task]: Document Methods in the HealthcareApiClient
3 participants