Class: Google::Cloud::Retail::V2::UpdateCompletionConfigRequest

Inherits:

Object

• Object
• Google::Cloud::Retail::V2::UpdateCompletionConfigRequest

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/retail/v2/catalog_service.rb

Overview

Request for CatalogService.UpdateCompletionConfig method.

Instance Attribute Summary

• #completion_config ⇒ ::Google::Cloud::Retail::V2::CompletionConfig

  Required.

• #update_mask ⇒ ::Google::Protobuf::FieldMask

  Indicates which fields in the provided CompletionConfig to update.

Instance Attribute Details

#completion_config ⇒ ::Google::Cloud::Retail::V2::CompletionConfig

Returns 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:

• (::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.

# File 'proto_docs/google/cloud/retail/v2/catalog_service.rb', line 200

class UpdateCompletionConfigRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#update_mask ⇒ ::Google::Protobuf::FieldMask

Returns 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.

Returns:

• (::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.

# File 'proto_docs/google/cloud/retail/v2/catalog_service.rb', line 200

class UpdateCompletionConfigRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end