source: vendor/google/apiclient-services/src/CloudHealthcare/Resource/ProjectsLocationsDatasetsDicomStores.php@ e3d4e0a

Last change on this file since e3d4e0a was e3d4e0a, checked in by Vlado 222039 <vlado.popovski@…>, 9 days ago

Upload project files

  • Property mode set to 100644
File size: 21.2 KB
Line 
1<?php
2/*
3 * Copyright 2014 Google Inc.
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
6 * use this file except in compliance with the License. You may obtain a copy of
7 * the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
13 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
14 * License for the specific language governing permissions and limitations under
15 * the License.
16 */
17
18namespace Google\Service\CloudHealthcare\Resource;
19
20use Google\Service\CloudHealthcare\DeidentifyDicomStoreRequest;
21use Google\Service\CloudHealthcare\DicomStore;
22use Google\Service\CloudHealthcare\DicomStoreMetrics;
23use Google\Service\CloudHealthcare\ExportDicomDataRequest;
24use Google\Service\CloudHealthcare\HealthcareEmpty;
25use Google\Service\CloudHealthcare\HttpBody;
26use Google\Service\CloudHealthcare\ImportDicomDataRequest;
27use Google\Service\CloudHealthcare\ListDicomStoresResponse;
28use Google\Service\CloudHealthcare\Operation;
29use Google\Service\CloudHealthcare\Policy;
30use Google\Service\CloudHealthcare\SetBlobStorageSettingsRequest;
31use Google\Service\CloudHealthcare\SetIamPolicyRequest;
32use Google\Service\CloudHealthcare\TestIamPermissionsRequest;
33use Google\Service\CloudHealthcare\TestIamPermissionsResponse;
34
35/**
36 * The "dicomStores" collection of methods.
37 * Typical usage is:
38 * <code>
39 * $healthcareService = new Google\Service\CloudHealthcare(...);
40 * $dicomStores = $healthcareService->projects_locations_datasets_dicomStores;
41 * </code>
42 */
43class ProjectsLocationsDatasetsDicomStores extends \Google\Service\Resource
44{
45 /**
46 * Creates a new DICOM store within the parent dataset. (dicomStores.create)
47 *
48 * @param string $parent Required. The name of the dataset this DICOM store
49 * belongs to.
50 * @param DicomStore $postBody
51 * @param array $optParams Optional parameters.
52 *
53 * @opt_param string dicomStoreId Required. The ID of the DICOM store that is
54 * being created. Any string value up to 256 characters in length.
55 * @return DicomStore
56 * @throws \Google\Service\Exception
57 */
58 public function create($parent, DicomStore $postBody, $optParams = [])
59 {
60 $params = ['parent' => $parent, 'postBody' => $postBody];
61 $params = array_merge($params, $optParams);
62 return $this->call('create', [$params], DicomStore::class);
63 }
64 /**
65 * De-identifies data from the source store and writes it to the destination
66 * store. The metadata field type is OperationMetadata. If the request is
67 * successful, the response field type is DeidentifyDicomStoreSummary. If errors
68 * occur, error is set. The LRO result may still be successful if de-
69 * identification fails for some DICOM instances. The output DICOM store will
70 * not contain these failed resources. Failed resource totals are tracked in
71 * Operation.metadata. Error details are also logged to Cloud Logging (see
72 * [Viewing error logs in Cloud
73 * Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)).
74 * (dicomStores.deidentify)
75 *
76 * @param string $sourceStore Required. Source DICOM store resource name. For
77 * example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}
78 * /dicomStores/{dicom_store_id}`.
79 * @param DeidentifyDicomStoreRequest $postBody
80 * @param array $optParams Optional parameters.
81 * @return Operation
82 * @throws \Google\Service\Exception
83 */
84 public function deidentify($sourceStore, DeidentifyDicomStoreRequest $postBody, $optParams = [])
85 {
86 $params = ['sourceStore' => $sourceStore, 'postBody' => $postBody];
87 $params = array_merge($params, $optParams);
88 return $this->call('deidentify', [$params], Operation::class);
89 }
90 /**
91 * Deletes the specified DICOM store and removes all images that are contained
92 * within it. (dicomStores.delete)
93 *
94 * @param string $name Required. The resource name of the DICOM store to delete.
95 * @param array $optParams Optional parameters.
96 * @return HealthcareEmpty
97 * @throws \Google\Service\Exception
98 */
99 public function delete($name, $optParams = [])
100 {
101 $params = ['name' => $name];
102 $params = array_merge($params, $optParams);
103 return $this->call('delete', [$params], HealthcareEmpty::class);
104 }
105 /**
106 * Exports data to the specified destination by copying it from the DICOM store.
107 * Errors are also logged to Cloud Logging. For more information, see [Viewing
108 * error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-
109 * tos/logging). The metadata field type is OperationMetadata.
110 * (dicomStores.export)
111 *
112 * @param string $name Required. The DICOM store resource name from which to
113 * export the data. For example, `projects/{project_id}/locations/{location_id}/
114 * datasets/{dataset_id}/dicomStores/{dicom_store_id}`.
115 * @param ExportDicomDataRequest $postBody
116 * @param array $optParams Optional parameters.
117 * @return Operation
118 * @throws \Google\Service\Exception
119 */
120 public function export($name, ExportDicomDataRequest $postBody, $optParams = [])
121 {
122 $params = ['name' => $name, 'postBody' => $postBody];
123 $params = array_merge($params, $optParams);
124 return $this->call('export', [$params], Operation::class);
125 }
126 /**
127 * Gets the specified DICOM store. (dicomStores.get)
128 *
129 * @param string $name Required. The resource name of the DICOM store to get.
130 * @param array $optParams Optional parameters.
131 * @return DicomStore
132 * @throws \Google\Service\Exception
133 */
134 public function get($name, $optParams = [])
135 {
136 $params = ['name' => $name];
137 $params = array_merge($params, $optParams);
138 return $this->call('get', [$params], DicomStore::class);
139 }
140 /**
141 * Gets metrics associated with the DICOM store.
142 * (dicomStores.getDICOMStoreMetrics)
143 *
144 * @param string $name Required. The resource name of the DICOM store to get
145 * metrics for.
146 * @param array $optParams Optional parameters.
147 * @return DicomStoreMetrics
148 * @throws \Google\Service\Exception
149 */
150 public function getDICOMStoreMetrics($name, $optParams = [])
151 {
152 $params = ['name' => $name];
153 $params = array_merge($params, $optParams);
154 return $this->call('getDICOMStoreMetrics', [$params], DicomStoreMetrics::class);
155 }
156 /**
157 * Gets the access control policy for a resource. Returns an empty policy if the
158 * resource exists and does not have a policy set. (dicomStores.getIamPolicy)
159 *
160 * @param string $resource REQUIRED: The resource for which the policy is being
161 * requested. See [Resource
162 * names](https://cloud.google.com/apis/design/resource_names) for the
163 * appropriate value for this field.
164 * @param array $optParams Optional parameters.
165 *
166 * @opt_param int options.requestedPolicyVersion Optional. The maximum policy
167 * version that will be used to format the policy. Valid values are 0, 1, and 3.
168 * Requests specifying an invalid value will be rejected. Requests for policies
169 * with any conditional role bindings must specify version 3. Policies with no
170 * conditional role bindings may specify any valid value or leave the field
171 * unset. The policy in the response might use the policy version that you
172 * specified, or it might use a lower policy version. For example, if you
173 * specify version 3, but the policy has no conditional role bindings, the
174 * response uses version 1. To learn which resources support conditions in their
175 * IAM policies, see the [IAM
176 * documentation](https://cloud.google.com/iam/help/conditions/resource-
177 * policies).
178 * @return Policy
179 * @throws \Google\Service\Exception
180 */
181 public function getIamPolicy($resource, $optParams = [])
182 {
183 $params = ['resource' => $resource];
184 $params = array_merge($params, $optParams);
185 return $this->call('getIamPolicy', [$params], Policy::class);
186 }
187 /**
188 * Imports data into the DICOM store by copying it from the specified source.
189 * Errors are logged to Cloud Logging. For more information, see [Viewing error
190 * logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-
191 * tos/logging). The metadata field type is OperationMetadata.
192 * (dicomStores.import)
193 *
194 * @param string $name Required. The name of the DICOM store resource into which
195 * the data is imported. For example, `projects/{project_id}/locations/{location
196 * _id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`.
197 * @param ImportDicomDataRequest $postBody
198 * @param array $optParams Optional parameters.
199 * @return Operation
200 * @throws \Google\Service\Exception
201 */
202 public function import($name, ImportDicomDataRequest $postBody, $optParams = [])
203 {
204 $params = ['name' => $name, 'postBody' => $postBody];
205 $params = array_merge($params, $optParams);
206 return $this->call('import', [$params], Operation::class);
207 }
208 /**
209 * Lists the DICOM stores in the given dataset.
210 * (dicomStores.listProjectsLocationsDatasetsDicomStores)
211 *
212 * @param string $parent Required. Name of the dataset.
213 * @param array $optParams Optional parameters.
214 *
215 * @opt_param string filter Restricts stores returned to those matching a
216 * filter. The following syntax is available: * A string field value can be
217 * written as text inside quotation marks, for example `"query text"`. The only
218 * valid relational operation for text fields is equality (`=`), where text is
219 * searched within the field, rather than having the field be equal to the text.
220 * For example, `"Comment = great"` returns messages with `great` in the comment
221 * field. * A number field value can be written as an integer, a decimal, or an
222 * exponential. The valid relational operators for number fields are the
223 * equality operator (`=`), along with the less than/greater than operators
224 * (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You
225 * can prepend the `NOT` operator to an expression to negate it. * A date field
226 * value must be written in `yyyy-mm-dd` form. Fields with date and time use the
227 * RFC3339 time format. Leading zeros are required for one-digit months and
228 * days. The valid relational operators for date fields are the equality
229 * operator (`=`) , along with the less than/greater than operators (`<`, `<=`,
230 * `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend
231 * the `NOT` operator to an expression to negate it. * Multiple field query
232 * expressions can be combined in one query by adding `AND` or `OR` operators
233 * between the expressions. If a boolean operator appears within a quoted
234 * string, it is not treated as special, it's just another part of the character
235 * string to be matched. You can prepend the `NOT` operator to an expression to
236 * negate it. Only filtering on labels is supported. For example,
237 * `labels.key=value`.
238 * @opt_param int pageSize Limit on the number of DICOM stores to return in a
239 * single response. If not specified, 100 is used. May not be larger than 1000.
240 * @opt_param string pageToken The next_page_token value returned from the
241 * previous List request, if any.
242 * @return ListDicomStoresResponse
243 * @throws \Google\Service\Exception
244 */
245 public function listProjectsLocationsDatasetsDicomStores($parent, $optParams = [])
246 {
247 $params = ['parent' => $parent];
248 $params = array_merge($params, $optParams);
249 return $this->call('list', [$params], ListDicomStoresResponse::class);
250 }
251 /**
252 * Updates the specified DICOM store. (dicomStores.patch)
253 *
254 * @param string $name Identifier. Resource name of the DICOM store, of the form
255 * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomSto
256 * res/{dicom_store_id}`.
257 * @param DicomStore $postBody
258 * @param array $optParams Optional parameters.
259 *
260 * @opt_param string updateMask Required. The update mask applies to the
261 * resource. For the `FieldMask` definition, see
262 * https://developers.google.com/protocol-
263 * buffers/docs/reference/google.protobuf#fieldmask
264 * @return DicomStore
265 * @throws \Google\Service\Exception
266 */
267 public function patch($name, DicomStore $postBody, $optParams = [])
268 {
269 $params = ['name' => $name, 'postBody' => $postBody];
270 $params = array_merge($params, $optParams);
271 return $this->call('patch', [$params], DicomStore::class);
272 }
273 /**
274 * SearchForInstances returns a list of matching instances. See [Search
275 * Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.
276 * html#sect_10.6). For details on the implementation of SearchForInstances, see
277 * [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_tr
278 * ansaction) in the Cloud Healthcare API conformance statement. For samples
279 * that show how to call SearchForInstances, see [Search for DICOM
280 * data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-
281 * dicom). (dicomStores.searchForInstances)
282 *
283 * @param string $parent Required. The name of the DICOM store that is being
284 * accessed. For example, `projects/{project_id}/locations/{location_id}/dataset
285 * s/{dataset_id}/dicomStores/{dicom_store_id}`.
286 * @param string $dicomWebPath Required. The path of the
287 * SearchForInstancesRequest DICOMweb request. For example, `instances`,
288 * `series/{series_uid}/instances`, or `studies/{study_uid}/instances`.
289 * @param array $optParams Optional parameters.
290 * @return HttpBody
291 * @throws \Google\Service\Exception
292 */
293 public function searchForInstances($parent, $dicomWebPath, $optParams = [])
294 {
295 $params = ['parent' => $parent, 'dicomWebPath' => $dicomWebPath];
296 $params = array_merge($params, $optParams);
297 return $this->call('searchForInstances', [$params], HttpBody::class);
298 }
299 /**
300 * SearchForSeries returns a list of matching series. See [Search Transaction] (
301 * http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6
302 * ). For details on the implementation of SearchForSeries, see [Search transact
303 * ion](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in
304 * the Cloud Healthcare API conformance statement. For samples that show how to
305 * call SearchForSeries, see [Search for DICOM
306 * data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-
307 * dicom). (dicomStores.searchForSeries)
308 *
309 * @param string $parent Required. The name of the DICOM store that is being
310 * accessed. For example, `projects/{project_id}/locations/{location_id}/dataset
311 * s/{dataset_id}/dicomStores/{dicom_store_id}`.
312 * @param string $dicomWebPath Required. The path of the SearchForSeries
313 * DICOMweb request. For example, `series` or `studies/{study_uid}/series`.
314 * @param array $optParams Optional parameters.
315 * @return HttpBody
316 * @throws \Google\Service\Exception
317 */
318 public function searchForSeries($parent, $dicomWebPath, $optParams = [])
319 {
320 $params = ['parent' => $parent, 'dicomWebPath' => $dicomWebPath];
321 $params = array_merge($params, $optParams);
322 return $this->call('searchForSeries', [$params], HttpBody::class);
323 }
324 /**
325 * SearchForStudies returns a list of matching studies. See [Search Transaction]
326 * (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.
327 * 6). For details on the implementation of SearchForStudies, see [Search transa
328 * ction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in
329 * the Cloud Healthcare API conformance statement. For samples that show how to
330 * call SearchForStudies, see [Search for DICOM
331 * data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-
332 * dicom). (dicomStores.searchForStudies)
333 *
334 * @param string $parent Required. The name of the DICOM store that is being
335 * accessed. For example, `projects/{project_id}/locations/{location_id}/dataset
336 * s/{dataset_id}/dicomStores/{dicom_store_id}`.
337 * @param string $dicomWebPath Required. The path of the SearchForStudies
338 * DICOMweb request. For example, `studies`.
339 * @param array $optParams Optional parameters.
340 * @return HttpBody
341 * @throws \Google\Service\Exception
342 */
343 public function searchForStudies($parent, $dicomWebPath, $optParams = [])
344 {
345 $params = ['parent' => $parent, 'dicomWebPath' => $dicomWebPath];
346 $params = array_merge($params, $optParams);
347 return $this->call('searchForStudies', [$params], HttpBody::class);
348 }
349 /**
350 * SetBlobStorageSettings sets the blob storage settings of the specified
351 * resources. (dicomStores.setBlobStorageSettings)
352 *
353 * @param string $resource Required. The path of the resource to update the blob
354 * storage settings in the format of `projects/{projectID}/locations/{locationID
355 * }/datasets/{datasetID}/dicomStores/{dicomStoreID}/dicomWeb/studies/{studyUID}
356 * `, `projects/{projectID}/locations/{locationID}/datasets/{datasetID}/dicomSto
357 * res/{dicomStoreID}/dicomWeb/studies/{studyUID}/series/{seriesUID}/`, or `proj
358 * ects/{projectID}/locations/{locationID}/datasets/{datasetID}/dicomStores/{dic
359 * omStoreID}/dicomWeb/studies/{studyUID}/series/{seriesUID}/instances/{instance
360 * UID}`. If `filter_config` is specified, set the value of `resource` to the
361 * resource name of a DICOM store in the format `projects/{projectID}/locations/
362 * {locationID}/datasets/{datasetID}/dicomStores/{dicomStoreID}`.
363 * @param SetBlobStorageSettingsRequest $postBody
364 * @param array $optParams Optional parameters.
365 * @return Operation
366 * @throws \Google\Service\Exception
367 */
368 public function setBlobStorageSettings($resource, SetBlobStorageSettingsRequest $postBody, $optParams = [])
369 {
370 $params = ['resource' => $resource, 'postBody' => $postBody];
371 $params = array_merge($params, $optParams);
372 return $this->call('setBlobStorageSettings', [$params], Operation::class);
373 }
374 /**
375 * Sets the access control policy on the specified resource. Replaces any
376 * existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and
377 * `PERMISSION_DENIED` errors. (dicomStores.setIamPolicy)
378 *
379 * @param string $resource REQUIRED: The resource for which the policy is being
380 * specified. See [Resource
381 * names](https://cloud.google.com/apis/design/resource_names) for the
382 * appropriate value for this field.
383 * @param SetIamPolicyRequest $postBody
384 * @param array $optParams Optional parameters.
385 * @return Policy
386 * @throws \Google\Service\Exception
387 */
388 public function setIamPolicy($resource, SetIamPolicyRequest $postBody, $optParams = [])
389 {
390 $params = ['resource' => $resource, 'postBody' => $postBody];
391 $params = array_merge($params, $optParams);
392 return $this->call('setIamPolicy', [$params], Policy::class);
393 }
394 /**
395 * StoreInstances stores DICOM instances associated with study instance unique
396 * identifiers (SUID). See [Store Transaction] (http://dicom.nema.org/medical/di
397 * com/current/output/html/part18.html#sect_10.5). For details on the
398 * implementation of StoreInstances, see [Store transaction](https://cloud.googl
399 * e.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API
400 * conformance statement. For samples that show how to call StoreInstances, see
401 * [Store DICOM data](https://cloud.google.com/healthcare/docs/how-
402 * tos/dicomweb#store-dicom). (dicomStores.storeInstances)
403 *
404 * @param string $parent Required. The name of the DICOM store that is being
405 * accessed. For example, `projects/{project_id}/locations/{location_id}/dataset
406 * s/{dataset_id}/dicomStores/{dicom_store_id}`.
407 * @param string $dicomWebPath Required. The path of the StoreInstances DICOMweb
408 * request. For example, `studies/[{study_uid}]`. Note that the `study_uid` is
409 * optional.
410 * @param HttpBody $postBody
411 * @param array $optParams Optional parameters.
412 * @return HttpBody
413 * @throws \Google\Service\Exception
414 */
415 public function storeInstances($parent, $dicomWebPath, HttpBody $postBody, $optParams = [])
416 {
417 $params = ['parent' => $parent, 'dicomWebPath' => $dicomWebPath, 'postBody' => $postBody];
418 $params = array_merge($params, $optParams);
419 return $this->call('storeInstances', [$params], HttpBody::class);
420 }
421 /**
422 * Returns permissions that a caller has on the specified resource. If the
423 * resource does not exist, this will return an empty set of permissions, not a
424 * `NOT_FOUND` error. Note: This operation is designed to be used for building
425 * permission-aware UIs and command-line tools, not for authorization checking.
426 * This operation may "fail open" without warning.
427 * (dicomStores.testIamPermissions)
428 *
429 * @param string $resource REQUIRED: The resource for which the policy detail is
430 * being requested. See [Resource
431 * names](https://cloud.google.com/apis/design/resource_names) for the
432 * appropriate value for this field.
433 * @param TestIamPermissionsRequest $postBody
434 * @param array $optParams Optional parameters.
435 * @return TestIamPermissionsResponse
436 * @throws \Google\Service\Exception
437 */
438 public function testIamPermissions($resource, TestIamPermissionsRequest $postBody, $optParams = [])
439 {
440 $params = ['resource' => $resource, 'postBody' => $postBody];
441 $params = array_merge($params, $optParams);
442 return $this->call('testIamPermissions', [$params], TestIamPermissionsResponse::class);
443 }
444}
445
446// Adding a class alias for backwards compatibility with the previous class name.
447class_alias(ProjectsLocationsDatasetsDicomStores::class, 'Google_Service_CloudHealthcare_Resource_ProjectsLocationsDatasetsDicomStores');
Note: See TracBrowser for help on using the repository browser.