Class protos.google.api.Documentation

Represents a Documentation.

Package

@google-cloud/service-usage

Constructors

(constructor)(properties)

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

Constructs a new Documentation.

Parameter
NameDescription
properties IDocumentation

Properties to set

Properties

documentationRootUrl

public documentationRootUrl: string;

Documentation documentationRootUrl.

overview

public overview: string;

Documentation overview.

pages

public pages: google.api.IPage[];

Documentation pages.

rules

public rules: google.api.IDocumentationRule[];

Documentation rules.

serviceRootUrl

public serviceRootUrl: string;

Documentation serviceRootUrl.

summary

public summary: string;

Documentation summary.

Methods

create(properties)

public static create(properties?: google.api.IDocumentation): google.api.Documentation;

Creates a new Documentation instance using the specified properties.

Parameter
NameDescription
properties IDocumentation

Properties to set

Returns
TypeDescription
google.api.Documentation

Documentation instance

decode(reader, length)

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

Decodes a Documentation 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.Documentation

Documentation

decodeDelimited(reader)

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

Decodes a Documentation 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.Documentation

Documentation

encode(message, writer)

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

Encodes the specified Documentation message. Does not implicitly messages.

Parameters
NameDescription
message IDocumentation

Documentation 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.IDocumentation, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IDocumentation

Documentation 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.Documentation;

Creates a Documentation 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.Documentation

Documentation

toJSON()

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

Converts this Documentation to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.api.Documentation

Documentation

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 Documentation 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