| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <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> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="healthcare_v1beta1.projects.locations.datasets.hl7V2Stores.messages.html">messages()</a></code> |
| </p> |
| <p class="firstline">Returns the messages Resource.</p> |
| |
| <p class="toc_element"> |
| <code><a href="#create">create(parent, body=None, hl7V2StoreId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Creates a new HL7v2 store within the parent dataset.</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Deletes the specified HL7v2 store and removes all messages that it</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets the specified HL7v2 store.</p> |
| <p class="toc_element"> |
| <code><a href="#getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets the access control policy for a resource.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(parent, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists the HL7v2 stores in the given dataset.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Updates the HL7v2 store.</p> |
| <p class="toc_element"> |
| <code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Sets the access control policy on the specified resource. Replaces any</p> |
| <p class="toc_element"> |
| <code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Returns permissions that a caller has on the specified resource.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="create">create(parent, body=None, hl7V2StoreId=None, x__xgafv=None)</code> |
| <pre>Creates a new HL7v2 store within the parent dataset. |
| |
| Args: |
| parent: string, The name of the dataset this HL7v2 store belongs to. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Represents an HL7v2 store. |
| "notificationConfigs": [ # A list of notification configs. Each configuration uses a filter to |
| # determine whether to publish a message (both Ingest & Create) on |
| # the corresponding notification destination. Only the message name is sent |
| # as part of the notification. Supplied by the client. |
| { # Specifies where and whether to send notifications upon changes to a |
| # data store. |
| "filter": "A String", # Restricts notifications sent for messages matching a filter. If this is |
| # empty, all messages are matched. Syntax: |
| # https://cloud.google.com/appengine/docs/standard/python/search/query_strings |
| # |
| # The following fields and functions are available for filtering: |
| # |
| # * `message_type`, from the MSH-9.1 field. For example, |
| # `NOT message_type = "ADT"`. |
| # * `send_date` or `sendDate`, the YYYY-MM-DD date the message was sent in |
| # the dataset's time_zone, from the MSH-7 segment. For example, |
| # `send_date < "2017-01-02"`. |
| # * `send_time`, the timestamp when the message was sent, using the |
| # RFC3339 time format for comparisons, from the MSH-7 segment. For example, |
| # `send_time < "2017-01-02T00:00:00-05:00"`. |
| # * `send_facility`, the care center that the message came from, from the |
| # MSH-4 segment. For example, `send_facility = "ABC"`. |
| # * `PatientId(value, type)`, which matches if the message lists a patient |
| # having an ID of the given value and type in the PID-2, PID-3, or PID-4 |
| # segments. For example, `PatientId("123456", "MRN")`. |
| # * `labels.x`, a string value of the label with key `x` as set using the |
| # Message.labels |
| # map. For example, `labels."priority"="high"`. The operator `:*` can be |
| # used to assert the existence of a label. For example, |
| # `labels."priority":*`. |
| "pubsubTopic": "A String", # The [Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that |
| # notifications of changes are published on. Supplied by the client. The |
| # notification is a `PubsubMessage` with the following fields: |
| # |
| # * `PubsubMessage.Data` contains the resource name. |
| # * `PubsubMessage.MessageId` is the ID of this notification. It is |
| # guaranteed to be unique within the topic. |
| # * `PubsubMessage.PublishTime` is the time when the message was |
| # published. |
| # |
| # Note that notifications are only sent if the topic is non-empty. [Topic |
| # names](https://cloud.google.com/pubsub/docs/overview#names) must be |
| # scoped to a project. Cloud Healthcare API service account must have |
| # publisher permissions on the given Pub/Sub topic. Not having adequate |
| # permissions causes the calls that send notifications to fail. |
| # |
| # If a notification can't be published to Cloud Pub/Sub, errors are |
| # logged to Cloud Logging. For more information, see |
| # [Viewing error logs in Cloud Logging](/healthcare/docs/how-tos/logging). |
| }, |
| ], |
| "rejectDuplicateMessage": True or False, # Determines whether to reject duplicate messages. A duplicate |
| # message is a message with the same raw bytes as a message that has already |
| # been ingested/created in this HL7v2 store. |
| # The default value is false, meaning that the store accepts the duplicate |
| # messages and it also returns the same ACK message in the |
| # IngestMessageResponse as has been returned previously. Note that only |
| # one resource is created in the store. |
| # When this field is set to true, |
| # CreateMessage/IngestMessage |
| # requests with a duplicate message will be rejected by the store, and |
| # IngestMessageErrorDetail returns a NACK message upon rejection. |
| "labels": { # User-supplied key-value pairs used to organize HL7v2 stores. |
| # |
| # Label keys must be between 1 and 63 characters long, have a UTF-8 encoding |
| # of maximum 128 bytes, and must conform to the |
| # following PCRE regular expression: |
| # \p{Ll}\p{Lo}{0,62} |
| # |
| # Label values are optional, must be between 1 and 63 characters long, have |
| # a UTF-8 encoding of maximum 128 bytes, and must conform to the |
| # following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} |
| # |
| # No more than 64 labels can be associated with a given store. |
| "a_key": "A String", |
| }, |
| "notificationConfig": { # Specifies where to send notifications upon changes to a data store. # The notification destination all messages (both Ingest & Create) are |
| # published on. Only the message name is sent as part of the notification. If |
| # this is unset, no notifications are sent. Supplied by the client. |
| "pubsubTopic": "A String", # The [Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that |
| # notifications of changes are published on. Supplied by the client. |
| # PubsubMessage.Data contains the resource name. |
| # PubsubMessage.MessageId is the ID of this message. It is guaranteed to be |
| # unique within the topic. |
| # PubsubMessage.PublishTime is the time at which the message was published. |
| # Notifications are only sent if the topic is |
| # non-empty. [Topic |
| # names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped |
| # to a project. Cloud Healthcare API service account must have publisher |
| # permissions on the given Cloud Pub/Sub topic. Not having adequate |
| # permissions causes the calls that send notifications to fail. |
| # |
| # If a notification can't be published to Cloud Pub/Sub, errors are logged to |
| # Cloud Logging (see [Viewing |
| # logs](/healthcare/docs/how-tos/logging)). If the number of |
| # errors exceeds a certain rate, some aren't submitted. |
| }, |
| "name": "A String", # Resource name of the HL7v2 store, of the form |
| # `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`. |
| "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 |
| # messages. |
| # messages. |
| "allowNullHeader": True or False, # Determines whether messages with no header are allowed. |
| "segmentTerminator": "A String", # Byte(s) to use as the segment terminator. If this is unset, '\r' is |
| # used as segment terminator, matching the HL7 version 2 |
| # specification. |
| "schema": { # A schema package contains a set of schemas and type definitions. # Schemas used to parse messages in this store, if schematized parsing is |
| # desired. |
| "schemas": [ # Schema configs that are layered based on their VersionSources that |
| # match the incoming message. Schema configs present in higher indices |
| # override those in lower indices with the same message type and trigger |
| # event if their VersionSources all match an incoming message. |
| { # Root config message for HL7v2 schema. This contains a schema structure of |
| # groups and segments, and filters that determine which messages to apply the |
| # schema structure to. |
| "messageSchemaConfigs": { # Map from each HL7v2 message type and trigger event pair, such as ADT_A04, |
| # to its schema configuration root group. |
| "a_key": { # An HL7v2 logical group construct. |
| "name": "A String", # The name of this group. For example, "ORDER_DETAIL". |
| "members": [ # Nested groups and/or segments. |
| { # Construct representing a logical group or a segment. |
| "group": # Object with schema name: SchemaGroup |
| "segment": { # An HL7v2 Segment. |
| "type": "A String", # The Segment type. For example, "PID". |
| "minOccurs": 42, # The minimum number of times this segment can be present in this group. |
| "maxOccurs": 42, # The maximum number of times this segment can be present in this group. |
| # 0 or -1 means unbounded. |
| }, |
| }, |
| ], |
| "maxOccurs": 42, # The maximum number of times this group can be repeated. 0 or -1 means |
| # unbounded. |
| "choice": True or False, # True indicates that this is a choice group, meaning that only one of its |
| # segments can exist in a given message. |
| "minOccurs": 42, # The minimum number of times this group must be present/repeated. |
| }, |
| }, |
| "version": [ # Each VersionSource is tested and only if they all match is the schema used |
| # for the message. |
| { # Describes a selector for extracting and matching an MSH field to a value. |
| "mshField": "A String", # The field to extract from the MSH segment. For example, "3.1" or "18[1].1". |
| "value": "A String", # The value to match with the field. For example, "My Application Name" or |
| # "2.3". |
| }, |
| ], |
| }, |
| ], |
| "ignoreMinOccurs": True or False, # Flag to ignore all min_occurs restrictions in the schema. This means that |
| # incoming messages can omit any group, segment, field, component, or |
| # subcomponent. |
| "types": [ # Schema type definitions that are layered based on their VersionSources |
| # that match the incoming message. Type definitions present in higher indices |
| # override those in lower indices with the same type name if their |
| # VersionSources all match an incoming message. |
| { # Root config for HL7v2 datatype definitions for a specific HL7v2 version. |
| "version": [ # The version selectors that this config applies to. A message must match |
| # ALL version sources to apply. |
| { # Describes a selector for extracting and matching an MSH field to a value. |
| "mshField": "A String", # The field to extract from the MSH segment. For example, "3.1" or "18[1].1". |
| "value": "A String", # The value to match with the field. For example, "My Application Name" or |
| # "2.3". |
| }, |
| ], |
| "type": [ # The HL7v2 type definitions. |
| { # A type definition for some HL7v2 type (incl. Segments and Datatypes). |
| "name": "A String", # The name of this type. This would be the segment or datatype name. |
| # For example, "PID" or "XPN". |
| "fields": [ # The (sub) fields this type has (if not primitive). |
| { # A (sub) field of a type. |
| "minOccurs": 42, # The minimum number of times this field must be present/repeated. |
| "table": "A String", # The HL7v2 table this field refers to. For example, PID-15 (Patient's |
| # Primary Language) usually refers to table "0296". |
| "maxOccurs": 42, # The maximum number of times this field can be repeated. 0 or -1 means |
| # unbounded. |
| "name": "A String", # The name of the field. For example, "PID-1" or just "1". |
| "type": "A String", # The type of this field. A Type with this name must be defined in an |
| # Hl7TypesConfig. |
| }, |
| ], |
| "primitive": "A String", # If this is a primitive type then this field is the type of the primitive |
| # For example, STRING. Leave unspecified for composite types. |
| }, |
| ], |
| }, |
| ], |
| "schematizedParsingType": "A String", # Determines how messages that don't parse successfully are handled. |
| }, |
| }, |
| } |
| |
| hl7V2StoreId: string, The ID of the HL7v2 store that is being created. |
| The string must match the following regex: `[\p{L}\p{N}_\-\.]{1,256}`. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents an HL7v2 store. |
| "notificationConfigs": [ # A list of notification configs. Each configuration uses a filter to |
| # determine whether to publish a message (both Ingest & Create) on |
| # the corresponding notification destination. Only the message name is sent |
| # as part of the notification. Supplied by the client. |
| { # Specifies where and whether to send notifications upon changes to a |
| # data store. |
| "filter": "A String", # Restricts notifications sent for messages matching a filter. If this is |
| # empty, all messages are matched. Syntax: |
| # https://cloud.google.com/appengine/docs/standard/python/search/query_strings |
| # |
| # The following fields and functions are available for filtering: |
| # |
| # * `message_type`, from the MSH-9.1 field. For example, |
| # `NOT message_type = "ADT"`. |
| # * `send_date` or `sendDate`, the YYYY-MM-DD date the message was sent in |
| # the dataset's time_zone, from the MSH-7 segment. For example, |
| # `send_date < "2017-01-02"`. |
| # * `send_time`, the timestamp when the message was sent, using the |
| # RFC3339 time format for comparisons, from the MSH-7 segment. For example, |
| # `send_time < "2017-01-02T00:00:00-05:00"`. |
| # * `send_facility`, the care center that the message came from, from the |
| # MSH-4 segment. For example, `send_facility = "ABC"`. |
| # * `PatientId(value, type)`, which matches if the message lists a patient |
| # having an ID of the given value and type in the PID-2, PID-3, or PID-4 |
| # segments. For example, `PatientId("123456", "MRN")`. |
| # * `labels.x`, a string value of the label with key `x` as set using the |
| # Message.labels |
| # map. For example, `labels."priority"="high"`. The operator `:*` can be |
| # used to assert the existence of a label. For example, |
| # `labels."priority":*`. |
| "pubsubTopic": "A String", # The [Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that |
| # notifications of changes are published on. Supplied by the client. The |
| # notification is a `PubsubMessage` with the following fields: |
| # |
| # * `PubsubMessage.Data` contains the resource name. |
| # * `PubsubMessage.MessageId` is the ID of this notification. It is |
| # guaranteed to be unique within the topic. |
| # * `PubsubMessage.PublishTime` is the time when the message was |
| # published. |
| # |
| # Note that notifications are only sent if the topic is non-empty. [Topic |
| # names](https://cloud.google.com/pubsub/docs/overview#names) must be |
| # scoped to a project. Cloud Healthcare API service account must have |
| # publisher permissions on the given Pub/Sub topic. Not having adequate |
| # permissions causes the calls that send notifications to fail. |
| # |
| # If a notification can't be published to Cloud Pub/Sub, errors are |
| # logged to Cloud Logging. For more information, see |
| # [Viewing error logs in Cloud Logging](/healthcare/docs/how-tos/logging). |
| }, |
| ], |
| "rejectDuplicateMessage": True or False, # Determines whether to reject duplicate messages. A duplicate |
| # message is a message with the same raw bytes as a message that has already |
| # been ingested/created in this HL7v2 store. |
| # The default value is false, meaning that the store accepts the duplicate |
| # messages and it also returns the same ACK message in the |
| # IngestMessageResponse as has been returned previously. Note that only |
| # one resource is created in the store. |
| # When this field is set to true, |
| # CreateMessage/IngestMessage |
| # requests with a duplicate message will be rejected by the store, and |
| # IngestMessageErrorDetail returns a NACK message upon rejection. |
| "labels": { # User-supplied key-value pairs used to organize HL7v2 stores. |
| # |
| # Label keys must be between 1 and 63 characters long, have a UTF-8 encoding |
| # of maximum 128 bytes, and must conform to the |
| # following PCRE regular expression: |
| # \p{Ll}\p{Lo}{0,62} |
| # |
| # Label values are optional, must be between 1 and 63 characters long, have |
| # a UTF-8 encoding of maximum 128 bytes, and must conform to the |
| # following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} |
| # |
| # No more than 64 labels can be associated with a given store. |
| "a_key": "A String", |
| }, |
| "notificationConfig": { # Specifies where to send notifications upon changes to a data store. # The notification destination all messages (both Ingest & Create) are |
| # published on. Only the message name is sent as part of the notification. If |
| # this is unset, no notifications are sent. Supplied by the client. |
| "pubsubTopic": "A String", # The [Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that |
| # notifications of changes are published on. Supplied by the client. |
| # PubsubMessage.Data contains the resource name. |
| # PubsubMessage.MessageId is the ID of this message. It is guaranteed to be |
| # unique within the topic. |
| # PubsubMessage.PublishTime is the time at which the message was published. |
| # Notifications are only sent if the topic is |
| # non-empty. [Topic |
| # names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped |
| # to a project. Cloud Healthcare API service account must have publisher |
| # permissions on the given Cloud Pub/Sub topic. Not having adequate |
| # permissions causes the calls that send notifications to fail. |
| # |
| # If a notification can't be published to Cloud Pub/Sub, errors are logged to |
| # Cloud Logging (see [Viewing |
| # logs](/healthcare/docs/how-tos/logging)). If the number of |
| # errors exceeds a certain rate, some aren't submitted. |
| }, |
| "name": "A String", # Resource name of the HL7v2 store, of the form |
| # `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`. |
| "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 |
| # messages. |
| # messages. |
| "allowNullHeader": True or False, # Determines whether messages with no header are allowed. |
| "segmentTerminator": "A String", # Byte(s) to use as the segment terminator. If this is unset, '\r' is |
| # used as segment terminator, matching the HL7 version 2 |
| # specification. |
| "schema": { # A schema package contains a set of schemas and type definitions. # Schemas used to parse messages in this store, if schematized parsing is |
| # desired. |
| "schemas": [ # Schema configs that are layered based on their VersionSources that |
| # match the incoming message. Schema configs present in higher indices |
| # override those in lower indices with the same message type and trigger |
| # event if their VersionSources all match an incoming message. |
| { # Root config message for HL7v2 schema. This contains a schema structure of |
| # groups and segments, and filters that determine which messages to apply the |
| # schema structure to. |
| "messageSchemaConfigs": { # Map from each HL7v2 message type and trigger event pair, such as ADT_A04, |
| # to its schema configuration root group. |
| "a_key": { # An HL7v2 logical group construct. |
| "name": "A String", # The name of this group. For example, "ORDER_DETAIL". |
| "members": [ # Nested groups and/or segments. |
| { # Construct representing a logical group or a segment. |
| "group": # Object with schema name: SchemaGroup |
| "segment": { # An HL7v2 Segment. |
| "type": "A String", # The Segment type. For example, "PID". |
| "minOccurs": 42, # The minimum number of times this segment can be present in this group. |
| "maxOccurs": 42, # The maximum number of times this segment can be present in this group. |
| # 0 or -1 means unbounded. |
| }, |
| }, |
| ], |
| "maxOccurs": 42, # The maximum number of times this group can be repeated. 0 or -1 means |
| # unbounded. |
| "choice": True or False, # True indicates that this is a choice group, meaning that only one of its |
| # segments can exist in a given message. |
| "minOccurs": 42, # The minimum number of times this group must be present/repeated. |
| }, |
| }, |
| "version": [ # Each VersionSource is tested and only if they all match is the schema used |
| # for the message. |
| { # Describes a selector for extracting and matching an MSH field to a value. |
| "mshField": "A String", # The field to extract from the MSH segment. For example, "3.1" or "18[1].1". |
| "value": "A String", # The value to match with the field. For example, "My Application Name" or |
| # "2.3". |
| }, |
| ], |
| }, |
| ], |
| "ignoreMinOccurs": True or False, # Flag to ignore all min_occurs restrictions in the schema. This means that |
| # incoming messages can omit any group, segment, field, component, or |
| # subcomponent. |
| "types": [ # Schema type definitions that are layered based on their VersionSources |
| # that match the incoming message. Type definitions present in higher indices |
| # override those in lower indices with the same type name if their |
| # VersionSources all match an incoming message. |
| { # Root config for HL7v2 datatype definitions for a specific HL7v2 version. |
| "version": [ # The version selectors that this config applies to. A message must match |
| # ALL version sources to apply. |
| { # Describes a selector for extracting and matching an MSH field to a value. |
| "mshField": "A String", # The field to extract from the MSH segment. For example, "3.1" or "18[1].1". |
| "value": "A String", # The value to match with the field. For example, "My Application Name" or |
| # "2.3". |
| }, |
| ], |
| "type": [ # The HL7v2 type definitions. |
| { # A type definition for some HL7v2 type (incl. Segments and Datatypes). |
| "name": "A String", # The name of this type. This would be the segment or datatype name. |
| # For example, "PID" or "XPN". |
| "fields": [ # The (sub) fields this type has (if not primitive). |
| { # A (sub) field of a type. |
| "minOccurs": 42, # The minimum number of times this field must be present/repeated. |
| "table": "A String", # The HL7v2 table this field refers to. For example, PID-15 (Patient's |
| # Primary Language) usually refers to table "0296". |
| "maxOccurs": 42, # The maximum number of times this field can be repeated. 0 or -1 means |
| # unbounded. |
| "name": "A String", # The name of the field. For example, "PID-1" or just "1". |
| "type": "A String", # The type of this field. A Type with this name must be defined in an |
| # Hl7TypesConfig. |
| }, |
| ], |
| "primitive": "A String", # If this is a primitive type then this field is the type of the primitive |
| # For example, STRING. Leave unspecified for composite types. |
| }, |
| ], |
| }, |
| ], |
| "schematizedParsingType": "A String", # Determines how messages that don't parse successfully are handled. |
| }, |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| <pre>Deletes the specified HL7v2 store and removes all messages that it |
| contains. |
| |
| Args: |
| name: string, The resource name of the HL7v2 store to delete. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A generic empty message that you can re-use to avoid defining duplicated |
| # empty messages in your APIs. A typical example is to use it as the request |
| # or the response type of an API method. For instance: |
| # |
| # service Foo { |
| # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); |
| # } |
| # |
| # The JSON representation for `Empty` is empty JSON object `{}`. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name, x__xgafv=None)</code> |
| <pre>Gets the specified HL7v2 store. |
| |
| Args: |
| name: string, The resource name of the HL7v2 store to get. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents an HL7v2 store. |
| "notificationConfigs": [ # A list of notification configs. Each configuration uses a filter to |
| # determine whether to publish a message (both Ingest & Create) on |
| # the corresponding notification destination. Only the message name is sent |
| # as part of the notification. Supplied by the client. |
| { # Specifies where and whether to send notifications upon changes to a |
| # data store. |
| "filter": "A String", # Restricts notifications sent for messages matching a filter. If this is |
| # empty, all messages are matched. Syntax: |
| # https://cloud.google.com/appengine/docs/standard/python/search/query_strings |
| # |
| # The following fields and functions are available for filtering: |
| # |
| # * `message_type`, from the MSH-9.1 field. For example, |
| # `NOT message_type = "ADT"`. |
| # * `send_date` or `sendDate`, the YYYY-MM-DD date the message was sent in |
| # the dataset's time_zone, from the MSH-7 segment. For example, |
| # `send_date < "2017-01-02"`. |
| # * `send_time`, the timestamp when the message was sent, using the |
| # RFC3339 time format for comparisons, from the MSH-7 segment. For example, |
| # `send_time < "2017-01-02T00:00:00-05:00"`. |
| # * `send_facility`, the care center that the message came from, from the |
| # MSH-4 segment. For example, `send_facility = "ABC"`. |
| # * `PatientId(value, type)`, which matches if the message lists a patient |
| # having an ID of the given value and type in the PID-2, PID-3, or PID-4 |
| # segments. For example, `PatientId("123456", "MRN")`. |
| # * `labels.x`, a string value of the label with key `x` as set using the |
| # Message.labels |
| # map. For example, `labels."priority"="high"`. The operator `:*` can be |
| # used to assert the existence of a label. For example, |
| # `labels."priority":*`. |
| "pubsubTopic": "A String", # The [Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that |
| # notifications of changes are published on. Supplied by the client. The |
| # notification is a `PubsubMessage` with the following fields: |
| # |
| # * `PubsubMessage.Data` contains the resource name. |
| # * `PubsubMessage.MessageId` is the ID of this notification. It is |
| # guaranteed to be unique within the topic. |
| # * `PubsubMessage.PublishTime` is the time when the message was |
| # published. |
| # |
| # Note that notifications are only sent if the topic is non-empty. [Topic |
| # names](https://cloud.google.com/pubsub/docs/overview#names) must be |
| # scoped to a project. Cloud Healthcare API service account must have |
| # publisher permissions on the given Pub/Sub topic. Not having adequate |
| # permissions causes the calls that send notifications to fail. |
| # |
| # If a notification can't be published to Cloud Pub/Sub, errors are |
| # logged to Cloud Logging. For more information, see |
| # [Viewing error logs in Cloud Logging](/healthcare/docs/how-tos/logging). |
| }, |
| ], |
| "rejectDuplicateMessage": True or False, # Determines whether to reject duplicate messages. A duplicate |
| # message is a message with the same raw bytes as a message that has already |
| # been ingested/created in this HL7v2 store. |
| # The default value is false, meaning that the store accepts the duplicate |
| # messages and it also returns the same ACK message in the |
| # IngestMessageResponse as has been returned previously. Note that only |
| # one resource is created in the store. |
| # When this field is set to true, |
| # CreateMessage/IngestMessage |
| # requests with a duplicate message will be rejected by the store, and |
| # IngestMessageErrorDetail returns a NACK message upon rejection. |
| "labels": { # User-supplied key-value pairs used to organize HL7v2 stores. |
| # |
| # Label keys must be between 1 and 63 characters long, have a UTF-8 encoding |
| # of maximum 128 bytes, and must conform to the |
| # following PCRE regular expression: |
| # \p{Ll}\p{Lo}{0,62} |
| # |
| # Label values are optional, must be between 1 and 63 characters long, have |
| # a UTF-8 encoding of maximum 128 bytes, and must conform to the |
| # following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} |
| # |
| # No more than 64 labels can be associated with a given store. |
| "a_key": "A String", |
| }, |
| "notificationConfig": { # Specifies where to send notifications upon changes to a data store. # The notification destination all messages (both Ingest & Create) are |
| # published on. Only the message name is sent as part of the notification. If |
| # this is unset, no notifications are sent. Supplied by the client. |
| "pubsubTopic": "A String", # The [Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that |
| # notifications of changes are published on. Supplied by the client. |
| # PubsubMessage.Data contains the resource name. |
| # PubsubMessage.MessageId is the ID of this message. It is guaranteed to be |
| # unique within the topic. |
| # PubsubMessage.PublishTime is the time at which the message was published. |
| # Notifications are only sent if the topic is |
| # non-empty. [Topic |
| # names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped |
| # to a project. Cloud Healthcare API service account must have publisher |
| # permissions on the given Cloud Pub/Sub topic. Not having adequate |
| # permissions causes the calls that send notifications to fail. |
| # |
| # If a notification can't be published to Cloud Pub/Sub, errors are logged to |
| # Cloud Logging (see [Viewing |
| # logs](/healthcare/docs/how-tos/logging)). If the number of |
| # errors exceeds a certain rate, some aren't submitted. |
| }, |
| "name": "A String", # Resource name of the HL7v2 store, of the form |
| # `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`. |
| "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 |
| # messages. |
| # messages. |
| "allowNullHeader": True or False, # Determines whether messages with no header are allowed. |
| "segmentTerminator": "A String", # Byte(s) to use as the segment terminator. If this is unset, '\r' is |
| # used as segment terminator, matching the HL7 version 2 |
| # specification. |
| "schema": { # A schema package contains a set of schemas and type definitions. # Schemas used to parse messages in this store, if schematized parsing is |
| # desired. |
| "schemas": [ # Schema configs that are layered based on their VersionSources that |
| # match the incoming message. Schema configs present in higher indices |
| # override those in lower indices with the same message type and trigger |
| # event if their VersionSources all match an incoming message. |
| { # Root config message for HL7v2 schema. This contains a schema structure of |
| # groups and segments, and filters that determine which messages to apply the |
| # schema structure to. |
| "messageSchemaConfigs": { # Map from each HL7v2 message type and trigger event pair, such as ADT_A04, |
| # to its schema configuration root group. |
| "a_key": { # An HL7v2 logical group construct. |
| "name": "A String", # The name of this group. For example, "ORDER_DETAIL". |
| "members": [ # Nested groups and/or segments. |
| { # Construct representing a logical group or a segment. |
| "group": # Object with schema name: SchemaGroup |
| "segment": { # An HL7v2 Segment. |
| "type": "A String", # The Segment type. For example, "PID". |
| "minOccurs": 42, # The minimum number of times this segment can be present in this group. |
| "maxOccurs": 42, # The maximum number of times this segment can be present in this group. |
| # 0 or -1 means unbounded. |
| }, |
| }, |
| ], |
| "maxOccurs": 42, # The maximum number of times this group can be repeated. 0 or -1 means |
| # unbounded. |
| "choice": True or False, # True indicates that this is a choice group, meaning that only one of its |
| # segments can exist in a given message. |
| "minOccurs": 42, # The minimum number of times this group must be present/repeated. |
| }, |
| }, |
| "version": [ # Each VersionSource is tested and only if they all match is the schema used |
| # for the message. |
| { # Describes a selector for extracting and matching an MSH field to a value. |
| "mshField": "A String", # The field to extract from the MSH segment. For example, "3.1" or "18[1].1". |
| "value": "A String", # The value to match with the field. For example, "My Application Name" or |
| # "2.3". |
| }, |
| ], |
| }, |
| ], |
| "ignoreMinOccurs": True or False, # Flag to ignore all min_occurs restrictions in the schema. This means that |
| # incoming messages can omit any group, segment, field, component, or |
| # subcomponent. |
| "types": [ # Schema type definitions that are layered based on their VersionSources |
| # that match the incoming message. Type definitions present in higher indices |
| # override those in lower indices with the same type name if their |
| # VersionSources all match an incoming message. |
| { # Root config for HL7v2 datatype definitions for a specific HL7v2 version. |
| "version": [ # The version selectors that this config applies to. A message must match |
| # ALL version sources to apply. |
| { # Describes a selector for extracting and matching an MSH field to a value. |
| "mshField": "A String", # The field to extract from the MSH segment. For example, "3.1" or "18[1].1". |
| "value": "A String", # The value to match with the field. For example, "My Application Name" or |
| # "2.3". |
| }, |
| ], |
| "type": [ # The HL7v2 type definitions. |
| { # A type definition for some HL7v2 type (incl. Segments and Datatypes). |
| "name": "A String", # The name of this type. This would be the segment or datatype name. |
| # For example, "PID" or "XPN". |
| "fields": [ # The (sub) fields this type has (if not primitive). |
| { # A (sub) field of a type. |
| "minOccurs": 42, # The minimum number of times this field must be present/repeated. |
| "table": "A String", # The HL7v2 table this field refers to. For example, PID-15 (Patient's |
| # Primary Language) usually refers to table "0296". |
| "maxOccurs": 42, # The maximum number of times this field can be repeated. 0 or -1 means |
| # unbounded. |
| "name": "A String", # The name of the field. For example, "PID-1" or just "1". |
| "type": "A String", # The type of this field. A Type with this name must be defined in an |
| # Hl7TypesConfig. |
| }, |
| ], |
| "primitive": "A String", # If this is a primitive type then this field is the type of the primitive |
| # For example, STRING. Leave unspecified for composite types. |
| }, |
| ], |
| }, |
| ], |
| "schematizedParsingType": "A String", # Determines how messages that don't parse successfully are handled. |
| }, |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</code> |
| <pre>Gets the access control policy for a resource. |
| Returns an empty policy if the resource exists and does not have a policy |
| set. |
| |
| Args: |
| resource: string, REQUIRED: The resource for which the policy is being requested. |
| See the operation documentation for the appropriate value for this field. (required) |
| options_requestedPolicyVersion: integer, Optional. The policy format version to be returned. |
| |
| Valid values are 0, 1, and 3. Requests specifying an invalid value will be |
| rejected. |
| |
| Requests for policies with any conditional bindings must specify version 3. |
| Policies without any conditional bindings may specify any valid value or |
| leave the field unset. |
| |
| To learn which resources support conditions in their IAM policies, see the |
| [IAM |
| documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # An Identity and Access Management (IAM) policy, which specifies access |
| # controls for Google Cloud resources. |
| # |
| # |
| # A `Policy` is a collection of `bindings`. A `binding` binds one or more |
| # `members` to a single `role`. Members can be user accounts, service accounts, |
| # Google groups, and domains (such as G Suite). A `role` is a named list of |
| # permissions; each `role` can be an IAM predefined role or a user-created |
| # custom role. |
| # |
| # For some types of Google Cloud resources, a `binding` can also specify a |
| # `condition`, which is a logical expression that allows access to a resource |
| # only if the expression evaluates to `true`. A condition can add constraints |
| # based on attributes of the request, the resource, or both. To learn which |
| # resources support conditions in their IAM policies, see the |
| # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| # |
| # **JSON example:** |
| # |
| # { |
| # "bindings": [ |
| # { |
| # "role": "roles/resourcemanager.organizationAdmin", |
| # "members": [ |
| # "user:mike@example.com", |
| # "group:admins@example.com", |
| # "domain:google.com", |
| # "serviceAccount:my-project-id@appspot.gserviceaccount.com" |
| # ] |
| # }, |
| # { |
| # "role": "roles/resourcemanager.organizationViewer", |
| # "members": [ |
| # "user:eve@example.com" |
| # ], |
| # "condition": { |
| # "title": "expirable access", |
| # "description": "Does not grant access after Sep 2020", |
| # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", |
| # } |
| # } |
| # ], |
| # "etag": "BwWWja0YfJA=", |
| # "version": 3 |
| # } |
| # |
| # **YAML example:** |
| # |
| # bindings: |
| # - members: |
| # - user:mike@example.com |
| # - group:admins@example.com |
| # - domain:google.com |
| # - serviceAccount:my-project-id@appspot.gserviceaccount.com |
| # role: roles/resourcemanager.organizationAdmin |
| # - members: |
| # - user:eve@example.com |
| # role: roles/resourcemanager.organizationViewer |
| # condition: |
| # title: expirable access |
| # description: Does not grant access after Sep 2020 |
| # expression: request.time < timestamp('2020-10-01T00:00:00.000Z') |
| # - etag: BwWWja0YfJA= |
| # - version: 3 |
| # |
| # For a description of IAM and its features, see the |
| # [IAM documentation](https://cloud.google.com/iam/docs/). |
| "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a |
| # `condition` that determines how and when the `bindings` are applied. Each |
| # of the `bindings` must contain at least one member. |
| { # Associates `members` with a `role`. |
| "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding. |
| # |
| # If the condition evaluates to `true`, then this binding applies to the |
| # current request. |
| # |
| # If the condition evaluates to `false`, then this binding does not apply to |
| # the current request. However, a different role binding might grant the same |
| # role to one or more of the members in this binding. |
| # |
| # To learn which resources support conditions in their IAM policies, see the |
| # [IAM |
| # documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| # syntax. CEL is a C-like expression language. The syntax and semantics of CEL |
| # are documented at https://github.com/google/cel-spec. |
| # |
| # Example (Comparison): |
| # |
| # title: "Summary size limit" |
| # description: "Determines if a summary is less than 100 chars" |
| # expression: "document.summary.size() < 100" |
| # |
| # Example (Equality): |
| # |
| # title: "Requestor is owner" |
| # description: "Determines if requestor is the document owner" |
| # expression: "document.owner == request.auth.claims.email" |
| # |
| # Example (Logic): |
| # |
| # title: "Public documents" |
| # description: "Determine whether the document should be publicly visible" |
| # expression: "document.type != 'private' && document.type != 'internal'" |
| # |
| # Example (Data Manipulation): |
| # |
| # title: "Notification string" |
| # description: "Create a notification string with a timestamp." |
| # expression: "'New message received at ' + string(document.create_time)" |
| # |
| # The exact variables and functions that may be referenced within an expression |
| # are determined by the service that evaluates it. See the service |
| # documentation for additional information. |
| "title": "A String", # Optional. Title for the expression, i.e. a short string describing |
| # its purpose. This can be used e.g. in UIs which allow to enter the |
| # expression. |
| "description": "A String", # Optional. Description of the expression. This is a longer text which |
| # describes the expression, e.g. when hovered over it in a UI. |
| "expression": "A String", # Textual representation of an expression in Common Expression Language |
| # syntax. |
| "location": "A String", # Optional. String indicating the location of the expression for error |
| # reporting, e.g. a file name and a position in the file. |
| }, |
| "members": [ # Specifies the identities requesting access for a Cloud Platform resource. |
| # `members` can have the following values: |
| # |
| # * `allUsers`: A special identifier that represents anyone who is |
| # on the internet; with or without a Google account. |
| # |
| # * `allAuthenticatedUsers`: A special identifier that represents anyone |
| # who is authenticated with a Google account or a service account. |
| # |
| # * `user:{emailid}`: An email address that represents a specific Google |
| # account. For example, `alice@example.com` . |
| # |
| # |
| # * `serviceAccount:{emailid}`: An email address that represents a service |
| # account. For example, `my-other-app@appspot.gserviceaccount.com`. |
| # |
| # * `group:{emailid}`: An email address that represents a Google group. |
| # For example, `admins@example.com`. |
| # |
| # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique |
| # identifier) representing a user that has been recently deleted. For |
| # example, `alice@example.com?uid=123456789012345678901`. If the user is |
| # recovered, this value reverts to `user:{emailid}` and the recovered user |
| # retains the role in the binding. |
| # |
| # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus |
| # unique identifier) representing a service account that has been recently |
| # deleted. For example, |
| # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. |
| # If the service account is undeleted, this value reverts to |
| # `serviceAccount:{emailid}` and the undeleted service account retains the |
| # role in the binding. |
| # |
| # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique |
| # identifier) representing a Google group that has been recently |
| # deleted. For example, `admins@example.com?uid=123456789012345678901`. If |
| # the group is recovered, this value reverts to `group:{emailid}` and the |
| # recovered group retains the role in the binding. |
| # |
| # |
| # * `domain:{domain}`: The G Suite domain (primary) that represents all the |
| # users of that domain. For example, `google.com` or `example.com`. |
| # |
| "A String", |
| ], |
| "role": "A String", # Role that is assigned to `members`. |
| # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| }, |
| ], |
| "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help |
| # prevent simultaneous updates of a policy from overwriting each other. |
| # It is strongly suggested that systems make use of the `etag` in the |
| # read-modify-write cycle to perform policy updates in order to avoid race |
| # conditions: An `etag` is returned in the response to `getIamPolicy`, and |
| # systems are expected to put that etag in the request to `setIamPolicy` to |
| # ensure that their change will be applied to the same version of the policy. |
| # |
| # **Important:** If you use IAM Conditions, you must include the `etag` field |
| # whenever you call `setIamPolicy`. If you omit this field, then IAM allows |
| # you to overwrite a version `3` policy with a version `1` policy, and all of |
| # the conditions in the version `3` policy are lost. |
| "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. |
| { # Specifies the audit configuration for a service. |
| # The configuration determines which permission types are logged, and what |
| # identities, if any, are exempted from logging. |
| # An AuditConfig must have one or more AuditLogConfigs. |
| # |
| # If there are AuditConfigs for both `allServices` and a specific service, |
| # the union of the two AuditConfigs is used for that service: the log_types |
| # specified in each AuditConfig are enabled, and the exempted_members in each |
| # AuditLogConfig are exempted. |
| # |
| # Example Policy with multiple AuditConfigs: |
| # |
| # { |
| # "audit_configs": [ |
| # { |
| # "service": "allServices", |
| # "audit_log_configs": [ |
| # { |
| # "log_type": "DATA_READ", |
| # "exempted_members": [ |
| # "user:jose@example.com" |
| # ] |
| # }, |
| # { |
| # "log_type": "DATA_WRITE" |
| # }, |
| # { |
| # "log_type": "ADMIN_READ" |
| # } |
| # ] |
| # }, |
| # { |
| # "service": "sampleservice.googleapis.com", |
| # "audit_log_configs": [ |
| # { |
| # "log_type": "DATA_READ" |
| # }, |
| # { |
| # "log_type": "DATA_WRITE", |
| # "exempted_members": [ |
| # "user:aliya@example.com" |
| # ] |
| # } |
| # ] |
| # } |
| # ] |
| # } |
| # |
| # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ |
| # logging. It also exempts jose@example.com from DATA_READ logging, and |
| # aliya@example.com from DATA_WRITE logging. |
| "auditLogConfigs": [ # The configuration for logging of each type of permission. |
| { # Provides the configuration for logging a type of permissions. |
| # Example: |
| # |
| # { |
| # "audit_log_configs": [ |
| # { |
| # "log_type": "DATA_READ", |
| # "exempted_members": [ |
| # "user:jose@example.com" |
| # ] |
| # }, |
| # { |
| # "log_type": "DATA_WRITE" |
| # } |
| # ] |
| # } |
| # |
| # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting |
| # jose@example.com from DATA_READ logging. |
| "logType": "A String", # The log type that this config enables. |
| "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of |
| # permission. |
| # Follows the same format of Binding.members. |
| "A String", |
| ], |
| }, |
| ], |
| "service": "A String", # Specifies a service that will be enabled for audit logging. |
| # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. |
| # `allServices` is a special value that covers all services. |
| }, |
| ], |
| "version": 42, # Specifies the format of the policy. |
| # |
| # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value |
| # are rejected. |
| # |
| # Any operation that affects conditional role bindings must specify version |
| # `3`. This requirement applies to the following operations: |
| # |
| # * Getting a policy that includes a conditional role binding |
| # * Adding a conditional role binding to a policy |
| # * Changing a conditional role binding in a policy |
| # * Removing any role binding, with or without a condition, from a policy |
| # that includes conditions |
| # |
| # **Important:** If you use IAM Conditions, you must include the `etag` field |
| # whenever you call `setIamPolicy`. If you omit this field, then IAM allows |
| # you to overwrite a version `3` policy with a version `1` policy, and all of |
| # the conditions in the version `3` policy are lost. |
| # |
| # If a policy does not include any conditions, operations on that policy may |
| # specify any valid version or leave the field unset. |
| # |
| # To learn which resources support conditions in their IAM policies, see the |
| # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(parent, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code> |
| <pre>Lists the HL7v2 stores in the given dataset. |
| |
| Args: |
| parent: string, Name of the dataset. (required) |
| pageSize: integer, Limit on the number of HL7v2 stores to return in a single response. |
| If zero the default page size of 100 is used. |
| filter: string, Restricts stores returned to those matching a filter. Syntax: |
| https://cloud.google.com/appengine/docs/standard/python/search/query_strings |
| Only filtering on labels is supported. For example, `labels.key=value`. |
| pageToken: string, The next_page_token value returned from the previous List request, if any. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Lists the HL7v2 stores in the given dataset. |
| "hl7V2Stores": [ # The returned HL7v2 stores. Won't be more HL7v2 stores than the value of |
| # page_size in the request. |
| { # Represents an HL7v2 store. |
| "notificationConfigs": [ # A list of notification configs. Each configuration uses a filter to |
| # determine whether to publish a message (both Ingest & Create) on |
| # the corresponding notification destination. Only the message name is sent |
| # as part of the notification. Supplied by the client. |
| { # Specifies where and whether to send notifications upon changes to a |
| # data store. |
| "filter": "A String", # Restricts notifications sent for messages matching a filter. If this is |
| # empty, all messages are matched. Syntax: |
| # https://cloud.google.com/appengine/docs/standard/python/search/query_strings |
| # |
| # The following fields and functions are available for filtering: |
| # |
| # * `message_type`, from the MSH-9.1 field. For example, |
| # `NOT message_type = "ADT"`. |
| # * `send_date` or `sendDate`, the YYYY-MM-DD date the message was sent in |
| # the dataset's time_zone, from the MSH-7 segment. For example, |
| # `send_date < "2017-01-02"`. |
| # * `send_time`, the timestamp when the message was sent, using the |
| # RFC3339 time format for comparisons, from the MSH-7 segment. For example, |
| # `send_time < "2017-01-02T00:00:00-05:00"`. |
| # * `send_facility`, the care center that the message came from, from the |
| # MSH-4 segment. For example, `send_facility = "ABC"`. |
| # * `PatientId(value, type)`, which matches if the message lists a patient |
| # having an ID of the given value and type in the PID-2, PID-3, or PID-4 |
| # segments. For example, `PatientId("123456", "MRN")`. |
| # * `labels.x`, a string value of the label with key `x` as set using the |
| # Message.labels |
| # map. For example, `labels."priority"="high"`. The operator `:*` can be |
| # used to assert the existence of a label. For example, |
| # `labels."priority":*`. |
| "pubsubTopic": "A String", # The [Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that |
| # notifications of changes are published on. Supplied by the client. The |
| # notification is a `PubsubMessage` with the following fields: |
| # |
| # * `PubsubMessage.Data` contains the resource name. |
| # * `PubsubMessage.MessageId` is the ID of this notification. It is |
| # guaranteed to be unique within the topic. |
| # * `PubsubMessage.PublishTime` is the time when the message was |
| # published. |
| # |
| # Note that notifications are only sent if the topic is non-empty. [Topic |
| # names](https://cloud.google.com/pubsub/docs/overview#names) must be |
| # scoped to a project. Cloud Healthcare API service account must have |
| # publisher permissions on the given Pub/Sub topic. Not having adequate |
| # permissions causes the calls that send notifications to fail. |
| # |
| # If a notification can't be published to Cloud Pub/Sub, errors are |
| # logged to Cloud Logging. For more information, see |
| # [Viewing error logs in Cloud Logging](/healthcare/docs/how-tos/logging). |
| }, |
| ], |
| "rejectDuplicateMessage": True or False, # Determines whether to reject duplicate messages. A duplicate |
| # message is a message with the same raw bytes as a message that has already |
| # been ingested/created in this HL7v2 store. |
| # The default value is false, meaning that the store accepts the duplicate |
| # messages and it also returns the same ACK message in the |
| # IngestMessageResponse as has been returned previously. Note that only |
| # one resource is created in the store. |
| # When this field is set to true, |
| # CreateMessage/IngestMessage |
| # requests with a duplicate message will be rejected by the store, and |
| # IngestMessageErrorDetail returns a NACK message upon rejection. |
| "labels": { # User-supplied key-value pairs used to organize HL7v2 stores. |
| # |
| # Label keys must be between 1 and 63 characters long, have a UTF-8 encoding |
| # of maximum 128 bytes, and must conform to the |
| # following PCRE regular expression: |
| # \p{Ll}\p{Lo}{0,62} |
| # |
| # Label values are optional, must be between 1 and 63 characters long, have |
| # a UTF-8 encoding of maximum 128 bytes, and must conform to the |
| # following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} |
| # |
| # No more than 64 labels can be associated with a given store. |
| "a_key": "A String", |
| }, |
| "notificationConfig": { # Specifies where to send notifications upon changes to a data store. # The notification destination all messages (both Ingest & Create) are |
| # published on. Only the message name is sent as part of the notification. If |
| # this is unset, no notifications are sent. Supplied by the client. |
| "pubsubTopic": "A String", # The [Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that |
| # notifications of changes are published on. Supplied by the client. |
| # PubsubMessage.Data contains the resource name. |
| # PubsubMessage.MessageId is the ID of this message. It is guaranteed to be |
| # unique within the topic. |
| # PubsubMessage.PublishTime is the time at which the message was published. |
| # Notifications are only sent if the topic is |
| # non-empty. [Topic |
| # names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped |
| # to a project. Cloud Healthcare API service account must have publisher |
| # permissions on the given Cloud Pub/Sub topic. Not having adequate |
| # permissions causes the calls that send notifications to fail. |
| # |
| # If a notification can't be published to Cloud Pub/Sub, errors are logged to |
| # Cloud Logging (see [Viewing |
| # logs](/healthcare/docs/how-tos/logging)). If the number of |
| # errors exceeds a certain rate, some aren't submitted. |
| }, |
| "name": "A String", # Resource name of the HL7v2 store, of the form |
| # `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`. |
| "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 |
| # messages. |
| # messages. |
| "allowNullHeader": True or False, # Determines whether messages with no header are allowed. |
| "segmentTerminator": "A String", # Byte(s) to use as the segment terminator. If this is unset, '\r' is |
| # used as segment terminator, matching the HL7 version 2 |
| # specification. |
| "schema": { # A schema package contains a set of schemas and type definitions. # Schemas used to parse messages in this store, if schematized parsing is |
| # desired. |
| "schemas": [ # Schema configs that are layered based on their VersionSources that |
| # match the incoming message. Schema configs present in higher indices |
| # override those in lower indices with the same message type and trigger |
| # event if their VersionSources all match an incoming message. |
| { # Root config message for HL7v2 schema. This contains a schema structure of |
| # groups and segments, and filters that determine which messages to apply the |
| # schema structure to. |
| "messageSchemaConfigs": { # Map from each HL7v2 message type and trigger event pair, such as ADT_A04, |
| # to its schema configuration root group. |
| "a_key": { # An HL7v2 logical group construct. |
| "name": "A String", # The name of this group. For example, "ORDER_DETAIL". |
| "members": [ # Nested groups and/or segments. |
| { # Construct representing a logical group or a segment. |
| "group": # Object with schema name: SchemaGroup |
| "segment": { # An HL7v2 Segment. |
| "type": "A String", # The Segment type. For example, "PID". |
| "minOccurs": 42, # The minimum number of times this segment can be present in this group. |
| "maxOccurs": 42, # The maximum number of times this segment can be present in this group. |
| # 0 or -1 means unbounded. |
| }, |
| }, |
| ], |
| "maxOccurs": 42, # The maximum number of times this group can be repeated. 0 or -1 means |
| # unbounded. |
| "choice": True or False, # True indicates that this is a choice group, meaning that only one of its |
| # segments can exist in a given message. |
| "minOccurs": 42, # The minimum number of times this group must be present/repeated. |
| }, |
| }, |
| "version": [ # Each VersionSource is tested and only if they all match is the schema used |
| # for the message. |
| { # Describes a selector for extracting and matching an MSH field to a value. |
| "mshField": "A String", # The field to extract from the MSH segment. For example, "3.1" or "18[1].1". |
| "value": "A String", # The value to match with the field. For example, "My Application Name" or |
| # "2.3". |
| }, |
| ], |
| }, |
| ], |
| "ignoreMinOccurs": True or False, # Flag to ignore all min_occurs restrictions in the schema. This means that |
| # incoming messages can omit any group, segment, field, component, or |
| # subcomponent. |
| "types": [ # Schema type definitions that are layered based on their VersionSources |
| # that match the incoming message. Type definitions present in higher indices |
| # override those in lower indices with the same type name if their |
| # VersionSources all match an incoming message. |
| { # Root config for HL7v2 datatype definitions for a specific HL7v2 version. |
| "version": [ # The version selectors that this config applies to. A message must match |
| # ALL version sources to apply. |
| { # Describes a selector for extracting and matching an MSH field to a value. |
| "mshField": "A String", # The field to extract from the MSH segment. For example, "3.1" or "18[1].1". |
| "value": "A String", # The value to match with the field. For example, "My Application Name" or |
| # "2.3". |
| }, |
| ], |
| "type": [ # The HL7v2 type definitions. |
| { # A type definition for some HL7v2 type (incl. Segments and Datatypes). |
| "name": "A String", # The name of this type. This would be the segment or datatype name. |
| # For example, "PID" or "XPN". |
| "fields": [ # The (sub) fields this type has (if not primitive). |
| { # A (sub) field of a type. |
| "minOccurs": 42, # The minimum number of times this field must be present/repeated. |
| "table": "A String", # The HL7v2 table this field refers to. For example, PID-15 (Patient's |
| # Primary Language) usually refers to table "0296". |
| "maxOccurs": 42, # The maximum number of times this field can be repeated. 0 or -1 means |
| # unbounded. |
| "name": "A String", # The name of the field. For example, "PID-1" or just "1". |
| "type": "A String", # The type of this field. A Type with this name must be defined in an |
| # Hl7TypesConfig. |
| }, |
| ], |
| "primitive": "A String", # If this is a primitive type then this field is the type of the primitive |
| # For example, STRING. Leave unspecified for composite types. |
| }, |
| ], |
| }, |
| ], |
| "schematizedParsingType": "A String", # Determines how messages that don't parse successfully are handled. |
| }, |
| }, |
| }, |
| ], |
| "nextPageToken": "A String", # Token to retrieve the next page of results or empty if there are no more |
| # results in the list. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> |
| <pre>Updates the HL7v2 store. |
| |
| Args: |
| name: string, Resource name of the HL7v2 store, of the form |
| `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Represents an HL7v2 store. |
| "notificationConfigs": [ # A list of notification configs. Each configuration uses a filter to |
| # determine whether to publish a message (both Ingest & Create) on |
| # the corresponding notification destination. Only the message name is sent |
| # as part of the notification. Supplied by the client. |
| { # Specifies where and whether to send notifications upon changes to a |
| # data store. |
| "filter": "A String", # Restricts notifications sent for messages matching a filter. If this is |
| # empty, all messages are matched. Syntax: |
| # https://cloud.google.com/appengine/docs/standard/python/search/query_strings |
| # |
| # The following fields and functions are available for filtering: |
| # |
| # * `message_type`, from the MSH-9.1 field. For example, |
| # `NOT message_type = "ADT"`. |
| # * `send_date` or `sendDate`, the YYYY-MM-DD date the message was sent in |
| # the dataset's time_zone, from the MSH-7 segment. For example, |
| # `send_date < "2017-01-02"`. |
| # * `send_time`, the timestamp when the message was sent, using the |
| # RFC3339 time format for comparisons, from the MSH-7 segment. For example, |
| # `send_time < "2017-01-02T00:00:00-05:00"`. |
| # * `send_facility`, the care center that the message came from, from the |
| # MSH-4 segment. For example, `send_facility = "ABC"`. |
| # * `PatientId(value, type)`, which matches if the message lists a patient |
| # having an ID of the given value and type in the PID-2, PID-3, or PID-4 |
| # segments. For example, `PatientId("123456", "MRN")`. |
| # * `labels.x`, a string value of the label with key `x` as set using the |
| # Message.labels |
| # map. For example, `labels."priority"="high"`. The operator `:*` can be |
| # used to assert the existence of a label. For example, |
| # `labels."priority":*`. |
| "pubsubTopic": "A String", # The [Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that |
| # notifications of changes are published on. Supplied by the client. The |
| # notification is a `PubsubMessage` with the following fields: |
| # |
| # * `PubsubMessage.Data` contains the resource name. |
| # * `PubsubMessage.MessageId` is the ID of this notification. It is |
| # guaranteed to be unique within the topic. |
| # * `PubsubMessage.PublishTime` is the time when the message was |
| # published. |
| # |
| # Note that notifications are only sent if the topic is non-empty. [Topic |
| # names](https://cloud.google.com/pubsub/docs/overview#names) must be |
| # scoped to a project. Cloud Healthcare API service account must have |
| # publisher permissions on the given Pub/Sub topic. Not having adequate |
| # permissions causes the calls that send notifications to fail. |
| # |
| # If a notification can't be published to Cloud Pub/Sub, errors are |
| # logged to Cloud Logging. For more information, see |
| # [Viewing error logs in Cloud Logging](/healthcare/docs/how-tos/logging). |
| }, |
| ], |
| "rejectDuplicateMessage": True or False, # Determines whether to reject duplicate messages. A duplicate |
| # message is a message with the same raw bytes as a message that has already |
| # been ingested/created in this HL7v2 store. |
| # The default value is false, meaning that the store accepts the duplicate |
| # messages and it also returns the same ACK message in the |
| # IngestMessageResponse as has been returned previously. Note that only |
| # one resource is created in the store. |
| # When this field is set to true, |
| # CreateMessage/IngestMessage |
| # requests with a duplicate message will be rejected by the store, and |
| # IngestMessageErrorDetail returns a NACK message upon rejection. |
| "labels": { # User-supplied key-value pairs used to organize HL7v2 stores. |
| # |
| # Label keys must be between 1 and 63 characters long, have a UTF-8 encoding |
| # of maximum 128 bytes, and must conform to the |
| # following PCRE regular expression: |
| # \p{Ll}\p{Lo}{0,62} |
| # |
| # Label values are optional, must be between 1 and 63 characters long, have |
| # a UTF-8 encoding of maximum 128 bytes, and must conform to the |
| # following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} |
| # |
| # No more than 64 labels can be associated with a given store. |
| "a_key": "A String", |
| }, |
| "notificationConfig": { # Specifies where to send notifications upon changes to a data store. # The notification destination all messages (both Ingest & Create) are |
| # published on. Only the message name is sent as part of the notification. If |
| # this is unset, no notifications are sent. Supplied by the client. |
| "pubsubTopic": "A String", # The [Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that |
| # notifications of changes are published on. Supplied by the client. |
| # PubsubMessage.Data contains the resource name. |
| # PubsubMessage.MessageId is the ID of this message. It is guaranteed to be |
| # unique within the topic. |
| # PubsubMessage.PublishTime is the time at which the message was published. |
| # Notifications are only sent if the topic is |
| # non-empty. [Topic |
| # names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped |
| # to a project. Cloud Healthcare API service account must have publisher |
| # permissions on the given Cloud Pub/Sub topic. Not having adequate |
| # permissions causes the calls that send notifications to fail. |
| # |
| # If a notification can't be published to Cloud Pub/Sub, errors are logged to |
| # Cloud Logging (see [Viewing |
| # logs](/healthcare/docs/how-tos/logging)). If the number of |
| # errors exceeds a certain rate, some aren't submitted. |
| }, |
| "name": "A String", # Resource name of the HL7v2 store, of the form |
| # `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`. |
| "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 |
| # messages. |
| # messages. |
| "allowNullHeader": True or False, # Determines whether messages with no header are allowed. |
| "segmentTerminator": "A String", # Byte(s) to use as the segment terminator. If this is unset, '\r' is |
| # used as segment terminator, matching the HL7 version 2 |
| # specification. |
| "schema": { # A schema package contains a set of schemas and type definitions. # Schemas used to parse messages in this store, if schematized parsing is |
| # desired. |
| "schemas": [ # Schema configs that are layered based on their VersionSources that |
| # match the incoming message. Schema configs present in higher indices |
| # override those in lower indices with the same message type and trigger |
| # event if their VersionSources all match an incoming message. |
| { # Root config message for HL7v2 schema. This contains a schema structure of |
| # groups and segments, and filters that determine which messages to apply the |
| # schema structure to. |
| "messageSchemaConfigs": { # Map from each HL7v2 message type and trigger event pair, such as ADT_A04, |
| # to its schema configuration root group. |
| "a_key": { # An HL7v2 logical group construct. |
| "name": "A String", # The name of this group. For example, "ORDER_DETAIL". |
| "members": [ # Nested groups and/or segments. |
| { # Construct representing a logical group or a segment. |
| "group": # Object with schema name: SchemaGroup |
| "segment": { # An HL7v2 Segment. |
| "type": "A String", # The Segment type. For example, "PID". |
| "minOccurs": 42, # The minimum number of times this segment can be present in this group. |
| "maxOccurs": 42, # The maximum number of times this segment can be present in this group. |
| # 0 or -1 means unbounded. |
| }, |
| }, |
| ], |
| "maxOccurs": 42, # The maximum number of times this group can be repeated. 0 or -1 means |
| # unbounded. |
| "choice": True or False, # True indicates that this is a choice group, meaning that only one of its |
| # segments can exist in a given message. |
| "minOccurs": 42, # The minimum number of times this group must be present/repeated. |
| }, |
| }, |
| "version": [ # Each VersionSource is tested and only if they all match is the schema used |
| # for the message. |
| { # Describes a selector for extracting and matching an MSH field to a value. |
| "mshField": "A String", # The field to extract from the MSH segment. For example, "3.1" or "18[1].1". |
| "value": "A String", # The value to match with the field. For example, "My Application Name" or |
| # "2.3". |
| }, |
| ], |
| }, |
| ], |
| "ignoreMinOccurs": True or False, # Flag to ignore all min_occurs restrictions in the schema. This means that |
| # incoming messages can omit any group, segment, field, component, or |
| # subcomponent. |
| "types": [ # Schema type definitions that are layered based on their VersionSources |
| # that match the incoming message. Type definitions present in higher indices |
| # override those in lower indices with the same type name if their |
| # VersionSources all match an incoming message. |
| { # Root config for HL7v2 datatype definitions for a specific HL7v2 version. |
| "version": [ # The version selectors that this config applies to. A message must match |
| # ALL version sources to apply. |
| { # Describes a selector for extracting and matching an MSH field to a value. |
| "mshField": "A String", # The field to extract from the MSH segment. For example, "3.1" or "18[1].1". |
| "value": "A String", # The value to match with the field. For example, "My Application Name" or |
| # "2.3". |
| }, |
| ], |
| "type": [ # The HL7v2 type definitions. |
| { # A type definition for some HL7v2 type (incl. Segments and Datatypes). |
| "name": "A String", # The name of this type. This would be the segment or datatype name. |
| # For example, "PID" or "XPN". |
| "fields": [ # The (sub) fields this type has (if not primitive). |
| { # A (sub) field of a type. |
| "minOccurs": 42, # The minimum number of times this field must be present/repeated. |
| "table": "A String", # The HL7v2 table this field refers to. For example, PID-15 (Patient's |
| # Primary Language) usually refers to table "0296". |
| "maxOccurs": 42, # The maximum number of times this field can be repeated. 0 or -1 means |
| # unbounded. |
| "name": "A String", # The name of the field. For example, "PID-1" or just "1". |
| "type": "A String", # The type of this field. A Type with this name must be defined in an |
| # Hl7TypesConfig. |
| }, |
| ], |
| "primitive": "A String", # If this is a primitive type then this field is the type of the primitive |
| # For example, STRING. Leave unspecified for composite types. |
| }, |
| ], |
| }, |
| ], |
| "schematizedParsingType": "A String", # Determines how messages that don't parse successfully are handled. |
| }, |
| }, |
| } |
| |
| updateMask: string, The update mask applies to the resource. For the `FieldMask` definition, |
| see |
| https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents an HL7v2 store. |
| "notificationConfigs": [ # A list of notification configs. Each configuration uses a filter to |
| # determine whether to publish a message (both Ingest & Create) on |
| # the corresponding notification destination. Only the message name is sent |
| # as part of the notification. Supplied by the client. |
| { # Specifies where and whether to send notifications upon changes to a |
| # data store. |
| "filter": "A String", # Restricts notifications sent for messages matching a filter. If this is |
| # empty, all messages are matched. Syntax: |
| # https://cloud.google.com/appengine/docs/standard/python/search/query_strings |
| # |
| # The following fields and functions are available for filtering: |
| # |
| # * `message_type`, from the MSH-9.1 field. For example, |
| # `NOT message_type = "ADT"`. |
| # * `send_date` or `sendDate`, the YYYY-MM-DD date the message was sent in |
| # the dataset's time_zone, from the MSH-7 segment. For example, |
| # `send_date < "2017-01-02"`. |
| # * `send_time`, the timestamp when the message was sent, using the |
| # RFC3339 time format for comparisons, from the MSH-7 segment. For example, |
| # `send_time < "2017-01-02T00:00:00-05:00"`. |
| # * `send_facility`, the care center that the message came from, from the |
| # MSH-4 segment. For example, `send_facility = "ABC"`. |
| # * `PatientId(value, type)`, which matches if the message lists a patient |
| # having an ID of the given value and type in the PID-2, PID-3, or PID-4 |
| # segments. For example, `PatientId("123456", "MRN")`. |
| # * `labels.x`, a string value of the label with key `x` as set using the |
| # Message.labels |
| # map. For example, `labels."priority"="high"`. The operator `:*` can be |
| # used to assert the existence of a label. For example, |
| # `labels."priority":*`. |
| "pubsubTopic": "A String", # The [Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that |
| # notifications of changes are published on. Supplied by the client. The |
| # notification is a `PubsubMessage` with the following fields: |
| # |
| # * `PubsubMessage.Data` contains the resource name. |
| # * `PubsubMessage.MessageId` is the ID of this notification. It is |
| # guaranteed to be unique within the topic. |
| # * `PubsubMessage.PublishTime` is the time when the message was |
| # published. |
| # |
| # Note that notifications are only sent if the topic is non-empty. [Topic |
| # names](https://cloud.google.com/pubsub/docs/overview#names) must be |
| # scoped to a project. Cloud Healthcare API service account must have |
| # publisher permissions on the given Pub/Sub topic. Not having adequate |
| # permissions causes the calls that send notifications to fail. |
| # |
| # If a notification can't be published to Cloud Pub/Sub, errors are |
| # logged to Cloud Logging. For more information, see |
| # [Viewing error logs in Cloud Logging](/healthcare/docs/how-tos/logging). |
| }, |
| ], |
| "rejectDuplicateMessage": True or False, # Determines whether to reject duplicate messages. A duplicate |
| # message is a message with the same raw bytes as a message that has already |
| # been ingested/created in this HL7v2 store. |
| # The default value is false, meaning that the store accepts the duplicate |
| # messages and it also returns the same ACK message in the |
| # IngestMessageResponse as has been returned previously. Note that only |
| # one resource is created in the store. |
| # When this field is set to true, |
| # CreateMessage/IngestMessage |
| # requests with a duplicate message will be rejected by the store, and |
| # IngestMessageErrorDetail returns a NACK message upon rejection. |
| "labels": { # User-supplied key-value pairs used to organize HL7v2 stores. |
| # |
| # Label keys must be between 1 and 63 characters long, have a UTF-8 encoding |
| # of maximum 128 bytes, and must conform to the |
| # following PCRE regular expression: |
| # \p{Ll}\p{Lo}{0,62} |
| # |
| # Label values are optional, must be between 1 and 63 characters long, have |
| # a UTF-8 encoding of maximum 128 bytes, and must conform to the |
| # following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} |
| # |
| # No more than 64 labels can be associated with a given store. |
| "a_key": "A String", |
| }, |
| "notificationConfig": { # Specifies where to send notifications upon changes to a data store. # The notification destination all messages (both Ingest & Create) are |
| # published on. Only the message name is sent as part of the notification. If |
| # this is unset, no notifications are sent. Supplied by the client. |
| "pubsubTopic": "A String", # The [Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that |
| # notifications of changes are published on. Supplied by the client. |
| # PubsubMessage.Data contains the resource name. |
| # PubsubMessage.MessageId is the ID of this message. It is guaranteed to be |
| # unique within the topic. |
| # PubsubMessage.PublishTime is the time at which the message was published. |
| # Notifications are only sent if the topic is |
| # non-empty. [Topic |
| # names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped |
| # to a project. Cloud Healthcare API service account must have publisher |
| # permissions on the given Cloud Pub/Sub topic. Not having adequate |
| # permissions causes the calls that send notifications to fail. |
| # |
| # If a notification can't be published to Cloud Pub/Sub, errors are logged to |
| # Cloud Logging (see [Viewing |
| # logs](/healthcare/docs/how-tos/logging)). If the number of |
| # errors exceeds a certain rate, some aren't submitted. |
| }, |
| "name": "A String", # Resource name of the HL7v2 store, of the form |
| # `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`. |
| "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 |
| # messages. |
| # messages. |
| "allowNullHeader": True or False, # Determines whether messages with no header are allowed. |
| "segmentTerminator": "A String", # Byte(s) to use as the segment terminator. If this is unset, '\r' is |
| # used as segment terminator, matching the HL7 version 2 |
| # specification. |
| "schema": { # A schema package contains a set of schemas and type definitions. # Schemas used to parse messages in this store, if schematized parsing is |
| # desired. |
| "schemas": [ # Schema configs that are layered based on their VersionSources that |
| # match the incoming message. Schema configs present in higher indices |
| # override those in lower indices with the same message type and trigger |
| # event if their VersionSources all match an incoming message. |
| { # Root config message for HL7v2 schema. This contains a schema structure of |
| # groups and segments, and filters that determine which messages to apply the |
| # schema structure to. |
| "messageSchemaConfigs": { # Map from each HL7v2 message type and trigger event pair, such as ADT_A04, |
| # to its schema configuration root group. |
| "a_key": { # An HL7v2 logical group construct. |
| "name": "A String", # The name of this group. For example, "ORDER_DETAIL". |
| "members": [ # Nested groups and/or segments. |
| { # Construct representing a logical group or a segment. |
| "group": # Object with schema name: SchemaGroup |
| "segment": { # An HL7v2 Segment. |
| "type": "A String", # The Segment type. For example, "PID". |
| "minOccurs": 42, # The minimum number of times this segment can be present in this group. |
| "maxOccurs": 42, # The maximum number of times this segment can be present in this group. |
| # 0 or -1 means unbounded. |
| }, |
| }, |
| ], |
| "maxOccurs": 42, # The maximum number of times this group can be repeated. 0 or -1 means |
| # unbounded. |
| "choice": True or False, # True indicates that this is a choice group, meaning that only one of its |
| # segments can exist in a given message. |
| "minOccurs": 42, # The minimum number of times this group must be present/repeated. |
| }, |
| }, |
| "version": [ # Each VersionSource is tested and only if they all match is the schema used |
| # for the message. |
| { # Describes a selector for extracting and matching an MSH field to a value. |
| "mshField": "A String", # The field to extract from the MSH segment. For example, "3.1" or "18[1].1". |
| "value": "A String", # The value to match with the field. For example, "My Application Name" or |
| # "2.3". |
| }, |
| ], |
| }, |
| ], |
| "ignoreMinOccurs": True or False, # Flag to ignore all min_occurs restrictions in the schema. This means that |
| # incoming messages can omit any group, segment, field, component, or |
| # subcomponent. |
| "types": [ # Schema type definitions that are layered based on their VersionSources |
| # that match the incoming message. Type definitions present in higher indices |
| # override those in lower indices with the same type name if their |
| # VersionSources all match an incoming message. |
| { # Root config for HL7v2 datatype definitions for a specific HL7v2 version. |
| "version": [ # The version selectors that this config applies to. A message must match |
| # ALL version sources to apply. |
| { # Describes a selector for extracting and matching an MSH field to a value. |
| "mshField": "A String", # The field to extract from the MSH segment. For example, "3.1" or "18[1].1". |
| "value": "A String", # The value to match with the field. For example, "My Application Name" or |
| # "2.3". |
| }, |
| ], |
| "type": [ # The HL7v2 type definitions. |
| { # A type definition for some HL7v2 type (incl. Segments and Datatypes). |
| "name": "A String", # The name of this type. This would be the segment or datatype name. |
| # For example, "PID" or "XPN". |
| "fields": [ # The (sub) fields this type has (if not primitive). |
| { # A (sub) field of a type. |
| "minOccurs": 42, # The minimum number of times this field must be present/repeated. |
| "table": "A String", # The HL7v2 table this field refers to. For example, PID-15 (Patient's |
| # Primary Language) usually refers to table "0296". |
| "maxOccurs": 42, # The maximum number of times this field can be repeated. 0 or -1 means |
| # unbounded. |
| "name": "A String", # The name of the field. For example, "PID-1" or just "1". |
| "type": "A String", # The type of this field. A Type with this name must be defined in an |
| # Hl7TypesConfig. |
| }, |
| ], |
| "primitive": "A String", # If this is a primitive type then this field is the type of the primitive |
| # For example, STRING. Leave unspecified for composite types. |
| }, |
| ], |
| }, |
| ], |
| "schematizedParsingType": "A String", # Determines how messages that don't parse successfully are handled. |
| }, |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code> |
| <pre>Sets the access control policy on the specified resource. Replaces any |
| existing policy. |
| |
| Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. |
| |
| Args: |
| resource: string, REQUIRED: The resource for which the policy is being specified. |
| See the operation documentation for the appropriate value for this field. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Request message for `SetIamPolicy` method. |
| "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only |
| # the fields in the mask will be modified. If no mask is provided, the |
| # following default mask is used: |
| # |
| # `paths: "bindings, etag"` |
| "policy": { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the `resource`. The size of |
| # the policy is limited to a few 10s of KB. An empty policy is a |
| # valid policy but certain Cloud Platform services (such as Projects) |
| # might reject them. |
| # controls for Google Cloud resources. |
| # |
| # |
| # A `Policy` is a collection of `bindings`. A `binding` binds one or more |
| # `members` to a single `role`. Members can be user accounts, service accounts, |
| # Google groups, and domains (such as G Suite). A `role` is a named list of |
| # permissions; each `role` can be an IAM predefined role or a user-created |
| # custom role. |
| # |
| # For some types of Google Cloud resources, a `binding` can also specify a |
| # `condition`, which is a logical expression that allows access to a resource |
| # only if the expression evaluates to `true`. A condition can add constraints |
| # based on attributes of the request, the resource, or both. To learn which |
| # resources support conditions in their IAM policies, see the |
| # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| # |
| # **JSON example:** |
| # |
| # { |
| # "bindings": [ |
| # { |
| # "role": "roles/resourcemanager.organizationAdmin", |
| # "members": [ |
| # "user:mike@example.com", |
| # "group:admins@example.com", |
| # "domain:google.com", |
| # "serviceAccount:my-project-id@appspot.gserviceaccount.com" |
| # ] |
| # }, |
| # { |
| # "role": "roles/resourcemanager.organizationViewer", |
| # "members": [ |
| # "user:eve@example.com" |
| # ], |
| # "condition": { |
| # "title": "expirable access", |
| # "description": "Does not grant access after Sep 2020", |
| # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", |
| # } |
| # } |
| # ], |
| # "etag": "BwWWja0YfJA=", |
| # "version": 3 |
| # } |
| # |
| # **YAML example:** |
| # |
| # bindings: |
| # - members: |
| # - user:mike@example.com |
| # - group:admins@example.com |
| # - domain:google.com |
| # - serviceAccount:my-project-id@appspot.gserviceaccount.com |
| # role: roles/resourcemanager.organizationAdmin |
| # - members: |
| # - user:eve@example.com |
| # role: roles/resourcemanager.organizationViewer |
| # condition: |
| # title: expirable access |
| # description: Does not grant access after Sep 2020 |
| # expression: request.time < timestamp('2020-10-01T00:00:00.000Z') |
| # - etag: BwWWja0YfJA= |
| # - version: 3 |
| # |
| # For a description of IAM and its features, see the |
| # [IAM documentation](https://cloud.google.com/iam/docs/). |
| "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a |
| # `condition` that determines how and when the `bindings` are applied. Each |
| # of the `bindings` must contain at least one member. |
| { # Associates `members` with a `role`. |
| "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding. |
| # |
| # If the condition evaluates to `true`, then this binding applies to the |
| # current request. |
| # |
| # If the condition evaluates to `false`, then this binding does not apply to |
| # the current request. However, a different role binding might grant the same |
| # role to one or more of the members in this binding. |
| # |
| # To learn which resources support conditions in their IAM policies, see the |
| # [IAM |
| # documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| # syntax. CEL is a C-like expression language. The syntax and semantics of CEL |
| # are documented at https://github.com/google/cel-spec. |
| # |
| # Example (Comparison): |
| # |
| # title: "Summary size limit" |
| # description: "Determines if a summary is less than 100 chars" |
| # expression: "document.summary.size() < 100" |
| # |
| # Example (Equality): |
| # |
| # title: "Requestor is owner" |
| # description: "Determines if requestor is the document owner" |
| # expression: "document.owner == request.auth.claims.email" |
| # |
| # Example (Logic): |
| # |
| # title: "Public documents" |
| # description: "Determine whether the document should be publicly visible" |
| # expression: "document.type != 'private' && document.type != 'internal'" |
| # |
| # Example (Data Manipulation): |
| # |
| # title: "Notification string" |
| # description: "Create a notification string with a timestamp." |
| # expression: "'New message received at ' + string(document.create_time)" |
| # |
| # The exact variables and functions that may be referenced within an expression |
| # are determined by the service that evaluates it. See the service |
| # documentation for additional information. |
| "title": "A String", # Optional. Title for the expression, i.e. a short string describing |
| # its purpose. This can be used e.g. in UIs which allow to enter the |
| # expression. |
| "description": "A String", # Optional. Description of the expression. This is a longer text which |
| # describes the expression, e.g. when hovered over it in a UI. |
| "expression": "A String", # Textual representation of an expression in Common Expression Language |
| # syntax. |
| "location": "A String", # Optional. String indicating the location of the expression for error |
| # reporting, e.g. a file name and a position in the file. |
| }, |
| "members": [ # Specifies the identities requesting access for a Cloud Platform resource. |
| # `members` can have the following values: |
| # |
| # * `allUsers`: A special identifier that represents anyone who is |
| # on the internet; with or without a Google account. |
| # |
| # * `allAuthenticatedUsers`: A special identifier that represents anyone |
| # who is authenticated with a Google account or a service account. |
| # |
| # * `user:{emailid}`: An email address that represents a specific Google |
| # account. For example, `alice@example.com` . |
| # |
| # |
| # * `serviceAccount:{emailid}`: An email address that represents a service |
| # account. For example, `my-other-app@appspot.gserviceaccount.com`. |
| # |
| # * `group:{emailid}`: An email address that represents a Google group. |
| # For example, `admins@example.com`. |
| # |
| # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique |
| # identifier) representing a user that has been recently deleted. For |
| # example, `alice@example.com?uid=123456789012345678901`. If the user is |
| # recovered, this value reverts to `user:{emailid}` and the recovered user |
| # retains the role in the binding. |
| # |
| # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus |
| # unique identifier) representing a service account that has been recently |
| # deleted. For example, |
| # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. |
| # If the service account is undeleted, this value reverts to |
| # `serviceAccount:{emailid}` and the undeleted service account retains the |
| # role in the binding. |
| # |
| # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique |
| # identifier) representing a Google group that has been recently |
| # deleted. For example, `admins@example.com?uid=123456789012345678901`. If |
| # the group is recovered, this value reverts to `group:{emailid}` and the |
| # recovered group retains the role in the binding. |
| # |
| # |
| # * `domain:{domain}`: The G Suite domain (primary) that represents all the |
| # users of that domain. For example, `google.com` or `example.com`. |
| # |
| "A String", |
| ], |
| "role": "A String", # Role that is assigned to `members`. |
| # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| }, |
| ], |
| "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help |
| # prevent simultaneous updates of a policy from overwriting each other. |
| # It is strongly suggested that systems make use of the `etag` in the |
| # read-modify-write cycle to perform policy updates in order to avoid race |
| # conditions: An `etag` is returned in the response to `getIamPolicy`, and |
| # systems are expected to put that etag in the request to `setIamPolicy` to |
| # ensure that their change will be applied to the same version of the policy. |
| # |
| # **Important:** If you use IAM Conditions, you must include the `etag` field |
| # whenever you call `setIamPolicy`. If you omit this field, then IAM allows |
| # you to overwrite a version `3` policy with a version `1` policy, and all of |
| # the conditions in the version `3` policy are lost. |
| "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. |
| { # Specifies the audit configuration for a service. |
| # The configuration determines which permission types are logged, and what |
| # identities, if any, are exempted from logging. |
| # An AuditConfig must have one or more AuditLogConfigs. |
| # |
| # If there are AuditConfigs for both `allServices` and a specific service, |
| # the union of the two AuditConfigs is used for that service: the log_types |
| # specified in each AuditConfig are enabled, and the exempted_members in each |
| # AuditLogConfig are exempted. |
| # |
| # Example Policy with multiple AuditConfigs: |
| # |
| # { |
| # "audit_configs": [ |
| # { |
| # "service": "allServices", |
| # "audit_log_configs": [ |
| # { |
| # "log_type": "DATA_READ", |
| # "exempted_members": [ |
| # "user:jose@example.com" |
| # ] |
| # }, |
| # { |
| # "log_type": "DATA_WRITE" |
| # }, |
| # { |
| # "log_type": "ADMIN_READ" |
| # } |
| # ] |
| # }, |
| # { |
| # "service": "sampleservice.googleapis.com", |
| # "audit_log_configs": [ |
| # { |
| # "log_type": "DATA_READ" |
| # }, |
| # { |
| # "log_type": "DATA_WRITE", |
| # "exempted_members": [ |
| # "user:aliya@example.com" |
| # ] |
| # } |
| # ] |
| # } |
| # ] |
| # } |
| # |
| # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ |
| # logging. It also exempts jose@example.com from DATA_READ logging, and |
| # aliya@example.com from DATA_WRITE logging. |
| "auditLogConfigs": [ # The configuration for logging of each type of permission. |
| { # Provides the configuration for logging a type of permissions. |
| # Example: |
| # |
| # { |
| # "audit_log_configs": [ |
| # { |
| # "log_type": "DATA_READ", |
| # "exempted_members": [ |
| # "user:jose@example.com" |
| # ] |
| # }, |
| # { |
| # "log_type": "DATA_WRITE" |
| # } |
| # ] |
| # } |
| # |
| # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting |
| # jose@example.com from DATA_READ logging. |
| "logType": "A String", # The log type that this config enables. |
| "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of |
| # permission. |
| # Follows the same format of Binding.members. |
| "A String", |
| ], |
| }, |
| ], |
| "service": "A String", # Specifies a service that will be enabled for audit logging. |
| # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. |
| # `allServices` is a special value that covers all services. |
| }, |
| ], |
| "version": 42, # Specifies the format of the policy. |
| # |
| # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value |
| # are rejected. |
| # |
| # Any operation that affects conditional role bindings must specify version |
| # `3`. This requirement applies to the following operations: |
| # |
| # * Getting a policy that includes a conditional role binding |
| # * Adding a conditional role binding to a policy |
| # * Changing a conditional role binding in a policy |
| # * Removing any role binding, with or without a condition, from a policy |
| # that includes conditions |
| # |
| # **Important:** If you use IAM Conditions, you must include the `etag` field |
| # whenever you call `setIamPolicy`. If you omit this field, then IAM allows |
| # you to overwrite a version `3` policy with a version `1` policy, and all of |
| # the conditions in the version `3` policy are lost. |
| # |
| # If a policy does not include any conditions, operations on that policy may |
| # specify any valid version or leave the field unset. |
| # |
| # To learn which resources support conditions in their IAM policies, see the |
| # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| }, |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # An Identity and Access Management (IAM) policy, which specifies access |
| # controls for Google Cloud resources. |
| # |
| # |
| # A `Policy` is a collection of `bindings`. A `binding` binds one or more |
| # `members` to a single `role`. Members can be user accounts, service accounts, |
| # Google groups, and domains (such as G Suite). A `role` is a named list of |
| # permissions; each `role` can be an IAM predefined role or a user-created |
| # custom role. |
| # |
| # For some types of Google Cloud resources, a `binding` can also specify a |
| # `condition`, which is a logical expression that allows access to a resource |
| # only if the expression evaluates to `true`. A condition can add constraints |
| # based on attributes of the request, the resource, or both. To learn which |
| # resources support conditions in their IAM policies, see the |
| # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| # |
| # **JSON example:** |
| # |
| # { |
| # "bindings": [ |
| # { |
| # "role": "roles/resourcemanager.organizationAdmin", |
| # "members": [ |
| # "user:mike@example.com", |
| # "group:admins@example.com", |
| # "domain:google.com", |
| # "serviceAccount:my-project-id@appspot.gserviceaccount.com" |
| # ] |
| # }, |
| # { |
| # "role": "roles/resourcemanager.organizationViewer", |
| # "members": [ |
| # "user:eve@example.com" |
| # ], |
| # "condition": { |
| # "title": "expirable access", |
| # "description": "Does not grant access after Sep 2020", |
| # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", |
| # } |
| # } |
| # ], |
| # "etag": "BwWWja0YfJA=", |
| # "version": 3 |
| # } |
| # |
| # **YAML example:** |
| # |
| # bindings: |
| # - members: |
| # - user:mike@example.com |
| # - group:admins@example.com |
| # - domain:google.com |
| # - serviceAccount:my-project-id@appspot.gserviceaccount.com |
| # role: roles/resourcemanager.organizationAdmin |
| # - members: |
| # - user:eve@example.com |
| # role: roles/resourcemanager.organizationViewer |
| # condition: |
| # title: expirable access |
| # description: Does not grant access after Sep 2020 |
| # expression: request.time < timestamp('2020-10-01T00:00:00.000Z') |
| # - etag: BwWWja0YfJA= |
| # - version: 3 |
| # |
| # For a description of IAM and its features, see the |
| # [IAM documentation](https://cloud.google.com/iam/docs/). |
| "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a |
| # `condition` that determines how and when the `bindings` are applied. Each |
| # of the `bindings` must contain at least one member. |
| { # Associates `members` with a `role`. |
| "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding. |
| # |
| # If the condition evaluates to `true`, then this binding applies to the |
| # current request. |
| # |
| # If the condition evaluates to `false`, then this binding does not apply to |
| # the current request. However, a different role binding might grant the same |
| # role to one or more of the members in this binding. |
| # |
| # To learn which resources support conditions in their IAM policies, see the |
| # [IAM |
| # documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| # syntax. CEL is a C-like expression language. The syntax and semantics of CEL |
| # are documented at https://github.com/google/cel-spec. |
| # |
| # Example (Comparison): |
| # |
| # title: "Summary size limit" |
| # description: "Determines if a summary is less than 100 chars" |
| # expression: "document.summary.size() < 100" |
| # |
| # Example (Equality): |
| # |
| # title: "Requestor is owner" |
| # description: "Determines if requestor is the document owner" |
| # expression: "document.owner == request.auth.claims.email" |
| # |
| # Example (Logic): |
| # |
| # title: "Public documents" |
| # description: "Determine whether the document should be publicly visible" |
| # expression: "document.type != 'private' && document.type != 'internal'" |
| # |
| # Example (Data Manipulation): |
| # |
| # title: "Notification string" |
| # description: "Create a notification string with a timestamp." |
| # expression: "'New message received at ' + string(document.create_time)" |
| # |
| # The exact variables and functions that may be referenced within an expression |
| # are determined by the service that evaluates it. See the service |
| # documentation for additional information. |
| "title": "A String", # Optional. Title for the expression, i.e. a short string describing |
| # its purpose. This can be used e.g. in UIs which allow to enter the |
| # expression. |
| "description": "A String", # Optional. Description of the expression. This is a longer text which |
| # describes the expression, e.g. when hovered over it in a UI. |
| "expression": "A String", # Textual representation of an expression in Common Expression Language |
| # syntax. |
| "location": "A String", # Optional. String indicating the location of the expression for error |
| # reporting, e.g. a file name and a position in the file. |
| }, |
| "members": [ # Specifies the identities requesting access for a Cloud Platform resource. |
| # `members` can have the following values: |
| # |
| # * `allUsers`: A special identifier that represents anyone who is |
| # on the internet; with or without a Google account. |
| # |
| # * `allAuthenticatedUsers`: A special identifier that represents anyone |
| # who is authenticated with a Google account or a service account. |
| # |
| # * `user:{emailid}`: An email address that represents a specific Google |
| # account. For example, `alice@example.com` . |
| # |
| # |
| # * `serviceAccount:{emailid}`: An email address that represents a service |
| # account. For example, `my-other-app@appspot.gserviceaccount.com`. |
| # |
| # * `group:{emailid}`: An email address that represents a Google group. |
| # For example, `admins@example.com`. |
| # |
| # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique |
| # identifier) representing a user that has been recently deleted. For |
| # example, `alice@example.com?uid=123456789012345678901`. If the user is |
| # recovered, this value reverts to `user:{emailid}` and the recovered user |
| # retains the role in the binding. |
| # |
| # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus |
| # unique identifier) representing a service account that has been recently |
| # deleted. For example, |
| # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. |
| # If the service account is undeleted, this value reverts to |
| # `serviceAccount:{emailid}` and the undeleted service account retains the |
| # role in the binding. |
| # |
| # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique |
| # identifier) representing a Google group that has been recently |
| # deleted. For example, `admins@example.com?uid=123456789012345678901`. If |
| # the group is recovered, this value reverts to `group:{emailid}` and the |
| # recovered group retains the role in the binding. |
| # |
| # |
| # * `domain:{domain}`: The G Suite domain (primary) that represents all the |
| # users of that domain. For example, `google.com` or `example.com`. |
| # |
| "A String", |
| ], |
| "role": "A String", # Role that is assigned to `members`. |
| # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| }, |
| ], |
| "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help |
| # prevent simultaneous updates of a policy from overwriting each other. |
| # It is strongly suggested that systems make use of the `etag` in the |
| # read-modify-write cycle to perform policy updates in order to avoid race |
| # conditions: An `etag` is returned in the response to `getIamPolicy`, and |
| # systems are expected to put that etag in the request to `setIamPolicy` to |
| # ensure that their change will be applied to the same version of the policy. |
| # |
| # **Important:** If you use IAM Conditions, you must include the `etag` field |
| # whenever you call `setIamPolicy`. If you omit this field, then IAM allows |
| # you to overwrite a version `3` policy with a version `1` policy, and all of |
| # the conditions in the version `3` policy are lost. |
| "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. |
| { # Specifies the audit configuration for a service. |
| # The configuration determines which permission types are logged, and what |
| # identities, if any, are exempted from logging. |
| # An AuditConfig must have one or more AuditLogConfigs. |
| # |
| # If there are AuditConfigs for both `allServices` and a specific service, |
| # the union of the two AuditConfigs is used for that service: the log_types |
| # specified in each AuditConfig are enabled, and the exempted_members in each |
| # AuditLogConfig are exempted. |
| # |
| # Example Policy with multiple AuditConfigs: |
| # |
| # { |
| # "audit_configs": [ |
| # { |
| # "service": "allServices", |
| # "audit_log_configs": [ |
| # { |
| # "log_type": "DATA_READ", |
| # "exempted_members": [ |
| # "user:jose@example.com" |
| # ] |
| # }, |
| # { |
| # "log_type": "DATA_WRITE" |
| # }, |
| # { |
| # "log_type": "ADMIN_READ" |
| # } |
| # ] |
| # }, |
| # { |
| # "service": "sampleservice.googleapis.com", |
| # "audit_log_configs": [ |
| # { |
| # "log_type": "DATA_READ" |
| # }, |
| # { |
| # "log_type": "DATA_WRITE", |
| # "exempted_members": [ |
| # "user:aliya@example.com" |
| # ] |
| # } |
| # ] |
| # } |
| # ] |
| # } |
| # |
| # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ |
| # logging. It also exempts jose@example.com from DATA_READ logging, and |
| # aliya@example.com from DATA_WRITE logging. |
| "auditLogConfigs": [ # The configuration for logging of each type of permission. |
| { # Provides the configuration for logging a type of permissions. |
| # Example: |
| # |
| # { |
| # "audit_log_configs": [ |
| # { |
| # "log_type": "DATA_READ", |
| # "exempted_members": [ |
| # "user:jose@example.com" |
| # ] |
| # }, |
| # { |
| # "log_type": "DATA_WRITE" |
| # } |
| # ] |
| # } |
| # |
| # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting |
| # jose@example.com from DATA_READ logging. |
| "logType": "A String", # The log type that this config enables. |
| "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of |
| # permission. |
| # Follows the same format of Binding.members. |
| "A String", |
| ], |
| }, |
| ], |
| "service": "A String", # Specifies a service that will be enabled for audit logging. |
| # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. |
| # `allServices` is a special value that covers all services. |
| }, |
| ], |
| "version": 42, # Specifies the format of the policy. |
| # |
| # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value |
| # are rejected. |
| # |
| # Any operation that affects conditional role bindings must specify version |
| # `3`. This requirement applies to the following operations: |
| # |
| # * Getting a policy that includes a conditional role binding |
| # * Adding a conditional role binding to a policy |
| # * Changing a conditional role binding in a policy |
| # * Removing any role binding, with or without a condition, from a policy |
| # that includes conditions |
| # |
| # **Important:** If you use IAM Conditions, you must include the `etag` field |
| # whenever you call `setIamPolicy`. If you omit this field, then IAM allows |
| # you to overwrite a version `3` policy with a version `1` policy, and all of |
| # the conditions in the version `3` policy are lost. |
| # |
| # If a policy does not include any conditions, operations on that policy may |
| # specify any valid version or leave the field unset. |
| # |
| # To learn which resources support conditions in their IAM policies, see the |
| # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code> |
| <pre>Returns permissions that a caller has on the specified resource. |
| If the resource does not exist, this will return an empty set of |
| permissions, not a `NOT_FOUND` error. |
| |
| Note: This operation is designed to be used for building permission-aware |
| UIs and command-line tools, not for authorization checking. This operation |
| may "fail open" without warning. |
| |
| Args: |
| resource: string, REQUIRED: The resource for which the policy detail is being requested. |
| See the operation documentation for the appropriate value for this field. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Request message for `TestIamPermissions` method. |
| "permissions": [ # The set of permissions to check for the `resource`. Permissions with |
| # wildcards (such as '*' or 'storage.*') are not allowed. For more |
| # information see |
| # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). |
| "A String", |
| ], |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response message for `TestIamPermissions` method. |
| "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is |
| # allowed. |
| "A String", |
| ], |
| }</pre> |
| </div> |
| |
| </body></html> |
