public static final class Engine.Builder extends GeneratedMessageV3.Builder<Engine.Builder> implements EngineOrBuilderMetadata that describes the training and serving parameters of an Engine.
Protobuf type google.cloud.discoveryengine.v1.Engine
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Engine.BuilderImplements
EngineOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllDataStoreIds(Iterable<String> values)
public Engine.Builder addAllDataStoreIds(Iterable<String> values)The data stores associated with this engine.
For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store.
If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here.
Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.
repeated string data_store_ids = 5;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The dataStoreIds to add. |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
This builder for chaining. |
addDataStoreIds(String value)
public Engine.Builder addDataStoreIds(String value)The data stores associated with this engine.
For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store.
If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here.
Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.
repeated string data_store_ids = 5;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe dataStoreIds to add. |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
This builder for chaining. |
addDataStoreIdsBytes(ByteString value)
public Engine.Builder addDataStoreIdsBytes(ByteString value)The data stores associated with this engine.
For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store.
If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here.
Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.
repeated string data_store_ids = 5;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the dataStoreIds to add. |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Engine.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
build()
public Engine build()| Returns | |
|---|---|
| Type | Description |
Engine |
|
buildPartial()
public Engine buildPartial()| Returns | |
|---|---|
| Type | Description |
Engine |
|
clear()
public Engine.Builder clear()| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
clearChatEngineConfig()
public Engine.Builder clearChatEngineConfig()Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
.google.cloud.discoveryengine.v1.Engine.ChatEngineConfig chat_engine_config = 11;
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
clearChatEngineMetadata()
public Engine.Builder clearChatEngineMetadata()Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
.google.cloud.discoveryengine.v1.Engine.ChatEngineMetadata chat_engine_metadata = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
clearCommonConfig()
public Engine.Builder clearCommonConfig()Common config spec that specifies the metadata of the engine.
.google.cloud.discoveryengine.v1.Engine.CommonConfig common_config = 15;
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
clearCreateTime()
public Engine.Builder clearCreateTime()Output only. Timestamp the Recommendation Engine was created at.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
clearDataStoreIds()
public Engine.Builder clearDataStoreIds()The data stores associated with this engine.
For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store.
If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here.
Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.
repeated string data_store_ids = 5;
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
This builder for chaining. |
clearDisplayName()
public Engine.Builder clearDisplayName()Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
This builder for chaining. |
clearEngineConfig()
public Engine.Builder clearEngineConfig()| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
clearEngineMetadata()
public Engine.Builder clearEngineMetadata()| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public Engine.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
clearIndustryVertical()
public Engine.Builder clearIndustryVertical() The industry vertical that the engine registers.
The restriction of the Engine industry vertical is based on
DataStore: If unspecified,
default to GENERIC. Vertical on Engine has to match vertical of the
DataStore liniked to the engine.
.google.cloud.discoveryengine.v1.IndustryVertical industry_vertical = 16;
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
This builder for chaining. |
clearName()
public Engine.Builder clearName()Immutable. The fully qualified resource name of the engine.
This field must be a UTF-8 encoded string with a length limit of 1024 characters.
Format:
projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}
engine should be 1-63 characters, and valid characters are
/a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Engine.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
clearSearchEngineConfig()
public Engine.Builder clearSearchEngineConfig()Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
.google.cloud.discoveryengine.v1.Engine.SearchEngineConfig search_engine_config = 13;
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
clearSolutionType()
public Engine.Builder clearSolutionType()Required. The solutions of the engine.
.google.cloud.discoveryengine.v1.SolutionType solution_type = 6 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
This builder for chaining. |
clearUpdateTime()
public Engine.Builder clearUpdateTime()Output only. Timestamp the Recommendation Engine was last updated.
.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
clone()
public Engine.Builder clone()| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
getChatEngineConfig()
public Engine.ChatEngineConfig getChatEngineConfig()Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
.google.cloud.discoveryengine.v1.Engine.ChatEngineConfig chat_engine_config = 11;
| Returns | |
|---|---|
| Type | Description |
Engine.ChatEngineConfig |
The chatEngineConfig. |
getChatEngineConfigBuilder()
public Engine.ChatEngineConfig.Builder getChatEngineConfigBuilder()Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
.google.cloud.discoveryengine.v1.Engine.ChatEngineConfig chat_engine_config = 11;
| Returns | |
|---|---|
| Type | Description |
Engine.ChatEngineConfig.Builder |
|
getChatEngineConfigOrBuilder()
public Engine.ChatEngineConfigOrBuilder getChatEngineConfigOrBuilder()Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
.google.cloud.discoveryengine.v1.Engine.ChatEngineConfig chat_engine_config = 11;
| Returns | |
|---|---|
| Type | Description |
Engine.ChatEngineConfigOrBuilder |
|
getChatEngineMetadata()
public Engine.ChatEngineMetadata getChatEngineMetadata()Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
.google.cloud.discoveryengine.v1.Engine.ChatEngineMetadata chat_engine_metadata = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Engine.ChatEngineMetadata |
The chatEngineMetadata. |
getChatEngineMetadataBuilder()
public Engine.ChatEngineMetadata.Builder getChatEngineMetadataBuilder()Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
.google.cloud.discoveryengine.v1.Engine.ChatEngineMetadata chat_engine_metadata = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Engine.ChatEngineMetadata.Builder |
|
getChatEngineMetadataOrBuilder()
public Engine.ChatEngineMetadataOrBuilder getChatEngineMetadataOrBuilder()Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
.google.cloud.discoveryengine.v1.Engine.ChatEngineMetadata chat_engine_metadata = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Engine.ChatEngineMetadataOrBuilder |
|
getCommonConfig()
public Engine.CommonConfig getCommonConfig()Common config spec that specifies the metadata of the engine.
.google.cloud.discoveryengine.v1.Engine.CommonConfig common_config = 15;
| Returns | |
|---|---|
| Type | Description |
Engine.CommonConfig |
The commonConfig. |
getCommonConfigBuilder()
public Engine.CommonConfig.Builder getCommonConfigBuilder()Common config spec that specifies the metadata of the engine.
.google.cloud.discoveryengine.v1.Engine.CommonConfig common_config = 15;
| Returns | |
|---|---|
| Type | Description |
Engine.CommonConfig.Builder |
|
getCommonConfigOrBuilder()
public Engine.CommonConfigOrBuilder getCommonConfigOrBuilder()Common config spec that specifies the metadata of the engine.
.google.cloud.discoveryengine.v1.Engine.CommonConfig common_config = 15;
| Returns | |
|---|---|
| Type | Description |
Engine.CommonConfigOrBuilder |
|
getCreateTime()
public Timestamp getCreateTime()Output only. Timestamp the Recommendation Engine was created at.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The createTime. |
getCreateTimeBuilder()
public Timestamp.Builder getCreateTimeBuilder()Output only. Timestamp the Recommendation Engine was created at.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Builder |
|
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()Output only. Timestamp the Recommendation Engine was created at.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getDataStoreIds(int index)
public String getDataStoreIds(int index)The data stores associated with this engine.
For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store.
If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here.
Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.
repeated string data_store_ids = 5;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The dataStoreIds at the given index. |
getDataStoreIdsBytes(int index)
public ByteString getDataStoreIdsBytes(int index)The data stores associated with this engine.
For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store.
If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here.
Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.
repeated string data_store_ids = 5;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the dataStoreIds at the given index. |
getDataStoreIdsCount()
public int getDataStoreIdsCount()The data stores associated with this engine.
For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store.
If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here.
Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.
repeated string data_store_ids = 5;
| Returns | |
|---|---|
| Type | Description |
int |
The count of dataStoreIds. |
getDataStoreIdsList()
public ProtocolStringList getDataStoreIdsList()The data stores associated with this engine.
For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store.
If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here.
Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.
repeated string data_store_ids = 5;
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the dataStoreIds. |
getDefaultInstanceForType()
public Engine getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Engine |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getDisplayName()
public String getDisplayName()Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String |
The displayName. |
getDisplayNameBytes()
public ByteString getDisplayNameBytes()Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for displayName. |
getEngineConfigCase()
public Engine.EngineConfigCase getEngineConfigCase()| Returns | |
|---|---|
| Type | Description |
Engine.EngineConfigCase |
|
getEngineMetadataCase()
public Engine.EngineMetadataCase getEngineMetadataCase()| Returns | |
|---|---|
| Type | Description |
Engine.EngineMetadataCase |
|
getIndustryVertical()
public IndustryVertical getIndustryVertical() The industry vertical that the engine registers.
The restriction of the Engine industry vertical is based on
DataStore: If unspecified,
default to GENERIC. Vertical on Engine has to match vertical of the
DataStore liniked to the engine.
.google.cloud.discoveryengine.v1.IndustryVertical industry_vertical = 16;
| Returns | |
|---|---|
| Type | Description |
IndustryVertical |
The industryVertical. |
getIndustryVerticalValue()
public int getIndustryVerticalValue() The industry vertical that the engine registers.
The restriction of the Engine industry vertical is based on
DataStore: If unspecified,
default to GENERIC. Vertical on Engine has to match vertical of the
DataStore liniked to the engine.
.google.cloud.discoveryengine.v1.IndustryVertical industry_vertical = 16;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for industryVertical. |
getName()
public String getName()Immutable. The fully qualified resource name of the engine.
This field must be a UTF-8 encoded string with a length limit of 1024 characters.
Format:
projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}
engine should be 1-63 characters, and valid characters are
/a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public ByteString getNameBytes()Immutable. The fully qualified resource name of the engine.
This field must be a UTF-8 encoded string with a length limit of 1024 characters.
Format:
projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}
engine should be 1-63 characters, and valid characters are
/a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getSearchEngineConfig()
public Engine.SearchEngineConfig getSearchEngineConfig()Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
.google.cloud.discoveryengine.v1.Engine.SearchEngineConfig search_engine_config = 13;
| Returns | |
|---|---|
| Type | Description |
Engine.SearchEngineConfig |
The searchEngineConfig. |
getSearchEngineConfigBuilder()
public Engine.SearchEngineConfig.Builder getSearchEngineConfigBuilder()Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
.google.cloud.discoveryengine.v1.Engine.SearchEngineConfig search_engine_config = 13;
| Returns | |
|---|---|
| Type | Description |
Engine.SearchEngineConfig.Builder |
|
getSearchEngineConfigOrBuilder()
public Engine.SearchEngineConfigOrBuilder getSearchEngineConfigOrBuilder()Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
.google.cloud.discoveryengine.v1.Engine.SearchEngineConfig search_engine_config = 13;
| Returns | |
|---|---|
| Type | Description |
Engine.SearchEngineConfigOrBuilder |
|
getSolutionType()
public SolutionType getSolutionType()Required. The solutions of the engine.
.google.cloud.discoveryengine.v1.SolutionType solution_type = 6 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
SolutionType |
The solutionType. |
getSolutionTypeValue()
public int getSolutionTypeValue()Required. The solutions of the engine.
.google.cloud.discoveryengine.v1.SolutionType solution_type = 6 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for solutionType. |
getUpdateTime()
public Timestamp getUpdateTime()Output only. Timestamp the Recommendation Engine was last updated.
.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The updateTime. |
getUpdateTimeBuilder()
public Timestamp.Builder getUpdateTimeBuilder()Output only. Timestamp the Recommendation Engine was last updated.
.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Builder |
|
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()Output only. Timestamp the Recommendation Engine was last updated.
.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
hasChatEngineConfig()
public boolean hasChatEngineConfig()Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
.google.cloud.discoveryengine.v1.Engine.ChatEngineConfig chat_engine_config = 11;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the chatEngineConfig field is set. |
hasChatEngineMetadata()
public boolean hasChatEngineMetadata()Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
.google.cloud.discoveryengine.v1.Engine.ChatEngineMetadata chat_engine_metadata = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the chatEngineMetadata field is set. |
hasCommonConfig()
public boolean hasCommonConfig()Common config spec that specifies the metadata of the engine.
.google.cloud.discoveryengine.v1.Engine.CommonConfig common_config = 15;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the commonConfig field is set. |
hasCreateTime()
public boolean hasCreateTime()Output only. Timestamp the Recommendation Engine was created at.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the createTime field is set. |
hasSearchEngineConfig()
public boolean hasSearchEngineConfig()Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
.google.cloud.discoveryengine.v1.Engine.SearchEngineConfig search_engine_config = 13;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the searchEngineConfig field is set. |
hasUpdateTime()
public boolean hasUpdateTime()Output only. Timestamp the Recommendation Engine was last updated.
.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the updateTime field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeChatEngineConfig(Engine.ChatEngineConfig value)
public Engine.Builder mergeChatEngineConfig(Engine.ChatEngineConfig value)Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
.google.cloud.discoveryengine.v1.Engine.ChatEngineConfig chat_engine_config = 11;
| Parameter | |
|---|---|
| Name | Description |
value |
Engine.ChatEngineConfig |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
mergeChatEngineMetadata(Engine.ChatEngineMetadata value)
public Engine.Builder mergeChatEngineMetadata(Engine.ChatEngineMetadata value)Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
.google.cloud.discoveryengine.v1.Engine.ChatEngineMetadata chat_engine_metadata = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Engine.ChatEngineMetadata |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
mergeCommonConfig(Engine.CommonConfig value)
public Engine.Builder mergeCommonConfig(Engine.CommonConfig value)Common config spec that specifies the metadata of the engine.
.google.cloud.discoveryengine.v1.Engine.CommonConfig common_config = 15;
| Parameter | |
|---|---|
| Name | Description |
value |
Engine.CommonConfig |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
mergeCreateTime(Timestamp value)
public Engine.Builder mergeCreateTime(Timestamp value)Output only. Timestamp the Recommendation Engine was created at.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
mergeFrom(Engine other)
public Engine.Builder mergeFrom(Engine other)| Parameter | |
|---|---|
| Name | Description |
other |
Engine |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Engine.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public Engine.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
mergeSearchEngineConfig(Engine.SearchEngineConfig value)
public Engine.Builder mergeSearchEngineConfig(Engine.SearchEngineConfig value)Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
.google.cloud.discoveryengine.v1.Engine.SearchEngineConfig search_engine_config = 13;
| Parameter | |
|---|---|
| Name | Description |
value |
Engine.SearchEngineConfig |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Engine.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
mergeUpdateTime(Timestamp value)
public Engine.Builder mergeUpdateTime(Timestamp value)Output only. Timestamp the Recommendation Engine was last updated.
.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
setChatEngineConfig(Engine.ChatEngineConfig value)
public Engine.Builder setChatEngineConfig(Engine.ChatEngineConfig value)Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
.google.cloud.discoveryengine.v1.Engine.ChatEngineConfig chat_engine_config = 11;
| Parameter | |
|---|---|
| Name | Description |
value |
Engine.ChatEngineConfig |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
setChatEngineConfig(Engine.ChatEngineConfig.Builder builderForValue)
public Engine.Builder setChatEngineConfig(Engine.ChatEngineConfig.Builder builderForValue)Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
.google.cloud.discoveryengine.v1.Engine.ChatEngineConfig chat_engine_config = 11;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Engine.ChatEngineConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
setChatEngineMetadata(Engine.ChatEngineMetadata value)
public Engine.Builder setChatEngineMetadata(Engine.ChatEngineMetadata value)Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
.google.cloud.discoveryengine.v1.Engine.ChatEngineMetadata chat_engine_metadata = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Engine.ChatEngineMetadata |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
setChatEngineMetadata(Engine.ChatEngineMetadata.Builder builderForValue)
public Engine.Builder setChatEngineMetadata(Engine.ChatEngineMetadata.Builder builderForValue)Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
.google.cloud.discoveryengine.v1.Engine.ChatEngineMetadata chat_engine_metadata = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Engine.ChatEngineMetadata.Builder |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
setCommonConfig(Engine.CommonConfig value)
public Engine.Builder setCommonConfig(Engine.CommonConfig value)Common config spec that specifies the metadata of the engine.
.google.cloud.discoveryengine.v1.Engine.CommonConfig common_config = 15;
| Parameter | |
|---|---|
| Name | Description |
value |
Engine.CommonConfig |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
setCommonConfig(Engine.CommonConfig.Builder builderForValue)
public Engine.Builder setCommonConfig(Engine.CommonConfig.Builder builderForValue)Common config spec that specifies the metadata of the engine.
.google.cloud.discoveryengine.v1.Engine.CommonConfig common_config = 15;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Engine.CommonConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
setCreateTime(Timestamp value)
public Engine.Builder setCreateTime(Timestamp value)Output only. Timestamp the Recommendation Engine was created at.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
setCreateTime(Timestamp.Builder builderForValue)
public Engine.Builder setCreateTime(Timestamp.Builder builderForValue)Output only. Timestamp the Recommendation Engine was created at.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
setDataStoreIds(int index, String value)
public Engine.Builder setDataStoreIds(int index, String value)The data stores associated with this engine.
For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store.
If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here.
Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.
repeated string data_store_ids = 5;
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe dataStoreIds to set. |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
This builder for chaining. |
setDisplayName(String value)
public Engine.Builder setDisplayName(String value)Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe displayName to set. |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
This builder for chaining. |
setDisplayNameBytes(ByteString value)
public Engine.Builder setDisplayNameBytes(ByteString value)Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for displayName to set. |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public Engine.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
setIndustryVertical(IndustryVertical value)
public Engine.Builder setIndustryVertical(IndustryVertical value) The industry vertical that the engine registers.
The restriction of the Engine industry vertical is based on
DataStore: If unspecified,
default to GENERIC. Vertical on Engine has to match vertical of the
DataStore liniked to the engine.
.google.cloud.discoveryengine.v1.IndustryVertical industry_vertical = 16;
| Parameter | |
|---|---|
| Name | Description |
value |
IndustryVerticalThe industryVertical to set. |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
This builder for chaining. |
setIndustryVerticalValue(int value)
public Engine.Builder setIndustryVerticalValue(int value) The industry vertical that the engine registers.
The restriction of the Engine industry vertical is based on
DataStore: If unspecified,
default to GENERIC. Vertical on Engine has to match vertical of the
DataStore liniked to the engine.
.google.cloud.discoveryengine.v1.IndustryVertical industry_vertical = 16;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for industryVertical to set. |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
This builder for chaining. |
setName(String value)
public Engine.Builder setName(String value)Immutable. The fully qualified resource name of the engine.
This field must be a UTF-8 encoded string with a length limit of 1024 characters.
Format:
projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}
engine should be 1-63 characters, and valid characters are
/a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public Engine.Builder setNameBytes(ByteString value)Immutable. The fully qualified resource name of the engine.
This field must be a UTF-8 encoded string with a length limit of 1024 characters.
Format:
projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}
engine should be 1-63 characters, and valid characters are
/a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Engine.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
setSearchEngineConfig(Engine.SearchEngineConfig value)
public Engine.Builder setSearchEngineConfig(Engine.SearchEngineConfig value)Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
.google.cloud.discoveryengine.v1.Engine.SearchEngineConfig search_engine_config = 13;
| Parameter | |
|---|---|
| Name | Description |
value |
Engine.SearchEngineConfig |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
setSearchEngineConfig(Engine.SearchEngineConfig.Builder builderForValue)
public Engine.Builder setSearchEngineConfig(Engine.SearchEngineConfig.Builder builderForValue)Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
.google.cloud.discoveryengine.v1.Engine.SearchEngineConfig search_engine_config = 13;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Engine.SearchEngineConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
setSolutionType(SolutionType value)
public Engine.Builder setSolutionType(SolutionType value)Required. The solutions of the engine.
.google.cloud.discoveryengine.v1.SolutionType solution_type = 6 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
SolutionTypeThe solutionType to set. |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
This builder for chaining. |
setSolutionTypeValue(int value)
public Engine.Builder setSolutionTypeValue(int value)Required. The solutions of the engine.
.google.cloud.discoveryengine.v1.SolutionType solution_type = 6 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for solutionType to set. |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final Engine.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
setUpdateTime(Timestamp value)
public Engine.Builder setUpdateTime(Timestamp value)Output only. Timestamp the Recommendation Engine was last updated.
.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
setUpdateTime(Timestamp.Builder builderForValue)
public Engine.Builder setUpdateTime(Timestamp.Builder builderForValue)Output only. Timestamp the Recommendation Engine was last updated.
.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|