Class protos.google.rpc.Help (0.2.0)

Represents a Help.

Package

Constructors

(constructor)(properties)

constructor(properties?: google.rpc.IHelp);

Constructs a new Help.

Parameter

Name	Description
properties	`IHelp` Properties to set

Properties

links

public links: google.rpc.Help.ILink[];

Help links.

Methods

create(properties)

public static create(properties?: google.rpc.IHelp): google.rpc.Help;

Creates a new Help instance using the specified properties.

Parameter

Name	Description
properties	`IHelp` Properties to set

Returns

Type	Description
google.rpc.Help	Help instance

decode(reader, length)

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

Decodes a Help 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.rpc.Help	Help

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.rpc.Help;

Decodes a Help 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.rpc.Help	Help

encode(message, writer)

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

Encodes the specified Help message. Does not implicitly messages.

Parameters

Name	Description
message	`IHelp` Help 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.rpc.IHelp, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`IHelp` Help 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.rpc.Help;

Creates a Help 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.rpc.Help	Help

toJSON()

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

Converts this Help to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

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

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

Parameters

Name	Description
message	`google.rpc.Help` Help
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 Help message.

Parameter

Name	Description
message	`{ [k: string]: any }` Plain object to verify

Returns

Type	Description
(string\|null)	`null` if valid, otherwise the reason why it is not