int
Optional. Index is used to encode Template
messages. The value of index can range between 1
and 2,147,483,647. Index must be unique within
all fields in a Template. (Nested Templates can
reuse indexes). Once a Template is defined, the
index cannot be changed, because it identifies
the field in the actual storage format. Index is
a mandatory field, but it is optional for top
level fields, and map/array "values"
definitions.
name
str
Required. The name of the field.
type_
str
Required. The datatype of this field. The following values
are supported:
Primitive types:
- string
- integer
- boolean
- double
- datetime. Must be of the format RFC3339 UTC "Zulu"
(Examples: "2014-10-02T15:01:23Z" and
"2014-10-02T15:01:23.045123456Z").
Complex types:
- enum
- array
- map
- record
record_fields
MutableSequence[google.cloud.dataplex_v1.types.AspectType.MetadataTemplate]
Optional. Field definition. You must specify
it if the type is record. It defines the nested
fields.
google.cloud.dataplex_v1.types.AspectType.MetadataTemplate
Optional. If the type is map, set map_items. map_items can
refer to a primitive field or a complex (record only) field.
To specify a primitive field, you only need to set name and
type in the nested MetadataTemplate. The recommended value
for the name field is item, as this isn't used in the actual
payload.
array_items
google.cloud.dataplex_v1.types.AspectType.MetadataTemplate
Optional. If the type is array, set array_items. array_items
can refer to a primitive field or a complex (record only)
field. To specify a primitive field, you only need to set
name and type in the nested MetadataTemplate. The
recommended value for the name field is item, as this isn't
used in the actual payload.
type_id
str
Optional. You can use type id if this
definition of the field needs to be reused
later. The type id must be unique across the
entire template. You can only specify it if the
field type is record.
type_ref
str
Optional. A reference to another field
definition (not an inline definition). The value
must be equal to the value of an id field
defined elsewhere in the MetadataTemplate. Only
fields with record type can refer to other
fields.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[],[],null,["# Class MetadataTemplate (2.11.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.11.0 (latest)](/python/docs/reference/dataplex/latest/google.cloud.dataplex_v1.types.AspectType.MetadataTemplate)\n- [2.10.2](/python/docs/reference/dataplex/2.10.2/google.cloud.dataplex_v1.types.AspectType.MetadataTemplate)\n- [2.9.0](/python/docs/reference/dataplex/2.9.0/google.cloud.dataplex_v1.types.AspectType.MetadataTemplate)\n- [2.8.0](/python/docs/reference/dataplex/2.8.0/google.cloud.dataplex_v1.types.AspectType.MetadataTemplate)\n- [2.7.1](/python/docs/reference/dataplex/2.7.1/google.cloud.dataplex_v1.types.AspectType.MetadataTemplate)\n- [2.6.0](/python/docs/reference/dataplex/2.6.0/google.cloud.dataplex_v1.types.AspectType.MetadataTemplate)\n- [2.5.0](/python/docs/reference/dataplex/2.5.0/google.cloud.dataplex_v1.types.AspectType.MetadataTemplate)\n- [2.4.0](/python/docs/reference/dataplex/2.4.0/google.cloud.dataplex_v1.types.AspectType.MetadataTemplate)\n- [2.3.1](/python/docs/reference/dataplex/2.3.1/google.cloud.dataplex_v1.types.AspectType.MetadataTemplate)\n- [2.2.2](/python/docs/reference/dataplex/2.2.2/google.cloud.dataplex_v1.types.AspectType.MetadataTemplate)\n- [2.1.0](/python/docs/reference/dataplex/2.1.0/google.cloud.dataplex_v1.types.AspectType.MetadataTemplate)\n- [2.0.1](/python/docs/reference/dataplex/2.0.1/google.cloud.dataplex_v1.types.AspectType.MetadataTemplate)\n- [1.13.0](/python/docs/reference/dataplex/1.13.0/google.cloud.dataplex_v1.types.AspectType.MetadataTemplate)\n- [1.12.3](/python/docs/reference/dataplex/1.12.3/google.cloud.dataplex_v1.types.AspectType.MetadataTemplate)\n- [1.11.0](/python/docs/reference/dataplex/1.11.0/google.cloud.dataplex_v1.types.AspectType.MetadataTemplate)\n- [1.10.0](/python/docs/reference/dataplex/1.10.0/google.cloud.dataplex_v1.types.AspectType.MetadataTemplate)\n- [1.9.0](/python/docs/reference/dataplex/1.9.0/google.cloud.dataplex_v1.types.AspectType.MetadataTemplate)\n- [1.8.1](/python/docs/reference/dataplex/1.8.1/google.cloud.dataplex_v1.types.AspectType.MetadataTemplate)\n- [1.7.0](/python/docs/reference/dataplex/1.7.0/google.cloud.dataplex_v1.types.AspectType.MetadataTemplate)\n- [1.6.2](/python/docs/reference/dataplex/1.6.2/google.cloud.dataplex_v1.types.AspectType.MetadataTemplate)\n- [1.5.1](/python/docs/reference/dataplex/1.5.1/google.cloud.dataplex_v1.types.AspectType.MetadataTemplate)\n- [1.4.3](/python/docs/reference/dataplex/1.4.3/google.cloud.dataplex_v1.types.AspectType.MetadataTemplate)\n- [1.3.0](/python/docs/reference/dataplex/1.3.0/google.cloud.dataplex_v1.types.AspectType.MetadataTemplate)\n- [1.2.0](/python/docs/reference/dataplex/1.2.0/google.cloud.dataplex_v1.types.AspectType.MetadataTemplate)\n- [1.1.3](/python/docs/reference/dataplex/1.1.3/google.cloud.dataplex_v1.types.AspectType.MetadataTemplate)\n- [1.0.1](/python/docs/reference/dataplex/1.0.1/google.cloud.dataplex_v1.types.AspectType.MetadataTemplate)\n- [0.2.1](/python/docs/reference/dataplex/0.2.1/google.cloud.dataplex_v1.types.AspectType.MetadataTemplate)\n- [0.1.0](/python/docs/reference/dataplex/0.1.0/google.cloud.dataplex_v1.types.AspectType.MetadataTemplate) \n\n MetadataTemplate(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nMetadataTemplate definition for an AspectType.\n\nClasses\n-------\n\n### Annotations\n\n Annotations(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nDefinition of the annotations of a field.\n\n### Constraints\n\n Constraints(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nDefinition of the constraints of a field.\n\n### EnumValue\n\n EnumValue(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nDefinition of Enumvalue, to be used for enum fields."]]