Class protos.google.cloud.retail.v2alpha.SearchRequest.ConversationalSearchSpec (3.6.0)
Stay organized with collections Save and categorize content based on your preferences.

Represents a ConversationalSearchSpec.

Package

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.retail.v2alpha.SearchRequest.IConversationalSearchSpec);

Constructs a new ConversationalSearchSpec.

Parameter
Name	Description
`properties`	`IConversationalSearchSpec` Properties to set

Properties

conversationId

public conversationId: string;

ConversationalSearchSpec conversationId.

followupConversationRequested

public followupConversationRequested: boolean;

ConversationalSearchSpec followupConversationRequested.

userAnswer

public userAnswer?: (google.cloud.retail.v2alpha.SearchRequest.ConversationalSearchSpec.IUserAnswer|null);

ConversationalSearchSpec userAnswer.

Methods

create(properties)

public static create(properties?: google.cloud.retail.v2alpha.SearchRequest.IConversationalSearchSpec): google.cloud.retail.v2alpha.SearchRequest.ConversationalSearchSpec;

Creates a new ConversationalSearchSpec instance using the specified properties.

Parameter
Name	Description
`properties`	`IConversationalSearchSpec` Properties to set

Returns
Type	Description
`ConversationalSearchSpec`	ConversationalSearchSpec instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.retail.v2alpha.SearchRequest.ConversationalSearchSpec;

Decodes a ConversationalSearchSpec 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
`ConversationalSearchSpec`	ConversationalSearchSpec

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.retail.v2alpha.SearchRequest.ConversationalSearchSpec;

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

Parameter
Name	Description
`reader`	`(Reader\|Uint8Array)` Reader or buffer to decode from

Returns
Type	Description
`ConversationalSearchSpec`	ConversationalSearchSpec

encode(message, writer)

public static encode(message: google.cloud.retail.v2alpha.SearchRequest.IConversationalSearchSpec, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified ConversationalSearchSpec message. Does not implicitly messages.

Parameters
Name	Description
`message`	`IConversationalSearchSpec` ConversationalSearchSpec 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.retail.v2alpha.SearchRequest.IConversationalSearchSpec, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name	Description
`message`	`IConversationalSearchSpec` ConversationalSearchSpec 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.retail.v2alpha.SearchRequest.ConversationalSearchSpec;

Creates a ConversationalSearchSpec 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
`ConversationalSearchSpec`	ConversationalSearchSpec

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for ConversationalSearchSpec

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

Returns
Type	Description
`{ [k: string]: any }`	JSON object

toObject(message, options)

public static toObject(message: google.cloud.retail.v2alpha.SearchRequest.ConversationalSearchSpec, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
Name	Description
`message`	`ConversationalSearchSpec` ConversationalSearchSpec
`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 ConversationalSearchSpec 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

Class protos.google.cloud.retail.v2alpha.SearchRequest.ConversationalSearchSpec (3.6.0) Stay organized with collections Save and categorize content based on your preferences.