Class RuntimeConfig.VertexAISearchRuntimeConfig (3.45.0)

public static final class RuntimeConfig.VertexAISearchRuntimeConfig extends GeneratedMessageV3 implements RuntimeConfig.VertexAISearchRuntimeConfigOrBuilder

Protobuf type google.cloud.aiplatform.v1beta1.RuntimeConfig.VertexAISearchRuntimeConfig

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > RuntimeConfig.VertexAISearchRuntimeConfig

Static Fields

APP_ID_FIELD_NUMBER

public static final int APP_ID_FIELD_NUMBER
Field Value
Type Description
int

SERVING_CONFIG_NAME_FIELD_NUMBER

public static final int SERVING_CONFIG_NAME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RuntimeConfig.VertexAISearchRuntimeConfig getDefaultInstance()
Returns
Type Description
RuntimeConfig.VertexAISearchRuntimeConfig

getDescriptor()

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

newBuilder()

public static RuntimeConfig.VertexAISearchRuntimeConfig.Builder newBuilder()
Returns
Type Description
RuntimeConfig.VertexAISearchRuntimeConfig.Builder

newBuilder(RuntimeConfig.VertexAISearchRuntimeConfig prototype)

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

parseDelimitedFrom(InputStream input)

public static RuntimeConfig.VertexAISearchRuntimeConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RuntimeConfig.VertexAISearchRuntimeConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static RuntimeConfig.VertexAISearchRuntimeConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
RuntimeConfig.VertexAISearchRuntimeConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static RuntimeConfig.VertexAISearchRuntimeConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
RuntimeConfig.VertexAISearchRuntimeConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static RuntimeConfig.VertexAISearchRuntimeConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RuntimeConfig.VertexAISearchRuntimeConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static RuntimeConfig.VertexAISearchRuntimeConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
RuntimeConfig.VertexAISearchRuntimeConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<RuntimeConfig.VertexAISearchRuntimeConfig> parser()
Returns
Type Description
Parser<VertexAISearchRuntimeConfig>

Methods

equals(Object obj)

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

getAppId()

public String getAppId()

Vertex AI Search App ID. This is used to construct the search request. By setting this app_id, API will construct the serving config which is required to call search API for the user. The app_id and serving_config_name cannot both be empty at the same time.

string app_id = 2;

Returns
Type Description
String

The appId.

getAppIdBytes()

public ByteString getAppIdBytes()

Vertex AI Search App ID. This is used to construct the search request. By setting this app_id, API will construct the serving config which is required to call search API for the user. The app_id and serving_config_name cannot both be empty at the same time.

string app_id = 2;

Returns
Type Description
ByteString

The bytes for appId.

getDefaultInstanceForType()

public RuntimeConfig.VertexAISearchRuntimeConfig getDefaultInstanceForType()
Returns
Type Description
RuntimeConfig.VertexAISearchRuntimeConfig

getParserForType()

public Parser<RuntimeConfig.VertexAISearchRuntimeConfig> getParserForType()
Returns
Type Description
Parser<VertexAISearchRuntimeConfig>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getServingConfigName() (deprecated)

public String getServingConfigName()

Deprecated. google.cloud.aiplatform.v1beta1.RuntimeConfig.VertexAISearchRuntimeConfig.serving_config_name is deprecated. See google/cloud/aiplatform/v1beta1/extension.proto;l=346

[Deprecated] Please use app_id instead. Vertex AI Search serving config name. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config}

string serving_config_name = 1 [deprecated = true];

Returns
Type Description
String

The servingConfigName.

getServingConfigNameBytes() (deprecated)

public ByteString getServingConfigNameBytes()

Deprecated. google.cloud.aiplatform.v1beta1.RuntimeConfig.VertexAISearchRuntimeConfig.serving_config_name is deprecated. See google/cloud/aiplatform/v1beta1/extension.proto;l=346

[Deprecated] Please use app_id instead. Vertex AI Search serving config name. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config}

string serving_config_name = 1 [deprecated = true];

Returns
Type Description
ByteString

The bytes for servingConfigName.

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public RuntimeConfig.VertexAISearchRuntimeConfig.Builder toBuilder()
Returns
Type Description
RuntimeConfig.VertexAISearchRuntimeConfig.Builder

writeTo(CodedOutputStream output)

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