Class EmbeddingConfig (0.41.0)

public final class EmbeddingConfig extends GeneratedMessageV3 implements EmbeddingConfigOrBuilder

Defines embedding config, used for bring your own embeddings feature.

Protobuf type google.cloud.discoveryengine.v1alpha.EmbeddingConfig

Static Fields

FIELD_PATH_FIELD_NUMBER

public static final int FIELD_PATH_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static EmbeddingConfig getDefaultInstance()
Returns
Type Description
EmbeddingConfig

getDescriptor()

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

newBuilder()

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

newBuilder(EmbeddingConfig prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public EmbeddingConfig getDefaultInstanceForType()
Returns
Type Description
EmbeddingConfig

getFieldPath()

public String getFieldPath()

Full field path in the schema mapped as embedding field.

string field_path = 1;

Returns
Type Description
String

The fieldPath.

getFieldPathBytes()

public ByteString getFieldPathBytes()

Full field path in the schema mapped as embedding field.

string field_path = 1;

Returns
Type Description
ByteString

The bytes for fieldPath.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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 EmbeddingConfig.Builder newBuilderForType()
Returns
Type Description
EmbeddingConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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