Google Cloud Retail V2 Client - Class UpdateCompletionConfigRequest (1.3.1)

Reference documentation and code samples for the Google Cloud Retail V2 Client class UpdateCompletionConfigRequest.

Request for CatalogService.UpdateCompletionConfig method.

Generated from protobuf message google.cloud.retail.v2.UpdateCompletionConfigRequest

Namespace

Google \ Cloud \ Retail \ V2

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ completion_config
Google\Cloud\Retail\V2\CompletionConfig

Required. The CompletionConfig to update. If the caller does not have permission to update the CompletionConfig , then a PERMISSION_DENIED error is returned. If the CompletionConfig to update does not exist, a NOT_FOUND error is returned.

↳ update_mask
Google\Protobuf\FieldMask

Indicates which fields in the provided CompletionConfig to update. The following are the only supported fields: * CompletionConfig.matching_order * CompletionConfig.max_suggestions * CompletionConfig.min_prefix_length * CompletionConfig.auto_learning If not set, all supported fields are updated.

getCompletionConfig

Required. The CompletionConfig to update.

If the caller does not have permission to update the CompletionConfig , then a PERMISSION_DENIED error is returned. If the CompletionConfig to update does not exist, a NOT_FOUND error is returned.

Returns
Type
Description

hasCompletionConfig

clearCompletionConfig

setCompletionConfig

Required. The CompletionConfig to update.

If the caller does not have permission to update the CompletionConfig , then a PERMISSION_DENIED error is returned. If the CompletionConfig to update does not exist, a NOT_FOUND error is returned.

Parameter
Name
Description
Returns
Type
Description
$this

getUpdateMask

Indicates which fields in the provided CompletionConfig to update. The following are the only supported fields:

Returns
Type
Description

hasUpdateMask

clearUpdateMask

setUpdateMask

Indicates which fields in the provided CompletionConfig to update. The following are the only supported fields:

Parameter
Name
Description
Returns
Type
Description
$this

static::build

Parameters
Name
Description
completionConfig
Google\Cloud\Retail\V2\CompletionConfig

Required. The CompletionConfig to update.

If the caller does not have permission to update the CompletionConfig , then a PERMISSION_DENIED error is returned.

If the CompletionConfig to update does not exist, a NOT_FOUND error is returned.

updateMask
Google\Protobuf\FieldMask

Indicates which fields in the provided CompletionConfig to update. The following are the only supported fields:

If not set, all supported fields are updated.

Design a Mobile Site
View Site in Mobile | Classic
Share by: