Class MetadataTemplate (2.5.0)

Version latest

• 2.5.0 (latest)
• 2.4.0
• 2.3.1
• 2.2.2
• 2.1.0
• 2.0.1
• 1.13.0
• 1.12.3
• 1.11.0
• 1.10.0
• 1.9.0
• 1.8.1
• 1.7.0
• 1.6.2
• 1.5.1
• 1.4.3
• 1.3.0
• 1.2.0
• 1.1.3
• 1.0.1
• 0.2.1
• 0.1.0

MetadataTemplate(mapping=None, *, ignore_unknown_fields=False, **kwargs)

MetadataTemplate definition for an 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. 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.
enum_values	MutableSequence[google.cloud.dataplex_v1.types.AspectType.MetadataTemplate.EnumValue] Optional. The list of values for an enum type. You must define it if the type is enum.
map_items	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.
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 for enum fields.