Index
DatasetService
(interface)CreateDatasetRequest
(message)Dataset
(message)DeidentifyDatasetRequest
(message)DeleteDatasetRequest
(message)GetDatasetRequest
(message)ListDatasetsRequest
(message)ListDatasetsResponse
(message)UpdateDatasetRequest
(message)
DatasetService
A service for manipulating health datasets.
CreateDataset |
---|
Creates a new health dataset. Results are returned through the
|
DeidentifyDataset |
---|
Creates a new dataset containing de-identified data from the source dataset. The
|
DeleteDataset |
---|
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).
|
GetDataset |
---|
Gets any metadata associated with a dataset.
|
ListDatasets |
---|
Lists the health datasets in the current project.
|
UpdateDataset |
---|
Updates dataset metadata.
|
CreateDatasetRequest
Creates a new dataset.
Fields | |
---|---|
parent |
Required. The name of the project where the server creates the dataset. For example, Authorization requires the following IAM permission on the specified resource
|
dataset_id |
Required. The ID of the dataset that is being created. The string must match the following regex: |
dataset |
The dataset that is being created. |
Dataset
A message representing a health dataset.
A health dataset represents a collection of healthcare data pertaining to one or more patients. This may include multiple modalities of healthcare data, such as electronic medical records or medical imaging data.
Fields | |
---|---|
name |
Identifier. Resource name of the dataset, of the form |
time_zone |
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. |
DeidentifyDatasetRequest
Redacts identifying information from the specified dataset.
Fields | |
---|---|
source_dataset |
Required. Source dataset resource name. For example, |
destination_dataset |
Required. The name of the dataset resource to create and write the redacted data to.
|
config |
Deidentify configuration. Only one of |
gcs_config_uri |
Cloud Storage location to read the JSON |
DeleteDatasetRequest
Deletes the specified dataset. Fails if the dataset contains any resources.
Fields | |
---|---|
name |
Required. The name of the dataset to delete. For example, Authorization requires the following IAM permission on the specified resource
|
GetDatasetRequest
Gets any metadata associated with a dataset.
Fields | |
---|---|
name |
Required. The name of the dataset to read. For example, Authorization requires the following IAM permission on the specified resource
|
ListDatasetsRequest
Lists the available datasets.
Fields | |
---|---|
parent |
Required. The name of the project whose datasets should be listed. For example, Authorization requires the following IAM permission on the specified resource
|
page_size |
The maximum number of items to return. If not specified, 100 is used. May not be larger than 1000. |
page_token |
The next_page_token value returned from a previous List request, if any. |
ListDatasetsResponse
Lists the available datasets.
Fields | |
---|---|
datasets[] |
The first page of datasets. |
next_page_token |
Token to retrieve the next page of results, or empty if there are no more results in the list. |
UpdateDatasetRequest
Updates dataset metadata.
Fields | |
---|---|
dataset |
Required. The dataset resource that updates the resource on the server. Only fields listed in Authorization requires the following IAM permission on the specified resource
|
update_mask |
Required. The update mask applies to the resource. For the |