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></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="healthcare_v1beta1.projects.locations.datasets.dicomStores.html">dicomStores()</a></code> 79</p> 80<p class="firstline">Returns the dicomStores Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="healthcare_v1beta1.projects.locations.datasets.fhirStores.html">fhirStores()</a></code> 84</p> 85<p class="firstline">Returns the fhirStores Resource.</p> 86 87<p class="toc_element"> 88 <code><a href="healthcare_v1beta1.projects.locations.datasets.hl7V2Stores.html">hl7V2Stores()</a></code> 89</p> 90<p class="firstline">Returns the hl7V2Stores Resource.</p> 91 92<p class="toc_element"> 93 <code><a href="healthcare_v1beta1.projects.locations.datasets.operations.html">operations()</a></code> 94</p> 95<p class="firstline">Returns the operations Resource.</p> 96 97<p class="toc_element"> 98 <code><a href="#create">create(parent, body, x__xgafv=None, datasetId=None)</a></code></p> 99<p class="firstline">Creates a new health dataset. Results are returned through the</p> 100<p class="toc_element"> 101 <code><a href="#deidentify">deidentify(sourceDataset, body, x__xgafv=None)</a></code></p> 102<p class="firstline">Creates a new dataset containing de-identified data from the source</p> 103<p class="toc_element"> 104 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 105<p class="firstline">Deletes the specified health dataset and all data contained in the dataset.</p> 106<p class="toc_element"> 107 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 108<p class="firstline">Gets any metadata associated with a dataset.</p> 109<p class="toc_element"> 110 <code><a href="#getIamPolicy">getIamPolicy(resource, x__xgafv=None)</a></code></p> 111<p class="firstline">Gets the access control policy for a resource.</p> 112<p class="toc_element"> 113 <code><a href="#list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p> 114<p class="firstline">Lists the health datasets in the current project.</p> 115<p class="toc_element"> 116 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 117<p class="firstline">Retrieves the next page of results.</p> 118<p class="toc_element"> 119 <code><a href="#patch">patch(name, body, updateMask=None, x__xgafv=None)</a></code></p> 120<p class="firstline">Updates dataset metadata.</p> 121<p class="toc_element"> 122 <code><a href="#setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</a></code></p> 123<p class="firstline">Sets the access control policy on the specified resource. Replaces any</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, x__xgafv=None, datasetId=None)</code> 130 <pre>Creates a new health dataset. Results are returned through the 131Operation interface which returns either an 132`Operation.response` which contains a Dataset or 133`Operation.error`. The metadata 134field type is OperationMetadata. 135A Google Cloud Platform project can contain up to 500 datasets across all 136regions. 137 138Args: 139 parent: string, The name of the project in which the dataset should be created (e.g., 140`projects/{project_id}/locations/{location_id}`). (required) 141 body: object, The request body. (required) 142 The object takes the form of: 143 144{ # A message representing a health dataset. 145 # 146 # A health dataset represents a collection of healthcare data pertaining to one 147 # or more patients. This may include multiple modalities of healthcare data, 148 # such as electronic medical records or medical imaging data. 149 "timeZone": "A String", # The default timezone used by this dataset. Must be a either a valid IANA 150 # time zone name such as "America/New_York" or empty, which defaults to UTC. 151 # This is used for parsing times in resources (e.g., HL7 messages) where no 152 # explicit timezone is specified. 153 "name": "A String", # Output only. Resource name of the dataset, of the form 154 # `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`. 155} 156 157 x__xgafv: string, V1 error format. 158 Allowed values 159 1 - v1 error format 160 2 - v2 error format 161 datasetId: string, The ID of the dataset that is being created. 162The string must match the following regex: `[\p{L}\p{N}_\-\.]{1,256}`. 163 164Returns: 165 An object of the form: 166 167 { # This resource represents a long-running operation that is the result of a 168 # network API call. 169 "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. 170 # different programming environments, including REST APIs and RPC APIs. It is 171 # used by [gRPC](https://github.com/grpc). Each `Status` message contains 172 # three pieces of data: error code, error message, and error details. 173 # 174 # You can find out more about this error model and how to work with it in the 175 # [API Design Guide](https://cloud.google.com/apis/design/errors). 176 "message": "A String", # A developer-facing error message, which should be in English. Any 177 # user-facing error message should be localized and sent in the 178 # google.rpc.Status.details field, or localized by the client. 179 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 180 "details": [ # A list of messages that carry the error details. There is a common set of 181 # message types for APIs to use. 182 { 183 "a_key": "", # Properties of the object. Contains field @type with type URL. 184 }, 185 ], 186 }, 187 "done": True or False, # If the value is `false`, it means the operation is still in progress. 188 # If `true`, the operation is completed, and either `error` or `response` is 189 # available. 190 "response": { # The normal response of the operation in case of success. If the original 191 # method returns no data on success, such as `Delete`, the response is 192 # `google.protobuf.Empty`. If the original method is standard 193 # `Get`/`Create`/`Update`, the response should be the resource. For other 194 # methods, the response should have the type `XxxResponse`, where `Xxx` 195 # is the original method name. For example, if the original method name 196 # is `TakeSnapshot()`, the inferred response type is 197 # `TakeSnapshotResponse`. 198 "a_key": "", # Properties of the object. Contains field @type with type URL. 199 }, 200 "name": "A String", # The server-assigned name, which is only unique within the same service that 201 # originally returns it. If you use the default HTTP mapping, the 202 # `name` should be a resource name ending with `operations/{unique_id}`. 203 "metadata": { # Service-specific metadata associated with the operation. It typically 204 # contains progress information and common metadata such as create time. 205 # Some services might not provide such metadata. Any method that returns a 206 # long-running operation should document the metadata type, if any. 207 "a_key": "", # Properties of the object. Contains field @type with type URL. 208 }, 209 }</pre> 210</div> 211 212<div class="method"> 213 <code class="details" id="deidentify">deidentify(sourceDataset, body, x__xgafv=None)</code> 214 <pre>Creates a new dataset containing de-identified data from the source 215dataset. The metadata field type 216is OperationMetadata. 217If the request is successful, the 218response field type is 219DeidentifySummary. 220If errors occur, 221details field type is 222DeidentifyErrorDetails. 223 224Args: 225 sourceDataset: string, Source dataset resource name. (e.g., 226`projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`). (required) 227 body: object, The request body. (required) 228 The object takes the form of: 229 230{ # Redacts identifying information from the specified dataset. 231 "destinationDataset": "A String", # The name of the dataset resource to create and write the redacted data to 232 # (e.g., 233 # 234 # * The destination dataset must not exist. 235 # * The destination dataset must be in the same project as the source 236 # dataset. De-identifying data across multiple projects is not supported. 237 "config": { # Configures de-id options specific to different types of content. # Deidentify configuration. 238 # Each submessage customizes the handling of an 239 # https://tools.ietf.org/html/rfc6838 media type or subtype. Configs are 240 # applied in a nested manner at runtime. 241 "text": { # Configures de-identification of text wherever it is found in the 242 # source_dataset. 243 "transformations": [ # The transformations to apply to the detected data. 244 { # A transformation to apply to text that is identified as a specific 245 # info_type. 246 "characterMaskConfig": { # Mask a string by replacing its characters with a fixed character. # Config for character mask. 247 "maskingCharacter": "A String", # Character to mask the sensitive values. If not supplied, defaults to "*". 248 }, 249 "redactConfig": { # Define how to redact sensitive values. Default behaviour is erase, # Config for text redaction. 250 # e.g. "My name is Jake." becomes "My name is ." 251 }, 252 "replaceWithInfoTypeConfig": { # When using the INSPECT_AND_TRANSFORM action, each match is replaced with # Config for replace with InfoType. 253 # the name of the info_type. For example, "My name is Jake" becomes "My name is 254 # [PERSON_NAME]." The TRANSFORM action is equivalent to redacting. 255 }, 256 "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. # Config for crypto hash. 257 # Uses SHA-256. 258 # Outputs a base64-encoded representation of the hashed output 259 # (for example, `L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=`). 260 "cryptoKey": "A String", # An AES 128/192/256 bit key. Causes the hash to be computed based on this 261 # key. A default key is generated for each DeidentifyDataset operation and is 262 # used wherever crypto_key is not specified. 263 }, 264 "infoTypes": [ # InfoTypes to apply this transformation to. If this is not specified, the 265 # transformation applies to any info_type. 266 "A String", 267 ], 268 "dateShiftConfig": { # Shift a date forward or backward in time by a random amount which is # Config for date shift. 269 # consistent for a given patient and crypto key combination. 270 "cryptoKey": "A String", # An AES 128/192/256 bit key. Causes the shift to be computed based on this 271 # key and the patient ID. A default key is generated for each 272 # DeidentifyDataset operation and is used wherever crypto_key is not 273 # specified. 274 }, 275 }, 276 ], 277 }, 278 "image": { # Specifies how de-identification of image pixel should be handled. # Configures de-identification of image pixels wherever they are found in the 279 # source_dataset. 280 "textRedactionMode": "A String", # Determines how to redact text from image. 281 }, 282 "fhir": { # Specifies how de-identification of a FHIR store should be handled. # Configures de-id of application/FHIR content. 283 "fieldMetadataList": [ # Specifies FHIR paths to match and how to transform them. Any field that 284 # is not matched by a FieldMetadata will be passed through to the output 285 # dataset unmodified. All extensions are removed in the output. 286 { # Specifies FHIR paths to match, and how to handle de-identification of 287 # matching fields. 288 "action": "A String", # Deidentify action for one field. 289 "paths": [ # List of paths to FHIR fields to be redacted. Each path is a 290 # period-separated list where each component is either a field name or 291 # FHIR type name, for example: Patient, HumanName. 292 # For "choice" types (those defined in the FHIR spec with the form: 293 # field[x]) we use two separate components. e.g. "deceasedAge.unit" is 294 # matched by "Deceased.Age.unit". 295 # Supported types are: AdministrativeGenderCode, Code, Date, DateTime, 296 # Decimal, HumanName, Id, LanguageCode, Markdown, MimeTypeCode, Oid, 297 # String, Uri, Uuid, Xhtml. 298 "A String", 299 ], 300 }, 301 ], 302 }, 303 "dicom": { # Specifies the parameters needed for de-identification of DICOM stores. # Configures de-id of application/DICOM content. 304 "filterProfile": "A String", # Tag filtering profile that determines which tags to keep/remove. 305 "removeList": { # List of tags to be filtered. # List of tags to remove. Keep all other tags. 306 "tags": [ # Tags to be filtered. Tags must be DICOM Data Elements, File Meta 307 # Elements, or Directory Structuring Elements, as defined at: 308 # http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. 309 # They may be provided by "Keyword" or "Tag". For example "PatientID", 310 # "00100010". 311 "A String", 312 ], 313 }, 314 "keepList": { # List of tags to be filtered. # List of tags to keep. Remove all other tags. 315 "tags": [ # Tags to be filtered. Tags must be DICOM Data Elements, File Meta 316 # Elements, or Directory Structuring Elements, as defined at: 317 # http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. 318 # They may be provided by "Keyword" or "Tag". For example "PatientID", 319 # "00100010". 320 "A String", 321 ], 322 }, 323 }, 324 }, 325 } 326 327 x__xgafv: string, V1 error format. 328 Allowed values 329 1 - v1 error format 330 2 - v2 error format 331 332Returns: 333 An object of the form: 334 335 { # This resource represents a long-running operation that is the result of a 336 # network API call. 337 "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. 338 # different programming environments, including REST APIs and RPC APIs. It is 339 # used by [gRPC](https://github.com/grpc). Each `Status` message contains 340 # three pieces of data: error code, error message, and error details. 341 # 342 # You can find out more about this error model and how to work with it in the 343 # [API Design Guide](https://cloud.google.com/apis/design/errors). 344 "message": "A String", # A developer-facing error message, which should be in English. Any 345 # user-facing error message should be localized and sent in the 346 # google.rpc.Status.details field, or localized by the client. 347 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 348 "details": [ # A list of messages that carry the error details. There is a common set of 349 # message types for APIs to use. 350 { 351 "a_key": "", # Properties of the object. Contains field @type with type URL. 352 }, 353 ], 354 }, 355 "done": True or False, # If the value is `false`, it means the operation is still in progress. 356 # If `true`, the operation is completed, and either `error` or `response` is 357 # available. 358 "response": { # The normal response of the operation in case of success. If the original 359 # method returns no data on success, such as `Delete`, the response is 360 # `google.protobuf.Empty`. If the original method is standard 361 # `Get`/`Create`/`Update`, the response should be the resource. For other 362 # methods, the response should have the type `XxxResponse`, where `Xxx` 363 # is the original method name. For example, if the original method name 364 # is `TakeSnapshot()`, the inferred response type is 365 # `TakeSnapshotResponse`. 366 "a_key": "", # Properties of the object. Contains field @type with type URL. 367 }, 368 "name": "A String", # The server-assigned name, which is only unique within the same service that 369 # originally returns it. If you use the default HTTP mapping, the 370 # `name` should be a resource name ending with `operations/{unique_id}`. 371 "metadata": { # Service-specific metadata associated with the operation. It typically 372 # contains progress information and common metadata such as create time. 373 # Some services might not provide such metadata. Any method that returns a 374 # long-running operation should document the metadata type, if any. 375 "a_key": "", # Properties of the object. Contains field @type with type URL. 376 }, 377 }</pre> 378</div> 379 380<div class="method"> 381 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 382 <pre>Deletes the specified health dataset and all data contained in the dataset. 383Deleting a dataset does not affect the sources from which the dataset was 384imported (if any). 385 386Args: 387 name: string, The name of the dataset to delete (e.g., 388`projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`). (required) 389 x__xgafv: string, V1 error format. 390 Allowed values 391 1 - v1 error format 392 2 - v2 error format 393 394Returns: 395 An object of the form: 396 397 { # A generic empty message that you can re-use to avoid defining duplicated 398 # empty messages in your APIs. A typical example is to use it as the request 399 # or the response type of an API method. For instance: 400 # 401 # service Foo { 402 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); 403 # } 404 # 405 # The JSON representation for `Empty` is empty JSON object `{}`. 406 }</pre> 407</div> 408 409<div class="method"> 410 <code class="details" id="get">get(name, x__xgafv=None)</code> 411 <pre>Gets any metadata associated with a dataset. 412 413Args: 414 name: string, The name of the dataset to read (e.g., 415`projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`). (required) 416 x__xgafv: string, V1 error format. 417 Allowed values 418 1 - v1 error format 419 2 - v2 error format 420 421Returns: 422 An object of the form: 423 424 { # A message representing a health dataset. 425 # 426 # A health dataset represents a collection of healthcare data pertaining to one 427 # or more patients. This may include multiple modalities of healthcare data, 428 # such as electronic medical records or medical imaging data. 429 "timeZone": "A String", # The default timezone used by this dataset. Must be a either a valid IANA 430 # time zone name such as "America/New_York" or empty, which defaults to UTC. 431 # This is used for parsing times in resources (e.g., HL7 messages) where no 432 # explicit timezone is specified. 433 "name": "A String", # Output only. Resource name of the dataset, of the form 434 # `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`. 435 }</pre> 436</div> 437 438<div class="method"> 439 <code class="details" id="getIamPolicy">getIamPolicy(resource, x__xgafv=None)</code> 440 <pre>Gets the access control policy for a resource. 441Returns an empty policy if the resource exists and does not have a policy 442set. 443 444Args: 445 resource: string, REQUIRED: The resource for which the policy is being requested. 446See the operation documentation for the appropriate value for this field. (required) 447 x__xgafv: string, V1 error format. 448 Allowed values 449 1 - v1 error format 450 2 - v2 error format 451 452Returns: 453 An object of the form: 454 455 { # Defines an Identity and Access Management (IAM) policy. It is used to 456 # specify access control policies for Cloud Platform resources. 457 # 458 # 459 # A `Policy` consists of a list of `bindings`. A `binding` binds a list of 460 # `members` to a `role`, where the members can be user accounts, Google groups, 461 # Google domains, and service accounts. A `role` is a named list of permissions 462 # defined by IAM. 463 # 464 # **JSON Example** 465 # 466 # { 467 # "bindings": [ 468 # { 469 # "role": "roles/owner", 470 # "members": [ 471 # "user:mike@example.com", 472 # "group:admins@example.com", 473 # "domain:google.com", 474 # "serviceAccount:my-other-app@appspot.gserviceaccount.com" 475 # ] 476 # }, 477 # { 478 # "role": "roles/viewer", 479 # "members": ["user:sean@example.com"] 480 # } 481 # ] 482 # } 483 # 484 # **YAML Example** 485 # 486 # bindings: 487 # - members: 488 # - user:mike@example.com 489 # - group:admins@example.com 490 # - domain:google.com 491 # - serviceAccount:my-other-app@appspot.gserviceaccount.com 492 # role: roles/owner 493 # - members: 494 # - user:sean@example.com 495 # role: roles/viewer 496 # 497 # 498 # For a description of IAM and its features, see the 499 # [IAM developer's guide](https://cloud.google.com/iam/docs). 500 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 501 { # Specifies the audit configuration for a service. 502 # The configuration determines which permission types are logged, and what 503 # identities, if any, are exempted from logging. 504 # An AuditConfig must have one or more AuditLogConfigs. 505 # 506 # If there are AuditConfigs for both `allServices` and a specific service, 507 # the union of the two AuditConfigs is used for that service: the log_types 508 # specified in each AuditConfig are enabled, and the exempted_members in each 509 # AuditLogConfig are exempted. 510 # 511 # Example Policy with multiple AuditConfigs: 512 # 513 # { 514 # "audit_configs": [ 515 # { 516 # "service": "allServices" 517 # "audit_log_configs": [ 518 # { 519 # "log_type": "DATA_READ", 520 # "exempted_members": [ 521 # "user:foo@gmail.com" 522 # ] 523 # }, 524 # { 525 # "log_type": "DATA_WRITE", 526 # }, 527 # { 528 # "log_type": "ADMIN_READ", 529 # } 530 # ] 531 # }, 532 # { 533 # "service": "fooservice.googleapis.com" 534 # "audit_log_configs": [ 535 # { 536 # "log_type": "DATA_READ", 537 # }, 538 # { 539 # "log_type": "DATA_WRITE", 540 # "exempted_members": [ 541 # "user:bar@gmail.com" 542 # ] 543 # } 544 # ] 545 # } 546 # ] 547 # } 548 # 549 # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ 550 # logging. It also exempts foo@gmail.com from DATA_READ logging, and 551 # bar@gmail.com from DATA_WRITE logging. 552 "auditLogConfigs": [ # The configuration for logging of each type of permission. 553 { # Provides the configuration for logging a type of permissions. 554 # Example: 555 # 556 # { 557 # "audit_log_configs": [ 558 # { 559 # "log_type": "DATA_READ", 560 # "exempted_members": [ 561 # "user:foo@gmail.com" 562 # ] 563 # }, 564 # { 565 # "log_type": "DATA_WRITE", 566 # } 567 # ] 568 # } 569 # 570 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting 571 # foo@gmail.com from DATA_READ logging. 572 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of 573 # permission. 574 # Follows the same format of Binding.members. 575 "A String", 576 ], 577 "logType": "A String", # The log type that this config enables. 578 }, 579 ], 580 "service": "A String", # Specifies a service that will be enabled for audit logging. 581 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. 582 # `allServices` is a special value that covers all services. 583 }, 584 ], 585 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help 586 # prevent simultaneous updates of a policy from overwriting each other. 587 # It is strongly suggested that systems make use of the `etag` in the 588 # read-modify-write cycle to perform policy updates in order to avoid race 589 # conditions: An `etag` is returned in the response to `getIamPolicy`, and 590 # systems are expected to put that etag in the request to `setIamPolicy` to 591 # ensure that their change will be applied to the same version of the policy. 592 # 593 # If no `etag` is provided in the call to `setIamPolicy`, then the existing 594 # policy is overwritten blindly. 595 "bindings": [ # Associates a list of `members` to a `role`. 596 # `bindings` with no members will result in an error. 597 { # Associates `members` with a `role`. 598 "role": "A String", # Role that is assigned to `members`. 599 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 600 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. 601 # `members` can have the following values: 602 # 603 # * `allUsers`: A special identifier that represents anyone who is 604 # on the internet; with or without a Google account. 605 # 606 # * `allAuthenticatedUsers`: A special identifier that represents anyone 607 # who is authenticated with a Google account or a service account. 608 # 609 # * `user:{emailid}`: An email address that represents a specific Google 610 # account. For example, `alice@gmail.com` . 611 # 612 # 613 # * `serviceAccount:{emailid}`: An email address that represents a service 614 # account. For example, `my-other-app@appspot.gserviceaccount.com`. 615 # 616 # * `group:{emailid}`: An email address that represents a Google group. 617 # For example, `admins@example.com`. 618 # 619 # 620 # * `domain:{domain}`: The G Suite domain (primary) that represents all the 621 # users of that domain. For example, `google.com` or `example.com`. 622 # 623 "A String", 624 ], 625 "condition": { # Represents an expression text. Example: # The condition that is associated with this binding. 626 # NOTE: An unsatisfied condition will not allow user access via current 627 # binding. Different bindings, including their conditions, are examined 628 # independently. 629 # 630 # title: "User account presence" 631 # description: "Determines whether the request has a user account" 632 # expression: "size(request.user) > 0" 633 "location": "A String", # An optional string indicating the location of the expression for error 634 # reporting, e.g. a file name and a position in the file. 635 "expression": "A String", # Textual representation of an expression in 636 # Common Expression Language syntax. 637 # 638 # The application context of the containing message determines which 639 # well-known feature set of CEL is supported. 640 "description": "A String", # An optional description of the expression. This is a longer text which 641 # describes the expression, e.g. when hovered over it in a UI. 642 "title": "A String", # An optional title for the expression, i.e. a short string describing 643 # its purpose. This can be used e.g. in UIs which allow to enter the 644 # expression. 645 }, 646 }, 647 ], 648 "version": 42, # Deprecated. 649 }</pre> 650</div> 651 652<div class="method"> 653 <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</code> 654 <pre>Lists the health datasets in the current project. 655 656Args: 657 parent: string, The name of the project whose datasets should be listed (e.g., 658`projects/{project_id}/locations/{location_id}`). (required) 659 pageToken: string, The next_page_token value returned from a previous List request, if any. 660 x__xgafv: string, V1 error format. 661 Allowed values 662 1 - v1 error format 663 2 - v2 error format 664 pageSize: integer, The maximum number of items to return. Capped to 100 if not specified. 665May not be larger than 1000. 666 667Returns: 668 An object of the form: 669 670 { # Lists the available datasets. 671 "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no 672 # more results in the list. 673 "datasets": [ # The first page of datasets. 674 { # A message representing a health dataset. 675 # 676 # A health dataset represents a collection of healthcare data pertaining to one 677 # or more patients. This may include multiple modalities of healthcare data, 678 # such as electronic medical records or medical imaging data. 679 "timeZone": "A String", # The default timezone used by this dataset. Must be a either a valid IANA 680 # time zone name such as "America/New_York" or empty, which defaults to UTC. 681 # This is used for parsing times in resources (e.g., HL7 messages) where no 682 # explicit timezone is specified. 683 "name": "A String", # Output only. Resource name of the dataset, of the form 684 # `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`. 685 }, 686 ], 687 }</pre> 688</div> 689 690<div class="method"> 691 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 692 <pre>Retrieves the next page of results. 693 694Args: 695 previous_request: The request for the previous page. (required) 696 previous_response: The response from the request for the previous page. (required) 697 698Returns: 699 A request object that you can call 'execute()' on to request the next 700 page. Returns None if there are no more items in the collection. 701 </pre> 702</div> 703 704<div class="method"> 705 <code class="details" id="patch">patch(name, body, updateMask=None, x__xgafv=None)</code> 706 <pre>Updates dataset metadata. 707 708Args: 709 name: string, Output only. Resource name of the dataset, of the form 710`projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`. (required) 711 body: object, The request body. (required) 712 The object takes the form of: 713 714{ # A message representing a health dataset. 715 # 716 # A health dataset represents a collection of healthcare data pertaining to one 717 # or more patients. This may include multiple modalities of healthcare data, 718 # such as electronic medical records or medical imaging data. 719 "timeZone": "A String", # The default timezone used by this dataset. Must be a either a valid IANA 720 # time zone name such as "America/New_York" or empty, which defaults to UTC. 721 # This is used for parsing times in resources (e.g., HL7 messages) where no 722 # explicit timezone is specified. 723 "name": "A String", # Output only. Resource name of the dataset, of the form 724 # `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`. 725} 726 727 updateMask: string, The update mask applies to the resource. For the `FieldMask` definition, 728see 729https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask 730 x__xgafv: string, V1 error format. 731 Allowed values 732 1 - v1 error format 733 2 - v2 error format 734 735Returns: 736 An object of the form: 737 738 { # A message representing a health dataset. 739 # 740 # A health dataset represents a collection of healthcare data pertaining to one 741 # or more patients. This may include multiple modalities of healthcare data, 742 # such as electronic medical records or medical imaging data. 743 "timeZone": "A String", # The default timezone used by this dataset. Must be a either a valid IANA 744 # time zone name such as "America/New_York" or empty, which defaults to UTC. 745 # This is used for parsing times in resources (e.g., HL7 messages) where no 746 # explicit timezone is specified. 747 "name": "A String", # Output only. Resource name of the dataset, of the form 748 # `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`. 749 }</pre> 750</div> 751 752<div class="method"> 753 <code class="details" id="setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</code> 754 <pre>Sets the access control policy on the specified resource. Replaces any 755existing policy. 756 757Args: 758 resource: string, REQUIRED: The resource for which the policy is being specified. 759See the operation documentation for the appropriate value for this field. (required) 760 body: object, The request body. (required) 761 The object takes the form of: 762 763{ # Request message for `SetIamPolicy` method. 764 "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 765 # the policy is limited to a few 10s of KB. An empty policy is a 766 # valid policy but certain Cloud Platform services (such as Projects) 767 # might reject them. 768 # specify access control policies for Cloud Platform resources. 769 # 770 # 771 # A `Policy` consists of a list of `bindings`. A `binding` binds a list of 772 # `members` to a `role`, where the members can be user accounts, Google groups, 773 # Google domains, and service accounts. A `role` is a named list of permissions 774 # defined by IAM. 775 # 776 # **JSON Example** 777 # 778 # { 779 # "bindings": [ 780 # { 781 # "role": "roles/owner", 782 # "members": [ 783 # "user:mike@example.com", 784 # "group:admins@example.com", 785 # "domain:google.com", 786 # "serviceAccount:my-other-app@appspot.gserviceaccount.com" 787 # ] 788 # }, 789 # { 790 # "role": "roles/viewer", 791 # "members": ["user:sean@example.com"] 792 # } 793 # ] 794 # } 795 # 796 # **YAML Example** 797 # 798 # bindings: 799 # - members: 800 # - user:mike@example.com 801 # - group:admins@example.com 802 # - domain:google.com 803 # - serviceAccount:my-other-app@appspot.gserviceaccount.com 804 # role: roles/owner 805 # - members: 806 # - user:sean@example.com 807 # role: roles/viewer 808 # 809 # 810 # For a description of IAM and its features, see the 811 # [IAM developer's guide](https://cloud.google.com/iam/docs). 812 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 813 { # Specifies the audit configuration for a service. 814 # The configuration determines which permission types are logged, and what 815 # identities, if any, are exempted from logging. 816 # An AuditConfig must have one or more AuditLogConfigs. 817 # 818 # If there are AuditConfigs for both `allServices` and a specific service, 819 # the union of the two AuditConfigs is used for that service: the log_types 820 # specified in each AuditConfig are enabled, and the exempted_members in each 821 # AuditLogConfig are exempted. 822 # 823 # Example Policy with multiple AuditConfigs: 824 # 825 # { 826 # "audit_configs": [ 827 # { 828 # "service": "allServices" 829 # "audit_log_configs": [ 830 # { 831 # "log_type": "DATA_READ", 832 # "exempted_members": [ 833 # "user:foo@gmail.com" 834 # ] 835 # }, 836 # { 837 # "log_type": "DATA_WRITE", 838 # }, 839 # { 840 # "log_type": "ADMIN_READ", 841 # } 842 # ] 843 # }, 844 # { 845 # "service": "fooservice.googleapis.com" 846 # "audit_log_configs": [ 847 # { 848 # "log_type": "DATA_READ", 849 # }, 850 # { 851 # "log_type": "DATA_WRITE", 852 # "exempted_members": [ 853 # "user:bar@gmail.com" 854 # ] 855 # } 856 # ] 857 # } 858 # ] 859 # } 860 # 861 # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ 862 # logging. It also exempts foo@gmail.com from DATA_READ logging, and 863 # bar@gmail.com from DATA_WRITE logging. 864 "auditLogConfigs": [ # The configuration for logging of each type of permission. 865 { # Provides the configuration for logging a type of permissions. 866 # Example: 867 # 868 # { 869 # "audit_log_configs": [ 870 # { 871 # "log_type": "DATA_READ", 872 # "exempted_members": [ 873 # "user:foo@gmail.com" 874 # ] 875 # }, 876 # { 877 # "log_type": "DATA_WRITE", 878 # } 879 # ] 880 # } 881 # 882 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting 883 # foo@gmail.com from DATA_READ logging. 884 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of 885 # permission. 886 # Follows the same format of Binding.members. 887 "A String", 888 ], 889 "logType": "A String", # The log type that this config enables. 890 }, 891 ], 892 "service": "A String", # Specifies a service that will be enabled for audit logging. 893 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. 894 # `allServices` is a special value that covers all services. 895 }, 896 ], 897 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help 898 # prevent simultaneous updates of a policy from overwriting each other. 899 # It is strongly suggested that systems make use of the `etag` in the 900 # read-modify-write cycle to perform policy updates in order to avoid race 901 # conditions: An `etag` is returned in the response to `getIamPolicy`, and 902 # systems are expected to put that etag in the request to `setIamPolicy` to 903 # ensure that their change will be applied to the same version of the policy. 904 # 905 # If no `etag` is provided in the call to `setIamPolicy`, then the existing 906 # policy is overwritten blindly. 907 "bindings": [ # Associates a list of `members` to a `role`. 908 # `bindings` with no members will result in an error. 909 { # Associates `members` with a `role`. 910 "role": "A String", # Role that is assigned to `members`. 911 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 912 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. 913 # `members` can have the following values: 914 # 915 # * `allUsers`: A special identifier that represents anyone who is 916 # on the internet; with or without a Google account. 917 # 918 # * `allAuthenticatedUsers`: A special identifier that represents anyone 919 # who is authenticated with a Google account or a service account. 920 # 921 # * `user:{emailid}`: An email address that represents a specific Google 922 # account. For example, `alice@gmail.com` . 923 # 924 # 925 # * `serviceAccount:{emailid}`: An email address that represents a service 926 # account. For example, `my-other-app@appspot.gserviceaccount.com`. 927 # 928 # * `group:{emailid}`: An email address that represents a Google group. 929 # For example, `admins@example.com`. 930 # 931 # 932 # * `domain:{domain}`: The G Suite domain (primary) that represents all the 933 # users of that domain. For example, `google.com` or `example.com`. 934 # 935 "A String", 936 ], 937 "condition": { # Represents an expression text. Example: # The condition that is associated with this binding. 938 # NOTE: An unsatisfied condition will not allow user access via current 939 # binding. Different bindings, including their conditions, are examined 940 # independently. 941 # 942 # title: "User account presence" 943 # description: "Determines whether the request has a user account" 944 # expression: "size(request.user) > 0" 945 "location": "A String", # An optional string indicating the location of the expression for error 946 # reporting, e.g. a file name and a position in the file. 947 "expression": "A String", # Textual representation of an expression in 948 # Common Expression Language syntax. 949 # 950 # The application context of the containing message determines which 951 # well-known feature set of CEL is supported. 952 "description": "A String", # An optional description of the expression. This is a longer text which 953 # describes the expression, e.g. when hovered over it in a UI. 954 "title": "A String", # An optional title for the expression, i.e. a short string describing 955 # its purpose. This can be used e.g. in UIs which allow to enter the 956 # expression. 957 }, 958 }, 959 ], 960 "version": 42, # Deprecated. 961 }, 962 "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only 963 # the fields in the mask will be modified. If no mask is provided, the 964 # following default mask is used: 965 # paths: "bindings, etag" 966 # This field is only used by Cloud IAM. 967 } 968 969 x__xgafv: string, V1 error format. 970 Allowed values 971 1 - v1 error format 972 2 - v2 error format 973 974Returns: 975 An object of the form: 976 977 { # Defines an Identity and Access Management (IAM) policy. It is used to 978 # specify access control policies for Cloud Platform resources. 979 # 980 # 981 # A `Policy` consists of a list of `bindings`. A `binding` binds a list of 982 # `members` to a `role`, where the members can be user accounts, Google groups, 983 # Google domains, and service accounts. A `role` is a named list of permissions 984 # defined by IAM. 985 # 986 # **JSON Example** 987 # 988 # { 989 # "bindings": [ 990 # { 991 # "role": "roles/owner", 992 # "members": [ 993 # "user:mike@example.com", 994 # "group:admins@example.com", 995 # "domain:google.com", 996 # "serviceAccount:my-other-app@appspot.gserviceaccount.com" 997 # ] 998 # }, 999 # { 1000 # "role": "roles/viewer", 1001 # "members": ["user:sean@example.com"] 1002 # } 1003 # ] 1004 # } 1005 # 1006 # **YAML Example** 1007 # 1008 # bindings: 1009 # - members: 1010 # - user:mike@example.com 1011 # - group:admins@example.com 1012 # - domain:google.com 1013 # - serviceAccount:my-other-app@appspot.gserviceaccount.com 1014 # role: roles/owner 1015 # - members: 1016 # - user:sean@example.com 1017 # role: roles/viewer 1018 # 1019 # 1020 # For a description of IAM and its features, see the 1021 # [IAM developer's guide](https://cloud.google.com/iam/docs). 1022 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 1023 { # Specifies the audit configuration for a service. 1024 # The configuration determines which permission types are logged, and what 1025 # identities, if any, are exempted from logging. 1026 # An AuditConfig must have one or more AuditLogConfigs. 1027 # 1028 # If there are AuditConfigs for both `allServices` and a specific service, 1029 # the union of the two AuditConfigs is used for that service: the log_types 1030 # specified in each AuditConfig are enabled, and the exempted_members in each 1031 # AuditLogConfig are exempted. 1032 # 1033 # Example Policy with multiple AuditConfigs: 1034 # 1035 # { 1036 # "audit_configs": [ 1037 # { 1038 # "service": "allServices" 1039 # "audit_log_configs": [ 1040 # { 1041 # "log_type": "DATA_READ", 1042 # "exempted_members": [ 1043 # "user:foo@gmail.com" 1044 # ] 1045 # }, 1046 # { 1047 # "log_type": "DATA_WRITE", 1048 # }, 1049 # { 1050 # "log_type": "ADMIN_READ", 1051 # } 1052 # ] 1053 # }, 1054 # { 1055 # "service": "fooservice.googleapis.com" 1056 # "audit_log_configs": [ 1057 # { 1058 # "log_type": "DATA_READ", 1059 # }, 1060 # { 1061 # "log_type": "DATA_WRITE", 1062 # "exempted_members": [ 1063 # "user:bar@gmail.com" 1064 # ] 1065 # } 1066 # ] 1067 # } 1068 # ] 1069 # } 1070 # 1071 # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ 1072 # logging. It also exempts foo@gmail.com from DATA_READ logging, and 1073 # bar@gmail.com from DATA_WRITE logging. 1074 "auditLogConfigs": [ # The configuration for logging of each type of permission. 1075 { # Provides the configuration for logging a type of permissions. 1076 # Example: 1077 # 1078 # { 1079 # "audit_log_configs": [ 1080 # { 1081 # "log_type": "DATA_READ", 1082 # "exempted_members": [ 1083 # "user:foo@gmail.com" 1084 # ] 1085 # }, 1086 # { 1087 # "log_type": "DATA_WRITE", 1088 # } 1089 # ] 1090 # } 1091 # 1092 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting 1093 # foo@gmail.com from DATA_READ logging. 1094 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of 1095 # permission. 1096 # Follows the same format of Binding.members. 1097 "A String", 1098 ], 1099 "logType": "A String", # The log type that this config enables. 1100 }, 1101 ], 1102 "service": "A String", # Specifies a service that will be enabled for audit logging. 1103 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. 1104 # `allServices` is a special value that covers all services. 1105 }, 1106 ], 1107 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help 1108 # prevent simultaneous updates of a policy from overwriting each other. 1109 # It is strongly suggested that systems make use of the `etag` in the 1110 # read-modify-write cycle to perform policy updates in order to avoid race 1111 # conditions: An `etag` is returned in the response to `getIamPolicy`, and 1112 # systems are expected to put that etag in the request to `setIamPolicy` to 1113 # ensure that their change will be applied to the same version of the policy. 1114 # 1115 # If no `etag` is provided in the call to `setIamPolicy`, then the existing 1116 # policy is overwritten blindly. 1117 "bindings": [ # Associates a list of `members` to a `role`. 1118 # `bindings` with no members will result in an error. 1119 { # Associates `members` with a `role`. 1120 "role": "A String", # Role that is assigned to `members`. 1121 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 1122 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. 1123 # `members` can have the following values: 1124 # 1125 # * `allUsers`: A special identifier that represents anyone who is 1126 # on the internet; with or without a Google account. 1127 # 1128 # * `allAuthenticatedUsers`: A special identifier that represents anyone 1129 # who is authenticated with a Google account or a service account. 1130 # 1131 # * `user:{emailid}`: An email address that represents a specific Google 1132 # account. For example, `alice@gmail.com` . 1133 # 1134 # 1135 # * `serviceAccount:{emailid}`: An email address that represents a service 1136 # account. For example, `my-other-app@appspot.gserviceaccount.com`. 1137 # 1138 # * `group:{emailid}`: An email address that represents a Google group. 1139 # For example, `admins@example.com`. 1140 # 1141 # 1142 # * `domain:{domain}`: The G Suite domain (primary) that represents all the 1143 # users of that domain. For example, `google.com` or `example.com`. 1144 # 1145 "A String", 1146 ], 1147 "condition": { # Represents an expression text. Example: # The condition that is associated with this binding. 1148 # NOTE: An unsatisfied condition will not allow user access via current 1149 # binding. Different bindings, including their conditions, are examined 1150 # independently. 1151 # 1152 # title: "User account presence" 1153 # description: "Determines whether the request has a user account" 1154 # expression: "size(request.user) > 0" 1155 "location": "A String", # An optional string indicating the location of the expression for error 1156 # reporting, e.g. a file name and a position in the file. 1157 "expression": "A String", # Textual representation of an expression in 1158 # Common Expression Language syntax. 1159 # 1160 # The application context of the containing message determines which 1161 # well-known feature set of CEL is supported. 1162 "description": "A String", # An optional description of the expression. This is a longer text which 1163 # describes the expression, e.g. when hovered over it in a UI. 1164 "title": "A String", # An optional title for the expression, i.e. a short string describing 1165 # its purpose. This can be used e.g. in UIs which allow to enter the 1166 # expression. 1167 }, 1168 }, 1169 ], 1170 "version": 42, # Deprecated. 1171 }</pre> 1172</div> 1173 1174<div class="method"> 1175 <code class="details" id="testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</code> 1176 <pre>Returns permissions that a caller has on the specified resource. 1177If the resource does not exist, this will return an empty set of 1178permissions, not a NOT_FOUND error. 1179 1180Note: This operation is designed to be used for building permission-aware 1181UIs and command-line tools, not for authorization checking. This operation 1182may "fail open" without warning. 1183 1184Args: 1185 resource: string, REQUIRED: The resource for which the policy detail is being requested. 1186See the operation documentation for the appropriate value for this field. (required) 1187 body: object, The request body. (required) 1188 The object takes the form of: 1189 1190{ # Request message for `TestIamPermissions` method. 1191 "permissions": [ # The set of permissions to check for the `resource`. Permissions with 1192 # wildcards (such as '*' or 'storage.*') are not allowed. For more 1193 # information see 1194 # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). 1195 "A String", 1196 ], 1197 } 1198 1199 x__xgafv: string, V1 error format. 1200 Allowed values 1201 1 - v1 error format 1202 2 - v2 error format 1203 1204Returns: 1205 An object of the form: 1206 1207 { # Response message for `TestIamPermissions` method. 1208 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is 1209 # allowed. 1210 "A String", 1211 ], 1212 }</pre> 1213</div> 1214 1215</body></html>