consents_revisions

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

Overview

Name	consents_revisions
Type	Resource
Id	google.healthcare.consents_revisions

Fields

The following fields are returned by SELECT queries:

list_revisions

Successful response

Name	Datatype	Description
name	string	Identifier. Resource name of the Consent, of the form projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}. Cannot be changed after creation.
consentArtifact	string	Required. The resource name of the Consent artifact that contains proof of the end user's consent, of the form projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}.
expireTime	string (google-datetime)	Timestamp in UTC of when this Consent is considered expired.
metadata	object	Optional. User-supplied key-value pairs used to organize Consent resources. Metadata keys must: - be between 1 and 63 characters long - have a UTF-8 encoding of maximum 128 bytes - begin with a letter - consist of up to 63 characters including lowercase letters, numeric characters, underscores, and dashes Metadata values must be: - be between 1 and 63 characters long - have a UTF-8 encoding of maximum 128 bytes - consist of up to 63 characters including lowercase letters, numeric characters, underscores, and dashes No more than 64 metadata entries can be associated with a given consent.
policies	array	Optional. Represents a user's consent in terms of the resources that can be accessed and under what conditions.
revisionCreateTime	string (google-datetime)	Output only. The timestamp that the revision was created.
revisionId	string	Output only. The revision ID of the Consent. The format is an 8-character hexadecimal string. Refer to a specific revision of a Consent by appending @{revision_id} to the Consent's resource name.
state	string	Required. Indicates the current state of this Consent.
ttl	string (google-duration)	Input only. The time to live for this Consent from when it is created.
userId	string	Required. User's UUID provided by the client.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_revisions	select	projectsId, locationsId, datasetsId, consentStoresId, consentsId	pageSize, pageToken, filter	Lists the revisions of the specified Consent in reverse chronological order.
delete_revision	delete	projectsId, locationsId, datasetsId, consentStoresId, consentsId		Deletes the specified revision of a Consent. An INVALID_ARGUMENT error occurs if the specified revision is the latest revision.

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
consentStoresId	string
consentsId	string
datasetsId	string
locationsId	string
projectsId	string
filter	string
pageSize	integer (int32)
pageToken	string

SELECT examples

list_revisions

Lists the revisions of the specified Consent in reverse chronological order.

SELECT
name,
consentArtifact,
expireTime,
metadata,
policies,
revisionCreateTime,
revisionId,
state,
ttl,
userId
FROM google.healthcare.consents_revisions
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND datasetsId = '{{ datasetsId }}' -- required
AND consentStoresId = '{{ consentStoresId }}' -- required
AND consentsId = '{{ consentsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}';

DELETE examples

delete_revision

Deletes the specified revision of a Consent. An INVALID_ARGUMENT error occurs if the specified revision is the latest revision.

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