Class UpdateCompletionConfigRequest (2.46.0)

public final class UpdateCompletionConfigRequest extends GeneratedMessageV3 implements UpdateCompletionConfigRequestOrBuilder

Request for CatalogService.UpdateCompletionConfig method.

Protobuf type google.cloud.retail.v2.UpdateCompletionConfigRequest

Static Fields

COMPLETION_CONFIG_FIELD_NUMBER

public static final int COMPLETION_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_MASK_FIELD_NUMBER

public static final int UPDATE_MASK_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static UpdateCompletionConfigRequest getDefaultInstance()
Returns
Type Description
UpdateCompletionConfigRequest

getDescriptor()

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

newBuilder()

public static UpdateCompletionConfigRequest.Builder newBuilder()
Returns
Type Description
UpdateCompletionConfigRequest.Builder

newBuilder(UpdateCompletionConfigRequest prototype)

public static UpdateCompletionConfigRequest.Builder newBuilder(UpdateCompletionConfigRequest prototype)
Parameter
Name Description
prototype UpdateCompletionConfigRequest
Returns
Type Description
UpdateCompletionConfigRequest.Builder

parseDelimitedFrom(InputStream input)

public static UpdateCompletionConfigRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
UpdateCompletionConfigRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UpdateCompletionConfigRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UpdateCompletionConfigRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static UpdateCompletionConfigRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
UpdateCompletionConfigRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static UpdateCompletionConfigRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UpdateCompletionConfigRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static UpdateCompletionConfigRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
UpdateCompletionConfigRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static UpdateCompletionConfigRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UpdateCompletionConfigRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static UpdateCompletionConfigRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
UpdateCompletionConfigRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static UpdateCompletionConfigRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UpdateCompletionConfigRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static UpdateCompletionConfigRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
UpdateCompletionConfigRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UpdateCompletionConfigRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UpdateCompletionConfigRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static UpdateCompletionConfigRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
UpdateCompletionConfigRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static UpdateCompletionConfigRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UpdateCompletionConfigRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<UpdateCompletionConfigRequest> parser()
Returns
Type Description
Parser<UpdateCompletionConfigRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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.

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

getParserForType()

public Parser<UpdateCompletionConfigRequest> getParserForType()
Returns
Type Description
Parser<UpdateCompletionConfigRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
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.

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public UpdateCompletionConfigRequest.Builder newBuilderForType()
Returns
Type Description
UpdateCompletionConfigRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected UpdateCompletionConfigRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
UpdateCompletionConfigRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public UpdateCompletionConfigRequest.Builder toBuilder()
Returns
Type Description
UpdateCompletionConfigRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException