Data Catalog v1 API - Class TagField (2.2.0)

public sealed class TagField : IMessage<TagField>, IEquatable<TagField>, IDeepCloneable<TagField>, IBufferMessage, IMessage

Reference documentation and code samples for the Data Catalog v1 API class TagField.

Contains the value and additional information on a field within a [Tag][google.cloud.datacatalog.v1.Tag].

Inheritance

Object > TagField

Implements

IMessage<TagField>, IEquatable<TagField>, IDeepCloneable<TagField>, IBufferMessage, IMessage

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.DataCatalog.V1

Assembly

Google.Cloud.DataCatalog.V1.dll

Constructors

TagField()

public TagField()

TagField(TagField)

public TagField(TagField other)

Parameter
Name	Description
`other`	`TagField`

Properties

BoolValue

public bool BoolValue { get; set; }

The value of a tag field with a boolean type.

Property Value
Type	Description
`Boolean`

DisplayName

public string DisplayName { get; set; }

Output only. The display name of this field.

Property Value
Type	Description
`String`

DoubleValue

public double DoubleValue { get; set; }

The value of a tag field with a double type.

Property Value
Type	Description
`Double`

EnumValue

public TagField.Types.EnumValue EnumValue { get; set; }

The value of a tag field with an enum type.

This value must be one of the allowed values listed in this enum.

Property Value
Type	Description
`TagField.Types.EnumValue`

KindCase

public TagField.KindOneofCase KindCase { get; }

Property Value
Type	Description
`TagField.KindOneofCase`

Order

public int Order { get; set; }

Output only. The order of this field with respect to other fields in this tag. Can be set by [Tag][google.cloud.datacatalog.v1.TagTemplateField.order].

For example, a higher value can indicate a more important field. The value can be negative. Multiple fields can have the same order, and field orders within a tag don't have to be sequential.

Property Value
Type	Description
`Int32`

RichtextValue

public string RichtextValue { get; set; }

The value of a tag field with a rich text type.

The maximum length is 10 MiB as this value holds HTML descriptions including encoded images. The maximum length of the text without images is 100 KiB.

Property Value
Type	Description
`String`

StringValue

public string StringValue { get; set; }

The value of a tag field with a string type.

The maximum length is 2000 UTF-8 characters.

Property Value
Type	Description
`String`

TimestampValue

public Timestamp TimestampValue { get; set; }

The value of a tag field with a timestamp type.

Property Value
Type	Description
`Timestamp`