Class protos.google.cloud.discoveryengine.v1alpha.Control.SynonymsAction (1.9.0)

Represents a SynonymsAction.

Package

@google-cloud/discoveryengine

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.discoveryengine.v1alpha.Control.ISynonymsAction);

Constructs a new SynonymsAction.

Parameter
Name Description
properties ISynonymsAction

Properties to set

Properties

synonyms

public synonyms: string[];

SynonymsAction synonyms.

Methods

create(properties)

public static create(properties?: google.cloud.discoveryengine.v1alpha.Control.ISynonymsAction): google.cloud.discoveryengine.v1alpha.Control.SynonymsAction;

Creates a new SynonymsAction instance using the specified properties.

Parameter
Name Description
properties ISynonymsAction

Properties to set

Returns
Type Description
SynonymsAction

SynonymsAction instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.discoveryengine.v1alpha.Control.SynonymsAction;

Decodes a SynonymsAction 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
SynonymsAction

SynonymsAction

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.discoveryengine.v1alpha.Control.SynonymsAction;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
SynonymsAction

SynonymsAction

encode(message, writer)

public static encode(message: google.cloud.discoveryengine.v1alpha.Control.ISynonymsAction, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified SynonymsAction message. Does not implicitly messages.

Parameters
Name Description
message ISynonymsAction

SynonymsAction 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.cloud.discoveryengine.v1alpha.Control.ISynonymsAction, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message ISynonymsAction

SynonymsAction 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.cloud.discoveryengine.v1alpha.Control.SynonymsAction;

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

SynonymsAction

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for SynonymsAction

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 SynonymsAction to JSON.

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

JSON object

toObject(message, options)

public static toObject(message: google.cloud.discoveryengine.v1alpha.Control.SynonymsAction, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
Name Description
message SynonymsAction

SynonymsAction

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