ProjectsLocationsDatasetsConsentStores
class ProjectsLocationsDatasetsConsentStores extends Resource (View source)
The "consentStores" collection of methods.
Typical usage is:
$healthcareService = new Google\Service\CloudHealthcare(...);
$consentStores = $healthcareService->projects_locations_datasets_consentStores;Methods
Checks if a particular data_id of a User data mapping in the specified consent store is consented for the specified use.
Creates a new consent store in the parent dataset. Attempting to create a consent store with the same ID as an existing store fails with an ALREADY_EXISTS error. (consentStores.create)
Deletes the specified consent store and removes all the consent store's data.
Evaluates the user's Consents for all matching User data mappings. Note: User data mappings are indexed asynchronously, which can cause a slight delay between the time mappings are created or updated and when they are included in EvaluateUserConsents results. (consentStores.evaluateUserConsents)
Gets the specified consent store. (consentStores.get)
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (consentStores.getIamPolicy)
Lists the consent stores in the specified dataset.
Updates the specified consent store. (consentStores.patch)
Queries all data_ids that are consented for a specified use in the given
consent store and writes them to a specified destination. The returned
Operation includes a progress counter for the number of User data mappings
processed. If the request is successful, a detailed response is returned of
type QueryAccessibleDataResponse, contained in the response field when the
operation finishes. The metadata field type is OperationMetadata. Errors are
logged to Cloud Logging (see Viewing error logs in Cloud
Logging). For
example, the following sample log entry shows a failed to evaluate consent policy error that occurred during a QueryAccessibleData call to consent
store projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/co nsentStores/{consent_store_id}. json jsonPayload: { @type: "type.googleap is.com/google.cloud.healthcare.logging.QueryAccessibleDataLogEntry" error: { code: 9 message: "failed to evaluate consent policy" } resourceName: "project s/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{c onsent_store_id}/consents/{consent_id}" } logName: "projects/{project_id}/log s/healthcare.googleapis.com%2Fquery_accessible_data" operation: { id: "projec ts/{project_id}/locations/{location_id}/datasets/{dataset_id}/operations/{ope ration_id}" producer: "healthcare.googleapis.com/QueryAccessibleData" } receiveTimestamp: "TIMESTAMP" resource: { labels: { consent_store_id: "{consent_store_id}" dataset_id: "{dataset_id}" location: "{location_id}" project_id: "{project_id}" } type: "healthcare_consent_store" } severity: "ERROR" timestamp: "TIMESTAMP" (consentStores.queryAccessibleData)
Sets the access control policy on the specified resource. Replaces any
existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and
PERMISSION_DENIED errors. (consentStores.setIamPolicy)
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
CheckDataAccessResponse
checkDataAccess(string $consentStore, CheckDataAccessRequest $postBody, array $optParams = [])
Checks if a particular data_id of a User data mapping in the specified consent store is consented for the specified use.
(consentStores.checkDataAccess)
ConsentStore
create(string $parent, ConsentStore $postBody, array $optParams = [])
Creates a new consent store in the parent dataset. Attempting to create a consent store with the same ID as an existing store fails with an ALREADY_EXISTS error. (consentStores.create)
HealthcareEmpty
delete(string $name, array $optParams = [])
Deletes the specified consent store and removes all the consent store's data.
(consentStores.delete)
EvaluateUserConsentsResponse
evaluateUserConsents(string $consentStore, EvaluateUserConsentsRequest $postBody, array $optParams = [])
Evaluates the user's Consents for all matching User data mappings. Note: User data mappings are indexed asynchronously, which can cause a slight delay between the time mappings are created or updated and when they are included in EvaluateUserConsents results. (consentStores.evaluateUserConsents)
ConsentStore
get(string $name, array $optParams = [])
Gets the specified consent store. (consentStores.get)
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. (consentStores.getIamPolicy)
ListConsentStoresResponse
listProjectsLocationsDatasetsConsentStores(string $parent, array $optParams = [])
Lists the consent stores in the specified dataset.
(consentStores.listProjectsLocationsDatasetsConsentStores)
ConsentStore
patch(string $name, ConsentStore $postBody, array $optParams = [])
Updates the specified consent store. (consentStores.patch)
Operation
queryAccessibleData(string $consentStore, QueryAccessibleDataRequest $postBody, array $optParams = [])
Queries all data_ids that are consented for a specified use in the given
consent store and writes them to a specified destination. The returned
Operation includes a progress counter for the number of User data mappings
processed. If the request is successful, a detailed response is returned of
type QueryAccessibleDataResponse, contained in the response field when the
operation finishes. The metadata field type is OperationMetadata. Errors are
logged to Cloud Logging (see Viewing error logs in Cloud
Logging). For
example, the following sample log entry shows a failed to evaluate consent policy error that occurred during a QueryAccessibleData call to consent
store projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/co nsentStores/{consent_store_id}. json jsonPayload: { @type: "type.googleap is.com/google.cloud.healthcare.logging.QueryAccessibleDataLogEntry" error: { code: 9 message: "failed to evaluate consent policy" } resourceName: "project s/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{c onsent_store_id}/consents/{consent_id}" } logName: "projects/{project_id}/log s/healthcare.googleapis.com%2Fquery_accessible_data" operation: { id: "projec ts/{project_id}/locations/{location_id}/datasets/{dataset_id}/operations/{ope ration_id}" producer: "healthcare.googleapis.com/QueryAccessibleData" } receiveTimestamp: "TIMESTAMP" resource: { labels: { consent_store_id: "{consent_store_id}" dataset_id: "{dataset_id}" location: "{location_id}" project_id: "{project_id}" } type: "healthcare_consent_store" } severity: "ERROR" timestamp: "TIMESTAMP" (consentStores.queryAccessibleData)
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. (consentStores.setIamPolicy)
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. (consentStores.testIamPermissions)