Class UpdateCompletionConfigRequest (2.14.0)

public final class UpdateCompletionConfigRequest extends GeneratedMessageV3 implements UpdateCompletionConfigRequestOrBuilder

Request for CatalogService.UpdateCompletionConfig method.

Protobuf type google.cloud.retail.v2alpha.UpdateCompletionConfigRequest

Static Fields

COMPLETION_CONFIG_FIELD_NUMBER

public static final int COMPLETION_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

UPDATE_MASK_FIELD_NUMBER

public static final int UPDATE_MASK_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static UpdateCompletionConfigRequest getDefaultInstance()
Returns
TypeDescription
UpdateCompletionConfigRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static UpdateCompletionConfigRequest.Builder newBuilder()
Returns
TypeDescription
UpdateCompletionConfigRequest.Builder

newBuilder(UpdateCompletionConfigRequest prototype)

public static UpdateCompletionConfigRequest.Builder newBuilder(UpdateCompletionConfigRequest prototype)
Parameter
NameDescription
prototypeUpdateCompletionConfigRequest
Returns
TypeDescription
UpdateCompletionConfigRequest.Builder

parseDelimitedFrom(InputStream input)

public static UpdateCompletionConfigRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
UpdateCompletionConfigRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UpdateCompletionConfigRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UpdateCompletionConfigRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static UpdateCompletionConfigRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
UpdateCompletionConfigRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static UpdateCompletionConfigRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UpdateCompletionConfigRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static UpdateCompletionConfigRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
UpdateCompletionConfigRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static UpdateCompletionConfigRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UpdateCompletionConfigRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static UpdateCompletionConfigRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
UpdateCompletionConfigRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static UpdateCompletionConfigRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UpdateCompletionConfigRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static UpdateCompletionConfigRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
UpdateCompletionConfigRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UpdateCompletionConfigRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UpdateCompletionConfigRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static UpdateCompletionConfigRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
UpdateCompletionConfigRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static UpdateCompletionConfigRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UpdateCompletionConfigRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<UpdateCompletionConfigRequest> parser()
Returns
TypeDescription
Parser<UpdateCompletionConfigRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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.v2alpha.CompletionConfig completion_config = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
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.v2alpha.CompletionConfig completion_config = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
CompletionConfigOrBuilder

getDefaultInstanceForType()

public UpdateCompletionConfigRequest getDefaultInstanceForType()
Returns
TypeDescription
UpdateCompletionConfigRequest

getParserForType()

public Parser<UpdateCompletionConfigRequest> getParserForType()
Returns
TypeDescription
Parser<UpdateCompletionConfigRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
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
TypeDescription
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
TypeDescription
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.v2alpha.CompletionConfig completion_config = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
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
TypeDescription
boolean

Whether the updateMask field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public UpdateCompletionConfigRequest.Builder newBuilderForType()
Returns
TypeDescription
UpdateCompletionConfigRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected UpdateCompletionConfigRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
UpdateCompletionConfigRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public UpdateCompletionConfigRequest.Builder toBuilder()
Returns
TypeDescription
UpdateCompletionConfigRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException