Class protos.google.api.LabelDescriptor

Represents a LabelDescriptor.

Package

@google-cloud/logging

Constructors

(constructor)(properties)

constructor(properties?: google.api.ILabelDescriptor);

Constructs a new LabelDescriptor.

Parameter
NameDescription
properties ILabelDescriptor

Properties to set

Properties

description

public description: string;

LabelDescriptor description.

Property Value
TypeDescription
string

key

public key: string;

LabelDescriptor key.

Property Value
TypeDescription
string

valueType

public valueType: (google.api.LabelDescriptor.ValueType|keyof typeof google.api.LabelDescriptor.ValueType);

LabelDescriptor valueType.

Property Value
TypeDescription
(google.api.LabelDescriptor.ValueType|keyof typeof google.api.LabelDescriptor.ValueType)

Methods

create(properties)

public static create(properties?: google.api.ILabelDescriptor): google.api.LabelDescriptor;

Creates a new LabelDescriptor instance using the specified properties.

Parameter
NameDescription
properties ILabelDescriptor

Properties to set

Returns
TypeDescription
google.api.LabelDescriptor

LabelDescriptor instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.api.LabelDescriptor;

Decodes a LabelDescriptor message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.api.LabelDescriptor

LabelDescriptor

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.api.LabelDescriptor;

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.api.LabelDescriptor

LabelDescriptor

encode(message, writer)

public static encode(message: google.api.ILabelDescriptor, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified LabelDescriptor message. Does not implicitly messages.

Parameters
NameDescription
message ILabelDescriptor

LabelDescriptor message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.api.ILabelDescriptor, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message ILabelDescriptor

LabelDescriptor message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.api.LabelDescriptor;

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

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
google.api.LabelDescriptor

LabelDescriptor

toJSON()

public toJSON(): { [k: string]: any };

Converts this LabelDescriptor to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.api.LabelDescriptor, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
NameDescription
message google.api.LabelDescriptor

LabelDescriptor

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a LabelDescriptor message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not