Class EmbeddingConfig (0.36.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
TypeDescription
int

Static Methods

getDefaultInstance()

public static EmbeddingConfig getDefaultInstance()
Returns
TypeDescription
EmbeddingConfig

getDescriptor()

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

newBuilder()

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

newBuilder(EmbeddingConfig prototype)

public static EmbeddingConfig.Builder newBuilder(EmbeddingConfig prototype)
Parameter
NameDescription
prototypeEmbeddingConfig
Returns
TypeDescription
EmbeddingConfig.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public EmbeddingConfig getDefaultInstanceForType()
Returns
TypeDescription
EmbeddingConfig

getFieldPath()

public String getFieldPath()

Full field path in the schema mapped as embedding field.

string field_path = 1;

Returns
TypeDescription
String

The fieldPath.

getFieldPathBytes()

public ByteString getFieldPathBytes()

Full field path in the schema mapped as embedding field.

string field_path = 1;

Returns
TypeDescription
ByteString

The bytes for fieldPath.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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