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
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.
Generated from protobuf field .google.cloud.retail.v2.CompletionConfig completion_config = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Retail\V2\CompletionConfig|null | |
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.
Generated from protobuf field .google.cloud.retail.v2.CompletionConfig completion_config = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Retail\V2\CompletionConfig
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUpdateMask
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.
Generated from protobuf field .google.protobuf.FieldMask update_mask = 2;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\FieldMask|null | |
hasUpdateMask
clearUpdateMask
setUpdateMask
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.
Generated from protobuf field .google.protobuf.FieldMask update_mask = 2;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\FieldMask
|
| Returns | |
|---|---|
| Type | Description |
$this | |