CompletionConfig

google.cloud.retail.v2alpha. CompletionConfig

Represents a CompletionConfig.

Constructor

new CompletionConfig(propertiesopt)

Constructs a new CompletionConfig.

Parameters:
Name Type Attributes Description
properties google.cloud.retail.v2alpha.ICompletionConfig <optional>

Properties to set

Implements:
  • ICompletionConfig

Members

allowlistInputConfig

CompletionConfig allowlistInputConfig.

autoLearning

CompletionConfig autoLearning.

denylistInputConfig

CompletionConfig denylistInputConfig.

lastAllowlistImportOperation

CompletionConfig lastAllowlistImportOperation.

lastDenylistImportOperation

CompletionConfig lastDenylistImportOperation.

lastSuggestionsImportOperation

CompletionConfig lastSuggestionsImportOperation.

matchingOrder

CompletionConfig matchingOrder.

maxSuggestions

CompletionConfig maxSuggestions.

minPrefixLength

CompletionConfig minPrefixLength.

name

CompletionConfig name.

suggestionsInputConfig

CompletionConfig suggestionsInputConfig.

Methods

toJSON() → {Object.<string, *>}

Converts this CompletionConfig to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.cloud.retail.v2alpha.CompletionConfig}

Creates a new CompletionConfig instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.retail.v2alpha.ICompletionConfig <optional>

Properties to set

Returns:
Type Description
google.cloud.retail.v2alpha.CompletionConfig

CompletionConfig instance

(static) decode(reader, lengthopt) → {google.cloud.retail.v2alpha.CompletionConfig}

Decodes a CompletionConfig message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Returns:
Type Description
google.cloud.retail.v2alpha.CompletionConfig

CompletionConfig

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.cloud.retail.v2alpha.CompletionConfig}

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

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Returns:
Type Description
google.cloud.retail.v2alpha.CompletionConfig

CompletionConfig

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified CompletionConfig message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.retail.v2alpha.ICompletionConfig

CompletionConfig message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

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

Parameters:
Name Type Attributes Description
message google.cloud.retail.v2alpha.ICompletionConfig

CompletionConfig message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.cloud.retail.v2alpha.CompletionConfig}

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

Parameters:
Name Type Description
object Object.<string, *>

Plain object

Returns:
Type Description
google.cloud.retail.v2alpha.CompletionConfig

CompletionConfig

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for CompletionConfig

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

your custom typeUrlPrefix(default "type.googleapis.com")

Returns:
Type Description
string

The default type url

(static) toObject(message, optionsopt) → {Object.<string, *>}

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

Parameters:
Name Type Attributes Description
message google.cloud.retail.v2alpha.CompletionConfig

CompletionConfig

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a CompletionConfig message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not