Represents a TagKey.
Package
@google-cloud/resource-managerConstructors
(constructor)(properties)
constructor(properties?: google.cloud.resourcemanager.v3.ITagKey);
Constructs a new TagKey.
Parameter | |
---|---|
Name | Description |
properties |
ITagKey
Properties to set |
Properties
createTime
public createTime?: (google.protobuf.ITimestamp|null);
TagKey createTime.
description
public description: string;
TagKey description.
etag
public etag: string;
TagKey etag.
name
public name: string;
TagKey name.
namespacedName
public namespacedName: string;
TagKey namespacedName.
parent
public parent: string;
TagKey parent.
purpose
public purpose: (google.cloud.resourcemanager.v3.Purpose|keyof typeof google.cloud.resourcemanager.v3.Purpose);
TagKey purpose.
purposeData
public purposeData: { [k: string]: string };
TagKey purposeData.
shortName
public shortName: string;
TagKey shortName.
updateTime
public updateTime?: (google.protobuf.ITimestamp|null);
TagKey updateTime.
Methods
create(properties)
public static create(properties?: google.cloud.resourcemanager.v3.ITagKey): google.cloud.resourcemanager.v3.TagKey;
Creates a new TagKey instance using the specified properties.
Parameter | |
---|---|
Name | Description |
properties |
ITagKey
Properties to set |
Returns | |
---|---|
Type | Description |
google.cloud.resourcemanager.v3.TagKey | TagKey instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.resourcemanager.v3.TagKey;
Decodes a TagKey message from the specified reader or buffer.
Parameters | |
---|---|
Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
Returns | |
---|---|
Type | Description |
google.cloud.resourcemanager.v3.TagKey | TagKey |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.resourcemanager.v3.TagKey;
Decodes a TagKey message from the specified reader or buffer, length delimited.
Parameter | |
---|---|
Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
Returns | |
---|---|
Type | Description |
google.cloud.resourcemanager.v3.TagKey | TagKey |
encode(message, writer)
public static encode(message: google.cloud.resourcemanager.v3.ITagKey, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified TagKey message. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
ITagKey
TagKey message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
Returns | |
---|---|
Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.resourcemanager.v3.ITagKey, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified TagKey message, length delimited. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
ITagKey
TagKey message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
Returns | |
---|---|
Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.resourcemanager.v3.TagKey;
Creates a TagKey message from a plain object. Also converts values to their respective internal types.
Parameter | |
---|---|
Name | Description |
object |
{ [k: string]: any }
Plain object |
Returns | |
---|---|
Type | Description |
google.cloud.resourcemanager.v3.TagKey | TagKey |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;
Gets the default type url for TagKey
Parameter | |
---|---|
Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
Returns | |
---|---|
Type | Description |
string | The default type url |
toJSON()
public toJSON(): { [k: string]: any };
Converts this TagKey to JSON.
Returns | |
---|---|
Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.resourcemanager.v3.TagKey, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from a TagKey message. Also converts values to other types if specified.
Parameters | |
---|---|
Name | Description |
message |
google.cloud.resourcemanager.v3.TagKey
TagKey |
options |
$protobuf.IConversionOptions
Conversion options |
Returns | |
---|---|
Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);
Verifies a TagKey message.
Parameter | |
---|---|
Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
Returns | |
---|---|
Type | Description |
(string|null) |
|