Skip to content

Commit 8e0b16c

Browse files
Google APIscopybara-github
Google APIs
authored and
copybara-github
committed
docs: Add documentation for Cloud Healthcare API Stackdriver Logging Protos
PiperOrigin-RevId: 474809566
1 parent dfd68f7 commit 8e0b16c

7 files changed

Lines changed: 529 additions & 0 deletions

File tree

‎google/cloud/healthcare/logging/BUILD.bazel‎

Lines changed: 182 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,182 @@
1+
# This file was automatically generated by BuildFileGenerator
2+
3+
# This is an API workspace, having public visibility by default makes perfect sense.
4+
package(default_visibility = ["//visibility:public"])
5+
6+
##############################################################################
7+
# Common
8+
##############################################################################
9+
load("@rules_proto//proto:defs.bzl", "proto_library")
10+
11+
proto_library(
12+
name = "logging_proto",
13+
srcs = [
14+
"annotation.proto",
15+
"consent.proto",
16+
"deid.proto",
17+
"dicom.proto",
18+
"fhir.proto",
19+
"hl7v2.proto",
20+
],
21+
deps = [
22+
"//google/rpc:status_proto",
23+
],
24+
)
25+
26+
##############################################################################
27+
# Java
28+
##############################################################################
29+
load(
30+
"@com_google_googleapis_imports//:imports.bzl",
31+
"java_grpc_library",
32+
"java_proto_library",
33+
)
34+
35+
java_proto_library(
36+
name = "logging_java_proto",
37+
deps = [":logging_proto"],
38+
)
39+
40+
java_grpc_library(
41+
name = "logging_java_grpc",
42+
srcs = [":logging_proto"],
43+
deps = [":logging_java_proto"],
44+
)
45+
46+
##############################################################################
47+
# Go
48+
##############################################################################
49+
load(
50+
"@com_google_googleapis_imports//:imports.bzl",
51+
"go_proto_library",
52+
)
53+
54+
go_proto_library(
55+
name = "logging_go_proto",
56+
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
57+
importpath = "google.golang.org/genproto/googleapis/cloud/healthcare/logging",
58+
protos = [":logging_proto"],
59+
deps = [
60+
"//google/rpc:status_go_proto",
61+
],
62+
)
63+
64+
##############################################################################
65+
# Python
66+
##############################################################################
67+
load(
68+
"@com_google_googleapis_imports//:imports.bzl",
69+
"moved_proto_library",
70+
"py_grpc_library",
71+
"py_proto_library",
72+
)
73+
74+
moved_proto_library(
75+
name = "logging_moved_proto",
76+
srcs = [":logging_proto"],
77+
deps = [
78+
"//google/rpc:status_proto",
79+
],
80+
)
81+
82+
py_proto_library(
83+
name = "logging_py_proto",
84+
deps = [":logging_moved_proto"],
85+
)
86+
87+
py_grpc_library(
88+
name = "logging_py_grpc",
89+
srcs = [":logging_moved_proto"],
90+
deps = [":logging_py_proto"],
91+
)
92+
93+
##############################################################################
94+
# PHP
95+
##############################################################################
96+
load(
97+
"@com_google_googleapis_imports//:imports.bzl",
98+
"php_grpc_library",
99+
"php_proto_library",
100+
)
101+
102+
php_proto_library(
103+
name = "logging_php_proto",
104+
deps = [":logging_proto"],
105+
)
106+
107+
php_grpc_library(
108+
name = "logging_php_grpc",
109+
srcs = [":logging_proto"],
110+
deps = [":logging_php_proto"],
111+
)
112+
113+
##############################################################################
114+
# Node.js
115+
##############################################################################
116+
load(
117+
"@com_google_googleapis_imports//:imports.bzl",
118+
"nodejs_gapic_assembly_pkg",
119+
"nodejs_gapic_library",
120+
)
121+
122+
123+
##############################################################################
124+
# Ruby
125+
##############################################################################
126+
load(
127+
"@com_google_googleapis_imports//:imports.bzl",
128+
"ruby_grpc_library",
129+
"ruby_proto_library",
130+
)
131+
132+
ruby_proto_library(
133+
name = "logging_ruby_proto",
134+
deps = [":logging_proto"],
135+
)
136+
137+
ruby_grpc_library(
138+
name = "logging_ruby_grpc",
139+
srcs = [":logging_proto"],
140+
deps = [":logging_ruby_proto"],
141+
)
142+
143+
##############################################################################
144+
# C#
145+
##############################################################################
146+
load(
147+
"@com_google_googleapis_imports//:imports.bzl",
148+
"csharp_grpc_library",
149+
"csharp_proto_library",
150+
)
151+
152+
csharp_proto_library(
153+
name = "logging_csharp_proto",
154+
deps = [":logging_proto"],
155+
)
156+
157+
csharp_grpc_library(
158+
name = "logging_csharp_grpc",
159+
srcs = [":logging_proto"],
160+
deps = [":logging_csharp_proto"],
161+
)
162+
163+
##############################################################################
164+
# C++
165+
##############################################################################
166+
load(
167+
"@com_google_googleapis_imports//:imports.bzl",
168+
"cc_grpc_library",
169+
"cc_proto_library",
170+
)
171+
172+
cc_proto_library(
173+
name = "logging_cc_proto",
174+
deps = [":logging_proto"],
175+
)
176+
177+
cc_grpc_library(
178+
name = "logging_cc_grpc",
179+
srcs = [":logging_proto"],
180+
grpc_only = True,
181+
deps = [":logging_cc_proto"],
182+
)

‎google/cloud/healthcare/logging/annotation.proto‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
// Copyright 2022 Google LLC
2+
//
3+
// Licensed under the Apache License, Version 2.0 (the "License");
4+
// you may not use this file except in compliance with the License.
5+
// You may obtain a copy of the License at
6+
//
7+
// http://www.apache.org/licenses/LICENSE-2.0
8+
//
9+
// Unless required by applicable law or agreed to in writing, software
10+
// distributed under the License is distributed on an "AS IS" BASIS,
11+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
// See the License for the specific language governing permissions and
13+
// limitations under the License.
14+
15+
syntax = "proto3";
16+
17+
package google.cloud.healthcare.logging;
18+
19+
import "google/rpc/status.proto";
20+
21+
option go_package = "google.golang.org/genproto/googleapis/cloud/healthcare/logging;logging";
22+
option java_package = "com.google.cloud.healthcare.logging";
23+
24+
// A log entry for an Annotation import long-running operation.
25+
message ImportAnnotationLogEntry {
26+
// The source in Cloud Storage. For example,
27+
// `gs://{bucket_id}/{path/to/file}`.
28+
string source = 1;
29+
30+
// The error code and message.
31+
google.rpc.Status error = 2;
32+
}
33+
34+
// A log entry for an Annotation export long-running operation.
35+
message ExportAnnotationLogEntry {
36+
// The destination in Cloud Storage or BigQuery.
37+
string destination = 1;
38+
39+
// The annotation record being exported. For example:
40+
// `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{store_id}/annotations/{annotation_id}`.
41+
string annotation_name = 2;
42+
43+
// The error code and message.
44+
google.rpc.Status error = 3;
45+
}
46+
47+
// A log entry for an Annotation evaluate long-running operation.
48+
message EvaluateAnnotationLogEntry {
49+
// The report destination in BigQuery.
50+
string destination = 1;
51+
52+
// The eval annotation record being evaluated. For example:
53+
// `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{eval_store_id}/annotations/{eval_annotation_id}`.
54+
string eval_annotation_name = 2;
55+
56+
// The golden annotation record being evaluated. For example:
57+
// `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{golden_store_id}/annotations/{golden_annotation_id}`.
58+
string golden_annotation_name = 3;
59+
60+
// The error code and message.
61+
google.rpc.Status error = 4;
62+
}

‎google/cloud/healthcare/logging/consent.proto‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
// Copyright 2022 Google LLC
2+
//
3+
// Licensed under the Apache License, Version 2.0 (the "License");
4+
// you may not use this file except in compliance with the License.
5+
// You may obtain a copy of the License at
6+
//
7+
// http://www.apache.org/licenses/LICENSE-2.0
8+
//
9+
// Unless required by applicable law or agreed to in writing, software
10+
// distributed under the License is distributed on an "AS IS" BASIS,
11+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
// See the License for the specific language governing permissions and
13+
// limitations under the License.
14+
15+
syntax = "proto3";
16+
17+
package google.cloud.healthcare.logging;
18+
19+
import "google/rpc/status.proto";
20+
21+
option go_package = "google.golang.org/genproto/googleapis/cloud/healthcare/logging;logging";
22+
option java_multiple_files = true;
23+
option java_outer_classname = "ConsentProto";
24+
option java_package = "com.google.cloud.healthcare.logging";
25+
26+
// A log entry for a Consent store QueryAccessibleData long-running operation.
27+
message QueryAccessibleDataLogEntry {
28+
// The resource being processed.
29+
string resource_name = 1;
30+
31+
// The error code and message.
32+
google.rpc.Status error = 2;
33+
}
34+
35+
// A log entry for a User Data Mapping indexing notification.
36+
message ConsentUserDataMappingLogEntry {
37+
// The User Data Mapping being indexed (for example,
38+
// `projects/{projectId}/locations/{locationId}/datasets/{datasetId}/consentStores/{storeId}/userDataMappings/{messageId}`).
39+
string resource_name = 1;
40+
41+
// The error code and message.
42+
google.rpc.Status error = 2;
43+
}

‎google/cloud/healthcare/logging/deid.proto‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
// Copyright 2022 Google LLC
2+
//
3+
// Licensed under the Apache License, Version 2.0 (the "License");
4+
// you may not use this file except in compliance with the License.
5+
// You may obtain a copy of the License at
6+
//
7+
// http://www.apache.org/licenses/LICENSE-2.0
8+
//
9+
// Unless required by applicable law or agreed to in writing, software
10+
// distributed under the License is distributed on an "AS IS" BASIS,
11+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
// See the License for the specific language governing permissions and
13+
// limitations under the License.
14+
15+
syntax = "proto3";
16+
17+
package google.cloud.healthcare.logging;
18+
19+
import "google/rpc/status.proto";
20+
21+
option go_package = "google.golang.org/genproto/googleapis/cloud/healthcare/logging;logging";
22+
option java_package = "com.google.cloud.healthcare.logging";
23+
24+
// A log entry for a de-identification long-running operation.
25+
message DeidentifyLogEntry {
26+
// The resource being de-identified.
27+
string resource_name = 1;
28+
29+
// The error code and message.
30+
google.rpc.Status error = 2;
31+
}

‎google/cloud/healthcare/logging/dicom.proto‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
// Copyright 2022 Google LLC
2+
//
3+
// Licensed under the Apache License, Version 2.0 (the "License");
4+
// you may not use this file except in compliance with the License.
5+
// You may obtain a copy of the License at
6+
//
7+
// http://www.apache.org/licenses/LICENSE-2.0
8+
//
9+
// Unless required by applicable law or agreed to in writing, software
10+
// distributed under the License is distributed on an "AS IS" BASIS,
11+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
// See the License for the specific language governing permissions and
13+
// limitations under the License.
14+
15+
syntax = "proto3";
16+
17+
package google.cloud.healthcare.logging;
18+
19+
import "google/rpc/status.proto";
20+
21+
option go_package = "google.golang.org/genproto/googleapis/cloud/healthcare/logging;logging";
22+
option java_package = "com.google.cloud.healthcare.logging";
23+
24+
// A log entry for a DICOM import long-running operation.
25+
message ImportDicomLogEntry {
26+
// The source file, in the format `gs://{bucket-id}/{path/to/file}`.
27+
string source = 1;
28+
29+
// The error code and message.
30+
google.rpc.Status error = 2;
31+
}
32+
33+
// A log entry for a DICOM export long-running operation.
34+
message ExportDicomLogEntry {
35+
// The DICOM resource being exported.
36+
string resource_name = 1;
37+
38+
// The error code and message.
39+
google.rpc.Status error = 2;
40+
}
41+
42+
// A log entry for a DICOM store Pub/Sub notification.
43+
message DicomNotificationLogEntry {
44+
// The DICOM resource being created.
45+
string resource_name = 1;
46+
47+
// The Pub/Sub topic that the notification is published on.
48+
string pubsub_topic = 2;
49+
50+
// The error code and message.
51+
google.rpc.Status error = 3;
52+
}
53+
54+
// A log entry for a DICOM streaming export notification.
55+
message DicomStreamLogEntry {
56+
// The DICOM resource being exported.
57+
string resource_name = 1;
58+
59+
// The destination in BigQuery, in the format
60+
// `bq://{projectId}.{bqDatasetId}.{bqTableId}`.
61+
string destination = 2;
62+
63+
// The error code and message.
64+
google.rpc.Status error = 3;
65+
}

0 commit comments

Comments
 (0)