Cloud Dataplex v1 API - Class AspectType.Types.MetadataTemplate (2.15.0)

Version latest

• 2.15.0 (latest)
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.0.0

public sealed class AspectType.Types.MetadataTemplate : IMessage<AspectType.Types.MetadataTemplate>, IEquatable<AspectType.Types.MetadataTemplate>, IDeepCloneable<AspectType.Types.MetadataTemplate>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud Dataplex v1 API class AspectType.Types.MetadataTemplate.

MetadataTemplate definition for AspectType

Inheritance

object > AspectType.Types.MetadataTemplate

Implements

IMessageAspectTypeTypesMetadataTemplate, IEquatableAspectTypeTypesMetadataTemplate, IDeepCloneableAspectTypeTypesMetadataTemplate, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Dataplex.V1

Assembly

Google.Cloud.Dataplex.V1.dll

Constructors

MetadataTemplate()

public MetadataTemplate()

MetadataTemplate(MetadataTemplate)

public MetadataTemplate(AspectType.Types.MetadataTemplate other)

Parameter
Name	Description
other	AspectTypeTypesMetadataTemplate

Properties

Annotations

public AspectType.Types.MetadataTemplate.Types.Annotations Annotations { get; set; }

Optional. Specifies annotations on this field.

Property Value
Type	Description
AspectTypeTypesMetadataTemplateTypesAnnotations

ArrayItems

public AspectType.Types.MetadataTemplate ArrayItems { get; set; }

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.

Property Value
Type	Description
AspectTypeTypesMetadataTemplate

Constraints

public AspectType.Types.MetadataTemplate.Types.Constraints Constraints { get; set; }

Optional. Specifies the constraints on this field.

Property Value
Type	Description
AspectTypeTypesMetadataTemplateTypesConstraints

EnumValues

public RepeatedField<AspectType.Types.MetadataTemplate.Types.EnumValue> EnumValues { get; }

Optional. The list of values for an enum type. Needs to be defined if the type is enum.

Property Value
Type	Description
RepeatedFieldAspectTypeTypesMetadataTemplateTypesEnumValue

Index

public int Index { get; set; }

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.

Property Value
Type	Description
int

MapItems

public AspectType.Types.MetadataTemplate MapItems { get; set; }

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.

Property Value
Type	Description
AspectTypeTypesMetadataTemplate

Name

public string Name { get; set; }

Required. The name of the field.

Property Value
Type	Description
string

RecordFields

public RepeatedField<AspectType.Types.MetadataTemplate> RecordFields { get; }

Optional. Field definition, needs to be specified if the type is record. Defines the nested fields.

Property Value
Type	Description
RepeatedFieldAspectTypeTypesMetadataTemplate

Type

public string Type { get; set; }

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).

Property Value
Type	Description
string

TypeId

public string TypeId { get; set; }

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.

Property Value
Type	Description
string

TypeRef

public string TypeRef { get; set; }

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.

Property Value
Type	Description
string