Class protos.google.cloud.compute.v1.HelpLink (4.5.0)

Represents a HelpLink.

Package

@google-cloud/compute

Constructors

constructor(properties?: google.cloud.compute.v1.IHelpLink);

Constructs a new HelpLink.

Parameter
Name Description
properties IHelpLink

Properties to set

Properties

public _description?: "description";

HelpLink _description.

public _url?: "url";

HelpLink _url.

public description?: (string|null);

HelpLink description.

public url?: (string|null);

HelpLink url.

Methods

public static create(properties?: google.cloud.compute.v1.IHelpLink): google.cloud.compute.v1.HelpLink;

Creates a new HelpLink instance using the specified properties.

Parameter
Name Description
properties IHelpLink

Properties to set

Returns
Type Description
HelpLink

HelpLink instance

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.compute.v1.HelpLink;

Decodes a HelpLink message from the specified reader or buffer.

Parameters
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
Type Description
HelpLink

HelpLink

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.compute.v1.HelpLink;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
HelpLink

HelpLink

public static encode(message: google.cloud.compute.v1.IHelpLink, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified HelpLink message. Does not implicitly messages.

Parameters
Name Description
message IHelpLink

HelpLink message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
Type Description
$protobuf.Writer

Writer

public static encodeDelimited(message: google.cloud.compute.v1.IHelpLink, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IHelpLink

HelpLink message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
Type Description
$protobuf.Writer

Writer

public static fromObject(object: { [k: string]: any }): google.cloud.compute.v1.HelpLink;

Creates a HelpLink 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
HelpLink

HelpLink

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for HelpLink

Parameter
Name Description
typeUrlPrefix string

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

Returns
Type Description
string

The default type url

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

Converts this HelpLink to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

public static toObject(message: google.cloud.compute.v1.HelpLink, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
Name Description
message HelpLink

HelpLink

options $protobuf.IConversionOptions

Conversion options

Returns
Type Description
{ [k: string]: any }

Plain object

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

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