user_data_mappings

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

Overview

Name	user_data_mappings
Type	Resource
Id	google.healthcare.user_data_mappings

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Resource name of the User data mapping, of the form projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/userDataMappings/{user_data_mapping_id}.
archiveTime	string (google-datetime)	Output only. Indicates the time when this mapping was archived.
archived	boolean	Output only. Indicates whether this mapping is archived.
dataId	string	Required. A unique identifier for the mapped resource.
resourceAttributes	array	Attributes of the resource. Only explicitly set attributes are displayed here. Attribute definitions with defaults set implicitly apply to these User data mappings. Attributes listed here must be single valued, that is, exactly one value is specified for the field "values" in each Attribute.
userId	string	Required. User's UUID provided by the client.

list

Successful response

Name	Datatype	Description
name	string	Resource name of the User data mapping, of the form projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/userDataMappings/{user_data_mapping_id}.
archiveTime	string (google-datetime)	Output only. Indicates the time when this mapping was archived.
archived	boolean	Output only. Indicates whether this mapping is archived.
dataId	string	Required. A unique identifier for the mapped resource.
resourceAttributes	array	Attributes of the resource. Only explicitly set attributes are displayed here. Attribute definitions with defaults set implicitly apply to these User data mappings. Attributes listed here must be single valued, that is, exactly one value is specified for the field "values" in each Attribute.
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
get	select	projectsId, locationsId, datasetsId, consentStoresId, userDataMappingsId		Gets the specified User data mapping.
list	select	projectsId, locationsId, datasetsId, consentStoresId	pageSize, pageToken, filter	Lists the User data mappings in the specified consent store.
create	insert	projectsId, locationsId, datasetsId, consentStoresId		Creates a new User data mapping in the parent consent store.
patch	update	projectsId, locationsId, datasetsId, consentStoresId, userDataMappingsId	updateMask	Updates the specified User data mapping.
delete	delete	projectsId, locationsId, datasetsId, consentStoresId, userDataMappingsId		Deletes the specified User data mapping.
archive	exec	projectsId, locationsId, datasetsId, consentStoresId, userDataMappingsId		Archives the specified User data mapping.

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
datasetsId	string
locationsId	string
projectsId	string
userDataMappingsId	string
filter	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

get

Gets the specified User data mapping.

SELECT
name,
archiveTime,
archived,
dataId,
resourceAttributes,
userId
FROM google.healthcare.user_data_mappings
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND datasetsId = '{{ datasetsId }}' -- required
AND consentStoresId = '{{ consentStoresId }}' -- required
AND userDataMappingsId = '{{ userDataMappingsId }}' -- required;

list

Lists the User data mappings in the specified consent store.

SELECT
name,
archiveTime,
archived,
dataId,
resourceAttributes,
userId
FROM google.healthcare.user_data_mappings
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND datasetsId = '{{ datasetsId }}' -- required
AND consentStoresId = '{{ consentStoresId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}';

INSERT examples

create

Creates a new User data mapping in the parent consent store.

INSERT INTO google.healthcare.user_data_mappings (
data__name,
data__dataId,
data__userId,
data__resourceAttributes,
projectsId,
locationsId,
datasetsId,
consentStoresId
)
SELECT 
'{{ name }}',
'{{ dataId }}',
'{{ userId }}',
'{{ resourceAttributes }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ datasetsId }}',
'{{ consentStoresId }}'
RETURNING
name,
archiveTime,
archived,
dataId,
resourceAttributes,
userId
;

Manifest

# Description fields are for documentation purposes
- name: user_data_mappings
  props:
    - name: projectsId
      value: string
      description: Required parameter for the user_data_mappings resource.
    - name: locationsId
      value: string
      description: Required parameter for the user_data_mappings resource.
    - name: datasetsId
      value: string
      description: Required parameter for the user_data_mappings resource.
    - name: consentStoresId
      value: string
      description: Required parameter for the user_data_mappings resource.
    - name: name
      value: string
      description: >
        Resource name of the User data mapping, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/userDataMappings/{user_data_mapping_id}`.
        
    - name: dataId
      value: string
      description: >
        Required. A unique identifier for the mapped resource.
        
    - name: userId
      value: string
      description: >
        Required. User's UUID provided by the client.
        
    - name: resourceAttributes
      value: array
      description: >
        Attributes of the resource. Only explicitly set attributes are displayed here. Attribute definitions with defaults set implicitly apply to these User data mappings. Attributes listed here must be single valued, that is, exactly one value is specified for the field "values" in each Attribute.
        

UPDATE examples

patch

Updates the specified User data mapping.

UPDATE google.healthcare.user_data_mappings
SET 
data__name = '{{ name }}',
data__dataId = '{{ dataId }}',
data__userId = '{{ userId }}',
data__resourceAttributes = '{{ resourceAttributes }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND datasetsId = '{{ datasetsId }}' --required
AND consentStoresId = '{{ consentStoresId }}' --required
AND userDataMappingsId = '{{ userDataMappingsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
archiveTime,
archived,
dataId,
resourceAttributes,
userId;

DELETE examples

delete

Deletes the specified User data mapping.

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

Lifecycle Methods

archive

Archives the specified User data mapping.

EXEC google.healthcare.user_data_mappings.archive 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@datasetsId='{{ datasetsId }}' --required, 
@consentStoresId='{{ consentStoresId }}' --required, 
@userDataMappingsId='{{ userDataMappingsId }}' --required;