1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="healthcare_v1beta1.html">Cloud Healthcare API</a> . <a href="healthcare_v1beta1.projects.html">projects</a> . <a href="healthcare_v1beta1.projects.locations.html">locations</a> . <a href="healthcare_v1beta1.projects.locations.datasets.html">datasets</a> . <a href="healthcare_v1beta1.projects.locations.datasets.hl7V2Stores.html">hl7V2Stores</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="healthcare_v1beta1.projects.locations.datasets.hl7V2Stores.messages.html">messages()</a></code> 79</p> 80<p class="firstline">Returns the messages Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="#create">create(parent, body, hl7V2StoreId=None, x__xgafv=None)</a></code></p> 84<p class="firstline">Creates a new HL7v2 store within the parent dataset.</p> 85<p class="toc_element"> 86 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 87<p class="firstline">Deletes the specified HL7v2 store and removes all messages that are</p> 88<p class="toc_element"> 89 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 90<p class="firstline">Gets the specified HL7v2 store.</p> 91<p class="toc_element"> 92 <code><a href="#getIamPolicy">getIamPolicy(resource, x__xgafv=None)</a></code></p> 93<p class="firstline">Gets the access control policy for a resource.</p> 94<p class="toc_element"> 95 <code><a href="#list">list(parent, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</a></code></p> 96<p class="firstline">Lists the HL7v2 stores in the given dataset.</p> 97<p class="toc_element"> 98 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 99<p class="firstline">Retrieves the next page of results.</p> 100<p class="toc_element"> 101 <code><a href="#patch">patch(name, body, updateMask=None, x__xgafv=None)</a></code></p> 102<p class="firstline">Updates the HL7v2 store.</p> 103<p class="toc_element"> 104 <code><a href="#setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</a></code></p> 105<p class="firstline">Sets the access control policy on the specified resource. Replaces any</p> 106<p class="toc_element"> 107 <code><a href="#testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</a></code></p> 108<p class="firstline">Returns permissions that a caller has on the specified resource.</p> 109<h3>Method Details</h3> 110<div class="method"> 111 <code class="details" id="create">create(parent, body, hl7V2StoreId=None, x__xgafv=None)</code> 112 <pre>Creates a new HL7v2 store within the parent dataset. 113 114Args: 115 parent: string, The name of the dataset this HL7v2 store belongs to. (required) 116 body: object, The request body. (required) 117 The object takes the form of: 118 119{ # Represents an HL7v2 store. 120 "parserConfig": { # The configuration for the parser. It determines how the server parses the # The configuration for the parser. It determines how the server parses the 121 # messages. 122 # messages. 123 "allowNullHeader": True or False, # Determines whether messages with no header are allowed. 124 "segmentTerminator": "A String", # Byte(s) to be used as the segment terminator. If this is unset, '\r' will 125 # be used as segment terminator. 126 }, 127 "labels": { # User-supplied key-value pairs used to organize HL7v2 stores. 128 # 129 # Label keys must be between 1 and 63 characters long, have a UTF-8 encoding 130 # of maximum 128 bytes, and must conform to the 131 # following PCRE regular expression: 132 # \p{Ll}\p{Lo}{0,62} 133 # 134 # Label values are optional, must be between 1 and 63 characters long, have 135 # a UTF-8 encoding of maximum 128 bytes, and must conform to the 136 # following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} 137 # 138 # No more than 64 labels can be associated with a given store. 139 "a_key": "A String", 140 }, 141 "name": "A String", # Output only. Resource name of the HL7v2 store, of the form 142 # `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`. 143 "notificationConfig": { # Specifies where notifications should be sent upon changes to a data store. # The notification destination all messages (both Ingest & Create) are 144 # published on. Only the message name is sent as part of the notification. If 145 # this is unset, no notifications will be sent. Supplied by the client. 146 "pubsubTopic": "A String", # The [Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that 147 # notifications of changes are published on. Supplied by the client. 148 # PubsubMessage.Data will contain the resource name. 149 # PubsubMessage.MessageId is the ID of this message. It is guaranteed to be 150 # unique within the topic. 151 # PubsubMessage.PublishTime is the time at which the message was published. 152 # Notifications are only sent if the topic is 153 # non-empty. [Topic 154 # names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped 155 # to a project. cloud-healthcare@system.gserviceaccount.com must have 156 # publisher permissions on the given Cloud Pub/Sub topic. Not having adequate 157 # permissions will cause the calls that send notifications to fail. 158 }, 159} 160 161 hl7V2StoreId: string, The ID of the HL7v2 store that is being created. 162The string must match the following regex: `[\p{L}\p{N}_\-\.]{1,256}`. 163 x__xgafv: string, V1 error format. 164 Allowed values 165 1 - v1 error format 166 2 - v2 error format 167 168Returns: 169 An object of the form: 170 171 { # Represents an HL7v2 store. 172 "parserConfig": { # The configuration for the parser. It determines how the server parses the # The configuration for the parser. It determines how the server parses the 173 # messages. 174 # messages. 175 "allowNullHeader": True or False, # Determines whether messages with no header are allowed. 176 "segmentTerminator": "A String", # Byte(s) to be used as the segment terminator. If this is unset, '\r' will 177 # be used as segment terminator. 178 }, 179 "labels": { # User-supplied key-value pairs used to organize HL7v2 stores. 180 # 181 # Label keys must be between 1 and 63 characters long, have a UTF-8 encoding 182 # of maximum 128 bytes, and must conform to the 183 # following PCRE regular expression: 184 # \p{Ll}\p{Lo}{0,62} 185 # 186 # Label values are optional, must be between 1 and 63 characters long, have 187 # a UTF-8 encoding of maximum 128 bytes, and must conform to the 188 # following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} 189 # 190 # No more than 64 labels can be associated with a given store. 191 "a_key": "A String", 192 }, 193 "name": "A String", # Output only. Resource name of the HL7v2 store, of the form 194 # `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`. 195 "notificationConfig": { # Specifies where notifications should be sent upon changes to a data store. # The notification destination all messages (both Ingest & Create) are 196 # published on. Only the message name is sent as part of the notification. If 197 # this is unset, no notifications will be sent. Supplied by the client. 198 "pubsubTopic": "A String", # The [Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that 199 # notifications of changes are published on. Supplied by the client. 200 # PubsubMessage.Data will contain the resource name. 201 # PubsubMessage.MessageId is the ID of this message. It is guaranteed to be 202 # unique within the topic. 203 # PubsubMessage.PublishTime is the time at which the message was published. 204 # Notifications are only sent if the topic is 205 # non-empty. [Topic 206 # names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped 207 # to a project. cloud-healthcare@system.gserviceaccount.com must have 208 # publisher permissions on the given Cloud Pub/Sub topic. Not having adequate 209 # permissions will cause the calls that send notifications to fail. 210 }, 211 }</pre> 212</div> 213 214<div class="method"> 215 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 216 <pre>Deletes the specified HL7v2 store and removes all messages that are 217contained within it. 218 219Args: 220 name: string, The resource name of the HL7v2 store to delete. (required) 221 x__xgafv: string, V1 error format. 222 Allowed values 223 1 - v1 error format 224 2 - v2 error format 225 226Returns: 227 An object of the form: 228 229 { # A generic empty message that you can re-use to avoid defining duplicated 230 # empty messages in your APIs. A typical example is to use it as the request 231 # or the response type of an API method. For instance: 232 # 233 # service Foo { 234 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); 235 # } 236 # 237 # The JSON representation for `Empty` is empty JSON object `{}`. 238 }</pre> 239</div> 240 241<div class="method"> 242 <code class="details" id="get">get(name, x__xgafv=None)</code> 243 <pre>Gets the specified HL7v2 store. 244 245Args: 246 name: string, The resource name of the HL7v2 store to get. (required) 247 x__xgafv: string, V1 error format. 248 Allowed values 249 1 - v1 error format 250 2 - v2 error format 251 252Returns: 253 An object of the form: 254 255 { # Represents an HL7v2 store. 256 "parserConfig": { # The configuration for the parser. It determines how the server parses the # The configuration for the parser. It determines how the server parses the 257 # messages. 258 # messages. 259 "allowNullHeader": True or False, # Determines whether messages with no header are allowed. 260 "segmentTerminator": "A String", # Byte(s) to be used as the segment terminator. If this is unset, '\r' will 261 # be used as segment terminator. 262 }, 263 "labels": { # User-supplied key-value pairs used to organize HL7v2 stores. 264 # 265 # Label keys must be between 1 and 63 characters long, have a UTF-8 encoding 266 # of maximum 128 bytes, and must conform to the 267 # following PCRE regular expression: 268 # \p{Ll}\p{Lo}{0,62} 269 # 270 # Label values are optional, must be between 1 and 63 characters long, have 271 # a UTF-8 encoding of maximum 128 bytes, and must conform to the 272 # following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} 273 # 274 # No more than 64 labels can be associated with a given store. 275 "a_key": "A String", 276 }, 277 "name": "A String", # Output only. Resource name of the HL7v2 store, of the form 278 # `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`. 279 "notificationConfig": { # Specifies where notifications should be sent upon changes to a data store. # The notification destination all messages (both Ingest & Create) are 280 # published on. Only the message name is sent as part of the notification. If 281 # this is unset, no notifications will be sent. Supplied by the client. 282 "pubsubTopic": "A String", # The [Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that 283 # notifications of changes are published on. Supplied by the client. 284 # PubsubMessage.Data will contain the resource name. 285 # PubsubMessage.MessageId is the ID of this message. It is guaranteed to be 286 # unique within the topic. 287 # PubsubMessage.PublishTime is the time at which the message was published. 288 # Notifications are only sent if the topic is 289 # non-empty. [Topic 290 # names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped 291 # to a project. cloud-healthcare@system.gserviceaccount.com must have 292 # publisher permissions on the given Cloud Pub/Sub topic. Not having adequate 293 # permissions will cause the calls that send notifications to fail. 294 }, 295 }</pre> 296</div> 297 298<div class="method"> 299 <code class="details" id="getIamPolicy">getIamPolicy(resource, x__xgafv=None)</code> 300 <pre>Gets the access control policy for a resource. 301Returns an empty policy if the resource exists and does not have a policy 302set. 303 304Args: 305 resource: string, REQUIRED: The resource for which the policy is being requested. 306See the operation documentation for the appropriate value for this field. (required) 307 x__xgafv: string, V1 error format. 308 Allowed values 309 1 - v1 error format 310 2 - v2 error format 311 312Returns: 313 An object of the form: 314 315 { # Defines an Identity and Access Management (IAM) policy. It is used to 316 # specify access control policies for Cloud Platform resources. 317 # 318 # 319 # A `Policy` consists of a list of `bindings`. A `binding` binds a list of 320 # `members` to a `role`, where the members can be user accounts, Google groups, 321 # Google domains, and service accounts. A `role` is a named list of permissions 322 # defined by IAM. 323 # 324 # **JSON Example** 325 # 326 # { 327 # "bindings": [ 328 # { 329 # "role": "roles/owner", 330 # "members": [ 331 # "user:mike@example.com", 332 # "group:admins@example.com", 333 # "domain:google.com", 334 # "serviceAccount:my-other-app@appspot.gserviceaccount.com" 335 # ] 336 # }, 337 # { 338 # "role": "roles/viewer", 339 # "members": ["user:sean@example.com"] 340 # } 341 # ] 342 # } 343 # 344 # **YAML Example** 345 # 346 # bindings: 347 # - members: 348 # - user:mike@example.com 349 # - group:admins@example.com 350 # - domain:google.com 351 # - serviceAccount:my-other-app@appspot.gserviceaccount.com 352 # role: roles/owner 353 # - members: 354 # - user:sean@example.com 355 # role: roles/viewer 356 # 357 # 358 # For a description of IAM and its features, see the 359 # [IAM developer's guide](https://cloud.google.com/iam/docs). 360 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 361 { # Specifies the audit configuration for a service. 362 # The configuration determines which permission types are logged, and what 363 # identities, if any, are exempted from logging. 364 # An AuditConfig must have one or more AuditLogConfigs. 365 # 366 # If there are AuditConfigs for both `allServices` and a specific service, 367 # the union of the two AuditConfigs is used for that service: the log_types 368 # specified in each AuditConfig are enabled, and the exempted_members in each 369 # AuditLogConfig are exempted. 370 # 371 # Example Policy with multiple AuditConfigs: 372 # 373 # { 374 # "audit_configs": [ 375 # { 376 # "service": "allServices" 377 # "audit_log_configs": [ 378 # { 379 # "log_type": "DATA_READ", 380 # "exempted_members": [ 381 # "user:foo@gmail.com" 382 # ] 383 # }, 384 # { 385 # "log_type": "DATA_WRITE", 386 # }, 387 # { 388 # "log_type": "ADMIN_READ", 389 # } 390 # ] 391 # }, 392 # { 393 # "service": "fooservice.googleapis.com" 394 # "audit_log_configs": [ 395 # { 396 # "log_type": "DATA_READ", 397 # }, 398 # { 399 # "log_type": "DATA_WRITE", 400 # "exempted_members": [ 401 # "user:bar@gmail.com" 402 # ] 403 # } 404 # ] 405 # } 406 # ] 407 # } 408 # 409 # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ 410 # logging. It also exempts foo@gmail.com from DATA_READ logging, and 411 # bar@gmail.com from DATA_WRITE logging. 412 "auditLogConfigs": [ # The configuration for logging of each type of permission. 413 { # Provides the configuration for logging a type of permissions. 414 # Example: 415 # 416 # { 417 # "audit_log_configs": [ 418 # { 419 # "log_type": "DATA_READ", 420 # "exempted_members": [ 421 # "user:foo@gmail.com" 422 # ] 423 # }, 424 # { 425 # "log_type": "DATA_WRITE", 426 # } 427 # ] 428 # } 429 # 430 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting 431 # foo@gmail.com from DATA_READ logging. 432 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of 433 # permission. 434 # Follows the same format of Binding.members. 435 "A String", 436 ], 437 "logType": "A String", # The log type that this config enables. 438 }, 439 ], 440 "service": "A String", # Specifies a service that will be enabled for audit logging. 441 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. 442 # `allServices` is a special value that covers all services. 443 }, 444 ], 445 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help 446 # prevent simultaneous updates of a policy from overwriting each other. 447 # It is strongly suggested that systems make use of the `etag` in the 448 # read-modify-write cycle to perform policy updates in order to avoid race 449 # conditions: An `etag` is returned in the response to `getIamPolicy`, and 450 # systems are expected to put that etag in the request to `setIamPolicy` to 451 # ensure that their change will be applied to the same version of the policy. 452 # 453 # If no `etag` is provided in the call to `setIamPolicy`, then the existing 454 # policy is overwritten blindly. 455 "bindings": [ # Associates a list of `members` to a `role`. 456 # `bindings` with no members will result in an error. 457 { # Associates `members` with a `role`. 458 "role": "A String", # Role that is assigned to `members`. 459 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 460 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. 461 # `members` can have the following values: 462 # 463 # * `allUsers`: A special identifier that represents anyone who is 464 # on the internet; with or without a Google account. 465 # 466 # * `allAuthenticatedUsers`: A special identifier that represents anyone 467 # who is authenticated with a Google account or a service account. 468 # 469 # * `user:{emailid}`: An email address that represents a specific Google 470 # account. For example, `alice@gmail.com` . 471 # 472 # 473 # * `serviceAccount:{emailid}`: An email address that represents a service 474 # account. For example, `my-other-app@appspot.gserviceaccount.com`. 475 # 476 # * `group:{emailid}`: An email address that represents a Google group. 477 # For example, `admins@example.com`. 478 # 479 # 480 # * `domain:{domain}`: The G Suite domain (primary) that represents all the 481 # users of that domain. For example, `google.com` or `example.com`. 482 # 483 "A String", 484 ], 485 "condition": { # Represents an expression text. Example: # The condition that is associated with this binding. 486 # NOTE: An unsatisfied condition will not allow user access via current 487 # binding. Different bindings, including their conditions, are examined 488 # independently. 489 # 490 # title: "User account presence" 491 # description: "Determines whether the request has a user account" 492 # expression: "size(request.user) > 0" 493 "location": "A String", # An optional string indicating the location of the expression for error 494 # reporting, e.g. a file name and a position in the file. 495 "expression": "A String", # Textual representation of an expression in 496 # Common Expression Language syntax. 497 # 498 # The application context of the containing message determines which 499 # well-known feature set of CEL is supported. 500 "description": "A String", # An optional description of the expression. This is a longer text which 501 # describes the expression, e.g. when hovered over it in a UI. 502 "title": "A String", # An optional title for the expression, i.e. a short string describing 503 # its purpose. This can be used e.g. in UIs which allow to enter the 504 # expression. 505 }, 506 }, 507 ], 508 "version": 42, # Deprecated. 509 }</pre> 510</div> 511 512<div class="method"> 513 <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</code> 514 <pre>Lists the HL7v2 stores in the given dataset. 515 516Args: 517 parent: string, Name of the dataset. (required) 518 pageToken: string, The next_page_token value returned from the previous List request, if any. 519 x__xgafv: string, V1 error format. 520 Allowed values 521 1 - v1 error format 522 2 - v2 error format 523 pageSize: integer, Limit on the number of HL7v2 stores to return in a single response. 524If zero the default page size of 100 is used. 525 filter: string, Restricts stores returned to those matching a filter. Syntax: 526https://cloud.google.com/appengine/docs/standard/python/search/query_strings 527Only filtering on labels is supported, for example `labels.key=value`. 528 529Returns: 530 An object of the form: 531 532 { # Lists the HL7v2 stores in the given dataset. 533 "nextPageToken": "A String", # Token to retrieve the next page of results or empty if there are no more 534 # results in the list. 535 "hl7V2Stores": [ # The returned HL7v2 stores. Won't be more HL7v2 stores than the value of 536 # page_size in the request. 537 { # Represents an HL7v2 store. 538 "parserConfig": { # The configuration for the parser. It determines how the server parses the # The configuration for the parser. It determines how the server parses the 539 # messages. 540 # messages. 541 "allowNullHeader": True or False, # Determines whether messages with no header are allowed. 542 "segmentTerminator": "A String", # Byte(s) to be used as the segment terminator. If this is unset, '\r' will 543 # be used as segment terminator. 544 }, 545 "labels": { # User-supplied key-value pairs used to organize HL7v2 stores. 546 # 547 # Label keys must be between 1 and 63 characters long, have a UTF-8 encoding 548 # of maximum 128 bytes, and must conform to the 549 # following PCRE regular expression: 550 # \p{Ll}\p{Lo}{0,62} 551 # 552 # Label values are optional, must be between 1 and 63 characters long, have 553 # a UTF-8 encoding of maximum 128 bytes, and must conform to the 554 # following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} 555 # 556 # No more than 64 labels can be associated with a given store. 557 "a_key": "A String", 558 }, 559 "name": "A String", # Output only. Resource name of the HL7v2 store, of the form 560 # `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`. 561 "notificationConfig": { # Specifies where notifications should be sent upon changes to a data store. # The notification destination all messages (both Ingest & Create) are 562 # published on. Only the message name is sent as part of the notification. If 563 # this is unset, no notifications will be sent. Supplied by the client. 564 "pubsubTopic": "A String", # The [Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that 565 # notifications of changes are published on. Supplied by the client. 566 # PubsubMessage.Data will contain the resource name. 567 # PubsubMessage.MessageId is the ID of this message. It is guaranteed to be 568 # unique within the topic. 569 # PubsubMessage.PublishTime is the time at which the message was published. 570 # Notifications are only sent if the topic is 571 # non-empty. [Topic 572 # names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped 573 # to a project. cloud-healthcare@system.gserviceaccount.com must have 574 # publisher permissions on the given Cloud Pub/Sub topic. Not having adequate 575 # permissions will cause the calls that send notifications to fail. 576 }, 577 }, 578 ], 579 }</pre> 580</div> 581 582<div class="method"> 583 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 584 <pre>Retrieves the next page of results. 585 586Args: 587 previous_request: The request for the previous page. (required) 588 previous_response: The response from the request for the previous page. (required) 589 590Returns: 591 A request object that you can call 'execute()' on to request the next 592 page. Returns None if there are no more items in the collection. 593 </pre> 594</div> 595 596<div class="method"> 597 <code class="details" id="patch">patch(name, body, updateMask=None, x__xgafv=None)</code> 598 <pre>Updates the HL7v2 store. 599 600Args: 601 name: string, Output only. Resource name of the HL7v2 store, of the form 602`projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`. (required) 603 body: object, The request body. (required) 604 The object takes the form of: 605 606{ # Represents an HL7v2 store. 607 "parserConfig": { # The configuration for the parser. It determines how the server parses the # The configuration for the parser. It determines how the server parses the 608 # messages. 609 # messages. 610 "allowNullHeader": True or False, # Determines whether messages with no header are allowed. 611 "segmentTerminator": "A String", # Byte(s) to be used as the segment terminator. If this is unset, '\r' will 612 # be used as segment terminator. 613 }, 614 "labels": { # User-supplied key-value pairs used to organize HL7v2 stores. 615 # 616 # Label keys must be between 1 and 63 characters long, have a UTF-8 encoding 617 # of maximum 128 bytes, and must conform to the 618 # following PCRE regular expression: 619 # \p{Ll}\p{Lo}{0,62} 620 # 621 # Label values are optional, must be between 1 and 63 characters long, have 622 # a UTF-8 encoding of maximum 128 bytes, and must conform to the 623 # following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} 624 # 625 # No more than 64 labels can be associated with a given store. 626 "a_key": "A String", 627 }, 628 "name": "A String", # Output only. Resource name of the HL7v2 store, of the form 629 # `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`. 630 "notificationConfig": { # Specifies where notifications should be sent upon changes to a data store. # The notification destination all messages (both Ingest & Create) are 631 # published on. Only the message name is sent as part of the notification. If 632 # this is unset, no notifications will be sent. Supplied by the client. 633 "pubsubTopic": "A String", # The [Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that 634 # notifications of changes are published on. Supplied by the client. 635 # PubsubMessage.Data will contain the resource name. 636 # PubsubMessage.MessageId is the ID of this message. It is guaranteed to be 637 # unique within the topic. 638 # PubsubMessage.PublishTime is the time at which the message was published. 639 # Notifications are only sent if the topic is 640 # non-empty. [Topic 641 # names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped 642 # to a project. cloud-healthcare@system.gserviceaccount.com must have 643 # publisher permissions on the given Cloud Pub/Sub topic. Not having adequate 644 # permissions will cause the calls that send notifications to fail. 645 }, 646} 647 648 updateMask: string, The update mask applies to the resource. For the `FieldMask` definition, 649see 650https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask 651 x__xgafv: string, V1 error format. 652 Allowed values 653 1 - v1 error format 654 2 - v2 error format 655 656Returns: 657 An object of the form: 658 659 { # Represents an HL7v2 store. 660 "parserConfig": { # The configuration for the parser. It determines how the server parses the # The configuration for the parser. It determines how the server parses the 661 # messages. 662 # messages. 663 "allowNullHeader": True or False, # Determines whether messages with no header are allowed. 664 "segmentTerminator": "A String", # Byte(s) to be used as the segment terminator. If this is unset, '\r' will 665 # be used as segment terminator. 666 }, 667 "labels": { # User-supplied key-value pairs used to organize HL7v2 stores. 668 # 669 # Label keys must be between 1 and 63 characters long, have a UTF-8 encoding 670 # of maximum 128 bytes, and must conform to the 671 # following PCRE regular expression: 672 # \p{Ll}\p{Lo}{0,62} 673 # 674 # Label values are optional, must be between 1 and 63 characters long, have 675 # a UTF-8 encoding of maximum 128 bytes, and must conform to the 676 # following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} 677 # 678 # No more than 64 labels can be associated with a given store. 679 "a_key": "A String", 680 }, 681 "name": "A String", # Output only. Resource name of the HL7v2 store, of the form 682 # `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`. 683 "notificationConfig": { # Specifies where notifications should be sent upon changes to a data store. # The notification destination all messages (both Ingest & Create) are 684 # published on. Only the message name is sent as part of the notification. If 685 # this is unset, no notifications will be sent. Supplied by the client. 686 "pubsubTopic": "A String", # The [Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that 687 # notifications of changes are published on. Supplied by the client. 688 # PubsubMessage.Data will contain the resource name. 689 # PubsubMessage.MessageId is the ID of this message. It is guaranteed to be 690 # unique within the topic. 691 # PubsubMessage.PublishTime is the time at which the message was published. 692 # Notifications are only sent if the topic is 693 # non-empty. [Topic 694 # names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped 695 # to a project. cloud-healthcare@system.gserviceaccount.com must have 696 # publisher permissions on the given Cloud Pub/Sub topic. Not having adequate 697 # permissions will cause the calls that send notifications to fail. 698 }, 699 }</pre> 700</div> 701 702<div class="method"> 703 <code class="details" id="setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</code> 704 <pre>Sets the access control policy on the specified resource. Replaces any 705existing policy. 706 707Args: 708 resource: string, REQUIRED: The resource for which the policy is being specified. 709See the operation documentation for the appropriate value for this field. (required) 710 body: object, The request body. (required) 711 The object takes the form of: 712 713{ # Request message for `SetIamPolicy` method. 714 "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 715 # the policy is limited to a few 10s of KB. An empty policy is a 716 # valid policy but certain Cloud Platform services (such as Projects) 717 # might reject them. 718 # specify access control policies for Cloud Platform resources. 719 # 720 # 721 # A `Policy` consists of a list of `bindings`. A `binding` binds a list of 722 # `members` to a `role`, where the members can be user accounts, Google groups, 723 # Google domains, and service accounts. A `role` is a named list of permissions 724 # defined by IAM. 725 # 726 # **JSON Example** 727 # 728 # { 729 # "bindings": [ 730 # { 731 # "role": "roles/owner", 732 # "members": [ 733 # "user:mike@example.com", 734 # "group:admins@example.com", 735 # "domain:google.com", 736 # "serviceAccount:my-other-app@appspot.gserviceaccount.com" 737 # ] 738 # }, 739 # { 740 # "role": "roles/viewer", 741 # "members": ["user:sean@example.com"] 742 # } 743 # ] 744 # } 745 # 746 # **YAML Example** 747 # 748 # bindings: 749 # - members: 750 # - user:mike@example.com 751 # - group:admins@example.com 752 # - domain:google.com 753 # - serviceAccount:my-other-app@appspot.gserviceaccount.com 754 # role: roles/owner 755 # - members: 756 # - user:sean@example.com 757 # role: roles/viewer 758 # 759 # 760 # For a description of IAM and its features, see the 761 # [IAM developer's guide](https://cloud.google.com/iam/docs). 762 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 763 { # Specifies the audit configuration for a service. 764 # The configuration determines which permission types are logged, and what 765 # identities, if any, are exempted from logging. 766 # An AuditConfig must have one or more AuditLogConfigs. 767 # 768 # If there are AuditConfigs for both `allServices` and a specific service, 769 # the union of the two AuditConfigs is used for that service: the log_types 770 # specified in each AuditConfig are enabled, and the exempted_members in each 771 # AuditLogConfig are exempted. 772 # 773 # Example Policy with multiple AuditConfigs: 774 # 775 # { 776 # "audit_configs": [ 777 # { 778 # "service": "allServices" 779 # "audit_log_configs": [ 780 # { 781 # "log_type": "DATA_READ", 782 # "exempted_members": [ 783 # "user:foo@gmail.com" 784 # ] 785 # }, 786 # { 787 # "log_type": "DATA_WRITE", 788 # }, 789 # { 790 # "log_type": "ADMIN_READ", 791 # } 792 # ] 793 # }, 794 # { 795 # "service": "fooservice.googleapis.com" 796 # "audit_log_configs": [ 797 # { 798 # "log_type": "DATA_READ", 799 # }, 800 # { 801 # "log_type": "DATA_WRITE", 802 # "exempted_members": [ 803 # "user:bar@gmail.com" 804 # ] 805 # } 806 # ] 807 # } 808 # ] 809 # } 810 # 811 # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ 812 # logging. It also exempts foo@gmail.com from DATA_READ logging, and 813 # bar@gmail.com from DATA_WRITE logging. 814 "auditLogConfigs": [ # The configuration for logging of each type of permission. 815 { # Provides the configuration for logging a type of permissions. 816 # Example: 817 # 818 # { 819 # "audit_log_configs": [ 820 # { 821 # "log_type": "DATA_READ", 822 # "exempted_members": [ 823 # "user:foo@gmail.com" 824 # ] 825 # }, 826 # { 827 # "log_type": "DATA_WRITE", 828 # } 829 # ] 830 # } 831 # 832 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting 833 # foo@gmail.com from DATA_READ logging. 834 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of 835 # permission. 836 # Follows the same format of Binding.members. 837 "A String", 838 ], 839 "logType": "A String", # The log type that this config enables. 840 }, 841 ], 842 "service": "A String", # Specifies a service that will be enabled for audit logging. 843 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. 844 # `allServices` is a special value that covers all services. 845 }, 846 ], 847 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help 848 # prevent simultaneous updates of a policy from overwriting each other. 849 # It is strongly suggested that systems make use of the `etag` in the 850 # read-modify-write cycle to perform policy updates in order to avoid race 851 # conditions: An `etag` is returned in the response to `getIamPolicy`, and 852 # systems are expected to put that etag in the request to `setIamPolicy` to 853 # ensure that their change will be applied to the same version of the policy. 854 # 855 # If no `etag` is provided in the call to `setIamPolicy`, then the existing 856 # policy is overwritten blindly. 857 "bindings": [ # Associates a list of `members` to a `role`. 858 # `bindings` with no members will result in an error. 859 { # Associates `members` with a `role`. 860 "role": "A String", # Role that is assigned to `members`. 861 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 862 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. 863 # `members` can have the following values: 864 # 865 # * `allUsers`: A special identifier that represents anyone who is 866 # on the internet; with or without a Google account. 867 # 868 # * `allAuthenticatedUsers`: A special identifier that represents anyone 869 # who is authenticated with a Google account or a service account. 870 # 871 # * `user:{emailid}`: An email address that represents a specific Google 872 # account. For example, `alice@gmail.com` . 873 # 874 # 875 # * `serviceAccount:{emailid}`: An email address that represents a service 876 # account. For example, `my-other-app@appspot.gserviceaccount.com`. 877 # 878 # * `group:{emailid}`: An email address that represents a Google group. 879 # For example, `admins@example.com`. 880 # 881 # 882 # * `domain:{domain}`: The G Suite domain (primary) that represents all the 883 # users of that domain. For example, `google.com` or `example.com`. 884 # 885 "A String", 886 ], 887 "condition": { # Represents an expression text. Example: # The condition that is associated with this binding. 888 # NOTE: An unsatisfied condition will not allow user access via current 889 # binding. Different bindings, including their conditions, are examined 890 # independently. 891 # 892 # title: "User account presence" 893 # description: "Determines whether the request has a user account" 894 # expression: "size(request.user) > 0" 895 "location": "A String", # An optional string indicating the location of the expression for error 896 # reporting, e.g. a file name and a position in the file. 897 "expression": "A String", # Textual representation of an expression in 898 # Common Expression Language syntax. 899 # 900 # The application context of the containing message determines which 901 # well-known feature set of CEL is supported. 902 "description": "A String", # An optional description of the expression. This is a longer text which 903 # describes the expression, e.g. when hovered over it in a UI. 904 "title": "A String", # An optional title for the expression, i.e. a short string describing 905 # its purpose. This can be used e.g. in UIs which allow to enter the 906 # expression. 907 }, 908 }, 909 ], 910 "version": 42, # Deprecated. 911 }, 912 "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only 913 # the fields in the mask will be modified. If no mask is provided, the 914 # following default mask is used: 915 # paths: "bindings, etag" 916 # This field is only used by Cloud IAM. 917 } 918 919 x__xgafv: string, V1 error format. 920 Allowed values 921 1 - v1 error format 922 2 - v2 error format 923 924Returns: 925 An object of the form: 926 927 { # Defines an Identity and Access Management (IAM) policy. It is used to 928 # specify access control policies for Cloud Platform resources. 929 # 930 # 931 # A `Policy` consists of a list of `bindings`. A `binding` binds a list of 932 # `members` to a `role`, where the members can be user accounts, Google groups, 933 # Google domains, and service accounts. A `role` is a named list of permissions 934 # defined by IAM. 935 # 936 # **JSON Example** 937 # 938 # { 939 # "bindings": [ 940 # { 941 # "role": "roles/owner", 942 # "members": [ 943 # "user:mike@example.com", 944 # "group:admins@example.com", 945 # "domain:google.com", 946 # "serviceAccount:my-other-app@appspot.gserviceaccount.com" 947 # ] 948 # }, 949 # { 950 # "role": "roles/viewer", 951 # "members": ["user:sean@example.com"] 952 # } 953 # ] 954 # } 955 # 956 # **YAML Example** 957 # 958 # bindings: 959 # - members: 960 # - user:mike@example.com 961 # - group:admins@example.com 962 # - domain:google.com 963 # - serviceAccount:my-other-app@appspot.gserviceaccount.com 964 # role: roles/owner 965 # - members: 966 # - user:sean@example.com 967 # role: roles/viewer 968 # 969 # 970 # For a description of IAM and its features, see the 971 # [IAM developer's guide](https://cloud.google.com/iam/docs). 972 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 973 { # Specifies the audit configuration for a service. 974 # The configuration determines which permission types are logged, and what 975 # identities, if any, are exempted from logging. 976 # An AuditConfig must have one or more AuditLogConfigs. 977 # 978 # If there are AuditConfigs for both `allServices` and a specific service, 979 # the union of the two AuditConfigs is used for that service: the log_types 980 # specified in each AuditConfig are enabled, and the exempted_members in each 981 # AuditLogConfig are exempted. 982 # 983 # Example Policy with multiple AuditConfigs: 984 # 985 # { 986 # "audit_configs": [ 987 # { 988 # "service": "allServices" 989 # "audit_log_configs": [ 990 # { 991 # "log_type": "DATA_READ", 992 # "exempted_members": [ 993 # "user:foo@gmail.com" 994 # ] 995 # }, 996 # { 997 # "log_type": "DATA_WRITE", 998 # }, 999 # { 1000 # "log_type": "ADMIN_READ", 1001 # } 1002 # ] 1003 # }, 1004 # { 1005 # "service": "fooservice.googleapis.com" 1006 # "audit_log_configs": [ 1007 # { 1008 # "log_type": "DATA_READ", 1009 # }, 1010 # { 1011 # "log_type": "DATA_WRITE", 1012 # "exempted_members": [ 1013 # "user:bar@gmail.com" 1014 # ] 1015 # } 1016 # ] 1017 # } 1018 # ] 1019 # } 1020 # 1021 # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ 1022 # logging. It also exempts foo@gmail.com from DATA_READ logging, and 1023 # bar@gmail.com from DATA_WRITE logging. 1024 "auditLogConfigs": [ # The configuration for logging of each type of permission. 1025 { # Provides the configuration for logging a type of permissions. 1026 # Example: 1027 # 1028 # { 1029 # "audit_log_configs": [ 1030 # { 1031 # "log_type": "DATA_READ", 1032 # "exempted_members": [ 1033 # "user:foo@gmail.com" 1034 # ] 1035 # }, 1036 # { 1037 # "log_type": "DATA_WRITE", 1038 # } 1039 # ] 1040 # } 1041 # 1042 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting 1043 # foo@gmail.com from DATA_READ logging. 1044 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of 1045 # permission. 1046 # Follows the same format of Binding.members. 1047 "A String", 1048 ], 1049 "logType": "A String", # The log type that this config enables. 1050 }, 1051 ], 1052 "service": "A String", # Specifies a service that will be enabled for audit logging. 1053 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. 1054 # `allServices` is a special value that covers all services. 1055 }, 1056 ], 1057 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help 1058 # prevent simultaneous updates of a policy from overwriting each other. 1059 # It is strongly suggested that systems make use of the `etag` in the 1060 # read-modify-write cycle to perform policy updates in order to avoid race 1061 # conditions: An `etag` is returned in the response to `getIamPolicy`, and 1062 # systems are expected to put that etag in the request to `setIamPolicy` to 1063 # ensure that their change will be applied to the same version of the policy. 1064 # 1065 # If no `etag` is provided in the call to `setIamPolicy`, then the existing 1066 # policy is overwritten blindly. 1067 "bindings": [ # Associates a list of `members` to a `role`. 1068 # `bindings` with no members will result in an error. 1069 { # Associates `members` with a `role`. 1070 "role": "A String", # Role that is assigned to `members`. 1071 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 1072 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. 1073 # `members` can have the following values: 1074 # 1075 # * `allUsers`: A special identifier that represents anyone who is 1076 # on the internet; with or without a Google account. 1077 # 1078 # * `allAuthenticatedUsers`: A special identifier that represents anyone 1079 # who is authenticated with a Google account or a service account. 1080 # 1081 # * `user:{emailid}`: An email address that represents a specific Google 1082 # account. For example, `alice@gmail.com` . 1083 # 1084 # 1085 # * `serviceAccount:{emailid}`: An email address that represents a service 1086 # account. For example, `my-other-app@appspot.gserviceaccount.com`. 1087 # 1088 # * `group:{emailid}`: An email address that represents a Google group. 1089 # For example, `admins@example.com`. 1090 # 1091 # 1092 # * `domain:{domain}`: The G Suite domain (primary) that represents all the 1093 # users of that domain. For example, `google.com` or `example.com`. 1094 # 1095 "A String", 1096 ], 1097 "condition": { # Represents an expression text. Example: # The condition that is associated with this binding. 1098 # NOTE: An unsatisfied condition will not allow user access via current 1099 # binding. Different bindings, including their conditions, are examined 1100 # independently. 1101 # 1102 # title: "User account presence" 1103 # description: "Determines whether the request has a user account" 1104 # expression: "size(request.user) > 0" 1105 "location": "A String", # An optional string indicating the location of the expression for error 1106 # reporting, e.g. a file name and a position in the file. 1107 "expression": "A String", # Textual representation of an expression in 1108 # Common Expression Language syntax. 1109 # 1110 # The application context of the containing message determines which 1111 # well-known feature set of CEL is supported. 1112 "description": "A String", # An optional description of the expression. This is a longer text which 1113 # describes the expression, e.g. when hovered over it in a UI. 1114 "title": "A String", # An optional title for the expression, i.e. a short string describing 1115 # its purpose. This can be used e.g. in UIs which allow to enter the 1116 # expression. 1117 }, 1118 }, 1119 ], 1120 "version": 42, # Deprecated. 1121 }</pre> 1122</div> 1123 1124<div class="method"> 1125 <code class="details" id="testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</code> 1126 <pre>Returns permissions that a caller has on the specified resource. 1127If the resource does not exist, this will return an empty set of 1128permissions, not a NOT_FOUND error. 1129 1130Note: This operation is designed to be used for building permission-aware 1131UIs and command-line tools, not for authorization checking. This operation 1132may "fail open" without warning. 1133 1134Args: 1135 resource: string, REQUIRED: The resource for which the policy detail is being requested. 1136See the operation documentation for the appropriate value for this field. (required) 1137 body: object, The request body. (required) 1138 The object takes the form of: 1139 1140{ # Request message for `TestIamPermissions` method. 1141 "permissions": [ # The set of permissions to check for the `resource`. Permissions with 1142 # wildcards (such as '*' or 'storage.*') are not allowed. For more 1143 # information see 1144 # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). 1145 "A String", 1146 ], 1147 } 1148 1149 x__xgafv: string, V1 error format. 1150 Allowed values 1151 1 - v1 error format 1152 2 - v2 error format 1153 1154Returns: 1155 An object of the form: 1156 1157 { # Response message for `TestIamPermissions` method. 1158 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is 1159 # allowed. 1160 "A String", 1161 ], 1162 }</pre> 1163</div> 1164 1165</body></html>