Class protos.google.cloud.retail.v2.CompletionDataInputConfig (3.6.0)

Represents a CompletionDataInputConfig.

Package

@google-cloud/retail

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.retail.v2.ICompletionDataInputConfig);

Constructs a new CompletionDataInputConfig.

Parameter
Name Description
properties ICompletionDataInputConfig

Properties to set

Properties

bigQuerySource

public bigQuerySource?: (google.cloud.retail.v2.IBigQuerySource|null);

CompletionDataInputConfig bigQuerySource.

source

public source?: "bigQuerySource";

CompletionDataInputConfig source.

Methods

create(properties)

public static create(properties?: google.cloud.retail.v2.ICompletionDataInputConfig): google.cloud.retail.v2.CompletionDataInputConfig;

Creates a new CompletionDataInputConfig instance using the specified properties.

Parameter
Name Description
properties ICompletionDataInputConfig

Properties to set

Returns
Type Description
CompletionDataInputConfig

CompletionDataInputConfig instance

decode(reader, length)

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

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

CompletionDataInputConfig

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.retail.v2.CompletionDataInputConfig;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
CompletionDataInputConfig

CompletionDataInputConfig

encode(message, writer)

public static encode(message: google.cloud.retail.v2.ICompletionDataInputConfig, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified CompletionDataInputConfig message. Does not implicitly messages.

Parameters
Name Description
message ICompletionDataInputConfig

CompletionDataInputConfig 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.v2.ICompletionDataInputConfig, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message ICompletionDataInputConfig

CompletionDataInputConfig 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.v2.CompletionDataInputConfig;

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

CompletionDataInputConfig

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for CompletionDataInputConfig

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message CompletionDataInputConfig

CompletionDataInputConfig

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