REST Resource: projects.locations.datasets.consentStores.attributeDefinitions

Resource: AttributeDefinition

A client-defined consent attribute.

JSON representation
{
  "name": string,
  "description": string,
  "category": enum(Category),
  "allowedValues": [
    string
  ],
  "consentDefaultValues": [
    string
  ],
  "dataMappingDefaultValue": string
}
Fields
name

string

Resource name of the attribute definition, of the form projects/{projectId}/locations/{locationId}/datasets/{datasetId}/consentStores/{consentStoreId}/attributeDefinitions/{attributeDefinitionId}.

description

string

A description of the attribute.

category

enum(Category)

Required. The category of the attribute. The value of this field cannot be changed after creation.

allowedValues[]

string

Required. Possible values for the attribute. The number of allowed values must not exceed 100. An empty list is invalid. The list can only be expanded after creation.

consentDefaultValues[]

string

Default values of the attribute in consents. If no default values are specified, it defaults to an empty value.

dataMappingDefaultValue

string

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.

Category

The category of an attribute.

Enums
CATEGORY_UNSPECIFIED No category specified. This option is invalid.
RESOURCE Specify when this attribute captures properties of data resources. For example, data anonymity or data type.
REQUEST Specify when this attribute captures properties of access requests. For example, requester's role or requester's organization.

Methods

create

Creates a new Attribute definition in the parent Consent store.

delete

Deletes the specified Attribute definition.

get

Gets the specified Attribute definition.

list

Lists the Attribute definitions in the given Consent store.

patch

Updates the specified Attribute definition.