Class DynamicRetrievalConfig (1.22.0)

public final class DynamicRetrievalConfig extends GeneratedMessageV3 implements DynamicRetrievalConfigOrBuilder

Describes the options to customize dynamic retrieval.

Protobuf type google.cloud.vertexai.v1.DynamicRetrievalConfig

Static Fields

DYNAMIC_THRESHOLD_FIELD_NUMBER

public static final int DYNAMIC_THRESHOLD_FIELD_NUMBER
Field Value
TypeDescription
int

MODE_FIELD_NUMBER

public static final int MODE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static DynamicRetrievalConfig getDefaultInstance()
Returns
TypeDescription
DynamicRetrievalConfig

getDescriptor()

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

newBuilder()

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

newBuilder(DynamicRetrievalConfig )

public static DynamicRetrievalConfig.Builder newBuilder(DynamicRetrievalConfig )
Parameter
NameDescription
DynamicRetrievalConfig
Returns
TypeDescription
DynamicRetrievalConfig.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public DynamicRetrievalConfig getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
float

The dynamicThreshold.

getMode()

public DynamicRetrievalConfig.Mode getMode()

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

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

Returns
TypeDescription
DynamicRetrievalConfig.Mode

The mode.

getModeValue()

public int getModeValue()

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

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

Returns
TypeDescription
int

The enum numeric value on the wire for mode.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
TypeDescription
boolean

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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