Class RuntimeConfig.VertexAISearchRuntimeConfig.Builder (3.47.0)

public static final class RuntimeConfig.VertexAISearchRuntimeConfig.Builder extends GeneratedMessageV3.Builder<RuntimeConfig.VertexAISearchRuntimeConfig.Builder> implements RuntimeConfig.VertexAISearchRuntimeConfigOrBuilder

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

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public RuntimeConfig.VertexAISearchRuntimeConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RuntimeConfig.VertexAISearchRuntimeConfig.Builder
Overrides

build()

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

buildPartial()

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

clear()

public RuntimeConfig.VertexAISearchRuntimeConfig.Builder clear()
Returns
Type Description
RuntimeConfig.VertexAISearchRuntimeConfig.Builder
Overrides

clearEngineId()

public RuntimeConfig.VertexAISearchRuntimeConfig.Builder clearEngineId()

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
RuntimeConfig.VertexAISearchRuntimeConfig.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public RuntimeConfig.VertexAISearchRuntimeConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
RuntimeConfig.VertexAISearchRuntimeConfig.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public RuntimeConfig.VertexAISearchRuntimeConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
RuntimeConfig.VertexAISearchRuntimeConfig.Builder
Overrides

clearServingConfigName()

public RuntimeConfig.VertexAISearchRuntimeConfig.Builder clearServingConfigName()

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
RuntimeConfig.VertexAISearchRuntimeConfig.Builder

This builder for chaining.

clone()

public RuntimeConfig.VertexAISearchRuntimeConfig.Builder clone()
Returns
Type Description
RuntimeConfig.VertexAISearchRuntimeConfig.Builder
Overrides

getDefaultInstanceForType()

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(RuntimeConfig.VertexAISearchRuntimeConfig other)

public RuntimeConfig.VertexAISearchRuntimeConfig.Builder mergeFrom(RuntimeConfig.VertexAISearchRuntimeConfig other)
Parameter
Name Description
other RuntimeConfig.VertexAISearchRuntimeConfig
Returns
Type Description
RuntimeConfig.VertexAISearchRuntimeConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RuntimeConfig.VertexAISearchRuntimeConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RuntimeConfig.VertexAISearchRuntimeConfig.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public RuntimeConfig.VertexAISearchRuntimeConfig.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
RuntimeConfig.VertexAISearchRuntimeConfig.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RuntimeConfig.VertexAISearchRuntimeConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RuntimeConfig.VertexAISearchRuntimeConfig.Builder
Overrides

setEngineId(String value)

public RuntimeConfig.VertexAISearchRuntimeConfig.Builder setEngineId(String value)

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];

Parameter
Name Description
value String

The engineId to set.

Returns
Type Description
RuntimeConfig.VertexAISearchRuntimeConfig.Builder

This builder for chaining.

setEngineIdBytes(ByteString value)

public RuntimeConfig.VertexAISearchRuntimeConfig.Builder setEngineIdBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for engineId to set.

Returns
Type Description
RuntimeConfig.VertexAISearchRuntimeConfig.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public RuntimeConfig.VertexAISearchRuntimeConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RuntimeConfig.VertexAISearchRuntimeConfig.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public RuntimeConfig.VertexAISearchRuntimeConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
RuntimeConfig.VertexAISearchRuntimeConfig.Builder
Overrides

setServingConfigName(String value)

public RuntimeConfig.VertexAISearchRuntimeConfig.Builder setServingConfigName(String value)

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];

Parameter
Name Description
value String

The servingConfigName to set.

Returns
Type Description
RuntimeConfig.VertexAISearchRuntimeConfig.Builder

This builder for chaining.

setServingConfigNameBytes(ByteString value)

public RuntimeConfig.VertexAISearchRuntimeConfig.Builder setServingConfigNameBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for servingConfigName to set.

Returns
Type Description
RuntimeConfig.VertexAISearchRuntimeConfig.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final RuntimeConfig.VertexAISearchRuntimeConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RuntimeConfig.VertexAISearchRuntimeConfig.Builder
Overrides