Documentation ¶
Overview ¶
Copyright 2022 Google LLC. All Rights Reserved.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. Package alpha defines operations in the declarative SDK.
Copyright 2022 Google LLC. All Rights Reserved.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Copyright 2022 Google LLC. All Rights Reserved.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Copyright 2022 Google LLC. All Rights Reserved.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Copyright 2022 Google LLC. All Rights Reserved.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Copyright 2022 Google LLC. All Rights Reserved.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Copyright 2022 Google LLC. All Rights Reserved.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Copyright 2022 Google LLC. All Rights Reserved.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Copyright 2022 Google LLC. All Rights Reserved.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Copyright 2022 Google LLC. All Rights Reserved.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Index ¶
- Constants
- Variables
- func DCLDatasetSchema() *dcl.Schema
- func DCLDicomStoreSchema() *dcl.Schema
- func DCLFhirStoreSchema() *dcl.Schema
- type Client
- func (c *Client) ApplyDataset(ctx context.Context, rawDesired *Dataset, opts ...dcl.ApplyOption) (*Dataset, error)
- func (c *Client) ApplyDicomStore(ctx context.Context, rawDesired *DicomStore, opts ...dcl.ApplyOption) (*DicomStore, error)
- func (c *Client) ApplyFhirStore(ctx context.Context, rawDesired *FhirStore, opts ...dcl.ApplyOption) (*FhirStore, error)
- func (c *Client) DeleteAllDataset(ctx context.Context, project, location string, filter func(*Dataset) bool) error
- func (c *Client) DeleteAllDicomStore(ctx context.Context, project, location, dataset string, ...) error
- func (c *Client) DeleteAllFhirStore(ctx context.Context, project, location, dataset string, ...) error
- func (c *Client) DeleteDataset(ctx context.Context, r *Dataset) error
- func (c *Client) DeleteDicomStore(ctx context.Context, r *DicomStore) error
- func (c *Client) DeleteFhirStore(ctx context.Context, r *FhirStore) error
- func (c *Client) GetDataset(ctx context.Context, r *Dataset) (*Dataset, error)
- func (c *Client) GetDicomStore(ctx context.Context, r *DicomStore) (*DicomStore, error)
- func (c *Client) GetFhirStore(ctx context.Context, r *FhirStore) (*FhirStore, error)
- func (c *Client) ListDataset(ctx context.Context, project, location string) (*DatasetList, error)
- func (c *Client) ListDatasetWithMaxResults(ctx context.Context, project, location string, pageSize int32) (*DatasetList, error)
- func (c *Client) ListDicomStore(ctx context.Context, project, location, dataset string) (*DicomStoreList, error)
- func (c *Client) ListDicomStoreWithMaxResults(ctx context.Context, project, location, dataset string, pageSize int32) (*DicomStoreList, error)
- func (c *Client) ListFhirStore(ctx context.Context, project, location, dataset string) (*FhirStoreList, error)
- func (c *Client) ListFhirStoreWithMaxResults(ctx context.Context, project, location, dataset string, pageSize int32) (*FhirStoreList, error)
- type Dataset
- type DatasetList
- type DicomStore
- type DicomStoreList
- type DicomStoreNotificationConfig
- type FhirStore
- type FhirStoreComplexDataTypeReferenceParsingEnum
- type FhirStoreList
- type FhirStoreNotificationConfig
- type FhirStoreStreamConfigs
- type FhirStoreStreamConfigsBigqueryDestination
- type FhirStoreStreamConfigsBigqueryDestinationSchemaConfig
- func (r *FhirStoreStreamConfigsBigqueryDestinationSchemaConfig) Empty() bool
- func (r *FhirStoreStreamConfigsBigqueryDestinationSchemaConfig) HashCode() string
- func (r *FhirStoreStreamConfigsBigqueryDestinationSchemaConfig) String() string
- func (r *FhirStoreStreamConfigsBigqueryDestinationSchemaConfig) UnmarshalJSON(data []byte) error
- type FhirStoreStreamConfigsBigqueryDestinationSchemaConfigSchemaTypeEnum
- type FhirStoreValidationConfig
- type FhirStoreVersionEnum
Constants ¶
const DatasetMaxPage = -1
const DicomStoreMaxPage = -1
const FhirStoreMaxPage = -1
Variables ¶
var YAML_dataset = []byte("info:\n title: Healthcare/Dataset\n description: The Healthcare Dataset resource\n x-dcl-struct-name: Dataset\n x-dcl-has-iam: false\npaths:\n get:\n description: The function used to get information about a Dataset\n parameters:\n - name: dataset\n required: true\n description: A full instance of a Dataset\n apply:\n description: The function used to apply information about a Dataset\n parameters:\n - name: dataset\n required: true\n description: A full instance of a Dataset\n delete:\n description: The function used to delete a Dataset\n parameters:\n - name: dataset\n required: true\n description: A full instance of a Dataset\n deleteAll:\n description: The function used to delete all Dataset\n parameters:\n - name: project\n required: true\n schema:\n type: string\n - name: location\n required: true\n schema:\n type: string\n list:\n description: The function used to list information about many Dataset\n parameters:\n - name: project\n required: true\n schema:\n type: string\n - name: location\n required: true\n schema:\n type: string\ncomponents:\n schemas:\n Dataset:\n title: Dataset\n x-dcl-id: projects/{{project}}/locations/{{location}}/datasets/{{name}}\n x-dcl-parent-container: project\n x-dcl-has-create: true\n x-dcl-has-iam: false\n x-dcl-read-timeout: 0\n x-dcl-apply-timeout: 0\n x-dcl-delete-timeout: 0\n type: object\n required:\n - name\n - project\n - location\n properties:\n location:\n type: string\n x-dcl-go-name: Location\n description: The location for the resource\n x-kubernetes-immutable: true\n name:\n type: string\n x-dcl-go-name: Name\n description: Resource name of the dataset, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`.\n x-kubernetes-immutable: true\n project:\n type: string\n x-dcl-go-name: Project\n description: The project for the resource\n x-kubernetes-immutable: true\n x-dcl-references:\n - resource: Cloudresourcemanager/Project\n field: name\n parent: true\n timeZone:\n type: string\n x-dcl-go-name: TimeZone\n description: The default timezone used by this dataset. Must be a either\n a valid IANA time zone name such as \"America/New_York\" or empty, which\n defaults to UTC. This is used for parsing times in resources, such as\n HL7v2 messages, where no explicit timezone is specified.\n")
blaze-out/k8-fastbuild/genfiles/cloud/graphite/mmv2/services/google/healthcare/alpha/dataset.yaml
var YAML_dicom_store = []byte("info:\n title: Healthcare/DicomStore\n description: The Healthcare DicomStore resource\n x-dcl-struct-name: DicomStore\n x-dcl-has-iam: false\npaths:\n get:\n description: The function used to get information about a DicomStore\n parameters:\n - name: dicomStore\n required: true\n description: A full instance of a DicomStore\n apply:\n description: The function used to apply information about a DicomStore\n parameters:\n - name: dicomStore\n required: true\n description: A full instance of a DicomStore\n delete:\n description: The function used to delete a DicomStore\n parameters:\n - name: dicomStore\n required: true\n description: A full instance of a DicomStore\n deleteAll:\n description: The function used to delete all DicomStore\n parameters:\n - name: project\n required: true\n schema:\n type: string\n - name: location\n required: true\n schema:\n type: string\n - name: dataset\n required: true\n schema:\n type: string\n list:\n description: The function used to list information about many DicomStore\n parameters:\n - name: project\n required: true\n schema:\n type: string\n - name: location\n required: true\n schema:\n type: string\n - name: dataset\n required: true\n schema:\n type: string\ncomponents:\n schemas:\n DicomStore:\n title: DicomStore\n x-dcl-id: projects/{{project}}/locations/{{location}}/datasets/{{dataset}}/dicomStores/{{name}}\n x-dcl-parent-container: project\n x-dcl-has-create: true\n x-dcl-has-iam: false\n x-dcl-read-timeout: 0\n x-dcl-apply-timeout: 0\n x-dcl-delete-timeout: 0\n type: object\n required:\n - name\n - project\n - location\n - dataset\n properties:\n dataset:\n type: string\n x-dcl-go-name: Dataset\n description: The dataset for the resource\n x-kubernetes-immutable: true\n x-dcl-references:\n - resource: Healthcare/Dataset\n field: name\n parent: true\n labels:\n type: object\n additionalProperties:\n type: string\n x-dcl-go-name: Labels\n description: 'User-supplied key-value pairs used to organize DICOM stores.\n Label keys must be between 1 and 63 characters long, have a UTF-8 encoding\n of maximum 128 bytes, and must conform to the following PCRE regular expression:\n p{Ll}p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters\n long, have a UTF-8 encoding of maximum 128 bytes, and must conform to\n the following PCRE regular expression: [p{Ll}p{Lo}p{N}_-]{0,63} No more\n than 64 labels can be associated with a given store.'\n location:\n type: string\n x-dcl-go-name: Location\n description: The location for the resource\n x-kubernetes-immutable: true\n name:\n type: string\n x-dcl-go-name: Name\n description: Resource name of the DICOM store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`.\n x-kubernetes-immutable: true\n notificationConfig:\n type: object\n x-dcl-go-name: NotificationConfig\n x-dcl-go-type: DicomStoreNotificationConfig\n description: Notification destination for new DICOM instances. Supplied\n by the client.\n properties:\n pubsubTopic:\n type: string\n x-dcl-go-name: PubsubTopic\n description: The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic\n that notifications of changes are published on. Supplied by the client.\n PubsubMessage.Data contains the resource name. PubsubMessage.MessageId\n is the ID of this message. It is guaranteed to be unique within the\n topic. PubsubMessage.PublishTime is the time at which the message\n was published. Notifications are only sent if the topic is non-empty.\n [Topic names](https://cloud.google.com/pubsub/docs/overview#names)\n must be scoped to a project. Cloud Healthcare API service account\n must have publisher permissions on the given Pub/Sub topic. Not having\n adequate permissions causes the calls that send notifications to fail.\n If a notification can't be published to Pub/Sub, errors are logged\n to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)).\n If the number of errors exceeds a certain rate, some aren't submitted.\n Note that not all operations trigger notifications, see [Configuring\n Pub/Sub notifications](https://cloud.google.com/healthcare/docs/how-tos/pubsub)\n for specific details.\n x-dcl-references:\n - resource: Pubsub/Topic\n field: name\n project:\n type: string\n x-dcl-go-name: Project\n description: The project for the resource\n x-kubernetes-immutable: true\n x-dcl-references:\n - resource: Cloudresourcemanager/Project\n field: name\n parent: true\n")
blaze-out/k8-fastbuild/genfiles/cloud/graphite/mmv2/services/google/healthcare/alpha/dicom_store.yaml
var YAML_fhir_store = []byte("info:\n title: Healthcare/FhirStore\n description: The Healthcare FhirStore resource\n x-dcl-struct-name: FhirStore\n x-dcl-has-iam: false\npaths:\n get:\n description: The function used to get information about a FhirStore\n parameters:\n - name: fhirStore\n required: true\n description: A full instance of a FhirStore\n apply:\n description: The function used to apply information about a FhirStore\n parameters:\n - name: fhirStore\n required: true\n description: A full instance of a FhirStore\n delete:\n description: The function used to delete a FhirStore\n parameters:\n - name: fhirStore\n required: true\n description: A full instance of a FhirStore\n deleteAll:\n description: The function used to delete all FhirStore\n parameters:\n - name: project\n required: true\n schema:\n type: string\n - name: location\n required: true\n schema:\n type: string\n - name: dataset\n required: true\n schema:\n type: string\n list:\n description: The function used to list information about many FhirStore\n parameters:\n - name: project\n required: true\n schema:\n type: string\n - name: location\n required: true\n schema:\n type: string\n - name: dataset\n required: true\n schema:\n type: string\ncomponents:\n schemas:\n FhirStore:\n title: FhirStore\n x-dcl-id: projects/{{project}}/locations/{{location}}/datasets/{{dataset}}/fhirStores/{{name}}\n x-dcl-parent-container: project\n x-dcl-has-create: true\n x-dcl-has-iam: false\n x-dcl-read-timeout: 0\n x-dcl-apply-timeout: 0\n x-dcl-delete-timeout: 0\n type: object\n required:\n - name\n - version\n - project\n - location\n - dataset\n properties:\n complexDataTypeReferenceParsing:\n type: string\n x-dcl-go-name: ComplexDataTypeReferenceParsing\n x-dcl-go-type: FhirStoreComplexDataTypeReferenceParsingEnum\n description: 'Enable parsing of references within complex FHIR data types\n such as Extensions. If this value is set to ENABLED, then features like\n referential integrity and Bundle reference rewriting apply to all references.\n If this flag has not been specified the behavior of the FHIR store will\n not change, references in complex data types will not be parsed. New stores\n will have this value set to ENABLED after a notification period. Warning:\n turning on this flag causes processing existing resources to fail if they\n contain references to non-existent resources. Possible values: COMPLEX_DATA_TYPE_REFERENCE_PARSING_UNSPECIFIED,\n DISABLED, ENABLED'\n enum:\n - COMPLEX_DATA_TYPE_REFERENCE_PARSING_UNSPECIFIED\n - DISABLED\n - ENABLED\n dataset:\n type: string\n x-dcl-go-name: Dataset\n description: The dataset for the resource\n x-kubernetes-immutable: true\n x-dcl-references:\n - resource: Healthcare/Dataset\n field: name\n parent: true\n defaultSearchHandlingStrict:\n type: boolean\n x-dcl-go-name: DefaultSearchHandlingStrict\n description: 'If true, overrides the default search behavior for this FHIR\n store to `handling=strict` which returns an error for unrecognized search\n parameters. If false, uses the FHIR specification default `handling=lenient`\n which ignores unrecognized search parameters. The handling can always\n be changed from the default on an individual API call by setting the HTTP\n header `Prefer: handling=strict` or `Prefer: handling=lenient`.'\n disableReferentialIntegrity:\n type: boolean\n x-dcl-go-name: DisableReferentialIntegrity\n description: Immutable. Whether to disable referential integrity in this\n FHIR store. This field is immutable after FHIR store creation. The default\n value is false, meaning that the API enforces referential integrity and\n fail the requests that result in inconsistent state in the FHIR store.\n When this field is set to true, the API skips referential integrity checks.\n Consequently, operations that rely on references, such as Patient-everything,\n do not return all the results if broken references exist.\n x-kubernetes-immutable: true\n disableResourceVersioning:\n type: boolean\n x-dcl-go-name: DisableResourceVersioning\n description: Immutable. Whether to disable resource versioning for this\n FHIR store. This field can not be changed after the creation of FHIR store.\n If set to false, which is the default behavior, all write operations cause\n historical versions to be recorded automatically. The historical versions\n can be fetched through the history APIs, but cannot be updated. If set\n to true, no historical versions are kept. The server sends errors for\n attempts to read the historical versions.\n x-kubernetes-immutable: true\n enableUpdateCreate:\n type: boolean\n x-dcl-go-name: EnableUpdateCreate\n description: Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate).\n This determines if the client can use an Update operation to create a\n new resource with a client-specified ID. If false, all IDs are server-assigned\n through the Create operation and attempts to update a non-existent resource\n return errors. It is strongly advised not to include or encode any sensitive\n data such as patient identifiers in client-specified resource IDs. Those\n IDs are part of the FHIR resource path recorded in Cloud audit logs and\n Pub/Sub notifications. Those IDs can also be contained in reference fields\n within other resources.\n labels:\n type: object\n additionalProperties:\n type: string\n x-dcl-go-name: Labels\n description: 'User-supplied key-value pairs used to organize FHIR stores.\n Label keys must be between 1 and 63 characters long, have a UTF-8 encoding\n of maximum 128 bytes, and must conform to the following PCRE regular expression:\n p{Ll}p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters\n long, have a UTF-8 encoding of maximum 128 bytes, and must conform to\n the following PCRE regular expression: [p{Ll}p{Lo}p{N}_-]{0,63} No more\n than 64 labels can be associated with a given store.'\n location:\n type: string\n x-dcl-go-name: Location\n description: The location for the resource\n x-kubernetes-immutable: true\n name:\n type: string\n x-dcl-go-name: Name\n description: Resource name of the FHIR store, of the form `projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`.\n x-kubernetes-immutable: true\n notificationConfig:\n type: object\n x-dcl-go-name: NotificationConfig\n x-dcl-go-type: FhirStoreNotificationConfig\n description: If non-empty, publish all resource modifications of this FHIR\n store to this destination. The Pub/Sub message attributes contain a map\n with a string describing the action that has triggered the notification.\n For example, \"action\":\"CreateResource\".\n properties:\n pubsubTopic:\n type: string\n x-dcl-go-name: PubsubTopic\n description: The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic\n that notifications of changes are published on. Supplied by the client.\n PubsubMessage.Data contains the resource name. PubsubMessage.MessageId\n is the ID of this message. It is guaranteed to be unique within the\n topic. PubsubMessage.PublishTime is the time at which the message\n was published. Notifications are only sent if the topic is non-empty.\n [Topic names](https://cloud.google.com/pubsub/docs/overview#names)\n must be scoped to a project. Cloud Healthcare API service account\n must have publisher permissions on the given Pub/Sub topic. Not having\n adequate permissions causes the calls that send notifications to fail.\n If a notification can't be published to Pub/Sub, errors are logged\n to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)).\n If the number of errors exceeds a certain rate, some aren't submitted.\n Note that not all operations trigger notifications, see [Configuring\n Pub/Sub notifications](https://cloud.google.com/healthcare/docs/how-tos/pubsub)\n for specific details.\n x-dcl-references:\n - resource: Pubsub/Topic\n field: name\n project:\n type: string\n x-dcl-go-name: Project\n description: The project for the resource\n x-kubernetes-immutable: true\n x-dcl-references:\n - resource: Cloudresourcemanager/Project\n field: name\n parent: true\n shardNum:\n type: integer\n format: int64\n x-dcl-go-name: ShardNum\n description: Immutable. The number of shards to index/search for FHIR search.\n This is a trade-off between write and search performance. Larger shard\n number enables better parallelism, especially during bulk import, at the\n expense of potentially slower search due to more shards to scan. This\n is a workaround to the hotspot issue created by monotonically increasing\n search document ID. This value, if set, must be in the range of [0, 64].\n Leaving it empty or setting it to 0 defaults to one shard. This field\n is immutable after store creation.\n x-kubernetes-immutable: true\n streamConfigs:\n type: array\n x-dcl-go-name: StreamConfigs\n description: A list of streaming configs that configure the destinations\n of streaming export for every resource mutation in this FHIR store. Each\n store is allowed to have up to 10 streaming configs. After a new config\n is added, the next resource mutation is streamed to the new location in\n addition to the existing ones. When a location is removed from the list,\n the server stops streaming to that location. Some lag (typically on the\n order of dozens of seconds) is expected before the results show up in\n the streaming destination.\n x-dcl-send-empty: true\n x-dcl-list-type: list\n items:\n type: object\n x-dcl-go-type: FhirStoreStreamConfigs\n properties:\n bigqueryDestination:\n type: object\n x-dcl-go-name: BigqueryDestination\n x-dcl-go-type: FhirStoreStreamConfigsBigqueryDestination\n description: The destination BigQuery structure that contains both\n the dataset location and corresponding schema config. The output\n is organized in one table per resource type. The server reuses the\n existing tables (if any) that are named after the resource types.\n For example, \"Patient\", \"Observation\". When there is no existing\n table for a given resource type, the server attempts to create one.\n When a table schema doesn't align with the schema config, either\n because of existing incompatible schema or out of band incompatible\n modification, the server does not stream in new data. BigQuery imposes\n a 1 MB limit on streaming insert row size, therefore any resource\n mutation that generates more than 1 MB of BigQuery data is not streamed.\n One resolution in this case is to delete the incompatible table\n and let the server recreate one, though the newly created table\n only contains data after the table recreation. Results are written\n to BigQuery tables according to the parameters in BigQueryDestination.WriteDisposition.\n Different versions of the same resource are distinguishable by the\n meta.versionId and meta.lastUpdated columns. The operation (CREATE/UPDATE/DELETE)\n that results in the new version is recorded in the meta.tag. The\n tables contain all historical resource versions since streaming\n was enabled. For query convenience, the server also creates one\n view per table of the same name containing only the current resource\n version. The streamed data in the BigQuery dataset is not guaranteed\n to be completely unique. The combination of the id and meta.versionId\n columns should ideally identify a single unique row. But in rare\n cases, duplicates may exist. At query time, users may use the SQL\n select statement to keep only one of the duplicate rows given an\n id and meta.versionId pair. Alternatively, the server created view\n mentioned above also filters out duplicates. If a resource mutation\n cannot be streamed to BigQuery, errors are logged to Cloud Logging.\n For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)).\n properties:\n datasetUri:\n type: string\n x-dcl-go-name: DatasetUri\n description: BigQuery URI to an existing dataset, up to 2000 characters\n long, in the format `bq://projectId.bqDatasetId`.\n schemaConfig:\n type: object\n x-dcl-go-name: SchemaConfig\n x-dcl-go-type: FhirStoreStreamConfigsBigqueryDestinationSchemaConfig\n description: The configuration for the exported BigQuery schema.\n properties:\n recursiveStructureDepth:\n type: integer\n format: int64\n x-dcl-go-name: RecursiveStructureDepth\n description: The depth for all recursive structures in the\n output analytics schema. For example, `concept` in the CodeSystem\n resource is a recursive structure; when the depth is 2,\n the CodeSystem table will have a column called `concept.concept`\n but not `concept.concept.concept`. If not specified or set\n to 0, the server will use the default value 2. The maximum\n depth allowed is 5.\n x-dcl-server-default: true\n schemaType:\n type: string\n x-dcl-go-name: SchemaType\n x-dcl-go-type: FhirStoreStreamConfigsBigqueryDestinationSchemaConfigSchemaTypeEnum\n description: 'Specifies the output schema type. Schema type\n is required. Possible values: SCHEMA_TYPE_UNSPECIFIED, LOSSLESS,\n ANALYTICS, ANALYTICS_V2'\n enum:\n - SCHEMA_TYPE_UNSPECIFIED\n - LOSSLESS\n - ANALYTICS\n - ANALYTICS_V2\n resourceTypes:\n type: array\n x-dcl-go-name: ResourceTypes\n description: Supply a FHIR resource type (such as \"Patient\" or \"Observation\").\n See https://www.hl7.org/fhir/valueset-resource-types.html for a\n list of all FHIR resource types. The server treats an empty list\n as an intent to stream all the supported resource types in this\n FHIR store.\n x-dcl-send-empty: true\n x-dcl-list-type: list\n items:\n type: string\n x-dcl-go-type: string\n validationConfig:\n type: object\n x-dcl-go-name: ValidationConfig\n x-dcl-go-type: FhirStoreValidationConfig\n description: Configuration for how to validate incoming FHIR resources against\n configured profiles.\n properties:\n disableFhirpathValidation:\n type: boolean\n x-dcl-go-name: DisableFhirpathValidation\n description: Whether to disable FHIRPath validation for incoming resources.\n Set this to true to disable checking incoming resources for conformance\n against FHIRPath requirement defined in the FHIR specification. This\n property only affects resource types that do not have profiles configured\n for them, any rules in enabled implementation guides will still be\n enforced.\n disableProfileValidation:\n type: boolean\n x-dcl-go-name: DisableProfileValidation\n description: Whether to disable profile validation for this FHIR store.\n Set this to true to disable checking incoming resources for conformance\n against structure definitions in this FHIR store.\n disableReferenceTypeValidation:\n type: boolean\n x-dcl-go-name: DisableReferenceTypeValidation\n description: Whether to disable reference type validation for incoming\n resources. Set this to true to disable checking incoming resources\n for conformance against reference type requirement defined in the\n FHIR specification. This property only affects resource types that\n do not have profiles configured for them, any rules in enabled implementation\n guides will still be enforced.\n disableRequiredFieldValidation:\n type: boolean\n x-dcl-go-name: DisableRequiredFieldValidation\n description: Whether to disable required fields validation for incoming\n resources. Set this to true to disable checking incoming resources\n for conformance against required fields requirement defined in the\n FHIR specification. This property only affects resource types that\n do not have profiles configured for them, any rules in enabled implementation\n guides will still be enforced.\n enabledImplementationGuides:\n type: array\n x-dcl-go-name: EnabledImplementationGuides\n description: 'A list of implementation guide URLs in this FHIR store\n that are used to configure the profiles to use for validation. For\n example, to use the US Core profiles for validation, set `enabled_implementation_guides`\n to `[\"http://hl7.org/fhir/us/core/ImplementationGuide/ig\"]`. If `enabled_implementation_guides`\n is empty or omitted, then incoming resources are only required to\n conform to the base FHIR profiles. Otherwise, a resource must conform\n to at least one profile listed in the `global` property of one of\n the enabled ImplementationGuides. The Cloud Healthcare API does not\n currently enforce all of the rules in a StructureDefinition. The following\n rules are supported: - min/max - minValue/maxValue - maxLength - type\n - fixed[x] - pattern[x] on simple types - slicing, when using \"value\"\n as the discriminator type When a URL cannot be resolved (for example,\n in a type assertion), the server does not return an error.'\n x-dcl-send-empty: true\n x-dcl-list-type: list\n items:\n type: string\n x-dcl-go-type: string\n version:\n type: string\n x-dcl-go-name: Version\n x-dcl-go-type: FhirStoreVersionEnum\n description: 'Immutable. The FHIR specification version that this FHIR store\n supports natively. This field is immutable after store creation. Requests\n are rejected if they contain FHIR resources of a different version. Version\n is required for every FHIR store. Possible values: VERSION_UNSPECIFIED,\n DSTU2, STU3, R4'\n x-kubernetes-immutable: true\n enum:\n - VERSION_UNSPECIFIED\n - DSTU2\n - STU3\n - R4\n")
blaze-out/k8-fastbuild/genfiles/cloud/graphite/mmv2/services/google/healthcare/alpha/fhir_store.yaml
Functions ¶
func DCLDatasetSchema ¶
func DCLDicomStoreSchema ¶
func DCLFhirStoreSchema ¶
Types ¶
type Client ¶
The Client is the base struct of all operations. This will receive the Get, Delete, List, and Apply operations on all resources.
func (*Client) ApplyDataset ¶
func (*Client) ApplyDicomStore ¶
func (c *Client) ApplyDicomStore(ctx context.Context, rawDesired *DicomStore, opts ...dcl.ApplyOption) (*DicomStore, error)
func (*Client) ApplyFhirStore ¶
func (*Client) DeleteAllDataset ¶
func (c *Client) DeleteAllDataset(ctx context.Context, project, location string, filter func(*Dataset) bool) error
DeleteAllDataset deletes all resources that the filter functions returns true on.
func (*Client) DeleteAllDicomStore ¶
func (c *Client) DeleteAllDicomStore(ctx context.Context, project, location, dataset string, filter func(*DicomStore) bool) error
DeleteAllDicomStore deletes all resources that the filter functions returns true on.
func (*Client) DeleteAllFhirStore ¶
func (c *Client) DeleteAllFhirStore(ctx context.Context, project, location, dataset string, filter func(*FhirStore) bool) error
DeleteAllFhirStore deletes all resources that the filter functions returns true on.
func (*Client) DeleteDataset ¶
func (*Client) DeleteDicomStore ¶
func (c *Client) DeleteDicomStore(ctx context.Context, r *DicomStore) error
func (*Client) DeleteFhirStore ¶
func (*Client) GetDataset ¶
func (*Client) GetDicomStore ¶
func (c *Client) GetDicomStore(ctx context.Context, r *DicomStore) (*DicomStore, error)
func (*Client) GetFhirStore ¶
func (*Client) ListDataset ¶
func (*Client) ListDatasetWithMaxResults ¶
func (*Client) ListDicomStore ¶
func (*Client) ListDicomStoreWithMaxResults ¶
func (*Client) ListFhirStore ¶
func (*Client) ListFhirStoreWithMaxResults ¶
type Dataset ¶
type Dataset struct { Name *string `json:"name"` TimeZone *string `json:"timeZone"` Project *string `json:"project"` Location *string `json:"location"` }
func (*Dataset) Describe ¶
func (r *Dataset) Describe() dcl.ServiceTypeVersion
Describe returns a simple description of this resource to ensure that automated tools can identify it.
type DatasetList ¶
type DatasetList struct { Items []*Dataset // contains filtered or unexported fields }
func (*DatasetList) HasNext ¶
func (l *DatasetList) HasNext() bool
type DicomStore ¶
type DicomStore struct { Name *string `json:"name"` NotificationConfig *DicomStoreNotificationConfig `json:"notificationConfig"` Labels map[string]string `json:"labels"` Project *string `json:"project"` Location *string `json:"location"` Dataset *string `json:"dataset"` }
func (*DicomStore) Describe ¶
func (r *DicomStore) Describe() dcl.ServiceTypeVersion
Describe returns a simple description of this resource to ensure that automated tools can identify it.
func (*DicomStore) ID ¶
func (r *DicomStore) ID() (string, error)
func (*DicomStore) String ¶
func (r *DicomStore) String() string
type DicomStoreList ¶
type DicomStoreList struct { Items []*DicomStore // contains filtered or unexported fields }
func (*DicomStoreList) HasNext ¶
func (l *DicomStoreList) HasNext() bool
type DicomStoreNotificationConfig ¶
type DicomStoreNotificationConfig struct { PubsubTopic *string `json:"pubsubTopic"` // contains filtered or unexported fields }
var EmptyDicomStoreNotificationConfig *DicomStoreNotificationConfig = &DicomStoreNotificationConfig{empty: true}
This object is used to assert a desired state where this DicomStoreNotificationConfig is empty. Go lacks global const objects, but this object should be treated as one. Modifying this object will have undesirable results.
func (*DicomStoreNotificationConfig) Empty ¶
func (r *DicomStoreNotificationConfig) Empty() bool
func (*DicomStoreNotificationConfig) HashCode ¶
func (r *DicomStoreNotificationConfig) HashCode() string
func (*DicomStoreNotificationConfig) String ¶
func (r *DicomStoreNotificationConfig) String() string
func (*DicomStoreNotificationConfig) UnmarshalJSON ¶
func (r *DicomStoreNotificationConfig) UnmarshalJSON(data []byte) error
type FhirStore ¶
type FhirStore struct { Name *string `json:"name"` EnableUpdateCreate *bool `json:"enableUpdateCreate"` NotificationConfig *FhirStoreNotificationConfig `json:"notificationConfig"` DisableReferentialIntegrity *bool `json:"disableReferentialIntegrity"` ShardNum *int64 `json:"shardNum"` DisableResourceVersioning *bool `json:"disableResourceVersioning"` Labels map[string]string `json:"labels"` Version *FhirStoreVersionEnum `json:"version"` StreamConfigs []FhirStoreStreamConfigs `json:"streamConfigs"` ValidationConfig *FhirStoreValidationConfig `json:"validationConfig"` DefaultSearchHandlingStrict *bool `json:"defaultSearchHandlingStrict"` ComplexDataTypeReferenceParsing *FhirStoreComplexDataTypeReferenceParsingEnum `json:"complexDataTypeReferenceParsing"` Project *string `json:"project"` Location *string `json:"location"` Dataset *string `json:"dataset"` }
func (*FhirStore) Describe ¶
func (r *FhirStore) Describe() dcl.ServiceTypeVersion
Describe returns a simple description of this resource to ensure that automated tools can identify it.
type FhirStoreComplexDataTypeReferenceParsingEnum ¶
type FhirStoreComplexDataTypeReferenceParsingEnum string
The enum FhirStoreComplexDataTypeReferenceParsingEnum.
func FhirStoreComplexDataTypeReferenceParsingEnumRef ¶
func FhirStoreComplexDataTypeReferenceParsingEnumRef(s string) *FhirStoreComplexDataTypeReferenceParsingEnum
FhirStoreComplexDataTypeReferenceParsingEnumRef returns a *FhirStoreComplexDataTypeReferenceParsingEnum with the value of string s If the empty string is provided, nil is returned.
func (FhirStoreComplexDataTypeReferenceParsingEnum) Validate ¶
func (v FhirStoreComplexDataTypeReferenceParsingEnum) Validate() error
type FhirStoreList ¶
type FhirStoreList struct { Items []*FhirStore // contains filtered or unexported fields }
func (*FhirStoreList) HasNext ¶
func (l *FhirStoreList) HasNext() bool
type FhirStoreNotificationConfig ¶
type FhirStoreNotificationConfig struct { PubsubTopic *string `json:"pubsubTopic"` // contains filtered or unexported fields }
var EmptyFhirStoreNotificationConfig *FhirStoreNotificationConfig = &FhirStoreNotificationConfig{empty: true}
This object is used to assert a desired state where this FhirStoreNotificationConfig is empty. Go lacks global const objects, but this object should be treated as one. Modifying this object will have undesirable results.
func (*FhirStoreNotificationConfig) Empty ¶
func (r *FhirStoreNotificationConfig) Empty() bool
func (*FhirStoreNotificationConfig) HashCode ¶
func (r *FhirStoreNotificationConfig) HashCode() string
func (*FhirStoreNotificationConfig) String ¶
func (r *FhirStoreNotificationConfig) String() string
func (*FhirStoreNotificationConfig) UnmarshalJSON ¶
func (r *FhirStoreNotificationConfig) UnmarshalJSON(data []byte) error
type FhirStoreStreamConfigs ¶
type FhirStoreStreamConfigs struct { ResourceTypes []string `json:"resourceTypes"` BigqueryDestination *FhirStoreStreamConfigsBigqueryDestination `json:"bigqueryDestination"` // contains filtered or unexported fields }
var EmptyFhirStoreStreamConfigs *FhirStoreStreamConfigs = &FhirStoreStreamConfigs{empty: true}
This object is used to assert a desired state where this FhirStoreStreamConfigs is empty. Go lacks global const objects, but this object should be treated as one. Modifying this object will have undesirable results.
func (*FhirStoreStreamConfigs) Empty ¶
func (r *FhirStoreStreamConfigs) Empty() bool
func (*FhirStoreStreamConfigs) HashCode ¶
func (r *FhirStoreStreamConfigs) HashCode() string
func (*FhirStoreStreamConfigs) String ¶
func (r *FhirStoreStreamConfigs) String() string
func (*FhirStoreStreamConfigs) UnmarshalJSON ¶
func (r *FhirStoreStreamConfigs) UnmarshalJSON(data []byte) error
type FhirStoreStreamConfigsBigqueryDestination ¶
type FhirStoreStreamConfigsBigqueryDestination struct { DatasetUri *string `json:"datasetUri"` SchemaConfig *FhirStoreStreamConfigsBigqueryDestinationSchemaConfig `json:"schemaConfig"` // contains filtered or unexported fields }
var EmptyFhirStoreStreamConfigsBigqueryDestination *FhirStoreStreamConfigsBigqueryDestination = &FhirStoreStreamConfigsBigqueryDestination{empty: true}
This object is used to assert a desired state where this FhirStoreStreamConfigsBigqueryDestination is empty. Go lacks global const objects, but this object should be treated as one. Modifying this object will have undesirable results.
func (*FhirStoreStreamConfigsBigqueryDestination) Empty ¶
func (r *FhirStoreStreamConfigsBigqueryDestination) Empty() bool
func (*FhirStoreStreamConfigsBigqueryDestination) HashCode ¶
func (r *FhirStoreStreamConfigsBigqueryDestination) HashCode() string
func (*FhirStoreStreamConfigsBigqueryDestination) String ¶
func (r *FhirStoreStreamConfigsBigqueryDestination) String() string
func (*FhirStoreStreamConfigsBigqueryDestination) UnmarshalJSON ¶
func (r *FhirStoreStreamConfigsBigqueryDestination) UnmarshalJSON(data []byte) error
type FhirStoreStreamConfigsBigqueryDestinationSchemaConfig ¶
type FhirStoreStreamConfigsBigqueryDestinationSchemaConfig struct { SchemaType *FhirStoreStreamConfigsBigqueryDestinationSchemaConfigSchemaTypeEnum `json:"schemaType"` RecursiveStructureDepth *int64 `json:"recursiveStructureDepth"` // contains filtered or unexported fields }
var EmptyFhirStoreStreamConfigsBigqueryDestinationSchemaConfig *FhirStoreStreamConfigsBigqueryDestinationSchemaConfig = &FhirStoreStreamConfigsBigqueryDestinationSchemaConfig{empty: true}
This object is used to assert a desired state where this FhirStoreStreamConfigsBigqueryDestinationSchemaConfig is empty. Go lacks global const objects, but this object should be treated as one. Modifying this object will have undesirable results.
func (*FhirStoreStreamConfigsBigqueryDestinationSchemaConfig) Empty ¶
func (r *FhirStoreStreamConfigsBigqueryDestinationSchemaConfig) Empty() bool
func (*FhirStoreStreamConfigsBigqueryDestinationSchemaConfig) HashCode ¶
func (r *FhirStoreStreamConfigsBigqueryDestinationSchemaConfig) HashCode() string
func (*FhirStoreStreamConfigsBigqueryDestinationSchemaConfig) String ¶
func (r *FhirStoreStreamConfigsBigqueryDestinationSchemaConfig) String() string
func (*FhirStoreStreamConfigsBigqueryDestinationSchemaConfig) UnmarshalJSON ¶
func (r *FhirStoreStreamConfigsBigqueryDestinationSchemaConfig) UnmarshalJSON(data []byte) error
type FhirStoreStreamConfigsBigqueryDestinationSchemaConfigSchemaTypeEnum ¶
type FhirStoreStreamConfigsBigqueryDestinationSchemaConfigSchemaTypeEnum string
The enum FhirStoreStreamConfigsBigqueryDestinationSchemaConfigSchemaTypeEnum.
func FhirStoreStreamConfigsBigqueryDestinationSchemaConfigSchemaTypeEnumRef ¶
func FhirStoreStreamConfigsBigqueryDestinationSchemaConfigSchemaTypeEnumRef(s string) *FhirStoreStreamConfigsBigqueryDestinationSchemaConfigSchemaTypeEnum
FhirStoreStreamConfigsBigqueryDestinationSchemaConfigSchemaTypeEnumRef returns a *FhirStoreStreamConfigsBigqueryDestinationSchemaConfigSchemaTypeEnum with the value of string s If the empty string is provided, nil is returned.
func (FhirStoreStreamConfigsBigqueryDestinationSchemaConfigSchemaTypeEnum) Validate ¶
func (v FhirStoreStreamConfigsBigqueryDestinationSchemaConfigSchemaTypeEnum) Validate() error
type FhirStoreValidationConfig ¶
type FhirStoreValidationConfig struct { DisableProfileValidation *bool `json:"disableProfileValidation"` EnabledImplementationGuides []string `json:"enabledImplementationGuides"` DisableRequiredFieldValidation *bool `json:"disableRequiredFieldValidation"` DisableReferenceTypeValidation *bool `json:"disableReferenceTypeValidation"` DisableFhirpathValidation *bool `json:"disableFhirpathValidation"` // contains filtered or unexported fields }
var EmptyFhirStoreValidationConfig *FhirStoreValidationConfig = &FhirStoreValidationConfig{empty: true}
This object is used to assert a desired state where this FhirStoreValidationConfig is empty. Go lacks global const objects, but this object should be treated as one. Modifying this object will have undesirable results.
func (*FhirStoreValidationConfig) Empty ¶
func (r *FhirStoreValidationConfig) Empty() bool
func (*FhirStoreValidationConfig) HashCode ¶
func (r *FhirStoreValidationConfig) HashCode() string
func (*FhirStoreValidationConfig) String ¶
func (r *FhirStoreValidationConfig) String() string
func (*FhirStoreValidationConfig) UnmarshalJSON ¶
func (r *FhirStoreValidationConfig) UnmarshalJSON(data []byte) error
type FhirStoreVersionEnum ¶
type FhirStoreVersionEnum string
The enum FhirStoreVersionEnum.
func FhirStoreVersionEnumRef ¶
func FhirStoreVersionEnumRef(s string) *FhirStoreVersionEnum
FhirStoreVersionEnumRef returns a *FhirStoreVersionEnum with the value of string s If the empty string is provided, nil is returned.
func (FhirStoreVersionEnum) Validate ¶
func (v FhirStoreVersionEnum) Validate() error