TagField

google.cloud.datacatalog.v1. TagField

Represents a TagField.

Constructor

new TagField(propertiesopt)

Constructs a new TagField.

Parameters:
Name Type Attributes Description
properties google.cloud.datacatalog.v1.ITagField <optional>

Properties to set

Implements:
  • ITagField

Classes

EnumValue

Members

boolValue

TagField boolValue.

displayName

TagField displayName.

doubleValue

TagField doubleValue.

enumValue

TagField enumValue.

kind

TagField kind.

order

TagField order.

richtextValue

TagField richtextValue.

stringValue

TagField stringValue.

timestampValue

TagField timestampValue.

Methods

toJSON() → {Object.<string, *>}

Converts this TagField to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.cloud.datacatalog.v1.TagField}

Creates a new TagField instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.datacatalog.v1.ITagField <optional>

Properties to set

Returns:
Type Description
google.cloud.datacatalog.v1.TagField

TagField instance

(static) decode(reader, lengthopt) → {google.cloud.datacatalog.v1.TagField}

Decodes a TagField message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Returns:
Type Description
google.cloud.datacatalog.v1.TagField

TagField

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.cloud.datacatalog.v1.TagField}

Decodes a TagField message from the specified reader or buffer, length delimited.

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Returns:
Type Description
google.cloud.datacatalog.v1.TagField

TagField

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified TagField message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.datacatalog.v1.ITagField

TagField message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

Encodes the specified TagField message, length delimited. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.datacatalog.v1.ITagField

TagField message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.cloud.datacatalog.v1.TagField}

Creates a TagField message from a plain object. Also converts values to their respective internal types.

Parameters:
Name Type Description
object Object.<string, *>

Plain object

Returns:
Type Description
google.cloud.datacatalog.v1.TagField

TagField

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for TagField

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

your custom typeUrlPrefix(default "type.googleapis.com")

Returns:
Type Description
string

The default type url

(static) toObject(message, optionsopt) → {Object.<string, *>}

Creates a plain object from a TagField message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.cloud.datacatalog.v1.TagField

TagField

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a TagField message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not