public static final class RuntimeConfig.VertexAISearchRuntimeConfig extends GeneratedMessage implements RuntimeConfig.VertexAISearchRuntimeConfigOrBuilderProtobuf type google.cloud.aiplatform.v1beta1.RuntimeConfig.VertexAISearchRuntimeConfig
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > RuntimeConfig.VertexAISearchRuntimeConfigStatic Fields
ENGINE_ID_FIELD_NUMBER
public static final int ENGINE_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 |
|
getDefaultInstanceForType()
public RuntimeConfig.VertexAISearchRuntimeConfig getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
RuntimeConfig.VertexAISearchRuntimeConfig |
|
getEngineId()
public String getEngineId()Optional. Vertex AI Search engine ID. This is used to construct the search request. By setting this engine_id, API will construct the serving config using the default value to call search API for the user. The engine_id and serving_config_name cannot both be empty at the same time.
string engine_id = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The engineId. |
getEngineIdBytes()
public ByteString getEngineIdBytes()Optional. Vertex AI Search engine ID. This is used to construct the search request. By setting this engine_id, API will construct the serving config using the default value to call search API for the user. The engine_id and serving_config_name cannot both be empty at the same time.
string engine_id = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for engineId. |
getParserForType()
public Parser<RuntimeConfig.VertexAISearchRuntimeConfig> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<VertexAISearchRuntimeConfig> |
|
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int |
|
getServingConfigName()
public String getServingConfigName() Optional. Vertex AI Search serving config name. Format:
projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config}
string serving_config_name = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The servingConfigName. |
getServingConfigNameBytes()
public ByteString getServingConfigNameBytes() Optional. Vertex AI Search serving config name. Format:
projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config}
string serving_config_name = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for servingConfigName. |
hashCode()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int |
|
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
newBuilderForType()
public RuntimeConfig.VertexAISearchRuntimeConfig.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
RuntimeConfig.VertexAISearchRuntimeConfig.Builder |
|
newBuilderForType(AbstractMessage.BuilderParent parent)
protected RuntimeConfig.VertexAISearchRuntimeConfig.Builder newBuilderForType(AbstractMessage.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent |
BuilderParent |
| Returns | |
|---|---|
| Type | Description |
RuntimeConfig.VertexAISearchRuntimeConfig.Builder |
|
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 |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|