Class protos.google.cloud.contentwarehouse.v1.SynonymSet (0.3.1)

Represents a SynonymSet.

Package

@google-cloud/contentwarehouse

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.contentwarehouse.v1.ISynonymSet);

Constructs a new SynonymSet.

Parameter
NameDescription
properties ISynonymSet

Properties to set

Properties

context

public context: string;

SynonymSet context.

name

public name: string;

SynonymSet name.

synonyms

public synonyms: google.cloud.contentwarehouse.v1.SynonymSet.ISynonym[];

SynonymSet synonyms.

Methods

create(properties)

public static create(properties?: google.cloud.contentwarehouse.v1.ISynonymSet): google.cloud.contentwarehouse.v1.SynonymSet;

Creates a new SynonymSet instance using the specified properties.

Parameter
NameDescription
properties ISynonymSet

Properties to set

Returns
TypeDescription
google.cloud.contentwarehouse.v1.SynonymSet

SynonymSet instance

decode(reader, length)

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

Decodes a SynonymSet 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.cloud.contentwarehouse.v1.SynonymSet

SynonymSet

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.contentwarehouse.v1.SynonymSet

SynonymSet

encode(message, writer)

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

Encodes the specified SynonymSet message. Does not implicitly messages.

Parameters
NameDescription
message ISynonymSet

SynonymSet 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.cloud.contentwarehouse.v1.ISynonymSet, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message ISynonymSet

SynonymSet 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.cloud.contentwarehouse.v1.SynonymSet;

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

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

Plain object

Returns
TypeDescription
google.cloud.contentwarehouse.v1.SynonymSet

SynonymSet

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for SynonymSet

Parameter
NameDescription
typeUrlPrefix string

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

Returns
TypeDescription
string

The default type url

toJSON()

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

Converts this SynonymSet to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.cloud.contentwarehouse.v1.SynonymSet

SynonymSet

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