Creates a new HL7v2 store within the parent dataset.
Scopes
You will need authorization for at least one of the following scopes to make a valid call:
- https://www.googleapis.com/auth/cloud-healthcare
- https://www.googleapis.com/auth/cloud-platform
If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-healthcare.
You can set the scope for this method like this: healthcare1-beta1 --scope <scope> projects locations-datasets-hl7-v2-stores-create ...
Required Scalar Argument
- <parent> (string)
- Required. The name of the dataset this HL7v2 store belongs to.
Required Request Value
The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.
For example, a structure like this:
Hl7V2Store:
labels: { string: string }
name: string
notification-config:
pubsub-topic: string
send-for-bulk-import: boolean
parser-config:
allow-null-header: boolean
schema:
ignore-min-occurs: boolean
schematized-parsing-type: string
unexpected-segment-handling: string
segment-terminator: string
version: string
reject-duplicate-message: boolean
can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.
-r . labels=key=ipsum
- 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.
- the value will be associated with the given
key
name=invidunt
- Identifier. Resource name of the HL7v2 store, of the form
projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}
.
- Identifier. Resource name of the HL7v2 store, of the form
notification-config pubsub-topic=stet
- The Pub/Sub 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 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 Pub/Sub, errors are logged to Cloud Logging (see Viewing error logs in Cloud Logging). If the number of errors exceeds a certain rate, some aren't submitted. Note that not all operations trigger notifications, see Configuring Pub/Sub notifications for specific details.
-
send-for-bulk-import=false
- Indicates whether or not to send Pub/Sub notifications on bulk import. Only supported for DICOM imports.
-
..parser-config allow-null-header=false
- Determines whether messages with no header are allowed.
schema ignore-min-occurs=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.
schematized-parsing-type=amet
- Determines how messages that fail to parse are handled.
-
unexpected-segment-handling=at
- Determines how unexpected segments (segments not matched to the schema) are handled.
-
.. segment-terminator=eirmod
- Byte(s) to use as the segment terminator. If this is unset, '\r' is used as segment terminator, matching the HL7 version 2 specification.
-
version=erat
- Immutable. Determines the version of both the default parser to be used when
schema
is not given, as well as the schematized parser used whenschema
is specified. This field is immutable after HL7v2 store creation.
- Immutable. Determines the version of both the default parser to be used when
-
.. reject-duplicate-message=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.
About Cursors
The cursor position is key to comfortably set complex nested structures. The following rules apply:
- The cursor position is always set relative to the current one, unless the field name starts with the
.
character. Fields can be nested such as in-r f.s.o
. - The cursor position is set relative to the top-level structure if it starts with
.
, e.g.-r .s.s
- You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify
-r struct.sub_struct=bar
. - You can move the cursor one level up by using
..
. Each additional.
moves it up one additional level. E.g....
would go three levels up.
Optional Output Flags
The method's return value a JSON encoded structure, which will be written to standard output by default.
- -o out
- out specifies the destination to which to write the server's result to.
It will be a JSON-encoded structure.
The destination may be
-
to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.
- out specifies the destination to which to write the server's result to.
It will be a JSON-encoded structure.
The destination may be
Optional Method Properties
You may set the following properties to further configure the call. Please note that -p
is followed by one
or more key-value-pairs, and is called like this -p k1=v1 k2=v2
even though the listing below repeats the
-p
for completeness.
- -p hl7-v2-store-id=string
- Required. The ID of the HL7v2 store that is being created. The string must match the following regex:
[\p{L}\p{N}_\-\.]{1,256}
.
- Required. The ID of the HL7v2 store that is being created. The string must match the following regex:
Optional General Properties
The following properties can configure any call, and are not specific to this method.
-
-p $-xgafv=string
- V1 error format.
-
-p access-token=string
- OAuth access token.
-
-p alt=string
- Data format for response.
-
-p callback=string
- JSONP
-
-p fields=string
- Selector specifying which fields to include in a partial response.
-
-p key=string
- API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
-
-p oauth-token=string
- OAuth 2.0 token for the current user.
-
-p pretty-print=boolean
- Returns response with indentations and line breaks.
-
-p quota-user=string
- Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
-
-p upload-type=string
- Legacy upload protocol for media (e.g. "media", "multipart").
-
-p upload-protocol=string
- Upload protocol for media (e.g. "raw", "multipart").