Class protos.google.cloud.dialogflow.v2beta1.SearchKnowledgeRequest (6.12.0)

Represents a SearchKnowledgeRequest.

Package

@google-cloud/dialogflow

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.dialogflow.v2beta1.ISearchKnowledgeRequest);

Constructs a new SearchKnowledgeRequest.

Parameter
Name Description
properties ISearchKnowledgeRequest

Properties to set

Properties

conversation

public conversation: string;

SearchKnowledgeRequest conversation.

conversationProfile

public conversationProfile: string;

SearchKnowledgeRequest conversationProfile.

endUserMetadata

public endUserMetadata?: (google.protobuf.IStruct|null);

SearchKnowledgeRequest endUserMetadata.

exactSearch

public exactSearch: boolean;

SearchKnowledgeRequest exactSearch.

latestMessage

public latestMessage: string;

SearchKnowledgeRequest latestMessage.

parent

public parent: string;

SearchKnowledgeRequest parent.

query

public query?: (google.cloud.dialogflow.v2beta1.ITextInput|null);

SearchKnowledgeRequest query.

querySource

public querySource: (google.cloud.dialogflow.v2beta1.SearchKnowledgeRequest.QuerySource|keyof typeof google.cloud.dialogflow.v2beta1.SearchKnowledgeRequest.QuerySource);

SearchKnowledgeRequest querySource.

searchConfig

public searchConfig?: (google.cloud.dialogflow.v2beta1.SearchKnowledgeRequest.ISearchConfig|null);

SearchKnowledgeRequest searchConfig.

sessionId

public sessionId: string;

SearchKnowledgeRequest sessionId.

Methods

create(properties)

public static create(properties?: google.cloud.dialogflow.v2beta1.ISearchKnowledgeRequest): google.cloud.dialogflow.v2beta1.SearchKnowledgeRequest;

Creates a new SearchKnowledgeRequest instance using the specified properties.

Parameter
Name Description
properties ISearchKnowledgeRequest

Properties to set

Returns
Type Description
SearchKnowledgeRequest

SearchKnowledgeRequest instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.dialogflow.v2beta1.SearchKnowledgeRequest;

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

SearchKnowledgeRequest

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.dialogflow.v2beta1.SearchKnowledgeRequest;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
SearchKnowledgeRequest

SearchKnowledgeRequest

encode(message, writer)

public static encode(message: google.cloud.dialogflow.v2beta1.ISearchKnowledgeRequest, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified SearchKnowledgeRequest message. Does not implicitly messages.

Parameters
Name Description
message ISearchKnowledgeRequest

SearchKnowledgeRequest 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.dialogflow.v2beta1.ISearchKnowledgeRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message ISearchKnowledgeRequest

SearchKnowledgeRequest 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.dialogflow.v2beta1.SearchKnowledgeRequest;

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

SearchKnowledgeRequest

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for SearchKnowledgeRequest

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message SearchKnowledgeRequest

SearchKnowledgeRequest

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