Represents a DocumentationRule.
Package
@google-cloud/service-managementConstructors
(constructor)(properties)
constructor(properties?: google.api.IDocumentationRule);
Constructs a new DocumentationRule.
Parameter | |
---|---|
Name | Description |
properties |
IDocumentationRule
Properties to set |
Properties
deprecationDescription
public deprecationDescription: string;
DocumentationRule deprecationDescription.
description
public description: string;
DocumentationRule description.
selector
public selector: string;
DocumentationRule selector.
Methods
create(properties)
public static create(properties?: google.api.IDocumentationRule): google.api.DocumentationRule;
Creates a new DocumentationRule instance using the specified properties.
Parameter | |
---|---|
Name | Description |
properties |
IDocumentationRule
Properties to set |
Returns | |
---|---|
Type | Description |
DocumentationRule | DocumentationRule instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.api.DocumentationRule;
Decodes a DocumentationRule 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 |
DocumentationRule | DocumentationRule |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.api.DocumentationRule;
Decodes a DocumentationRule message from the specified reader or buffer, length delimited.
Parameter | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
Returns | |
---|---|
Type | Description |
DocumentationRule | DocumentationRule |
encode(message, writer)
public static encode(message: google.api.IDocumentationRule, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified DocumentationRule message. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IDocumentationRule
DocumentationRule 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.api.IDocumentationRule, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified DocumentationRule message, length delimited. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IDocumentationRule
DocumentationRule 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.api.DocumentationRule;
Creates a DocumentationRule 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 |
DocumentationRule | DocumentationRule |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;
Gets the default type url for DocumentationRule
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 DocumentationRule to JSON.
Returns | |
---|---|
Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.api.DocumentationRule, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from a DocumentationRule message. Also converts values to other types if specified.
Parameters | |
---|---|
Name | Description |
message |
DocumentationRule
DocumentationRule |
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 DocumentationRule message.
Parameter | |
---|---|
Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
Returns | |
---|---|
Type | Description |
(string|null) |
|