MetadataTemplate(mapping=None, *, ignore_unknown_fields=False, **kwargs)MetadataTemplate definition for AspectType
Attributes |
|
|---|---|
| Name | Description |
index |
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); 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, needs to be specified if the type is record. Defines the nested fields. |
enum_values |
MutableSequence[google.cloud.dataplex_v1.types.AspectType.MetadataTemplate.EnumValue]
Optional. The list of values for an enum type. Needs to be defined if the type is enum. |
map_items |
google.cloud.dataplex_v1.types.AspectType.MetadataTemplate
Optional. map_items needs to be set if the type is map. map_items can refer to a primitive field or a complex (record only) field. To specify a primitive field, just name and type needs to be set in the nested MetadataTemplate. The recommended value for the name field is item, as this is not used in the actual payload. |
array_items |
google.cloud.dataplex_v1.types.AspectType.MetadataTemplate
Optional. array_items needs to be set if the type is array. array_items can refer to a primitive field or a complex (record only) field. To specify a primitive field, just name and type needs to be set in the nested MetadataTemplate. The recommended value for the name field is item, as this is not used in the actual payload. |
type_id |
str
Optional. Id can be used if this definition of the field needs to be reused later. Id needs to be unique across the entire template. Id can only be specified if the field type is record. |
type_ref |
str
Optional. A reference to another field definition (instead of an inline definition). The value must be equal to the value of an id field defined elsewhere in the MetadataTemplate. Only fields with type as record can refer to other fields. |
constraints |
google.cloud.dataplex_v1.types.AspectType.MetadataTemplate.Constraints
Optional. Specifies the constraints on this field. |
annotations |
google.cloud.dataplex_v1.types.AspectType.MetadataTemplate.Annotations
Optional. Specifies annotations on this field. |
Classes
Annotations
Annotations(mapping=None, *, ignore_unknown_fields=False, **kwargs)Definition of the annotations of a field
Constraints
Constraints(mapping=None, *, ignore_unknown_fields=False, **kwargs)Definition of the constraints of a field
EnumValue
EnumValue(mapping=None, *, ignore_unknown_fields=False, **kwargs)Definition of Enumvalue (to be used by enum fields)