• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5  margin: 0;
6  padding: 0;
7  border: 0;
8  font-weight: inherit;
9  font-style: inherit;
10  font-size: 100%;
11  font-family: inherit;
12  vertical-align: baseline;
13}
14
15body {
16  font-size: 13px;
17  padding: 1em;
18}
19
20h1 {
21  font-size: 26px;
22  margin-bottom: 1em;
23}
24
25h2 {
26  font-size: 24px;
27  margin-bottom: 1em;
28}
29
30h3 {
31  font-size: 20px;
32  margin-bottom: 1em;
33  margin-top: 1em;
34}
35
36pre, code {
37  line-height: 1.5;
38  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42  margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46  font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50  border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54  margin-top: 0.5em;
55}
56
57.firstline {
58  margin-left: 2 em;
59}
60
61.method  {
62  margin-top: 1em;
63  border: solid 1px #CCC;
64  padding: 1em;
65  background: #EEE;
66}
67
68.details {
69  font-weight: bold;
70  font-size: 14px;
71}
72
73</style>
74
75<h1><a href="healthcare_v1beta1.html">Cloud Healthcare API</a> . <a href="healthcare_v1beta1.projects.html">projects</a> . <a href="healthcare_v1beta1.projects.locations.html">locations</a> . <a href="healthcare_v1beta1.projects.locations.datasets.html">datasets</a> . <a href="healthcare_v1beta1.projects.locations.datasets.dicomStores.html">dicomStores</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="healthcare_v1beta1.projects.locations.datasets.dicomStores.studies.html">studies()</a></code>
79</p>
80<p class="firstline">Returns the studies Resource.</p>
81
82<p class="toc_element">
83  <code><a href="#create">create(parent, body, dicomStoreId=None, x__xgafv=None)</a></code></p>
84<p class="firstline">Creates a new DICOM store within the parent dataset.</p>
85<p class="toc_element">
86  <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
87<p class="firstline">Deletes the specified DICOM store and removes all images that are contained</p>
88<p class="toc_element">
89  <code><a href="#export">export(name, body, x__xgafv=None)</a></code></p>
90<p class="firstline">Exports data to the specified destination by copying it from the DICOM</p>
91<p class="toc_element">
92  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
93<p class="firstline">Gets the specified DICOM store.</p>
94<p class="toc_element">
95  <code><a href="#getIamPolicy">getIamPolicy(resource, x__xgafv=None)</a></code></p>
96<p class="firstline">Gets the access control policy for a resource.</p>
97<p class="toc_element">
98  <code><a href="#import_">import_(name, body, x__xgafv=None)</a></code></p>
99<p class="firstline">Imports data into the DICOM store by copying it from the specified source.</p>
100<p class="toc_element">
101  <code><a href="#list">list(parent, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</a></code></p>
102<p class="firstline">Lists the DICOM stores in the given dataset.</p>
103<p class="toc_element">
104  <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
105<p class="firstline">Retrieves the next page of results.</p>
106<p class="toc_element">
107  <code><a href="#patch">patch(name, body, updateMask=None, x__xgafv=None)</a></code></p>
108<p class="firstline">Updates the specified DICOM store.</p>
109<p class="toc_element">
110  <code><a href="#searchForInstances">searchForInstances(parent, dicomWebPath, x__xgafv=None)</a></code></p>
111<p class="firstline">SearchForInstances returns a list of matching instances. See</p>
112<p class="toc_element">
113  <code><a href="#searchForSeries">searchForSeries(parent, dicomWebPath, x__xgafv=None)</a></code></p>
114<p class="firstline">SearchForSeries returns a list of matching series. See</p>
115<p class="toc_element">
116  <code><a href="#searchForStudies">searchForStudies(parent, dicomWebPath, x__xgafv=None)</a></code></p>
117<p class="firstline">SearchForStudies returns a list of matching studies. See</p>
118<p class="toc_element">
119  <code><a href="#setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</a></code></p>
120<p class="firstline">Sets the access control policy on the specified resource. Replaces any</p>
121<p class="toc_element">
122  <code><a href="#storeInstances">storeInstances(parent, dicomWebPath, body, x__xgafv=None)</a></code></p>
123<p class="firstline">StoreInstances stores DICOM instances associated with study instance unique</p>
124<p class="toc_element">
125  <code><a href="#testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</a></code></p>
126<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
127<h3>Method Details</h3>
128<div class="method">
129    <code class="details" id="create">create(parent, body, dicomStoreId=None, x__xgafv=None)</code>
130  <pre>Creates a new DICOM store within the parent dataset.
131
132Args:
133  parent: string, The name of the dataset this DICOM store belongs to. (required)
134  body: object, The request body. (required)
135    The object takes the form of:
136
137{ # Represents a DICOM store.
138  "labels": { # User-supplied key-value pairs used to organize DICOM stores.
139      #
140      # Label keys must be between 1 and 63 characters long, have a UTF-8 encoding
141      # of maximum 128 bytes, and must conform to the
142      # following PCRE regular expression:
143      # \p{Ll}\p{Lo}{0,62}
144      #
145      # Label values are optional, must be between 1 and 63 characters long, have
146      # a UTF-8 encoding of maximum 128 bytes, and must conform to the
147      # following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63}
148      #
149      # No more than 64 labels can be associated with a given store.
150    "a_key": "A String",
151  },
152  "notificationConfig": { # Specifies where notifications should be sent upon changes to a data store. # Notification destination for new DICOM instances.
153      # Supplied by the client.
154    "pubsubTopic": "A String", # The [Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that
155        # notifications of changes are published on. Supplied by the client.
156        # PubsubMessage.Data will contain the resource name.
157        # PubsubMessage.MessageId is the ID of this message. It is guaranteed to be
158        # unique within the topic.
159        # PubsubMessage.PublishTime is the time at which the message was published.
160        # Notifications are only sent if the topic is
161        # non-empty. [Topic
162        # names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped
163        # to a project. cloud-healthcare@system.gserviceaccount.com must have
164        # publisher permissions on the given Cloud Pub/Sub topic. Not having adequate
165        # permissions will cause the calls that send notifications to fail.
166  },
167  "name": "A String", # Output only. Resource name of the DICOM store, of the form
168      # `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`.
169}
170
171  dicomStoreId: string, The ID of the DICOM store that is being created.
172Any string value up to 256 characters in length.
173  x__xgafv: string, V1 error format.
174    Allowed values
175      1 - v1 error format
176      2 - v2 error format
177
178Returns:
179  An object of the form:
180
181    { # Represents a DICOM store.
182    "labels": { # User-supplied key-value pairs used to organize DICOM stores.
183        #
184        # Label keys must be between 1 and 63 characters long, have a UTF-8 encoding
185        # of maximum 128 bytes, and must conform to the
186        # following PCRE regular expression:
187        # \p{Ll}\p{Lo}{0,62}
188        #
189        # Label values are optional, must be between 1 and 63 characters long, have
190        # a UTF-8 encoding of maximum 128 bytes, and must conform to the
191        # following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63}
192        #
193        # No more than 64 labels can be associated with a given store.
194      "a_key": "A String",
195    },
196    "notificationConfig": { # Specifies where notifications should be sent upon changes to a data store. # Notification destination for new DICOM instances.
197        # Supplied by the client.
198      "pubsubTopic": "A String", # The [Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that
199          # notifications of changes are published on. Supplied by the client.
200          # PubsubMessage.Data will contain the resource name.
201          # PubsubMessage.MessageId is the ID of this message. It is guaranteed to be
202          # unique within the topic.
203          # PubsubMessage.PublishTime is the time at which the message was published.
204          # Notifications are only sent if the topic is
205          # non-empty. [Topic
206          # names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped
207          # to a project. cloud-healthcare@system.gserviceaccount.com must have
208          # publisher permissions on the given Cloud Pub/Sub topic. Not having adequate
209          # permissions will cause the calls that send notifications to fail.
210    },
211    "name": "A String", # Output only. Resource name of the DICOM store, of the form
212        # `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`.
213  }</pre>
214</div>
215
216<div class="method">
217    <code class="details" id="delete">delete(name, x__xgafv=None)</code>
218  <pre>Deletes the specified DICOM store and removes all images that are contained
219within it.
220
221Args:
222  name: string, The resource name of the DICOM store to delete. (required)
223  x__xgafv: string, V1 error format.
224    Allowed values
225      1 - v1 error format
226      2 - v2 error format
227
228Returns:
229  An object of the form:
230
231    { # A generic empty message that you can re-use to avoid defining duplicated
232      # empty messages in your APIs. A typical example is to use it as the request
233      # or the response type of an API method. For instance:
234      #
235      #     service Foo {
236      #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
237      #     }
238      #
239      # The JSON representation for `Empty` is empty JSON object `{}`.
240  }</pre>
241</div>
242
243<div class="method">
244    <code class="details" id="export">export(name, body, x__xgafv=None)</code>
245  <pre>Exports data to the specified destination by copying it from the DICOM
246store.
247The metadata field type is
248OperationMetadata.
249
250Args:
251  name: string, The DICOM store resource name from which the data should be exported (e.g.,
252`projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). (required)
253  body: object, The request body. (required)
254    The object takes the form of:
255
256{ # Exports data from the specified DICOM store.
257      # If a given resource (e.g., a DICOM object with the same SOPInstance UID)
258      # already exists in the output, it is overwritten with the version
259      # in the source dataset.
260      # Exported DICOM data will persist when the DICOM store from which it was
261      # exported is deleted.
262    "bigqueryDestination": { # The BigQuery table where the output should be written. # The BigQuery output destination.
263        #
264        # You can only export to a BigQuery dataset that's in the same project as
265        # the DICOM store you're exporting from.
266        #
267        # The BigQuery location requires two IAM roles:
268        # `roles/bigquery.dataEditor` and `roles/bigquery.jobUser`.
269      "tableUri": "A String", # BigQuery URI to a table, up to 2000 characters long, in the format
270          # `bq://projectId.bqDatasetId.tableId`
271      "force": True or False, # If the destination table already exists and this flag is `TRUE`, the table
272          # will be overwritten by the contents of the DICOM store. If the flag is not
273          # set and the destination table already exists, the export call returns an
274          # error.
275    },
276    "gcsDestination": { # The Cloud Storage location where the output should be written, and the export # The Cloud Storage output destination.
277        #
278        # The Cloud Storage location requires the `roles/storage.objectAdmin` Cloud
279        # IAM role.
280        # configuration.
281      "mimeType": "A String", # MIME types supported by DICOM spec.
282          # Each file will be written in the following format:
283          # `.../{study_id}/{series_id}/{instance_id}[/{frame_number}].{extension}`
284          # The frame_number component will exist only for multi-frame instances.
285          #
286          # Refer to the DICOM conformance statement for permissible MIME types:
287          # https://cloud.google.com/healthcare/docs/dicom#wado-rs
288          #
289          # The following extensions will be used for output files:
290          #   application/dicom -> .dcm
291          #   image/jpeg -> .jpg
292          #   image/png -> .png
293          #
294          # If unspecified, the instances will be exported in their original
295          # DICOM format.
296      "uriPrefix": "A String", # The Cloud Storage destination to export to.
297          #
298          # URI for a Cloud Storage directory where result files should be written (in
299          # the format `gs://{bucket-id}/{path/to/destination/dir}`). If there is no
300          # trailing slash, the service will append one when composing the object path.
301          # The user is responsible for creating the Cloud Storage bucket referenced in
302          # `uri_prefix`.
303    },
304  }
305
306  x__xgafv: string, V1 error format.
307    Allowed values
308      1 - v1 error format
309      2 - v2 error format
310
311Returns:
312  An object of the form:
313
314    { # This resource represents a long-running operation that is the result of a
315      # network API call.
316    "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
317        # different programming environments, including REST APIs and RPC APIs. It is
318        # used by [gRPC](https://github.com/grpc). Each `Status` message contains
319        # three pieces of data: error code, error message, and error details.
320        #
321        # You can find out more about this error model and how to work with it in the
322        # [API Design Guide](https://cloud.google.com/apis/design/errors).
323      "message": "A String", # A developer-facing error message, which should be in English. Any
324          # user-facing error message should be localized and sent in the
325          # google.rpc.Status.details field, or localized by the client.
326      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
327      "details": [ # A list of messages that carry the error details.  There is a common set of
328          # message types for APIs to use.
329        {
330          "a_key": "", # Properties of the object. Contains field @type with type URL.
331        },
332      ],
333    },
334    "done": True or False, # If the value is `false`, it means the operation is still in progress.
335        # If `true`, the operation is completed, and either `error` or `response` is
336        # available.
337    "response": { # The normal response of the operation in case of success.  If the original
338        # method returns no data on success, such as `Delete`, the response is
339        # `google.protobuf.Empty`.  If the original method is standard
340        # `Get`/`Create`/`Update`, the response should be the resource.  For other
341        # methods, the response should have the type `XxxResponse`, where `Xxx`
342        # is the original method name.  For example, if the original method name
343        # is `TakeSnapshot()`, the inferred response type is
344        # `TakeSnapshotResponse`.
345      "a_key": "", # Properties of the object. Contains field @type with type URL.
346    },
347    "name": "A String", # The server-assigned name, which is only unique within the same service that
348        # originally returns it. If you use the default HTTP mapping, the
349        # `name` should be a resource name ending with `operations/{unique_id}`.
350    "metadata": { # Service-specific metadata associated with the operation.  It typically
351        # contains progress information and common metadata such as create time.
352        # Some services might not provide such metadata.  Any method that returns a
353        # long-running operation should document the metadata type, if any.
354      "a_key": "", # Properties of the object. Contains field @type with type URL.
355    },
356  }</pre>
357</div>
358
359<div class="method">
360    <code class="details" id="get">get(name, x__xgafv=None)</code>
361  <pre>Gets the specified DICOM store.
362
363Args:
364  name: string, The resource name of the DICOM store to get. (required)
365  x__xgafv: string, V1 error format.
366    Allowed values
367      1 - v1 error format
368      2 - v2 error format
369
370Returns:
371  An object of the form:
372
373    { # Represents a DICOM store.
374    "labels": { # User-supplied key-value pairs used to organize DICOM stores.
375        #
376        # Label keys must be between 1 and 63 characters long, have a UTF-8 encoding
377        # of maximum 128 bytes, and must conform to the
378        # following PCRE regular expression:
379        # \p{Ll}\p{Lo}{0,62}
380        #
381        # Label values are optional, must be between 1 and 63 characters long, have
382        # a UTF-8 encoding of maximum 128 bytes, and must conform to the
383        # following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63}
384        #
385        # No more than 64 labels can be associated with a given store.
386      "a_key": "A String",
387    },
388    "notificationConfig": { # Specifies where notifications should be sent upon changes to a data store. # Notification destination for new DICOM instances.
389        # Supplied by the client.
390      "pubsubTopic": "A String", # The [Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that
391          # notifications of changes are published on. Supplied by the client.
392          # PubsubMessage.Data will contain the resource name.
393          # PubsubMessage.MessageId is the ID of this message. It is guaranteed to be
394          # unique within the topic.
395          # PubsubMessage.PublishTime is the time at which the message was published.
396          # Notifications are only sent if the topic is
397          # non-empty. [Topic
398          # names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped
399          # to a project. cloud-healthcare@system.gserviceaccount.com must have
400          # publisher permissions on the given Cloud Pub/Sub topic. Not having adequate
401          # permissions will cause the calls that send notifications to fail.
402    },
403    "name": "A String", # Output only. Resource name of the DICOM store, of the form
404        # `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`.
405  }</pre>
406</div>
407
408<div class="method">
409    <code class="details" id="getIamPolicy">getIamPolicy(resource, x__xgafv=None)</code>
410  <pre>Gets the access control policy for a resource.
411Returns an empty policy if the resource exists and does not have a policy
412set.
413
414Args:
415  resource: string, REQUIRED: The resource for which the policy is being requested.
416See the operation documentation for the appropriate value for this field. (required)
417  x__xgafv: string, V1 error format.
418    Allowed values
419      1 - v1 error format
420      2 - v2 error format
421
422Returns:
423  An object of the form:
424
425    { # Defines an Identity and Access Management (IAM) policy. It is used to
426      # specify access control policies for Cloud Platform resources.
427      #
428      #
429      # A `Policy` consists of a list of `bindings`. A `binding` binds a list of
430      # `members` to a `role`, where the members can be user accounts, Google groups,
431      # Google domains, and service accounts. A `role` is a named list of permissions
432      # defined by IAM.
433      #
434      # **JSON Example**
435      #
436      #     {
437      #       "bindings": [
438      #         {
439      #           "role": "roles/owner",
440      #           "members": [
441      #             "user:mike@example.com",
442      #             "group:admins@example.com",
443      #             "domain:google.com",
444      #             "serviceAccount:my-other-app@appspot.gserviceaccount.com"
445      #           ]
446      #         },
447      #         {
448      #           "role": "roles/viewer",
449      #           "members": ["user:sean@example.com"]
450      #         }
451      #       ]
452      #     }
453      #
454      # **YAML Example**
455      #
456      #     bindings:
457      #     - members:
458      #       - user:mike@example.com
459      #       - group:admins@example.com
460      #       - domain:google.com
461      #       - serviceAccount:my-other-app@appspot.gserviceaccount.com
462      #       role: roles/owner
463      #     - members:
464      #       - user:sean@example.com
465      #       role: roles/viewer
466      #
467      #
468      # For a description of IAM and its features, see the
469      # [IAM developer's guide](https://cloud.google.com/iam/docs).
470    "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
471      { # Specifies the audit configuration for a service.
472          # The configuration determines which permission types are logged, and what
473          # identities, if any, are exempted from logging.
474          # An AuditConfig must have one or more AuditLogConfigs.
475          #
476          # If there are AuditConfigs for both `allServices` and a specific service,
477          # the union of the two AuditConfigs is used for that service: the log_types
478          # specified in each AuditConfig are enabled, and the exempted_members in each
479          # AuditLogConfig are exempted.
480          #
481          # Example Policy with multiple AuditConfigs:
482          #
483          #     {
484          #       "audit_configs": [
485          #         {
486          #           "service": "allServices"
487          #           "audit_log_configs": [
488          #             {
489          #               "log_type": "DATA_READ",
490          #               "exempted_members": [
491          #                 "user:foo@gmail.com"
492          #               ]
493          #             },
494          #             {
495          #               "log_type": "DATA_WRITE",
496          #             },
497          #             {
498          #               "log_type": "ADMIN_READ",
499          #             }
500          #           ]
501          #         },
502          #         {
503          #           "service": "fooservice.googleapis.com"
504          #           "audit_log_configs": [
505          #             {
506          #               "log_type": "DATA_READ",
507          #             },
508          #             {
509          #               "log_type": "DATA_WRITE",
510          #               "exempted_members": [
511          #                 "user:bar@gmail.com"
512          #               ]
513          #             }
514          #           ]
515          #         }
516          #       ]
517          #     }
518          #
519          # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
520          # logging. It also exempts foo@gmail.com from DATA_READ logging, and
521          # bar@gmail.com from DATA_WRITE logging.
522        "auditLogConfigs": [ # The configuration for logging of each type of permission.
523          { # Provides the configuration for logging a type of permissions.
524              # Example:
525              #
526              #     {
527              #       "audit_log_configs": [
528              #         {
529              #           "log_type": "DATA_READ",
530              #           "exempted_members": [
531              #             "user:foo@gmail.com"
532              #           ]
533              #         },
534              #         {
535              #           "log_type": "DATA_WRITE",
536              #         }
537              #       ]
538              #     }
539              #
540              # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
541              # foo@gmail.com from DATA_READ logging.
542            "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
543                # permission.
544                # Follows the same format of Binding.members.
545              "A String",
546            ],
547            "logType": "A String", # The log type that this config enables.
548          },
549        ],
550        "service": "A String", # Specifies a service that will be enabled for audit logging.
551            # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
552            # `allServices` is a special value that covers all services.
553      },
554    ],
555    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
556        # prevent simultaneous updates of a policy from overwriting each other.
557        # It is strongly suggested that systems make use of the `etag` in the
558        # read-modify-write cycle to perform policy updates in order to avoid race
559        # conditions: An `etag` is returned in the response to `getIamPolicy`, and
560        # systems are expected to put that etag in the request to `setIamPolicy` to
561        # ensure that their change will be applied to the same version of the policy.
562        #
563        # If no `etag` is provided in the call to `setIamPolicy`, then the existing
564        # policy is overwritten blindly.
565    "bindings": [ # Associates a list of `members` to a `role`.
566        # `bindings` with no members will result in an error.
567      { # Associates `members` with a `role`.
568        "role": "A String", # Role that is assigned to `members`.
569            # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
570        "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
571            # `members` can have the following values:
572            #
573            # * `allUsers`: A special identifier that represents anyone who is
574            #    on the internet; with or without a Google account.
575            #
576            # * `allAuthenticatedUsers`: A special identifier that represents anyone
577            #    who is authenticated with a Google account or a service account.
578            #
579            # * `user:{emailid}`: An email address that represents a specific Google
580            #    account. For example, `alice@gmail.com` .
581            #
582            #
583            # * `serviceAccount:{emailid}`: An email address that represents a service
584            #    account. For example, `my-other-app@appspot.gserviceaccount.com`.
585            #
586            # * `group:{emailid}`: An email address that represents a Google group.
587            #    For example, `admins@example.com`.
588            #
589            #
590            # * `domain:{domain}`: The G Suite domain (primary) that represents all the
591            #    users of that domain. For example, `google.com` or `example.com`.
592            #
593          "A String",
594        ],
595        "condition": { # Represents an expression text. Example: # The condition that is associated with this binding.
596            # NOTE: An unsatisfied condition will not allow user access via current
597            # binding. Different bindings, including their conditions, are examined
598            # independently.
599            #
600            #     title: "User account presence"
601            #     description: "Determines whether the request has a user account"
602            #     expression: "size(request.user) > 0"
603          "location": "A String", # An optional string indicating the location of the expression for error
604              # reporting, e.g. a file name and a position in the file.
605          "expression": "A String", # Textual representation of an expression in
606              # Common Expression Language syntax.
607              #
608              # The application context of the containing message determines which
609              # well-known feature set of CEL is supported.
610          "description": "A String", # An optional description of the expression. This is a longer text which
611              # describes the expression, e.g. when hovered over it in a UI.
612          "title": "A String", # An optional title for the expression, i.e. a short string describing
613              # its purpose. This can be used e.g. in UIs which allow to enter the
614              # expression.
615        },
616      },
617    ],
618    "version": 42, # Deprecated.
619  }</pre>
620</div>
621
622<div class="method">
623    <code class="details" id="import_">import_(name, body, x__xgafv=None)</code>
624  <pre>Imports data into the DICOM store by copying it from the specified source.
625For errors, the Operation will be populated with error details (in the form
626of ImportDicomDataErrorDetails in error.details), which will hold
627finer-grained error information.
628The metadata field type is
629OperationMetadata.
630
631Args:
632  name: string, The name of the DICOM store resource into which the data is imported (e.g.,
633`projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). (required)
634  body: object, The request body. (required)
635    The object takes the form of:
636
637{ # Imports data into the specified DICOM store.
638      # Returns an error if any of the files to import are not DICOM files. This
639      # API will accept duplicate DICOM instances, by simply ignoring the newly
640      # pushed instance (it will not overwrite).
641    "gcsSource": { # Specifies the configuration for importing data from Cloud Storage. # Cloud Storage source data location and import configuration.
642        #
643        # The Cloud Storage location requires the `roles/storage.objectViewer`
644        # Cloud IAM role.
645      "uri": "A String", # Points to a Cloud Storage URI containing file(s) with
646          # content only. The URI must be in the following format:
647          # `gs://{bucket_id}/{object_id}`. The URI can include wildcards in
648          # `object_id` and thus identify multiple files. Supported wildcards:
649          #  '*' to match 0 or more non-separator characters
650          #  '**' to match 0 or more characters (including separators). Must be used at
651          #       the end of a path and with no other wildcards in the
652          #       path. Can also be used with a file extension (such as .dcm), which
653          #       imports all files with the extension in the specified directory and
654          #       its sub-directories. For example,
655          #       `gs://my-bucket/my-directory/**.dcm` imports all files with .dcm
656          #       extensions in `my-directory/` and its sub-directories.
657          #  '?' to match 1 character
658          # All other URI formats are invalid.
659          # Files matching the wildcard are expected to contain content only, no
660          # metadata.
661    },
662  }
663
664  x__xgafv: string, V1 error format.
665    Allowed values
666      1 - v1 error format
667      2 - v2 error format
668
669Returns:
670  An object of the form:
671
672    { # This resource represents a long-running operation that is the result of a
673      # network API call.
674    "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
675        # different programming environments, including REST APIs and RPC APIs. It is
676        # used by [gRPC](https://github.com/grpc). Each `Status` message contains
677        # three pieces of data: error code, error message, and error details.
678        #
679        # You can find out more about this error model and how to work with it in the
680        # [API Design Guide](https://cloud.google.com/apis/design/errors).
681      "message": "A String", # A developer-facing error message, which should be in English. Any
682          # user-facing error message should be localized and sent in the
683          # google.rpc.Status.details field, or localized by the client.
684      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
685      "details": [ # A list of messages that carry the error details.  There is a common set of
686          # message types for APIs to use.
687        {
688          "a_key": "", # Properties of the object. Contains field @type with type URL.
689        },
690      ],
691    },
692    "done": True or False, # If the value is `false`, it means the operation is still in progress.
693        # If `true`, the operation is completed, and either `error` or `response` is
694        # available.
695    "response": { # The normal response of the operation in case of success.  If the original
696        # method returns no data on success, such as `Delete`, the response is
697        # `google.protobuf.Empty`.  If the original method is standard
698        # `Get`/`Create`/`Update`, the response should be the resource.  For other
699        # methods, the response should have the type `XxxResponse`, where `Xxx`
700        # is the original method name.  For example, if the original method name
701        # is `TakeSnapshot()`, the inferred response type is
702        # `TakeSnapshotResponse`.
703      "a_key": "", # Properties of the object. Contains field @type with type URL.
704    },
705    "name": "A String", # The server-assigned name, which is only unique within the same service that
706        # originally returns it. If you use the default HTTP mapping, the
707        # `name` should be a resource name ending with `operations/{unique_id}`.
708    "metadata": { # Service-specific metadata associated with the operation.  It typically
709        # contains progress information and common metadata such as create time.
710        # Some services might not provide such metadata.  Any method that returns a
711        # long-running operation should document the metadata type, if any.
712      "a_key": "", # Properties of the object. Contains field @type with type URL.
713    },
714  }</pre>
715</div>
716
717<div class="method">
718    <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</code>
719  <pre>Lists the DICOM stores in the given dataset.
720
721Args:
722  parent: string, Name of the dataset. (required)
723  pageToken: string, The next_page_token value returned from the previous List request, if any.
724  x__xgafv: string, V1 error format.
725    Allowed values
726      1 - v1 error format
727      2 - v2 error format
728  pageSize: integer, Limit on the number of DICOM stores to return in a single response.
729If zero the default page size of 100 is used.
730  filter: string, Restricts stores returned to those matching a filter. Syntax:
731https://cloud.google.com/appengine/docs/standard/python/search/query_strings
732Only filtering on labels is supported, for example `labels.key=value`.
733
734Returns:
735  An object of the form:
736
737    { # Lists the DICOM stores in the given dataset.
738    "nextPageToken": "A String", # Token to retrieve the next page of results or empty if there are no more
739        # results in the list.
740    "dicomStores": [ # The returned DICOM stores. Won't be more DICOM stores than the value of
741        # page_size in the request.
742      { # Represents a DICOM store.
743        "labels": { # User-supplied key-value pairs used to organize DICOM stores.
744            #
745            # Label keys must be between 1 and 63 characters long, have a UTF-8 encoding
746            # of maximum 128 bytes, and must conform to the
747            # following PCRE regular expression:
748            # \p{Ll}\p{Lo}{0,62}
749            #
750            # Label values are optional, must be between 1 and 63 characters long, have
751            # a UTF-8 encoding of maximum 128 bytes, and must conform to the
752            # following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63}
753            #
754            # No more than 64 labels can be associated with a given store.
755          "a_key": "A String",
756        },
757        "notificationConfig": { # Specifies where notifications should be sent upon changes to a data store. # Notification destination for new DICOM instances.
758            # Supplied by the client.
759          "pubsubTopic": "A String", # The [Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that
760              # notifications of changes are published on. Supplied by the client.
761              # PubsubMessage.Data will contain the resource name.
762              # PubsubMessage.MessageId is the ID of this message. It is guaranteed to be
763              # unique within the topic.
764              # PubsubMessage.PublishTime is the time at which the message was published.
765              # Notifications are only sent if the topic is
766              # non-empty. [Topic
767              # names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped
768              # to a project. cloud-healthcare@system.gserviceaccount.com must have
769              # publisher permissions on the given Cloud Pub/Sub topic. Not having adequate
770              # permissions will cause the calls that send notifications to fail.
771        },
772        "name": "A String", # Output only. Resource name of the DICOM store, of the form
773            # `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`.
774      },
775    ],
776  }</pre>
777</div>
778
779<div class="method">
780    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
781  <pre>Retrieves the next page of results.
782
783Args:
784  previous_request: The request for the previous page. (required)
785  previous_response: The response from the request for the previous page. (required)
786
787Returns:
788  A request object that you can call 'execute()' on to request the next
789  page. Returns None if there are no more items in the collection.
790    </pre>
791</div>
792
793<div class="method">
794    <code class="details" id="patch">patch(name, body, updateMask=None, x__xgafv=None)</code>
795  <pre>Updates the specified DICOM store.
796
797Args:
798  name: string, Output only. Resource name of the DICOM store, of the form
799`projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. (required)
800  body: object, The request body. (required)
801    The object takes the form of:
802
803{ # Represents a DICOM store.
804  "labels": { # User-supplied key-value pairs used to organize DICOM stores.
805      #
806      # Label keys must be between 1 and 63 characters long, have a UTF-8 encoding
807      # of maximum 128 bytes, and must conform to the
808      # following PCRE regular expression:
809      # \p{Ll}\p{Lo}{0,62}
810      #
811      # Label values are optional, must be between 1 and 63 characters long, have
812      # a UTF-8 encoding of maximum 128 bytes, and must conform to the
813      # following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63}
814      #
815      # No more than 64 labels can be associated with a given store.
816    "a_key": "A String",
817  },
818  "notificationConfig": { # Specifies where notifications should be sent upon changes to a data store. # Notification destination for new DICOM instances.
819      # Supplied by the client.
820    "pubsubTopic": "A String", # The [Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that
821        # notifications of changes are published on. Supplied by the client.
822        # PubsubMessage.Data will contain the resource name.
823        # PubsubMessage.MessageId is the ID of this message. It is guaranteed to be
824        # unique within the topic.
825        # PubsubMessage.PublishTime is the time at which the message was published.
826        # Notifications are only sent if the topic is
827        # non-empty. [Topic
828        # names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped
829        # to a project. cloud-healthcare@system.gserviceaccount.com must have
830        # publisher permissions on the given Cloud Pub/Sub topic. Not having adequate
831        # permissions will cause the calls that send notifications to fail.
832  },
833  "name": "A String", # Output only. Resource name of the DICOM store, of the form
834      # `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`.
835}
836
837  updateMask: string, The update mask applies to the resource. For the `FieldMask` definition,
838see
839https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
840  x__xgafv: string, V1 error format.
841    Allowed values
842      1 - v1 error format
843      2 - v2 error format
844
845Returns:
846  An object of the form:
847
848    { # Represents a DICOM store.
849    "labels": { # User-supplied key-value pairs used to organize DICOM stores.
850        #
851        # Label keys must be between 1 and 63 characters long, have a UTF-8 encoding
852        # of maximum 128 bytes, and must conform to the
853        # following PCRE regular expression:
854        # \p{Ll}\p{Lo}{0,62}
855        #
856        # Label values are optional, must be between 1 and 63 characters long, have
857        # a UTF-8 encoding of maximum 128 bytes, and must conform to the
858        # following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63}
859        #
860        # No more than 64 labels can be associated with a given store.
861      "a_key": "A String",
862    },
863    "notificationConfig": { # Specifies where notifications should be sent upon changes to a data store. # Notification destination for new DICOM instances.
864        # Supplied by the client.
865      "pubsubTopic": "A String", # The [Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that
866          # notifications of changes are published on. Supplied by the client.
867          # PubsubMessage.Data will contain the resource name.
868          # PubsubMessage.MessageId is the ID of this message. It is guaranteed to be
869          # unique within the topic.
870          # PubsubMessage.PublishTime is the time at which the message was published.
871          # Notifications are only sent if the topic is
872          # non-empty. [Topic
873          # names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped
874          # to a project. cloud-healthcare@system.gserviceaccount.com must have
875          # publisher permissions on the given Cloud Pub/Sub topic. Not having adequate
876          # permissions will cause the calls that send notifications to fail.
877    },
878    "name": "A String", # Output only. Resource name of the DICOM store, of the form
879        # `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`.
880  }</pre>
881</div>
882
883<div class="method">
884    <code class="details" id="searchForInstances">searchForInstances(parent, dicomWebPath, x__xgafv=None)</code>
885  <pre>SearchForInstances returns a list of matching instances. See
886http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6.
887
888Args:
889  parent: string, The name of the DICOM store that is being accessed (e.g.,
890`projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). (required)
891  dicomWebPath: string, The path of the SearchForInstancesRequest DICOMweb request (e.g.,
892`instances` or `series/{series_uid}/instances` or
893`studies/{study_uid}/instances`). (required)
894  x__xgafv: string, V1 error format.
895    Allowed values
896      1 - v1 error format
897      2 - v2 error format
898
899Returns:
900  An object of the form:
901
902    { # Message that represents an arbitrary HTTP body. It should only be used for
903        # payload formats that can't be represented as JSON, such as raw binary or
904        # an HTML page.
905        #
906        #
907        # This message can be used both in streaming and non-streaming API methods in
908        # the request as well as the response.
909        #
910        # It can be used as a top-level request field, which is convenient if one
911        # wants to extract parameters from either the URL or HTTP template into the
912        # request fields and also want access to the raw HTTP body.
913        #
914        # Example:
915        #
916        #     message GetResourceRequest {
917        #       // A unique request id.
918        #       string request_id = 1;
919        #
920        #       // The raw HTTP body is bound to this field.
921        #       google.api.HttpBody http_body = 2;
922        #     }
923        #
924        #     service ResourceService {
925        #       rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);
926        #       rpc UpdateResource(google.api.HttpBody) returns
927        #       (google.protobuf.Empty);
928        #     }
929        #
930        # Example with streaming methods:
931        #
932        #     service CaldavService {
933        #       rpc GetCalendar(stream google.api.HttpBody)
934        #         returns (stream google.api.HttpBody);
935        #       rpc UpdateCalendar(stream google.api.HttpBody)
936        #         returns (stream google.api.HttpBody);
937        #     }
938        #
939        # Use of this type only changes how the request and response bodies are
940        # handled, all other features will continue to work unchanged.
941      "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
942      "data": "A String", # The HTTP request/response body as raw binary.
943      "extensions": [ # Application specific response metadata. Must be set in the first response
944          # for streaming APIs.
945        {
946          "a_key": "", # Properties of the object. Contains field @type with type URL.
947        },
948      ],
949    }</pre>
950</div>
951
952<div class="method">
953    <code class="details" id="searchForSeries">searchForSeries(parent, dicomWebPath, x__xgafv=None)</code>
954  <pre>SearchForSeries returns a list of matching series. See
955http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6.
956
957Args:
958  parent: string, The name of the DICOM store that is being accessed (e.g.,
959`projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). (required)
960  dicomWebPath: string, The path of the SearchForSeries DICOMweb request(e.g., `series` or
961`studies/{study_uid}/series`). (required)
962  x__xgafv: string, V1 error format.
963    Allowed values
964      1 - v1 error format
965      2 - v2 error format
966
967Returns:
968  An object of the form:
969
970    { # Message that represents an arbitrary HTTP body. It should only be used for
971        # payload formats that can't be represented as JSON, such as raw binary or
972        # an HTML page.
973        #
974        #
975        # This message can be used both in streaming and non-streaming API methods in
976        # the request as well as the response.
977        #
978        # It can be used as a top-level request field, which is convenient if one
979        # wants to extract parameters from either the URL or HTTP template into the
980        # request fields and also want access to the raw HTTP body.
981        #
982        # Example:
983        #
984        #     message GetResourceRequest {
985        #       // A unique request id.
986        #       string request_id = 1;
987        #
988        #       // The raw HTTP body is bound to this field.
989        #       google.api.HttpBody http_body = 2;
990        #     }
991        #
992        #     service ResourceService {
993        #       rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);
994        #       rpc UpdateResource(google.api.HttpBody) returns
995        #       (google.protobuf.Empty);
996        #     }
997        #
998        # Example with streaming methods:
999        #
1000        #     service CaldavService {
1001        #       rpc GetCalendar(stream google.api.HttpBody)
1002        #         returns (stream google.api.HttpBody);
1003        #       rpc UpdateCalendar(stream google.api.HttpBody)
1004        #         returns (stream google.api.HttpBody);
1005        #     }
1006        #
1007        # Use of this type only changes how the request and response bodies are
1008        # handled, all other features will continue to work unchanged.
1009      "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
1010      "data": "A String", # The HTTP request/response body as raw binary.
1011      "extensions": [ # Application specific response metadata. Must be set in the first response
1012          # for streaming APIs.
1013        {
1014          "a_key": "", # Properties of the object. Contains field @type with type URL.
1015        },
1016      ],
1017    }</pre>
1018</div>
1019
1020<div class="method">
1021    <code class="details" id="searchForStudies">searchForStudies(parent, dicomWebPath, x__xgafv=None)</code>
1022  <pre>SearchForStudies returns a list of matching studies. See
1023http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6.
1024
1025Args:
1026  parent: string, The name of the DICOM store that is being accessed (e.g.,
1027`projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). (required)
1028  dicomWebPath: string, The path of the SearchForStudies DICOMweb request (e.g., `studies`). (required)
1029  x__xgafv: string, V1 error format.
1030    Allowed values
1031      1 - v1 error format
1032      2 - v2 error format
1033
1034Returns:
1035  An object of the form:
1036
1037    { # Message that represents an arbitrary HTTP body. It should only be used for
1038        # payload formats that can't be represented as JSON, such as raw binary or
1039        # an HTML page.
1040        #
1041        #
1042        # This message can be used both in streaming and non-streaming API methods in
1043        # the request as well as the response.
1044        #
1045        # It can be used as a top-level request field, which is convenient if one
1046        # wants to extract parameters from either the URL or HTTP template into the
1047        # request fields and also want access to the raw HTTP body.
1048        #
1049        # Example:
1050        #
1051        #     message GetResourceRequest {
1052        #       // A unique request id.
1053        #       string request_id = 1;
1054        #
1055        #       // The raw HTTP body is bound to this field.
1056        #       google.api.HttpBody http_body = 2;
1057        #     }
1058        #
1059        #     service ResourceService {
1060        #       rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);
1061        #       rpc UpdateResource(google.api.HttpBody) returns
1062        #       (google.protobuf.Empty);
1063        #     }
1064        #
1065        # Example with streaming methods:
1066        #
1067        #     service CaldavService {
1068        #       rpc GetCalendar(stream google.api.HttpBody)
1069        #         returns (stream google.api.HttpBody);
1070        #       rpc UpdateCalendar(stream google.api.HttpBody)
1071        #         returns (stream google.api.HttpBody);
1072        #     }
1073        #
1074        # Use of this type only changes how the request and response bodies are
1075        # handled, all other features will continue to work unchanged.
1076      "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
1077      "data": "A String", # The HTTP request/response body as raw binary.
1078      "extensions": [ # Application specific response metadata. Must be set in the first response
1079          # for streaming APIs.
1080        {
1081          "a_key": "", # Properties of the object. Contains field @type with type URL.
1082        },
1083      ],
1084    }</pre>
1085</div>
1086
1087<div class="method">
1088    <code class="details" id="setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</code>
1089  <pre>Sets the access control policy on the specified resource. Replaces any
1090existing policy.
1091
1092Args:
1093  resource: string, REQUIRED: The resource for which the policy is being specified.
1094See the operation documentation for the appropriate value for this field. (required)
1095  body: object, The request body. (required)
1096    The object takes the form of:
1097
1098{ # Request message for `SetIamPolicy` method.
1099    "policy": { # Defines an Identity and Access Management (IAM) policy. It is used to # REQUIRED: The complete policy to be applied to the `resource`. The size of
1100        # the policy is limited to a few 10s of KB. An empty policy is a
1101        # valid policy but certain Cloud Platform services (such as Projects)
1102        # might reject them.
1103        # specify access control policies for Cloud Platform resources.
1104        #
1105        #
1106        # A `Policy` consists of a list of `bindings`. A `binding` binds a list of
1107        # `members` to a `role`, where the members can be user accounts, Google groups,
1108        # Google domains, and service accounts. A `role` is a named list of permissions
1109        # defined by IAM.
1110        #
1111        # **JSON Example**
1112        #
1113        #     {
1114        #       "bindings": [
1115        #         {
1116        #           "role": "roles/owner",
1117        #           "members": [
1118        #             "user:mike@example.com",
1119        #             "group:admins@example.com",
1120        #             "domain:google.com",
1121        #             "serviceAccount:my-other-app@appspot.gserviceaccount.com"
1122        #           ]
1123        #         },
1124        #         {
1125        #           "role": "roles/viewer",
1126        #           "members": ["user:sean@example.com"]
1127        #         }
1128        #       ]
1129        #     }
1130        #
1131        # **YAML Example**
1132        #
1133        #     bindings:
1134        #     - members:
1135        #       - user:mike@example.com
1136        #       - group:admins@example.com
1137        #       - domain:google.com
1138        #       - serviceAccount:my-other-app@appspot.gserviceaccount.com
1139        #       role: roles/owner
1140        #     - members:
1141        #       - user:sean@example.com
1142        #       role: roles/viewer
1143        #
1144        #
1145        # For a description of IAM and its features, see the
1146        # [IAM developer's guide](https://cloud.google.com/iam/docs).
1147      "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
1148        { # Specifies the audit configuration for a service.
1149            # The configuration determines which permission types are logged, and what
1150            # identities, if any, are exempted from logging.
1151            # An AuditConfig must have one or more AuditLogConfigs.
1152            #
1153            # If there are AuditConfigs for both `allServices` and a specific service,
1154            # the union of the two AuditConfigs is used for that service: the log_types
1155            # specified in each AuditConfig are enabled, and the exempted_members in each
1156            # AuditLogConfig are exempted.
1157            #
1158            # Example Policy with multiple AuditConfigs:
1159            #
1160            #     {
1161            #       "audit_configs": [
1162            #         {
1163            #           "service": "allServices"
1164            #           "audit_log_configs": [
1165            #             {
1166            #               "log_type": "DATA_READ",
1167            #               "exempted_members": [
1168            #                 "user:foo@gmail.com"
1169            #               ]
1170            #             },
1171            #             {
1172            #               "log_type": "DATA_WRITE",
1173            #             },
1174            #             {
1175            #               "log_type": "ADMIN_READ",
1176            #             }
1177            #           ]
1178            #         },
1179            #         {
1180            #           "service": "fooservice.googleapis.com"
1181            #           "audit_log_configs": [
1182            #             {
1183            #               "log_type": "DATA_READ",
1184            #             },
1185            #             {
1186            #               "log_type": "DATA_WRITE",
1187            #               "exempted_members": [
1188            #                 "user:bar@gmail.com"
1189            #               ]
1190            #             }
1191            #           ]
1192            #         }
1193            #       ]
1194            #     }
1195            #
1196            # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
1197            # logging. It also exempts foo@gmail.com from DATA_READ logging, and
1198            # bar@gmail.com from DATA_WRITE logging.
1199          "auditLogConfigs": [ # The configuration for logging of each type of permission.
1200            { # Provides the configuration for logging a type of permissions.
1201                # Example:
1202                #
1203                #     {
1204                #       "audit_log_configs": [
1205                #         {
1206                #           "log_type": "DATA_READ",
1207                #           "exempted_members": [
1208                #             "user:foo@gmail.com"
1209                #           ]
1210                #         },
1211                #         {
1212                #           "log_type": "DATA_WRITE",
1213                #         }
1214                #       ]
1215                #     }
1216                #
1217                # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
1218                # foo@gmail.com from DATA_READ logging.
1219              "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
1220                  # permission.
1221                  # Follows the same format of Binding.members.
1222                "A String",
1223              ],
1224              "logType": "A String", # The log type that this config enables.
1225            },
1226          ],
1227          "service": "A String", # Specifies a service that will be enabled for audit logging.
1228              # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
1229              # `allServices` is a special value that covers all services.
1230        },
1231      ],
1232      "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
1233          # prevent simultaneous updates of a policy from overwriting each other.
1234          # It is strongly suggested that systems make use of the `etag` in the
1235          # read-modify-write cycle to perform policy updates in order to avoid race
1236          # conditions: An `etag` is returned in the response to `getIamPolicy`, and
1237          # systems are expected to put that etag in the request to `setIamPolicy` to
1238          # ensure that their change will be applied to the same version of the policy.
1239          #
1240          # If no `etag` is provided in the call to `setIamPolicy`, then the existing
1241          # policy is overwritten blindly.
1242      "bindings": [ # Associates a list of `members` to a `role`.
1243          # `bindings` with no members will result in an error.
1244        { # Associates `members` with a `role`.
1245          "role": "A String", # Role that is assigned to `members`.
1246              # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
1247          "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
1248              # `members` can have the following values:
1249              #
1250              # * `allUsers`: A special identifier that represents anyone who is
1251              #    on the internet; with or without a Google account.
1252              #
1253              # * `allAuthenticatedUsers`: A special identifier that represents anyone
1254              #    who is authenticated with a Google account or a service account.
1255              #
1256              # * `user:{emailid}`: An email address that represents a specific Google
1257              #    account. For example, `alice@gmail.com` .
1258              #
1259              #
1260              # * `serviceAccount:{emailid}`: An email address that represents a service
1261              #    account. For example, `my-other-app@appspot.gserviceaccount.com`.
1262              #
1263              # * `group:{emailid}`: An email address that represents a Google group.
1264              #    For example, `admins@example.com`.
1265              #
1266              #
1267              # * `domain:{domain}`: The G Suite domain (primary) that represents all the
1268              #    users of that domain. For example, `google.com` or `example.com`.
1269              #
1270            "A String",
1271          ],
1272          "condition": { # Represents an expression text. Example: # The condition that is associated with this binding.
1273              # NOTE: An unsatisfied condition will not allow user access via current
1274              # binding. Different bindings, including their conditions, are examined
1275              # independently.
1276              #
1277              #     title: "User account presence"
1278              #     description: "Determines whether the request has a user account"
1279              #     expression: "size(request.user) > 0"
1280            "location": "A String", # An optional string indicating the location of the expression for error
1281                # reporting, e.g. a file name and a position in the file.
1282            "expression": "A String", # Textual representation of an expression in
1283                # Common Expression Language syntax.
1284                #
1285                # The application context of the containing message determines which
1286                # well-known feature set of CEL is supported.
1287            "description": "A String", # An optional description of the expression. This is a longer text which
1288                # describes the expression, e.g. when hovered over it in a UI.
1289            "title": "A String", # An optional title for the expression, i.e. a short string describing
1290                # its purpose. This can be used e.g. in UIs which allow to enter the
1291                # expression.
1292          },
1293        },
1294      ],
1295      "version": 42, # Deprecated.
1296    },
1297    "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
1298        # the fields in the mask will be modified. If no mask is provided, the
1299        # following default mask is used:
1300        # paths: "bindings, etag"
1301        # This field is only used by Cloud IAM.
1302  }
1303
1304  x__xgafv: string, V1 error format.
1305    Allowed values
1306      1 - v1 error format
1307      2 - v2 error format
1308
1309Returns:
1310  An object of the form:
1311
1312    { # Defines an Identity and Access Management (IAM) policy. It is used to
1313      # specify access control policies for Cloud Platform resources.
1314      #
1315      #
1316      # A `Policy` consists of a list of `bindings`. A `binding` binds a list of
1317      # `members` to a `role`, where the members can be user accounts, Google groups,
1318      # Google domains, and service accounts. A `role` is a named list of permissions
1319      # defined by IAM.
1320      #
1321      # **JSON Example**
1322      #
1323      #     {
1324      #       "bindings": [
1325      #         {
1326      #           "role": "roles/owner",
1327      #           "members": [
1328      #             "user:mike@example.com",
1329      #             "group:admins@example.com",
1330      #             "domain:google.com",
1331      #             "serviceAccount:my-other-app@appspot.gserviceaccount.com"
1332      #           ]
1333      #         },
1334      #         {
1335      #           "role": "roles/viewer",
1336      #           "members": ["user:sean@example.com"]
1337      #         }
1338      #       ]
1339      #     }
1340      #
1341      # **YAML Example**
1342      #
1343      #     bindings:
1344      #     - members:
1345      #       - user:mike@example.com
1346      #       - group:admins@example.com
1347      #       - domain:google.com
1348      #       - serviceAccount:my-other-app@appspot.gserviceaccount.com
1349      #       role: roles/owner
1350      #     - members:
1351      #       - user:sean@example.com
1352      #       role: roles/viewer
1353      #
1354      #
1355      # For a description of IAM and its features, see the
1356      # [IAM developer's guide](https://cloud.google.com/iam/docs).
1357    "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
1358      { # Specifies the audit configuration for a service.
1359          # The configuration determines which permission types are logged, and what
1360          # identities, if any, are exempted from logging.
1361          # An AuditConfig must have one or more AuditLogConfigs.
1362          #
1363          # If there are AuditConfigs for both `allServices` and a specific service,
1364          # the union of the two AuditConfigs is used for that service: the log_types
1365          # specified in each AuditConfig are enabled, and the exempted_members in each
1366          # AuditLogConfig are exempted.
1367          #
1368          # Example Policy with multiple AuditConfigs:
1369          #
1370          #     {
1371          #       "audit_configs": [
1372          #         {
1373          #           "service": "allServices"
1374          #           "audit_log_configs": [
1375          #             {
1376          #               "log_type": "DATA_READ",
1377          #               "exempted_members": [
1378          #                 "user:foo@gmail.com"
1379          #               ]
1380          #             },
1381          #             {
1382          #               "log_type": "DATA_WRITE",
1383          #             },
1384          #             {
1385          #               "log_type": "ADMIN_READ",
1386          #             }
1387          #           ]
1388          #         },
1389          #         {
1390          #           "service": "fooservice.googleapis.com"
1391          #           "audit_log_configs": [
1392          #             {
1393          #               "log_type": "DATA_READ",
1394          #             },
1395          #             {
1396          #               "log_type": "DATA_WRITE",
1397          #               "exempted_members": [
1398          #                 "user:bar@gmail.com"
1399          #               ]
1400          #             }
1401          #           ]
1402          #         }
1403          #       ]
1404          #     }
1405          #
1406          # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
1407          # logging. It also exempts foo@gmail.com from DATA_READ logging, and
1408          # bar@gmail.com from DATA_WRITE logging.
1409        "auditLogConfigs": [ # The configuration for logging of each type of permission.
1410          { # Provides the configuration for logging a type of permissions.
1411              # Example:
1412              #
1413              #     {
1414              #       "audit_log_configs": [
1415              #         {
1416              #           "log_type": "DATA_READ",
1417              #           "exempted_members": [
1418              #             "user:foo@gmail.com"
1419              #           ]
1420              #         },
1421              #         {
1422              #           "log_type": "DATA_WRITE",
1423              #         }
1424              #       ]
1425              #     }
1426              #
1427              # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
1428              # foo@gmail.com from DATA_READ logging.
1429            "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
1430                # permission.
1431                # Follows the same format of Binding.members.
1432              "A String",
1433            ],
1434            "logType": "A String", # The log type that this config enables.
1435          },
1436        ],
1437        "service": "A String", # Specifies a service that will be enabled for audit logging.
1438            # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
1439            # `allServices` is a special value that covers all services.
1440      },
1441    ],
1442    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
1443        # prevent simultaneous updates of a policy from overwriting each other.
1444        # It is strongly suggested that systems make use of the `etag` in the
1445        # read-modify-write cycle to perform policy updates in order to avoid race
1446        # conditions: An `etag` is returned in the response to `getIamPolicy`, and
1447        # systems are expected to put that etag in the request to `setIamPolicy` to
1448        # ensure that their change will be applied to the same version of the policy.
1449        #
1450        # If no `etag` is provided in the call to `setIamPolicy`, then the existing
1451        # policy is overwritten blindly.
1452    "bindings": [ # Associates a list of `members` to a `role`.
1453        # `bindings` with no members will result in an error.
1454      { # Associates `members` with a `role`.
1455        "role": "A String", # Role that is assigned to `members`.
1456            # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
1457        "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
1458            # `members` can have the following values:
1459            #
1460            # * `allUsers`: A special identifier that represents anyone who is
1461            #    on the internet; with or without a Google account.
1462            #
1463            # * `allAuthenticatedUsers`: A special identifier that represents anyone
1464            #    who is authenticated with a Google account or a service account.
1465            #
1466            # * `user:{emailid}`: An email address that represents a specific Google
1467            #    account. For example, `alice@gmail.com` .
1468            #
1469            #
1470            # * `serviceAccount:{emailid}`: An email address that represents a service
1471            #    account. For example, `my-other-app@appspot.gserviceaccount.com`.
1472            #
1473            # * `group:{emailid}`: An email address that represents a Google group.
1474            #    For example, `admins@example.com`.
1475            #
1476            #
1477            # * `domain:{domain}`: The G Suite domain (primary) that represents all the
1478            #    users of that domain. For example, `google.com` or `example.com`.
1479            #
1480          "A String",
1481        ],
1482        "condition": { # Represents an expression text. Example: # The condition that is associated with this binding.
1483            # NOTE: An unsatisfied condition will not allow user access via current
1484            # binding. Different bindings, including their conditions, are examined
1485            # independently.
1486            #
1487            #     title: "User account presence"
1488            #     description: "Determines whether the request has a user account"
1489            #     expression: "size(request.user) > 0"
1490          "location": "A String", # An optional string indicating the location of the expression for error
1491              # reporting, e.g. a file name and a position in the file.
1492          "expression": "A String", # Textual representation of an expression in
1493              # Common Expression Language syntax.
1494              #
1495              # The application context of the containing message determines which
1496              # well-known feature set of CEL is supported.
1497          "description": "A String", # An optional description of the expression. This is a longer text which
1498              # describes the expression, e.g. when hovered over it in a UI.
1499          "title": "A String", # An optional title for the expression, i.e. a short string describing
1500              # its purpose. This can be used e.g. in UIs which allow to enter the
1501              # expression.
1502        },
1503      },
1504    ],
1505    "version": 42, # Deprecated.
1506  }</pre>
1507</div>
1508
1509<div class="method">
1510    <code class="details" id="storeInstances">storeInstances(parent, dicomWebPath, body, x__xgafv=None)</code>
1511  <pre>StoreInstances stores DICOM instances associated with study instance unique
1512identifiers (SUID). See
1513http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5.
1514
1515Args:
1516  parent: string, The name of the DICOM store that is being accessed (e.g.,
1517`projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). (required)
1518  dicomWebPath: string, The path of the StoreInstances DICOMweb request (e.g.,
1519`studies/[{study_id}]`). Note that the `study_uid` is optional. (required)
1520  body: object, The request body. (required)
1521    The object takes the form of:
1522
1523{ # Message that represents an arbitrary HTTP body. It should only be used for
1524      # payload formats that can't be represented as JSON, such as raw binary or
1525      # an HTML page.
1526      #
1527      #
1528      # This message can be used both in streaming and non-streaming API methods in
1529      # the request as well as the response.
1530      #
1531      # It can be used as a top-level request field, which is convenient if one
1532      # wants to extract parameters from either the URL or HTTP template into the
1533      # request fields and also want access to the raw HTTP body.
1534      #
1535      # Example:
1536      #
1537      #     message GetResourceRequest {
1538      #       // A unique request id.
1539      #       string request_id = 1;
1540      #
1541      #       // The raw HTTP body is bound to this field.
1542      #       google.api.HttpBody http_body = 2;
1543      #     }
1544      #
1545      #     service ResourceService {
1546      #       rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);
1547      #       rpc UpdateResource(google.api.HttpBody) returns
1548      #       (google.protobuf.Empty);
1549      #     }
1550      #
1551      # Example with streaming methods:
1552      #
1553      #     service CaldavService {
1554      #       rpc GetCalendar(stream google.api.HttpBody)
1555      #         returns (stream google.api.HttpBody);
1556      #       rpc UpdateCalendar(stream google.api.HttpBody)
1557      #         returns (stream google.api.HttpBody);
1558      #     }
1559      #
1560      # Use of this type only changes how the request and response bodies are
1561      # handled, all other features will continue to work unchanged.
1562    "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
1563    "data": "A String", # The HTTP request/response body as raw binary.
1564    "extensions": [ # Application specific response metadata. Must be set in the first response
1565        # for streaming APIs.
1566      {
1567        "a_key": "", # Properties of the object. Contains field @type with type URL.
1568      },
1569    ],
1570  }
1571
1572  x__xgafv: string, V1 error format.
1573    Allowed values
1574      1 - v1 error format
1575      2 - v2 error format
1576
1577Returns:
1578  An object of the form:
1579
1580    { # Message that represents an arbitrary HTTP body. It should only be used for
1581        # payload formats that can't be represented as JSON, such as raw binary or
1582        # an HTML page.
1583        #
1584        #
1585        # This message can be used both in streaming and non-streaming API methods in
1586        # the request as well as the response.
1587        #
1588        # It can be used as a top-level request field, which is convenient if one
1589        # wants to extract parameters from either the URL or HTTP template into the
1590        # request fields and also want access to the raw HTTP body.
1591        #
1592        # Example:
1593        #
1594        #     message GetResourceRequest {
1595        #       // A unique request id.
1596        #       string request_id = 1;
1597        #
1598        #       // The raw HTTP body is bound to this field.
1599        #       google.api.HttpBody http_body = 2;
1600        #     }
1601        #
1602        #     service ResourceService {
1603        #       rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);
1604        #       rpc UpdateResource(google.api.HttpBody) returns
1605        #       (google.protobuf.Empty);
1606        #     }
1607        #
1608        # Example with streaming methods:
1609        #
1610        #     service CaldavService {
1611        #       rpc GetCalendar(stream google.api.HttpBody)
1612        #         returns (stream google.api.HttpBody);
1613        #       rpc UpdateCalendar(stream google.api.HttpBody)
1614        #         returns (stream google.api.HttpBody);
1615        #     }
1616        #
1617        # Use of this type only changes how the request and response bodies are
1618        # handled, all other features will continue to work unchanged.
1619      "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
1620      "data": "A String", # The HTTP request/response body as raw binary.
1621      "extensions": [ # Application specific response metadata. Must be set in the first response
1622          # for streaming APIs.
1623        {
1624          "a_key": "", # Properties of the object. Contains field @type with type URL.
1625        },
1626      ],
1627    }</pre>
1628</div>
1629
1630<div class="method">
1631    <code class="details" id="testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</code>
1632  <pre>Returns permissions that a caller has on the specified resource.
1633If the resource does not exist, this will return an empty set of
1634permissions, not a NOT_FOUND error.
1635
1636Note: This operation is designed to be used for building permission-aware
1637UIs and command-line tools, not for authorization checking. This operation
1638may "fail open" without warning.
1639
1640Args:
1641  resource: string, REQUIRED: The resource for which the policy detail is being requested.
1642See the operation documentation for the appropriate value for this field. (required)
1643  body: object, The request body. (required)
1644    The object takes the form of:
1645
1646{ # Request message for `TestIamPermissions` method.
1647    "permissions": [ # The set of permissions to check for the `resource`. Permissions with
1648        # wildcards (such as '*' or 'storage.*') are not allowed. For more
1649        # information see
1650        # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
1651      "A String",
1652    ],
1653  }
1654
1655  x__xgafv: string, V1 error format.
1656    Allowed values
1657      1 - v1 error format
1658      2 - v2 error format
1659
1660Returns:
1661  An object of the form:
1662
1663    { # Response message for `TestIamPermissions` method.
1664    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
1665        # allowed.
1666      "A String",
1667    ],
1668  }</pre>
1669</div>
1670
1671</body></html>