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_v1alpha2.html">Cloud Healthcare API</a> . <a href="healthcare_v1alpha2.projects.html">projects</a> . <a href="healthcare_v1alpha2.projects.locations.html">locations</a> . <a href="healthcare_v1alpha2.projects.locations.datasets.html">datasets</a> . <a href="healthcare_v1alpha2.projects.locations.datasets.dicomStores.html">dicomStores</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="healthcare_v1alpha2.projects.locations.datasets.dicomStores.dicomWeb.html">dicomWeb()</a></code> 79</p> 80<p class="firstline">Returns the dicomWeb 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, pageSize=None, pageToken=None, x__xgafv=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="#setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</a></code></p> 111<p class="firstline">Sets the access control policy on the specified resource. Replaces any</p> 112<p class="toc_element"> 113 <code><a href="#testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</a></code></p> 114<p class="firstline">Returns permissions that a caller has on the specified resource.</p> 115<h3>Method Details</h3> 116<div class="method"> 117 <code class="details" id="create">create(parent, body, dicomStoreId=None, x__xgafv=None)</code> 118 <pre>Creates a new DICOM store within the parent dataset. 119 120Args: 121 parent: string, The name of the dataset this DICOM store belongs to. (required) 122 body: object, The request body. (required) 123 The object takes the form of: 124 125{ # Represents a DICOM store. 126 "labels": { # User-supplied key-value pairs used to organize DICOM stores. 127 # 128 # Label keys must be between 1 and 63 characters long, have a UTF-8 encoding 129 # of maximum 128 bytes, and must conform to the 130 # following PCRE regular expression: 131 # \p{Ll}\p{Lo}{0,62} 132 # 133 # Label values are optional, must be between 1 and 63 characters long, have 134 # a UTF-8 encoding of maximum 128 bytes, and must conform to the 135 # following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} 136 # 137 # No more than 64 labels can be associated with a given store. 138 "a_key": "A String", 139 }, 140 "notificationConfig": { # Specifies where notifications should be sent upon changes to a data store. # Notification destination for new DICOM instances. 141 # Supplied by the client. 142 "pubsubTopic": "A String", # The [Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that 143 # notifications of changes are published on. Supplied by the client. 144 # PubsubMessage.Data will contain the resource name. 145 # PubsubMessage.MessageId is the ID of this message. It is guaranteed to be 146 # unique within the topic. 147 # PubsubMessage.PublishTime is the time at which the message was published. 148 # Notifications are only sent if the topic is 149 # non-empty. [Topic 150 # names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped 151 # to a project. cloud-healthcare@system.gserviceaccount.com must have 152 # publisher permissions on the given Cloud Pub/Sub topic. Not having adequate 153 # permissions will cause the calls that send notifications to fail. 154 }, 155 "name": "A String", # Output only. Resource name of the DICOM store, of the form 156 # `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. 157} 158 159 dicomStoreId: string, The ID of the DICOM store that is being created. 160Any string value up to 256 characters in length. 161 x__xgafv: string, V1 error format. 162 Allowed values 163 1 - v1 error format 164 2 - v2 error format 165 166Returns: 167 An object of the form: 168 169 { # Represents a DICOM store. 170 "labels": { # User-supplied key-value pairs used to organize DICOM stores. 171 # 172 # Label keys must be between 1 and 63 characters long, have a UTF-8 encoding 173 # of maximum 128 bytes, and must conform to the 174 # following PCRE regular expression: 175 # \p{Ll}\p{Lo}{0,62} 176 # 177 # Label values are optional, must be between 1 and 63 characters long, have 178 # a UTF-8 encoding of maximum 128 bytes, and must conform to the 179 # following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} 180 # 181 # No more than 64 labels can be associated with a given store. 182 "a_key": "A String", 183 }, 184 "notificationConfig": { # Specifies where notifications should be sent upon changes to a data store. # Notification destination for new DICOM instances. 185 # Supplied by the client. 186 "pubsubTopic": "A String", # The [Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that 187 # notifications of changes are published on. Supplied by the client. 188 # PubsubMessage.Data will contain the resource name. 189 # PubsubMessage.MessageId is the ID of this message. It is guaranteed to be 190 # unique within the topic. 191 # PubsubMessage.PublishTime is the time at which the message was published. 192 # Notifications are only sent if the topic is 193 # non-empty. [Topic 194 # names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped 195 # to a project. cloud-healthcare@system.gserviceaccount.com must have 196 # publisher permissions on the given Cloud Pub/Sub topic. Not having adequate 197 # permissions will cause the calls that send notifications to fail. 198 }, 199 "name": "A String", # Output only. Resource name of the DICOM store, of the form 200 # `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. 201 }</pre> 202</div> 203 204<div class="method"> 205 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 206 <pre>Deletes the specified DICOM store and removes all images that are contained 207within it. 208 209Args: 210 name: string, The resource name of the DICOM store to delete. (required) 211 x__xgafv: string, V1 error format. 212 Allowed values 213 1 - v1 error format 214 2 - v2 error format 215 216Returns: 217 An object of the form: 218 219 { # A generic empty message that you can re-use to avoid defining duplicated 220 # empty messages in your APIs. A typical example is to use it as the request 221 # or the response type of an API method. For instance: 222 # 223 # service Foo { 224 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); 225 # } 226 # 227 # The JSON representation for `Empty` is empty JSON object `{}`. 228 }</pre> 229</div> 230 231<div class="method"> 232 <code class="details" id="export">export(name, body, x__xgafv=None)</code> 233 <pre>Exports data to the specified destination by copying it from the DICOM 234store. 235The metadata field type is 236OperationMetadata. 237 238Args: 239 name: string, The DICOM store resource name from which the data should be exported (e.g., 240`projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). (required) 241 body: object, The request body. (required) 242 The object takes the form of: 243 244{ # Exports data from the specified DICOM store. 245 # If a given resource (e.g., a DICOM object with the same SOPInstance UID) 246 # already exists in the output, it is overwritten with the version 247 # in the source dataset. 248 # Exported DICOM data will persist when the DICOM store from which it was 249 # exported is deleted. 250 "bigqueryDestination": { # The BigQuery table where the output should be written. # The BigQuery output destination. 251 # 252 # You can only export to a BigQuery dataset that's in the same project as 253 # the DICOM store you're exporting from. 254 # 255 # The BigQuery location requires two IAM roles: 256 # `roles/bigquery.dataEditor` and `roles/bigquery.jobUser`. 257 "tableUri": "A String", # BigQuery URI to a table, up to 2000 characters long, in the format 258 # `bq://projectId.bqDatasetId.tableId` 259 "force": True or False, # If the destination table already exists and this flag is `TRUE`, the table 260 # will be overwritten by the contents of the DICOM store. If the flag is not 261 # set and the destination table already exists, the export call returns an 262 # error. 263 }, 264 "gcsDestination": { # The Cloud Storage location where the output should be written, and the export # The Cloud Storage output destination. 265 # 266 # The Cloud Storage location requires the `roles/storage.objectAdmin` Cloud 267 # IAM role. 268 # configuration. 269 "mimeType": "A String", # MIME types supported by DICOM spec. 270 # Each file will be written in the following format: 271 # `.../{study_id}/{series_id}/{instance_id}[/{frame_number}].{extension}` 272 # The frame_number component will exist only for multi-frame instances. 273 # 274 # Refer to the DICOM conformance statement for permissible MIME types: 275 # https://cloud.google.com/healthcare/docs/dicom#wado-rs 276 # 277 # The following extensions will be used for output files: 278 # application/dicom -> .dcm 279 # image/jpeg -> .jpg 280 # image/png -> .png 281 # 282 # If unspecified, the instances will be exported in their original 283 # DICOM format. 284 "uriPrefix": "A String", # The Cloud Storage destination to export to. 285 # 286 # URI for a Cloud Storage directory where result files should be written (in 287 # the format `gs://{bucket-id}/{path/to/destination/dir}`). If there is no 288 # trailing slash, the service will append one when composing the object path. 289 # The user is responsible for creating the Cloud Storage bucket referenced in 290 # `uri_prefix`. 291 }, 292 } 293 294 x__xgafv: string, V1 error format. 295 Allowed values 296 1 - v1 error format 297 2 - v2 error format 298 299Returns: 300 An object of the form: 301 302 { # This resource represents a long-running operation that is the result of a 303 # network API call. 304 "metadata": { # Service-specific metadata associated with the operation. It typically 305 # contains progress information and common metadata such as create time. 306 # Some services might not provide such metadata. Any method that returns a 307 # long-running operation should document the metadata type, if any. 308 "a_key": "", # Properties of the object. Contains field @type with type URL. 309 }, 310 "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. 311 # different programming environments, including REST APIs and RPC APIs. It is 312 # used by [gRPC](https://github.com/grpc). Each `Status` message contains 313 # three pieces of data: error code, error message, and error details. 314 # 315 # You can find out more about this error model and how to work with it in the 316 # [API Design Guide](https://cloud.google.com/apis/design/errors). 317 "message": "A String", # A developer-facing error message, which should be in English. Any 318 # user-facing error message should be localized and sent in the 319 # google.rpc.Status.details field, or localized by the client. 320 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 321 "details": [ # A list of messages that carry the error details. There is a common set of 322 # message types for APIs to use. 323 { 324 "a_key": "", # Properties of the object. Contains field @type with type URL. 325 }, 326 ], 327 }, 328 "done": True or False, # If the value is `false`, it means the operation is still in progress. 329 # If `true`, the operation is completed, and either `error` or `response` is 330 # available. 331 "response": { # The normal response of the operation in case of success. If the original 332 # method returns no data on success, such as `Delete`, the response is 333 # `google.protobuf.Empty`. If the original method is standard 334 # `Get`/`Create`/`Update`, the response should be the resource. For other 335 # methods, the response should have the type `XxxResponse`, where `Xxx` 336 # is the original method name. For example, if the original method name 337 # is `TakeSnapshot()`, the inferred response type is 338 # `TakeSnapshotResponse`. 339 "a_key": "", # Properties of the object. Contains field @type with type URL. 340 }, 341 "name": "A String", # The server-assigned name, which is only unique within the same service that 342 # originally returns it. If you use the default HTTP mapping, the 343 # `name` should be a resource name ending with `operations/{unique_id}`. 344 }</pre> 345</div> 346 347<div class="method"> 348 <code class="details" id="get">get(name, x__xgafv=None)</code> 349 <pre>Gets the specified DICOM store. 350 351Args: 352 name: string, The resource name of the DICOM store to get. (required) 353 x__xgafv: string, V1 error format. 354 Allowed values 355 1 - v1 error format 356 2 - v2 error format 357 358Returns: 359 An object of the form: 360 361 { # Represents a DICOM store. 362 "labels": { # User-supplied key-value pairs used to organize DICOM stores. 363 # 364 # Label keys must be between 1 and 63 characters long, have a UTF-8 encoding 365 # of maximum 128 bytes, and must conform to the 366 # following PCRE regular expression: 367 # \p{Ll}\p{Lo}{0,62} 368 # 369 # Label values are optional, must be between 1 and 63 characters long, have 370 # a UTF-8 encoding of maximum 128 bytes, and must conform to the 371 # following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} 372 # 373 # No more than 64 labels can be associated with a given store. 374 "a_key": "A String", 375 }, 376 "notificationConfig": { # Specifies where notifications should be sent upon changes to a data store. # Notification destination for new DICOM instances. 377 # Supplied by the client. 378 "pubsubTopic": "A String", # The [Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that 379 # notifications of changes are published on. Supplied by the client. 380 # PubsubMessage.Data will contain the resource name. 381 # PubsubMessage.MessageId is the ID of this message. It is guaranteed to be 382 # unique within the topic. 383 # PubsubMessage.PublishTime is the time at which the message was published. 384 # Notifications are only sent if the topic is 385 # non-empty. [Topic 386 # names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped 387 # to a project. cloud-healthcare@system.gserviceaccount.com must have 388 # publisher permissions on the given Cloud Pub/Sub topic. Not having adequate 389 # permissions will cause the calls that send notifications to fail. 390 }, 391 "name": "A String", # Output only. Resource name of the DICOM store, of the form 392 # `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. 393 }</pre> 394</div> 395 396<div class="method"> 397 <code class="details" id="getIamPolicy">getIamPolicy(resource, x__xgafv=None)</code> 398 <pre>Gets the access control policy for a resource. 399Returns an empty policy if the resource exists and does not have a policy 400set. 401 402Args: 403 resource: string, REQUIRED: The resource for which the policy is being requested. 404See the operation documentation for the appropriate value for this field. (required) 405 x__xgafv: string, V1 error format. 406 Allowed values 407 1 - v1 error format 408 2 - v2 error format 409 410Returns: 411 An object of the form: 412 413 { # Defines an Identity and Access Management (IAM) policy. It is used to 414 # specify access control policies for Cloud Platform resources. 415 # 416 # 417 # A `Policy` consists of a list of `bindings`. A `binding` binds a list of 418 # `members` to a `role`, where the members can be user accounts, Google groups, 419 # Google domains, and service accounts. A `role` is a named list of permissions 420 # defined by IAM. 421 # 422 # **JSON Example** 423 # 424 # { 425 # "bindings": [ 426 # { 427 # "role": "roles/owner", 428 # "members": [ 429 # "user:mike@example.com", 430 # "group:admins@example.com", 431 # "domain:google.com", 432 # "serviceAccount:my-other-app@appspot.gserviceaccount.com" 433 # ] 434 # }, 435 # { 436 # "role": "roles/viewer", 437 # "members": ["user:sean@example.com"] 438 # } 439 # ] 440 # } 441 # 442 # **YAML Example** 443 # 444 # bindings: 445 # - members: 446 # - user:mike@example.com 447 # - group:admins@example.com 448 # - domain:google.com 449 # - serviceAccount:my-other-app@appspot.gserviceaccount.com 450 # role: roles/owner 451 # - members: 452 # - user:sean@example.com 453 # role: roles/viewer 454 # 455 # 456 # For a description of IAM and its features, see the 457 # [IAM developer's guide](https://cloud.google.com/iam/docs). 458 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 459 { # Specifies the audit configuration for a service. 460 # The configuration determines which permission types are logged, and what 461 # identities, if any, are exempted from logging. 462 # An AuditConfig must have one or more AuditLogConfigs. 463 # 464 # If there are AuditConfigs for both `allServices` and a specific service, 465 # the union of the two AuditConfigs is used for that service: the log_types 466 # specified in each AuditConfig are enabled, and the exempted_members in each 467 # AuditLogConfig are exempted. 468 # 469 # Example Policy with multiple AuditConfigs: 470 # 471 # { 472 # "audit_configs": [ 473 # { 474 # "service": "allServices" 475 # "audit_log_configs": [ 476 # { 477 # "log_type": "DATA_READ", 478 # "exempted_members": [ 479 # "user:foo@gmail.com" 480 # ] 481 # }, 482 # { 483 # "log_type": "DATA_WRITE", 484 # }, 485 # { 486 # "log_type": "ADMIN_READ", 487 # } 488 # ] 489 # }, 490 # { 491 # "service": "fooservice.googleapis.com" 492 # "audit_log_configs": [ 493 # { 494 # "log_type": "DATA_READ", 495 # }, 496 # { 497 # "log_type": "DATA_WRITE", 498 # "exempted_members": [ 499 # "user:bar@gmail.com" 500 # ] 501 # } 502 # ] 503 # } 504 # ] 505 # } 506 # 507 # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ 508 # logging. It also exempts foo@gmail.com from DATA_READ logging, and 509 # bar@gmail.com from DATA_WRITE logging. 510 "auditLogConfigs": [ # The configuration for logging of each type of permission. 511 { # Provides the configuration for logging a type of permissions. 512 # Example: 513 # 514 # { 515 # "audit_log_configs": [ 516 # { 517 # "log_type": "DATA_READ", 518 # "exempted_members": [ 519 # "user:foo@gmail.com" 520 # ] 521 # }, 522 # { 523 # "log_type": "DATA_WRITE", 524 # } 525 # ] 526 # } 527 # 528 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting 529 # foo@gmail.com from DATA_READ logging. 530 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of 531 # permission. 532 # Follows the same format of Binding.members. 533 "A String", 534 ], 535 "logType": "A String", # The log type that this config enables. 536 }, 537 ], 538 "service": "A String", # Specifies a service that will be enabled for audit logging. 539 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. 540 # `allServices` is a special value that covers all services. 541 }, 542 ], 543 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help 544 # prevent simultaneous updates of a policy from overwriting each other. 545 # It is strongly suggested that systems make use of the `etag` in the 546 # read-modify-write cycle to perform policy updates in order to avoid race 547 # conditions: An `etag` is returned in the response to `getIamPolicy`, and 548 # systems are expected to put that etag in the request to `setIamPolicy` to 549 # ensure that their change will be applied to the same version of the policy. 550 # 551 # If no `etag` is provided in the call to `setIamPolicy`, then the existing 552 # policy is overwritten blindly. 553 "bindings": [ # Associates a list of `members` to a `role`. 554 # `bindings` with no members will result in an error. 555 { # Associates `members` with a `role`. 556 "role": "A String", # Role that is assigned to `members`. 557 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 558 "condition": { # Represents an expression text. Example: # The condition that is associated with this binding. 559 # NOTE: An unsatisfied condition will not allow user access via current 560 # binding. Different bindings, including their conditions, are examined 561 # independently. 562 # 563 # title: "User account presence" 564 # description: "Determines whether the request has a user account" 565 # expression: "size(request.user) > 0" 566 "description": "A String", # An optional description of the expression. This is a longer text which 567 # describes the expression, e.g. when hovered over it in a UI. 568 "expression": "A String", # Textual representation of an expression in 569 # Common Expression Language syntax. 570 # 571 # The application context of the containing message determines which 572 # well-known feature set of CEL is supported. 573 "location": "A String", # An optional string indicating the location of the expression for error 574 # reporting, e.g. a file name and a position in the file. 575 "title": "A String", # An optional title for the expression, i.e. a short string describing 576 # its purpose. This can be used e.g. in UIs which allow to enter the 577 # expression. 578 }, 579 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. 580 # `members` can have the following values: 581 # 582 # * `allUsers`: A special identifier that represents anyone who is 583 # on the internet; with or without a Google account. 584 # 585 # * `allAuthenticatedUsers`: A special identifier that represents anyone 586 # who is authenticated with a Google account or a service account. 587 # 588 # * `user:{emailid}`: An email address that represents a specific Google 589 # account. For example, `alice@gmail.com` . 590 # 591 # 592 # * `serviceAccount:{emailid}`: An email address that represents a service 593 # account. For example, `my-other-app@appspot.gserviceaccount.com`. 594 # 595 # * `group:{emailid}`: An email address that represents a Google group. 596 # For example, `admins@example.com`. 597 # 598 # 599 # * `domain:{domain}`: The G Suite domain (primary) that represents all the 600 # users of that domain. For example, `google.com` or `example.com`. 601 # 602 "A String", 603 ], 604 }, 605 ], 606 "version": 42, # Deprecated. 607 }</pre> 608</div> 609 610<div class="method"> 611 <code class="details" id="import_">import_(name, body, x__xgafv=None)</code> 612 <pre>Imports data into the DICOM store by copying it from the specified source. 613For errors, the Operation will be populated with error details (in the form 614of ImportDicomDataErrorDetails in error.details), which will hold 615finer-grained error information. 616The metadata field type is 617OperationMetadata. 618 619Args: 620 name: string, The name of the DICOM store resource into which the data is imported (e.g., 621`projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). (required) 622 body: object, The request body. (required) 623 The object takes the form of: 624 625{ # Imports data into the specified DICOM store. 626 # Returns an error if any of the files to import are not DICOM files. This 627 # API will accept duplicate DICOM instances, by simply ignoring the newly 628 # pushed instance (it will not overwrite). 629 "gcsSource": { # Specifies the configuration for importing data from Cloud Storage. # Cloud Storage source data location and import configuration. 630 # 631 # The Cloud Storage location requires the `roles/storage.objectViewer` 632 # Cloud IAM role. 633 "uri": "A String", # Points to a Cloud Storage URI containing file(s) with 634 # content only. The URI must be in the following format: 635 # `gs://{bucket_id}/{object_id}`. The URI can include wildcards in 636 # `object_id` and thus identify multiple files. Supported wildcards: 637 # '*' to match 0 or more non-separator characters 638 # '**' to match 0 or more characters (including separators). Must be used at 639 # the end of a path and with no other wildcards in the 640 # path. Can also be used with a file extension (such as .dcm), which 641 # imports all files with the extension in the specified directory and 642 # its sub-directories. For example, 643 # `gs://my-bucket/my-directory/**.dcm` imports all files with .dcm 644 # extensions in `my-directory/` and its sub-directories. 645 # '?' to match 1 character 646 # All other URI formats are invalid. 647 # Files matching the wildcard are expected to contain content only, no 648 # metadata. 649 }, 650 } 651 652 x__xgafv: string, V1 error format. 653 Allowed values 654 1 - v1 error format 655 2 - v2 error format 656 657Returns: 658 An object of the form: 659 660 { # This resource represents a long-running operation that is the result of a 661 # network API call. 662 "metadata": { # Service-specific metadata associated with the operation. It typically 663 # contains progress information and common metadata such as create time. 664 # Some services might not provide such metadata. Any method that returns a 665 # long-running operation should document the metadata type, if any. 666 "a_key": "", # Properties of the object. Contains field @type with type URL. 667 }, 668 "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. 669 # different programming environments, including REST APIs and RPC APIs. It is 670 # used by [gRPC](https://github.com/grpc). Each `Status` message contains 671 # three pieces of data: error code, error message, and error details. 672 # 673 # You can find out more about this error model and how to work with it in the 674 # [API Design Guide](https://cloud.google.com/apis/design/errors). 675 "message": "A String", # A developer-facing error message, which should be in English. Any 676 # user-facing error message should be localized and sent in the 677 # google.rpc.Status.details field, or localized by the client. 678 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 679 "details": [ # A list of messages that carry the error details. There is a common set of 680 # message types for APIs to use. 681 { 682 "a_key": "", # Properties of the object. Contains field @type with type URL. 683 }, 684 ], 685 }, 686 "done": True or False, # If the value is `false`, it means the operation is still in progress. 687 # If `true`, the operation is completed, and either `error` or `response` is 688 # available. 689 "response": { # The normal response of the operation in case of success. If the original 690 # method returns no data on success, such as `Delete`, the response is 691 # `google.protobuf.Empty`. If the original method is standard 692 # `Get`/`Create`/`Update`, the response should be the resource. For other 693 # methods, the response should have the type `XxxResponse`, where `Xxx` 694 # is the original method name. For example, if the original method name 695 # is `TakeSnapshot()`, the inferred response type is 696 # `TakeSnapshotResponse`. 697 "a_key": "", # Properties of the object. Contains field @type with type URL. 698 }, 699 "name": "A String", # The server-assigned name, which is only unique within the same service that 700 # originally returns it. If you use the default HTTP mapping, the 701 # `name` should be a resource name ending with `operations/{unique_id}`. 702 }</pre> 703</div> 704 705<div class="method"> 706 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None, filter=None)</code> 707 <pre>Lists the DICOM stores in the given dataset. 708 709Args: 710 parent: string, Name of the dataset. (required) 711 pageSize: integer, Limit on the number of DICOM stores to return in a single response. 712If zero the default page size of 100 is used. 713 pageToken: string, The next_page_token value returned from the previous List request, if any. 714 x__xgafv: string, V1 error format. 715 Allowed values 716 1 - v1 error format 717 2 - v2 error format 718 filter: string, Restricts stores returned to those matching a filter. Syntax: 719https://cloud.google.com/appengine/docs/standard/python/search/query_strings 720Only filtering on labels is supported, for example `labels.key=value`. 721 722Returns: 723 An object of the form: 724 725 { # Lists the DICOM stores in the given dataset. 726 "nextPageToken": "A String", # Token to retrieve the next page of results or empty if there are no more 727 # results in the list. 728 "dicomStores": [ # The returned DICOM stores. Won't be more DICOM stores than the value of 729 # page_size in the request. 730 { # Represents a DICOM store. 731 "labels": { # User-supplied key-value pairs used to organize DICOM stores. 732 # 733 # Label keys must be between 1 and 63 characters long, have a UTF-8 encoding 734 # of maximum 128 bytes, and must conform to the 735 # following PCRE regular expression: 736 # \p{Ll}\p{Lo}{0,62} 737 # 738 # Label values are optional, must be between 1 and 63 characters long, have 739 # a UTF-8 encoding of maximum 128 bytes, and must conform to the 740 # following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} 741 # 742 # No more than 64 labels can be associated with a given store. 743 "a_key": "A String", 744 }, 745 "notificationConfig": { # Specifies where notifications should be sent upon changes to a data store. # Notification destination for new DICOM instances. 746 # Supplied by the client. 747 "pubsubTopic": "A String", # The [Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that 748 # notifications of changes are published on. Supplied by the client. 749 # PubsubMessage.Data will contain the resource name. 750 # PubsubMessage.MessageId is the ID of this message. It is guaranteed to be 751 # unique within the topic. 752 # PubsubMessage.PublishTime is the time at which the message was published. 753 # Notifications are only sent if the topic is 754 # non-empty. [Topic 755 # names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped 756 # to a project. cloud-healthcare@system.gserviceaccount.com must have 757 # publisher permissions on the given Cloud Pub/Sub topic. Not having adequate 758 # permissions will cause the calls that send notifications to fail. 759 }, 760 "name": "A String", # Output only. Resource name of the DICOM store, of the form 761 # `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. 762 }, 763 ], 764 }</pre> 765</div> 766 767<div class="method"> 768 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 769 <pre>Retrieves the next page of results. 770 771Args: 772 previous_request: The request for the previous page. (required) 773 previous_response: The response from the request for the previous page. (required) 774 775Returns: 776 A request object that you can call 'execute()' on to request the next 777 page. Returns None if there are no more items in the collection. 778 </pre> 779</div> 780 781<div class="method"> 782 <code class="details" id="patch">patch(name, body, updateMask=None, x__xgafv=None)</code> 783 <pre>Updates the specified DICOM store. 784 785Args: 786 name: string, Output only. Resource name of the DICOM store, of the form 787`projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. (required) 788 body: object, The request body. (required) 789 The object takes the form of: 790 791{ # Represents a DICOM store. 792 "labels": { # User-supplied key-value pairs used to organize DICOM stores. 793 # 794 # Label keys must be between 1 and 63 characters long, have a UTF-8 encoding 795 # of maximum 128 bytes, and must conform to the 796 # following PCRE regular expression: 797 # \p{Ll}\p{Lo}{0,62} 798 # 799 # Label values are optional, must be between 1 and 63 characters long, have 800 # a UTF-8 encoding of maximum 128 bytes, and must conform to the 801 # following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} 802 # 803 # No more than 64 labels can be associated with a given store. 804 "a_key": "A String", 805 }, 806 "notificationConfig": { # Specifies where notifications should be sent upon changes to a data store. # Notification destination for new DICOM instances. 807 # Supplied by the client. 808 "pubsubTopic": "A String", # The [Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that 809 # notifications of changes are published on. Supplied by the client. 810 # PubsubMessage.Data will contain the resource name. 811 # PubsubMessage.MessageId is the ID of this message. It is guaranteed to be 812 # unique within the topic. 813 # PubsubMessage.PublishTime is the time at which the message was published. 814 # Notifications are only sent if the topic is 815 # non-empty. [Topic 816 # names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped 817 # to a project. cloud-healthcare@system.gserviceaccount.com must have 818 # publisher permissions on the given Cloud Pub/Sub topic. Not having adequate 819 # permissions will cause the calls that send notifications to fail. 820 }, 821 "name": "A String", # Output only. Resource name of the DICOM store, of the form 822 # `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. 823} 824 825 updateMask: string, The update mask applies to the resource. For the `FieldMask` definition, 826see 827https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask 828 x__xgafv: string, V1 error format. 829 Allowed values 830 1 - v1 error format 831 2 - v2 error format 832 833Returns: 834 An object of the form: 835 836 { # Represents a DICOM store. 837 "labels": { # User-supplied key-value pairs used to organize DICOM stores. 838 # 839 # Label keys must be between 1 and 63 characters long, have a UTF-8 encoding 840 # of maximum 128 bytes, and must conform to the 841 # following PCRE regular expression: 842 # \p{Ll}\p{Lo}{0,62} 843 # 844 # Label values are optional, must be between 1 and 63 characters long, have 845 # a UTF-8 encoding of maximum 128 bytes, and must conform to the 846 # following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} 847 # 848 # No more than 64 labels can be associated with a given store. 849 "a_key": "A String", 850 }, 851 "notificationConfig": { # Specifies where notifications should be sent upon changes to a data store. # Notification destination for new DICOM instances. 852 # Supplied by the client. 853 "pubsubTopic": "A String", # The [Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that 854 # notifications of changes are published on. Supplied by the client. 855 # PubsubMessage.Data will contain the resource name. 856 # PubsubMessage.MessageId is the ID of this message. It is guaranteed to be 857 # unique within the topic. 858 # PubsubMessage.PublishTime is the time at which the message was published. 859 # Notifications are only sent if the topic is 860 # non-empty. [Topic 861 # names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped 862 # to a project. cloud-healthcare@system.gserviceaccount.com must have 863 # publisher permissions on the given Cloud Pub/Sub topic. Not having adequate 864 # permissions will cause the calls that send notifications to fail. 865 }, 866 "name": "A String", # Output only. Resource name of the DICOM store, of the form 867 # `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. 868 }</pre> 869</div> 870 871<div class="method"> 872 <code class="details" id="setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</code> 873 <pre>Sets the access control policy on the specified resource. Replaces any 874existing policy. 875 876Args: 877 resource: string, REQUIRED: The resource for which the policy is being specified. 878See the operation documentation for the appropriate value for this field. (required) 879 body: object, The request body. (required) 880 The object takes the form of: 881 882{ # Request message for `SetIamPolicy` method. 883 "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 884 # the policy is limited to a few 10s of KB. An empty policy is a 885 # valid policy but certain Cloud Platform services (such as Projects) 886 # might reject them. 887 # specify access control policies for Cloud Platform resources. 888 # 889 # 890 # A `Policy` consists of a list of `bindings`. A `binding` binds a list of 891 # `members` to a `role`, where the members can be user accounts, Google groups, 892 # Google domains, and service accounts. A `role` is a named list of permissions 893 # defined by IAM. 894 # 895 # **JSON Example** 896 # 897 # { 898 # "bindings": [ 899 # { 900 # "role": "roles/owner", 901 # "members": [ 902 # "user:mike@example.com", 903 # "group:admins@example.com", 904 # "domain:google.com", 905 # "serviceAccount:my-other-app@appspot.gserviceaccount.com" 906 # ] 907 # }, 908 # { 909 # "role": "roles/viewer", 910 # "members": ["user:sean@example.com"] 911 # } 912 # ] 913 # } 914 # 915 # **YAML Example** 916 # 917 # bindings: 918 # - members: 919 # - user:mike@example.com 920 # - group:admins@example.com 921 # - domain:google.com 922 # - serviceAccount:my-other-app@appspot.gserviceaccount.com 923 # role: roles/owner 924 # - members: 925 # - user:sean@example.com 926 # role: roles/viewer 927 # 928 # 929 # For a description of IAM and its features, see the 930 # [IAM developer's guide](https://cloud.google.com/iam/docs). 931 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 932 { # Specifies the audit configuration for a service. 933 # The configuration determines which permission types are logged, and what 934 # identities, if any, are exempted from logging. 935 # An AuditConfig must have one or more AuditLogConfigs. 936 # 937 # If there are AuditConfigs for both `allServices` and a specific service, 938 # the union of the two AuditConfigs is used for that service: the log_types 939 # specified in each AuditConfig are enabled, and the exempted_members in each 940 # AuditLogConfig are exempted. 941 # 942 # Example Policy with multiple AuditConfigs: 943 # 944 # { 945 # "audit_configs": [ 946 # { 947 # "service": "allServices" 948 # "audit_log_configs": [ 949 # { 950 # "log_type": "DATA_READ", 951 # "exempted_members": [ 952 # "user:foo@gmail.com" 953 # ] 954 # }, 955 # { 956 # "log_type": "DATA_WRITE", 957 # }, 958 # { 959 # "log_type": "ADMIN_READ", 960 # } 961 # ] 962 # }, 963 # { 964 # "service": "fooservice.googleapis.com" 965 # "audit_log_configs": [ 966 # { 967 # "log_type": "DATA_READ", 968 # }, 969 # { 970 # "log_type": "DATA_WRITE", 971 # "exempted_members": [ 972 # "user:bar@gmail.com" 973 # ] 974 # } 975 # ] 976 # } 977 # ] 978 # } 979 # 980 # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ 981 # logging. It also exempts foo@gmail.com from DATA_READ logging, and 982 # bar@gmail.com from DATA_WRITE logging. 983 "auditLogConfigs": [ # The configuration for logging of each type of permission. 984 { # Provides the configuration for logging a type of permissions. 985 # Example: 986 # 987 # { 988 # "audit_log_configs": [ 989 # { 990 # "log_type": "DATA_READ", 991 # "exempted_members": [ 992 # "user:foo@gmail.com" 993 # ] 994 # }, 995 # { 996 # "log_type": "DATA_WRITE", 997 # } 998 # ] 999 # } 1000 # 1001 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting 1002 # foo@gmail.com from DATA_READ logging. 1003 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of 1004 # permission. 1005 # Follows the same format of Binding.members. 1006 "A String", 1007 ], 1008 "logType": "A String", # The log type that this config enables. 1009 }, 1010 ], 1011 "service": "A String", # Specifies a service that will be enabled for audit logging. 1012 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. 1013 # `allServices` is a special value that covers all services. 1014 }, 1015 ], 1016 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help 1017 # prevent simultaneous updates of a policy from overwriting each other. 1018 # It is strongly suggested that systems make use of the `etag` in the 1019 # read-modify-write cycle to perform policy updates in order to avoid race 1020 # conditions: An `etag` is returned in the response to `getIamPolicy`, and 1021 # systems are expected to put that etag in the request to `setIamPolicy` to 1022 # ensure that their change will be applied to the same version of the policy. 1023 # 1024 # If no `etag` is provided in the call to `setIamPolicy`, then the existing 1025 # policy is overwritten blindly. 1026 "bindings": [ # Associates a list of `members` to a `role`. 1027 # `bindings` with no members will result in an error. 1028 { # Associates `members` with a `role`. 1029 "role": "A String", # Role that is assigned to `members`. 1030 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 1031 "condition": { # Represents an expression text. Example: # The condition that is associated with this binding. 1032 # NOTE: An unsatisfied condition will not allow user access via current 1033 # binding. Different bindings, including their conditions, are examined 1034 # independently. 1035 # 1036 # title: "User account presence" 1037 # description: "Determines whether the request has a user account" 1038 # expression: "size(request.user) > 0" 1039 "description": "A String", # An optional description of the expression. This is a longer text which 1040 # describes the expression, e.g. when hovered over it in a UI. 1041 "expression": "A String", # Textual representation of an expression in 1042 # Common Expression Language syntax. 1043 # 1044 # The application context of the containing message determines which 1045 # well-known feature set of CEL is supported. 1046 "location": "A String", # An optional string indicating the location of the expression for error 1047 # reporting, e.g. a file name and a position in the file. 1048 "title": "A String", # An optional title for the expression, i.e. a short string describing 1049 # its purpose. This can be used e.g. in UIs which allow to enter the 1050 # expression. 1051 }, 1052 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. 1053 # `members` can have the following values: 1054 # 1055 # * `allUsers`: A special identifier that represents anyone who is 1056 # on the internet; with or without a Google account. 1057 # 1058 # * `allAuthenticatedUsers`: A special identifier that represents anyone 1059 # who is authenticated with a Google account or a service account. 1060 # 1061 # * `user:{emailid}`: An email address that represents a specific Google 1062 # account. For example, `alice@gmail.com` . 1063 # 1064 # 1065 # * `serviceAccount:{emailid}`: An email address that represents a service 1066 # account. For example, `my-other-app@appspot.gserviceaccount.com`. 1067 # 1068 # * `group:{emailid}`: An email address that represents a Google group. 1069 # For example, `admins@example.com`. 1070 # 1071 # 1072 # * `domain:{domain}`: The G Suite domain (primary) that represents all the 1073 # users of that domain. For example, `google.com` or `example.com`. 1074 # 1075 "A String", 1076 ], 1077 }, 1078 ], 1079 "version": 42, # Deprecated. 1080 }, 1081 "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only 1082 # the fields in the mask will be modified. If no mask is provided, the 1083 # following default mask is used: 1084 # paths: "bindings, etag" 1085 # This field is only used by Cloud IAM. 1086 } 1087 1088 x__xgafv: string, V1 error format. 1089 Allowed values 1090 1 - v1 error format 1091 2 - v2 error format 1092 1093Returns: 1094 An object of the form: 1095 1096 { # Defines an Identity and Access Management (IAM) policy. It is used to 1097 # specify access control policies for Cloud Platform resources. 1098 # 1099 # 1100 # A `Policy` consists of a list of `bindings`. A `binding` binds a list of 1101 # `members` to a `role`, where the members can be user accounts, Google groups, 1102 # Google domains, and service accounts. A `role` is a named list of permissions 1103 # defined by IAM. 1104 # 1105 # **JSON Example** 1106 # 1107 # { 1108 # "bindings": [ 1109 # { 1110 # "role": "roles/owner", 1111 # "members": [ 1112 # "user:mike@example.com", 1113 # "group:admins@example.com", 1114 # "domain:google.com", 1115 # "serviceAccount:my-other-app@appspot.gserviceaccount.com" 1116 # ] 1117 # }, 1118 # { 1119 # "role": "roles/viewer", 1120 # "members": ["user:sean@example.com"] 1121 # } 1122 # ] 1123 # } 1124 # 1125 # **YAML Example** 1126 # 1127 # bindings: 1128 # - members: 1129 # - user:mike@example.com 1130 # - group:admins@example.com 1131 # - domain:google.com 1132 # - serviceAccount:my-other-app@appspot.gserviceaccount.com 1133 # role: roles/owner 1134 # - members: 1135 # - user:sean@example.com 1136 # role: roles/viewer 1137 # 1138 # 1139 # For a description of IAM and its features, see the 1140 # [IAM developer's guide](https://cloud.google.com/iam/docs). 1141 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 1142 { # Specifies the audit configuration for a service. 1143 # The configuration determines which permission types are logged, and what 1144 # identities, if any, are exempted from logging. 1145 # An AuditConfig must have one or more AuditLogConfigs. 1146 # 1147 # If there are AuditConfigs for both `allServices` and a specific service, 1148 # the union of the two AuditConfigs is used for that service: the log_types 1149 # specified in each AuditConfig are enabled, and the exempted_members in each 1150 # AuditLogConfig are exempted. 1151 # 1152 # Example Policy with multiple AuditConfigs: 1153 # 1154 # { 1155 # "audit_configs": [ 1156 # { 1157 # "service": "allServices" 1158 # "audit_log_configs": [ 1159 # { 1160 # "log_type": "DATA_READ", 1161 # "exempted_members": [ 1162 # "user:foo@gmail.com" 1163 # ] 1164 # }, 1165 # { 1166 # "log_type": "DATA_WRITE", 1167 # }, 1168 # { 1169 # "log_type": "ADMIN_READ", 1170 # } 1171 # ] 1172 # }, 1173 # { 1174 # "service": "fooservice.googleapis.com" 1175 # "audit_log_configs": [ 1176 # { 1177 # "log_type": "DATA_READ", 1178 # }, 1179 # { 1180 # "log_type": "DATA_WRITE", 1181 # "exempted_members": [ 1182 # "user:bar@gmail.com" 1183 # ] 1184 # } 1185 # ] 1186 # } 1187 # ] 1188 # } 1189 # 1190 # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ 1191 # logging. It also exempts foo@gmail.com from DATA_READ logging, and 1192 # bar@gmail.com from DATA_WRITE logging. 1193 "auditLogConfigs": [ # The configuration for logging of each type of permission. 1194 { # Provides the configuration for logging a type of permissions. 1195 # Example: 1196 # 1197 # { 1198 # "audit_log_configs": [ 1199 # { 1200 # "log_type": "DATA_READ", 1201 # "exempted_members": [ 1202 # "user:foo@gmail.com" 1203 # ] 1204 # }, 1205 # { 1206 # "log_type": "DATA_WRITE", 1207 # } 1208 # ] 1209 # } 1210 # 1211 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting 1212 # foo@gmail.com from DATA_READ logging. 1213 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of 1214 # permission. 1215 # Follows the same format of Binding.members. 1216 "A String", 1217 ], 1218 "logType": "A String", # The log type that this config enables. 1219 }, 1220 ], 1221 "service": "A String", # Specifies a service that will be enabled for audit logging. 1222 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. 1223 # `allServices` is a special value that covers all services. 1224 }, 1225 ], 1226 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help 1227 # prevent simultaneous updates of a policy from overwriting each other. 1228 # It is strongly suggested that systems make use of the `etag` in the 1229 # read-modify-write cycle to perform policy updates in order to avoid race 1230 # conditions: An `etag` is returned in the response to `getIamPolicy`, and 1231 # systems are expected to put that etag in the request to `setIamPolicy` to 1232 # ensure that their change will be applied to the same version of the policy. 1233 # 1234 # If no `etag` is provided in the call to `setIamPolicy`, then the existing 1235 # policy is overwritten blindly. 1236 "bindings": [ # Associates a list of `members` to a `role`. 1237 # `bindings` with no members will result in an error. 1238 { # Associates `members` with a `role`. 1239 "role": "A String", # Role that is assigned to `members`. 1240 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 1241 "condition": { # Represents an expression text. Example: # The condition that is associated with this binding. 1242 # NOTE: An unsatisfied condition will not allow user access via current 1243 # binding. Different bindings, including their conditions, are examined 1244 # independently. 1245 # 1246 # title: "User account presence" 1247 # description: "Determines whether the request has a user account" 1248 # expression: "size(request.user) > 0" 1249 "description": "A String", # An optional description of the expression. This is a longer text which 1250 # describes the expression, e.g. when hovered over it in a UI. 1251 "expression": "A String", # Textual representation of an expression in 1252 # Common Expression Language syntax. 1253 # 1254 # The application context of the containing message determines which 1255 # well-known feature set of CEL is supported. 1256 "location": "A String", # An optional string indicating the location of the expression for error 1257 # reporting, e.g. a file name and a position in the file. 1258 "title": "A String", # An optional title for the expression, i.e. a short string describing 1259 # its purpose. This can be used e.g. in UIs which allow to enter the 1260 # expression. 1261 }, 1262 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. 1263 # `members` can have the following values: 1264 # 1265 # * `allUsers`: A special identifier that represents anyone who is 1266 # on the internet; with or without a Google account. 1267 # 1268 # * `allAuthenticatedUsers`: A special identifier that represents anyone 1269 # who is authenticated with a Google account or a service account. 1270 # 1271 # * `user:{emailid}`: An email address that represents a specific Google 1272 # account. For example, `alice@gmail.com` . 1273 # 1274 # 1275 # * `serviceAccount:{emailid}`: An email address that represents a service 1276 # account. For example, `my-other-app@appspot.gserviceaccount.com`. 1277 # 1278 # * `group:{emailid}`: An email address that represents a Google group. 1279 # For example, `admins@example.com`. 1280 # 1281 # 1282 # * `domain:{domain}`: The G Suite domain (primary) that represents all the 1283 # users of that domain. For example, `google.com` or `example.com`. 1284 # 1285 "A String", 1286 ], 1287 }, 1288 ], 1289 "version": 42, # Deprecated. 1290 }</pre> 1291</div> 1292 1293<div class="method"> 1294 <code class="details" id="testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</code> 1295 <pre>Returns permissions that a caller has on the specified resource. 1296If the resource does not exist, this will return an empty set of 1297permissions, not a NOT_FOUND error. 1298 1299Note: This operation is designed to be used for building permission-aware 1300UIs and command-line tools, not for authorization checking. This operation 1301may "fail open" without warning. 1302 1303Args: 1304 resource: string, REQUIRED: The resource for which the policy detail is being requested. 1305See the operation documentation for the appropriate value for this field. (required) 1306 body: object, The request body. (required) 1307 The object takes the form of: 1308 1309{ # Request message for `TestIamPermissions` method. 1310 "permissions": [ # The set of permissions to check for the `resource`. Permissions with 1311 # wildcards (such as '*' or 'storage.*') are not allowed. For more 1312 # information see 1313 # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). 1314 "A String", 1315 ], 1316 } 1317 1318 x__xgafv: string, V1 error format. 1319 Allowed values 1320 1 - v1 error format 1321 2 - v2 error format 1322 1323Returns: 1324 An object of the form: 1325 1326 { # Response message for `TestIamPermissions` method. 1327 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is 1328 # allowed. 1329 "A String", 1330 ], 1331 }</pre> 1332</div> 1333 1334</body></html>