Class protos.google.cloud.retail.v2alpha.SearchRequest.QueryExpansionSpec (3.1.0)

Represents a QueryExpansionSpec.

Package

@google-cloud/retail

Constructors

(constructor)(properties)

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

Constructs a new QueryExpansionSpec.

Parameter
Name Description
properties IQueryExpansionSpec

Properties to set

Properties

condition

public condition: (google.cloud.retail.v2alpha.SearchRequest.QueryExpansionSpec.Condition|keyof typeof google.cloud.retail.v2alpha.SearchRequest.QueryExpansionSpec.Condition);

QueryExpansionSpec condition.

pinUnexpandedResults

public pinUnexpandedResults: boolean;

QueryExpansionSpec pinUnexpandedResults.

Methods

create(properties)

public static create(properties?: google.cloud.retail.v2alpha.SearchRequest.IQueryExpansionSpec): google.cloud.retail.v2alpha.SearchRequest.QueryExpansionSpec;

Creates a new QueryExpansionSpec instance using the specified properties.

Parameter
Name Description
properties IQueryExpansionSpec

Properties to set

Returns
Type Description
QueryExpansionSpec

QueryExpansionSpec instance

decode(reader, length)

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

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

QueryExpansionSpec

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
QueryExpansionSpec

QueryExpansionSpec

encode(message, writer)

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

Encodes the specified QueryExpansionSpec message. Does not implicitly messages.

Parameters
Name Description
message IQueryExpansionSpec

QueryExpansionSpec 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.IQueryExpansionSpec, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IQueryExpansionSpec

QueryExpansionSpec 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.QueryExpansionSpec;

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

QueryExpansionSpec

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for QueryExpansionSpec

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message QueryExpansionSpec

QueryExpansionSpec

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