class ProjectsLocationsDatasets extends Resource (View source)

The "datasets" collection of methods.

Typical usage is:

 $healthcareService = new Google\Service\CloudHealthcare(...);
 $datasets = $healthcareService->projects_locations_datasets;

Methods

create(string $parent, Dataset $postBody, array $optParams = [])

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.

deidentify(string $sourceDataset, DeidentifyDatasetRequest $postBody, array $optParams = [])

Creates a new dataset containing de-identified data from the source dataset.

delete(string $name, array $optParams = [])

Deletes the specified health dataset and all data contained in the dataset.

get(string $name, array $optParams = [])

Gets any metadata associated with a dataset. (datasets.get)

getIamPolicy(string $resource, array $optParams = [])

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (datasets.getIamPolicy)

listProjectsLocationsDatasets(string $parent, array $optParams = [])

Lists the health datasets in the current project.

patch(string $name, Dataset $postBody, array $optParams = [])

Updates dataset metadata. (datasets.patch)

setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. (datasets.setIamPolicy)

testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])

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.

Details

Operation create(string $parent, Dataset $postBody, array $optParams = [])

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.

(datasets.create)

Parameters

string $parent

Required. The name of the project where the server creates the dataset. For example, projects/{project_id}/locations/{location_id}.

Dataset $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Operation deidentify(string $sourceDataset, DeidentifyDatasetRequest $postBody, array $optParams = [])

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. (datasets.deidentify)

Parameters

string $sourceDataset

Required. Source dataset resource name. For example, projects/{project_id}/locations/{location_id}/datasets/{dataset_id}.

DeidentifyDatasetRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

HealthcareEmpty delete(string $name, array $optParams = [])

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). (datasets.delete)

Parameters

string $name

Required. The name of the dataset to delete. For example, projects/{project_id}/locations/{location_id}/datasets/{dataset_id}.

array $optParams

Optional parameters.

Return Value

HealthcareEmpty

Exceptions

Exception

Dataset get(string $name, array $optParams = [])

Gets any metadata associated with a dataset. (datasets.get)

Parameters

string $name

Required. The name of the dataset to read. For example, projects/{project_id}/locations/{location_id}/datasets/{dataset_id}.

array $optParams

Optional parameters.

Return Value

Dataset

Exceptions

Exception

Policy getIamPolicy(string $resource, array $optParams = [])

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (datasets.getIamPolicy)

Parameters

string $resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

ListDatasetsResponse listProjectsLocationsDatasets(string $parent, array $optParams = [])

Lists the health datasets in the current project.

(datasets.listProjectsLocationsDatasets)

Parameters

string $parent

Required. The name of the project whose datasets should be listed. For example, projects/{project_id}/locations/{location_id}.

array $optParams

Optional parameters.

Return Value

ListDatasetsResponse

Exceptions

Exception

Dataset patch(string $name, Dataset $postBody, array $optParams = [])

Updates dataset metadata. (datasets.patch)

Parameters

string $name

Identifier. Resource name of the dataset, of the form projects/{project_id}/locations/{location_id}/datasets/{dataset_id}.

Dataset $postBody
array $optParams

Optional parameters.

Return Value

Dataset

Exceptions

Exception

Policy setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. (datasets.setIamPolicy)

Parameters

string $resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

SetIamPolicyRequest $postBody
array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

TestIamPermissionsResponse testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])

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. (datasets.testIamPermissions)

Parameters

string $resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

TestIamPermissionsRequest $postBody
array $optParams

Optional parameters.

Return Value

TestIamPermissionsResponse

Exceptions

Exception