Class DynamicRetrievalConfig (3.56.0)

public final class DynamicRetrievalConfig extends GeneratedMessageV3 implements DynamicRetrievalConfigOrBuilder

Describes the options to customize dynamic retrieval.

Protobuf type google.cloud.aiplatform.v1.DynamicRetrievalConfig

Static Fields

DYNAMIC_THRESHOLD_FIELD_NUMBER

public static final int DYNAMIC_THRESHOLD_FIELD_NUMBER
Field Value
Type Description
int

MODE_FIELD_NUMBER

public static final int MODE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static DynamicRetrievalConfig getDefaultInstance()
Returns
Type Description
DynamicRetrievalConfig

getDescriptor()

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

newBuilder()

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

newBuilder(DynamicRetrievalConfig prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public DynamicRetrievalConfig getDefaultInstanceForType()
Returns
Type Description
DynamicRetrievalConfig

getDynamicThreshold()

public float getDynamicThreshold()

Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.

optional float dynamic_threshold = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
float

The dynamicThreshold.

getMode()

public DynamicRetrievalConfig.Mode getMode()

The mode of the predictor to be used in dynamic retrieval.

.google.cloud.aiplatform.v1.DynamicRetrievalConfig.Mode mode = 1;

Returns
Type Description
DynamicRetrievalConfig.Mode

The mode.

getModeValue()

public int getModeValue()

The mode of the predictor to be used in dynamic retrieval.

.google.cloud.aiplatform.v1.DynamicRetrievalConfig.Mode mode = 1;

Returns
Type Description
int

The enum numeric value on the wire for mode.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasDynamicThreshold()

public boolean hasDynamicThreshold()

Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.

optional float dynamic_threshold = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the dynamicThreshold 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 DynamicRetrievalConfig.Builder newBuilderForType()
Returns
Type Description
DynamicRetrievalConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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