datasets

Creates, updates, deletes, gets or lists a datasets resource.

Overview

Name	datasets
Type	Resource
Id	google.healthcare.datasets

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Identifier. Resource name of the dataset, of the form projects/{project_id}/locations/{location_id}/datasets/{dataset_id}.
encryptionSpec	object	Optional. Customer-managed encryption key spec for a Dataset. If set, this Dataset and all of its sub-resources will be secured by this key. If empty, the Dataset is secured by the default Google encryption key. (id: EncryptionSpec)
satisfiesPzi	boolean	Output only. Whether the dataset satisfies zone isolation.
satisfiesPzs	boolean	Output only. Whether the dataset satisfies zone separation.
timeZone	string	Optional. The default timezone used by this dataset. Must be a either a valid IANA time zone name such as "America/New_York" or empty, which defaults to UTC. This is used for parsing times in resources, such as HL7 messages, where no explicit timezone is specified.

list

Successful response

Name	Datatype	Description
name	string	Identifier. Resource name of the dataset, of the form projects/{project_id}/locations/{location_id}/datasets/{dataset_id}.
encryptionSpec	object	Optional. Customer-managed encryption key spec for a Dataset. If set, this Dataset and all of its sub-resources will be secured by this key. If empty, the Dataset is secured by the default Google encryption key. (id: EncryptionSpec)
satisfiesPzi	boolean	Output only. Whether the dataset satisfies zone isolation.
satisfiesPzs	boolean	Output only. Whether the dataset satisfies zone separation.
timeZone	string	Optional. The default timezone used by this dataset. Must be a either a valid IANA time zone name such as "America/New_York" or empty, which defaults to UTC. This is used for parsing times in resources, such as HL7 messages, where no explicit timezone is specified.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, datasetsId		Gets any metadata associated with a dataset.
list	select	projectsId, locationsId	pageSize, pageToken	Lists the health datasets in the current project.
create	insert	projectsId, locationsId	datasetId	Creates a new health dataset. Results are returned through the Operation interface which returns either an Operation.response which contains a Dataset or Operation.error. The metadata field type is OperationMetadata.
patch	update	projectsId, locationsId, datasetsId	updateMask	Updates dataset metadata.
delete	delete	projectsId, locationsId, datasetsId		Deletes the specified health dataset and all data contained in the dataset. Deleting a dataset does not affect the sources from which the dataset was imported (if any).
deidentify	exec	projectsId, locationsId, datasetsId		Creates a new dataset containing de-identified data from the source dataset. The metadata field type is OperationMetadata. If the request is successful, the response field type is DeidentifySummary. If errors occur, error is set. The LRO result may still be successful if de-identification fails for some DICOM instances. The new de-identified dataset will not contain these failed resources. Failed resource totals are tracked in Operation.metadata. Error details are also logged to Cloud Logging. For more information, see Viewing error logs in Cloud Logging.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
datasetsId	string
locationsId	string
projectsId	string
datasetId	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

get

Gets any metadata associated with a dataset.

SELECT
name,
encryptionSpec,
satisfiesPzi,
satisfiesPzs,
timeZone
FROM google.healthcare.datasets
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND datasetsId = '{{ datasetsId }}' -- required;

list

Lists the health datasets in the current project.

SELECT
name,
encryptionSpec,
satisfiesPzi,
satisfiesPzs,
timeZone
FROM google.healthcare.datasets
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

INSERT examples

create

Creates a new health dataset. Results are returned through the Operation interface which returns either an Operation.response which contains a Dataset or Operation.error. The metadata field type is OperationMetadata.

INSERT INTO google.healthcare.datasets (
data__name,
data__timeZone,
data__encryptionSpec,
projectsId,
locationsId,
datasetId
)
SELECT 
'{{ name }}',
'{{ timeZone }}',
'{{ encryptionSpec }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ datasetId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: datasets
  props:
    - name: projectsId
      value: string
      description: Required parameter for the datasets resource.
    - name: locationsId
      value: string
      description: Required parameter for the datasets resource.
    - name: name
      value: string
      description: >
        Identifier. Resource name of the dataset, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`.
        
    - name: timeZone
      value: string
      description: >
        Optional. The default timezone used by this dataset. Must be a either a valid IANA time zone name such as "America/New_York" or empty, which defaults to UTC. This is used for parsing times in resources, such as HL7 messages, where no explicit timezone is specified.
        
    - name: encryptionSpec
      value: object
      description: >
        Optional. Customer-managed encryption key spec for a Dataset. If set, this Dataset and all of its sub-resources will be secured by this key. If empty, the Dataset is secured by the default Google encryption key.
        
    - name: datasetId
      value: string

UPDATE examples

patch

Updates dataset metadata.

UPDATE google.healthcare.datasets
SET 
data__name = '{{ name }}',
data__timeZone = '{{ timeZone }}',
data__encryptionSpec = '{{ encryptionSpec }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND datasetsId = '{{ datasetsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
encryptionSpec,
satisfiesPzi,
satisfiesPzs,
timeZone;

DELETE examples

delete

Deletes the specified health dataset and all data contained in the dataset. Deleting a dataset does not affect the sources from which the dataset was imported (if any).

DELETE FROM google.healthcare.datasets
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND datasetsId = '{{ datasetsId }}' --required;

Lifecycle Methods

deidentify

Creates a new dataset containing de-identified data from the source dataset. The metadata field type is OperationMetadata. If the request is successful, the response field type is DeidentifySummary. If errors occur, error is set. The LRO result may still be successful if de-identification fails for some DICOM instances. The new de-identified dataset will not contain these failed resources. Failed resource totals are tracked in Operation.metadata. Error details are also logged to Cloud Logging. For more information, see Viewing error logs in Cloud Logging.

EXEC google.healthcare.datasets.deidentify 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@datasetsId='{{ datasetsId }}' --required 
@@json=
'{
"destinationDataset": "{{ destinationDataset }}", 
"config": "{{ config }}", 
"gcsConfigUri": "{{ gcsConfigUri }}"
}';