Class protos.google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest (2.6.0)

Represents an AdvancedCompleteQueryRequest.

Package

@google-cloud/discoveryengine

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.discoveryengine.v1beta.IAdvancedCompleteQueryRequest);

Constructs a new AdvancedCompleteQueryRequest.

Parameter
Name Description
properties IAdvancedCompleteQueryRequest

Properties to set

Properties

boostSpec

public boostSpec?: (google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest.IBoostSpec|null);

AdvancedCompleteQueryRequest boostSpec.

completionConfig

public completionConfig: string;

AdvancedCompleteQueryRequest completionConfig.

includeTailSuggestions

public includeTailSuggestions: boolean;

AdvancedCompleteQueryRequest includeTailSuggestions.

query

public query: string;

AdvancedCompleteQueryRequest query.

queryModel

public queryModel: string;

AdvancedCompleteQueryRequest queryModel.

suggestionTypes

public suggestionTypes: google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest.SuggestionType[];

AdvancedCompleteQueryRequest suggestionTypes.

userInfo

public userInfo?: (google.cloud.discoveryengine.v1beta.IUserInfo|null);

AdvancedCompleteQueryRequest userInfo.

userPseudoId

public userPseudoId: string;

AdvancedCompleteQueryRequest userPseudoId.

Methods

create(properties)

public static create(properties?: google.cloud.discoveryengine.v1beta.IAdvancedCompleteQueryRequest): google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest;

Creates a new AdvancedCompleteQueryRequest instance using the specified properties.

Parameter
Name Description
properties IAdvancedCompleteQueryRequest

Properties to set

Returns
Type Description
AdvancedCompleteQueryRequest

AdvancedCompleteQueryRequest instance

decode(reader, length)

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

Decodes an AdvancedCompleteQueryRequest 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
AdvancedCompleteQueryRequest

AdvancedCompleteQueryRequest

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest;

Decodes an AdvancedCompleteQueryRequest message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
AdvancedCompleteQueryRequest

AdvancedCompleteQueryRequest

encode(message, writer)

public static encode(message: google.cloud.discoveryengine.v1beta.IAdvancedCompleteQueryRequest, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified AdvancedCompleteQueryRequest message. Does not implicitly messages.

Parameters
Name Description
message IAdvancedCompleteQueryRequest

AdvancedCompleteQueryRequest 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.v1beta.IAdvancedCompleteQueryRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IAdvancedCompleteQueryRequest

AdvancedCompleteQueryRequest 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.v1beta.AdvancedCompleteQueryRequest;

Creates an AdvancedCompleteQueryRequest 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
AdvancedCompleteQueryRequest

AdvancedCompleteQueryRequest

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for AdvancedCompleteQueryRequest

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message AdvancedCompleteQueryRequest

AdvancedCompleteQueryRequest

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 an AdvancedCompleteQueryRequest 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