consent_stores

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

Overview

Name	consent_stores
Type	Resource
Id	google.healthcare.consent_stores

Fields

Name	Datatype	Description
name	string	Identifier. Resource name of the consent store, of the form projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}. Cannot be changed after creation.
defaultConsentTtl	string	Optional. Default time to live for Consents created in this store. Must be at least 24 hours. Updating this field will not affect the expiration time of existing consents.
enableConsentCreateOnUpdate	boolean	Optional. If true, UpdateConsent creates the Consent if it does not already exist. If unspecified, defaults to false.
labels	object	Optional. User-supplied key-value pairs used to organize consent stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62}. Label values must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63}. No more than 64 labels can be associated with a given store. For more information: https://cloud.google.com/healthcare/docs/how-tos/labeling-resources

Methods

Name	Accessible by	Required Params	Description
get	SELECT	consentStoresId, datasetsId, locationsId, projectsId	Gets the specified consent store.
list	SELECT	datasetsId, locationsId, projectsId	Lists the consent stores in the specified dataset.
create	INSERT	datasetsId, locationsId, projectsId	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.
delete	DELETE	consentStoresId, datasetsId, locationsId, projectsId	Deletes the specified consent store and removes all the consent store's data.
patch	UPDATE	consentStoresId, datasetsId, locationsId, projectsId	Updates the specified consent store.
check_data_access	EXEC	consentStoresId, datasetsId, locationsId, projectsId	Checks if a particular data_id of a User data mapping in the specified consent store is consented for the specified use.
evaluate_user_consents	EXEC	consentStoresId, datasetsId, locationsId, projectsId	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.
query_accessible_data	EXEC	consentStoresId, datasetsId, locationsId, projectsId	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}/consentStores/{consent_store_id}. json jsonPayload: { @type: "type.googleapis.com/google.cloud.healthcare.logging.QueryAccessibleDataLogEntry" error: { code: 9 message: "failed to evaluate consent policy" } resourceName: "projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}" } logName: "projects/{project_id}/logs/healthcare.googleapis.com%2Fquery_accessible_data" operation: { id: "projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/operations/{operation_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"

SELECT examples

Lists the consent stores in the specified dataset.

SELECT
name,
defaultConsentTtl,
enableConsentCreateOnUpdate,
labels
FROM google.healthcare.consent_stores
WHERE datasetsId = '{{ datasetsId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

INSERT example

Use the following StackQL query and manifest file to create a new consent_stores resource.

All Properties

/*+ create */
INSERT INTO google.healthcare.consent_stores (
datasetsId,
locationsId,
projectsId,
name,
defaultConsentTtl,
labels,
enableConsentCreateOnUpdate
)
SELECT 
'{{ datasetsId }}',
'{{ locationsId }}',
'{{ projectsId }}',
'{{ name }}',
'{{ defaultConsentTtl }}',
'{{ labels }}',
{{ enableConsentCreateOnUpdate }}
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: defaultConsentTtl
      value: string
    - name: labels
      value: object
    - name: enableConsentCreateOnUpdate
      value: boolean

UPDATE example

Updates a consent_stores resource.

/*+ update */
UPDATE google.healthcare.consent_stores
SET 
name = '{{ name }}',
defaultConsentTtl = '{{ defaultConsentTtl }}',
labels = '{{ labels }}',
enableConsentCreateOnUpdate = true|false
WHERE 
consentStoresId = '{{ consentStoresId }}'
AND datasetsId = '{{ datasetsId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

DELETE example

Deletes the specified consent_stores resource.

/*+ delete */
DELETE FROM google.healthcare.consent_stores
WHERE consentStoresId = '{{ consentStoresId }}'
AND datasetsId = '{{ datasetsId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';