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