Class protos.google.cloud.discoveryengine.v1alpha.RecommendRequest (1.4.1)

Represents a RecommendRequest.

Package

@google-cloud/discoveryengine

Constructors

(constructor)(properties)

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

Constructs a new RecommendRequest.

Parameter
NameDescription
properties IRecommendRequest

Properties to set

Properties

filter

public filter: string;

RecommendRequest filter.

pageSize

public pageSize: number;

RecommendRequest pageSize.

params

public params: { [k: string]: google.protobuf.IValue };

RecommendRequest params.

servingConfig

public servingConfig: string;

RecommendRequest servingConfig.

userEvent

public userEvent?: (google.cloud.discoveryengine.v1alpha.IUserEvent|null);

RecommendRequest userEvent.

userLabels

public userLabels: { [k: string]: string };

RecommendRequest userLabels.

validateOnly

public validateOnly: boolean;

RecommendRequest validateOnly.

Methods

create(properties)

public static create(properties?: google.cloud.discoveryengine.v1alpha.IRecommendRequest): google.cloud.discoveryengine.v1alpha.RecommendRequest;

Creates a new RecommendRequest instance using the specified properties.

Parameter
NameDescription
properties IRecommendRequest

Properties to set

Returns
TypeDescription
RecommendRequest

RecommendRequest instance

decode(reader, length)

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

Decodes a RecommendRequest message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
RecommendRequest

RecommendRequest

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
RecommendRequest

RecommendRequest

encode(message, writer)

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

Encodes the specified RecommendRequest message. Does not implicitly messages.

Parameters
NameDescription
message IRecommendRequest

RecommendRequest 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.discoveryengine.v1alpha.IRecommendRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IRecommendRequest

RecommendRequest 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.discoveryengine.v1alpha.RecommendRequest;

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

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

Plain object

Returns
TypeDescription
RecommendRequest

RecommendRequest

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for RecommendRequest

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

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message RecommendRequest

RecommendRequest

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