Class UpdateCompletionConfigRequest.Builder (2.45.0)

public static final class UpdateCompletionConfigRequest.Builder extends GeneratedMessageV3.Builder<UpdateCompletionConfigRequest.Builder> implements UpdateCompletionConfigRequestOrBuilder

Request for CatalogService.UpdateCompletionConfig method.

Protobuf type google.cloud.retail.v2.UpdateCompletionConfigRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public UpdateCompletionConfigRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
UpdateCompletionConfigRequest.Builder
Overrides

build()

public UpdateCompletionConfigRequest build()
Returns
Type Description
UpdateCompletionConfigRequest

buildPartial()

public UpdateCompletionConfigRequest buildPartial()
Returns
Type Description
UpdateCompletionConfigRequest

clear()

public UpdateCompletionConfigRequest.Builder clear()
Returns
Type Description
UpdateCompletionConfigRequest.Builder
Overrides

clearCompletionConfig()

public UpdateCompletionConfigRequest.Builder clearCompletionConfig()

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.

.google.cloud.retail.v2.CompletionConfig completion_config = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
UpdateCompletionConfigRequest.Builder

clearField(Descriptors.FieldDescriptor field)

public UpdateCompletionConfigRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
UpdateCompletionConfigRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public UpdateCompletionConfigRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
UpdateCompletionConfigRequest.Builder
Overrides

clearUpdateMask()

public UpdateCompletionConfigRequest.Builder clearUpdateMask()

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.

.google.protobuf.FieldMask update_mask = 2;

Returns
Type Description
UpdateCompletionConfigRequest.Builder

clone()

public UpdateCompletionConfigRequest.Builder clone()
Returns
Type Description
UpdateCompletionConfigRequest.Builder
Overrides

getCompletionConfig()

public CompletionConfig 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.

.google.cloud.retail.v2.CompletionConfig completion_config = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
CompletionConfig

The completionConfig.

getCompletionConfigBuilder()

public CompletionConfig.Builder getCompletionConfigBuilder()

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.

.google.cloud.retail.v2.CompletionConfig completion_config = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
CompletionConfig.Builder

getCompletionConfigOrBuilder()

public CompletionConfigOrBuilder getCompletionConfigOrBuilder()

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.

.google.cloud.retail.v2.CompletionConfig completion_config = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
CompletionConfigOrBuilder

getDefaultInstanceForType()

public UpdateCompletionConfigRequest getDefaultInstanceForType()
Returns
Type Description
UpdateCompletionConfigRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getUpdateMask()

public FieldMask 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.

.google.protobuf.FieldMask update_mask = 2;

Returns
Type Description
FieldMask

The updateMask.

getUpdateMaskBuilder()

public FieldMask.Builder getUpdateMaskBuilder()

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.

.google.protobuf.FieldMask update_mask = 2;

Returns
Type Description
Builder

getUpdateMaskOrBuilder()

public FieldMaskOrBuilder getUpdateMaskOrBuilder()

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.

.google.protobuf.FieldMask update_mask = 2;

Returns
Type Description
FieldMaskOrBuilder

hasCompletionConfig()

public boolean hasCompletionConfig()

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.

.google.cloud.retail.v2.CompletionConfig completion_config = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the completionConfig field is set.

hasUpdateMask()

public boolean hasUpdateMask()

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.

.google.protobuf.FieldMask update_mask = 2;

Returns
Type Description
boolean

Whether the updateMask field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCompletionConfig(CompletionConfig value)

public UpdateCompletionConfigRequest.Builder mergeCompletionConfig(CompletionConfig value)

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.

.google.cloud.retail.v2.CompletionConfig completion_config = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value CompletionConfig
Returns
Type Description
UpdateCompletionConfigRequest.Builder

mergeFrom(UpdateCompletionConfigRequest other)

public UpdateCompletionConfigRequest.Builder mergeFrom(UpdateCompletionConfigRequest other)
Parameter
Name Description
other UpdateCompletionConfigRequest
Returns
Type Description
UpdateCompletionConfigRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public UpdateCompletionConfigRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UpdateCompletionConfigRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public UpdateCompletionConfigRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
UpdateCompletionConfigRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final UpdateCompletionConfigRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
UpdateCompletionConfigRequest.Builder
Overrides

mergeUpdateMask(FieldMask value)

public UpdateCompletionConfigRequest.Builder mergeUpdateMask(FieldMask value)

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.

.google.protobuf.FieldMask update_mask = 2;

Parameter
Name Description
value FieldMask
Returns
Type Description
UpdateCompletionConfigRequest.Builder

setCompletionConfig(CompletionConfig value)

public UpdateCompletionConfigRequest.Builder setCompletionConfig(CompletionConfig value)

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.

.google.cloud.retail.v2.CompletionConfig completion_config = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value CompletionConfig
Returns
Type Description
UpdateCompletionConfigRequest.Builder

setCompletionConfig(CompletionConfig.Builder builderForValue)

public UpdateCompletionConfigRequest.Builder setCompletionConfig(CompletionConfig.Builder builderForValue)

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.

.google.cloud.retail.v2.CompletionConfig completion_config = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue CompletionConfig.Builder
Returns
Type Description
UpdateCompletionConfigRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public UpdateCompletionConfigRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
UpdateCompletionConfigRequest.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public UpdateCompletionConfigRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
UpdateCompletionConfigRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final UpdateCompletionConfigRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
UpdateCompletionConfigRequest.Builder
Overrides

setUpdateMask(FieldMask value)

public UpdateCompletionConfigRequest.Builder setUpdateMask(FieldMask value)

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.

.google.protobuf.FieldMask update_mask = 2;

Parameter
Name Description
value FieldMask
Returns
Type Description
UpdateCompletionConfigRequest.Builder

setUpdateMask(FieldMask.Builder builderForValue)

public UpdateCompletionConfigRequest.Builder setUpdateMask(FieldMask.Builder builderForValue)

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.

.google.protobuf.FieldMask update_mask = 2;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
UpdateCompletionConfigRequest.Builder