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