Class GoogleCloudDataplexV1AspectTypeMetadataTemplate
MetadataTemplate definition for an AspectType.
Implements
Inherited Members
Namespace: Google.Apis.CloudDataplex.v1.Data
Assembly: Google.Apis.CloudDataplex.v1.dll
Syntax
public class GoogleCloudDataplexV1AspectTypeMetadataTemplate : IDirectResponseSchema
Properties
Annotations
Optional. Specifies annotations on this field.
Declaration
[JsonProperty("annotations")]
public virtual GoogleCloudDataplexV1AspectTypeMetadataTemplateAnnotations Annotations { get; set; }
Property Value
Type | Description |
---|---|
GoogleCloudDataplexV1AspectTypeMetadataTemplateAnnotations |
ArrayItems
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.
Declaration
[JsonProperty("arrayItems")]
public virtual GoogleCloudDataplexV1AspectTypeMetadataTemplate ArrayItems { get; set; }
Property Value
Type | Description |
---|---|
GoogleCloudDataplexV1AspectTypeMetadataTemplate |
Constraints
Optional. Specifies the constraints on this field.
Declaration
[JsonProperty("constraints")]
public virtual GoogleCloudDataplexV1AspectTypeMetadataTemplateConstraints Constraints { get; set; }
Property Value
Type | Description |
---|---|
GoogleCloudDataplexV1AspectTypeMetadataTemplateConstraints |
ETag
The ETag of the item.
Declaration
public virtual string ETag { get; set; }
Property Value
Type | Description |
---|---|
string |
EnumValues
Optional. The list of values for an enum type. You must define it if the type is enum.
Declaration
[JsonProperty("enumValues")]
public virtual IList<GoogleCloudDataplexV1AspectTypeMetadataTemplateEnumValue> EnumValues { get; set; }
Property Value
Type | Description |
---|---|
IList<GoogleCloudDataplexV1AspectTypeMetadataTemplateEnumValue> |
Index
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.
Declaration
[JsonProperty("index")]
public virtual int? Index { get; set; }
Property Value
Type | Description |
---|---|
int? |
MapItems
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.
Declaration
[JsonProperty("mapItems")]
public virtual GoogleCloudDataplexV1AspectTypeMetadataTemplate MapItems { get; set; }
Property Value
Type | Description |
---|---|
GoogleCloudDataplexV1AspectTypeMetadataTemplate |
Name
Required. The name of the field.
Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type | Description |
---|---|
string |
RecordFields
Optional. Field definition. You must specify it if the type is record. It defines the nested fields.
Declaration
[JsonProperty("recordFields")]
public virtual IList<GoogleCloudDataplexV1AspectTypeMetadataTemplate> RecordFields { get; set; }
Property Value
Type | Description |
---|---|
IList<GoogleCloudDataplexV1AspectTypeMetadataTemplate> |
Type
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
Declaration
[JsonProperty("type")]
public virtual string Type { get; set; }
Property Value
Type | Description |
---|---|
string |
TypeId
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.
Declaration
[JsonProperty("typeId")]
public virtual string TypeId { get; set; }
Property Value
Type | Description |
---|---|
string |
TypeRef
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.
Declaration
[JsonProperty("typeRef")]
public virtual string TypeRef { get; set; }
Property Value
Type | Description |
---|---|
string |