TagKey

google.cloud.resourcemanager.v3. TagKey

Represents a TagKey.

Constructor

new TagKey(propertiesopt)

Constructs a new TagKey.

Parameters:
Name Type Attributes Description
properties google.cloud.resourcemanager.v3.ITagKey <optional>

Properties to set

Implements:
  • ITagKey

Members

createTime

TagKey createTime.

description

TagKey description.

etag

TagKey etag.

name

TagKey name.

namespacedName

TagKey namespacedName.

parent

TagKey parent.

purpose

TagKey purpose.

purposeData

TagKey purposeData.

shortName

TagKey shortName.

updateTime

TagKey updateTime.

Methods

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

Converts this TagKey to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.cloud.resourcemanager.v3.TagKey}

Creates a new TagKey instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.resourcemanager.v3.ITagKey <optional>

Properties to set

Returns:
Type Description
google.cloud.resourcemanager.v3.TagKey

TagKey instance

(static) decode(reader, lengthopt) → {google.cloud.resourcemanager.v3.TagKey}

Decodes a TagKey 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.resourcemanager.v3.TagKey

TagKey

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.resourcemanager.v3.TagKey}

Decodes a TagKey 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.resourcemanager.v3.TagKey

TagKey

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 TagKey message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.resourcemanager.v3.ITagKey

TagKey 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 TagKey message, length delimited. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.resourcemanager.v3.ITagKey

TagKey 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.resourcemanager.v3.TagKey}

Creates a TagKey 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.resourcemanager.v3.TagKey

TagKey

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for TagKey

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 TagKey message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.cloud.resourcemanager.v3.TagKey

TagKey

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

Verifies a TagKey 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