Skip to main content

attribute_definitions

Overview

Nameattribute_definitions
TypeResource
Idgoogle.healthcare.attribute_definitions

Fields

NameDatatypeDescription
namestringResource name of the Attribute definition, of the form projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/attributeDefinitions/{attribute_definition_id}. Cannot be changed after creation.
descriptionstringOptional. A description of the attribute.
allowedValuesarrayRequired. Possible values for the attribute. The number of allowed values must not exceed 500. An empty list is invalid. The list can only be expanded after creation.
categorystringRequired. The category of the attribute. The value of this field cannot be changed after creation.
consentDefaultValuesarrayOptional. Default values of the attribute in Consents. If no default values are specified, it defaults to an empty value.
dataMappingDefaultValuestringOptional. Default value of the attribute in User data mappings. If no default value is specified, it defaults to an empty value. This field is only applicable to attributes of the category RESOURCE.

Methods

NameAccessible byRequired ParamsDescription
getSELECTattributeDefinitionsId, consentStoresId, datasetsId, locationsId, projectsIdGets the specified Attribute definition.
listSELECTconsentStoresId, datasetsId, locationsId, projectsIdLists the Attribute definitions in the specified consent store.
createINSERTconsentStoresId, datasetsId, locationsId, projectsIdCreates a new Attribute definition in the parent consent store.
deleteDELETEattributeDefinitionsId, consentStoresId, datasetsId, locationsId, projectsIdDeletes the specified Attribute definition. Fails if the Attribute definition is referenced by any User data mapping, or the latest revision of any Consent.
_listEXECconsentStoresId, datasetsId, locationsId, projectsIdLists the Attribute definitions in the specified consent store.
patchEXECattributeDefinitionsId, consentStoresId, datasetsId, locationsId, projectsIdUpdates the specified Attribute definition.