- 0.50.0 (latest)
- 0.49.0
- 0.48.0
- 0.47.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
public final class Engine extends GeneratedMessageV3 implements EngineOrBuilder
Metadata that describes the training and serving parameters of an Engine.
Protobuf type google.cloud.discoveryengine.v1.Engine
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > EngineImplements
EngineOrBuilderStatic Fields
CHAT_ENGINE_CONFIG_FIELD_NUMBER
public static final int CHAT_ENGINE_CONFIG_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
CHAT_ENGINE_METADATA_FIELD_NUMBER
public static final int CHAT_ENGINE_METADATA_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
COMMON_CONFIG_FIELD_NUMBER
public static final int COMMON_CONFIG_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
DATA_STORE_IDS_FIELD_NUMBER
public static final int DATA_STORE_IDS_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
DISABLE_ANALYTICS_FIELD_NUMBER
public static final int DISABLE_ANALYTICS_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
INDUSTRY_VERTICAL_FIELD_NUMBER
public static final int INDUSTRY_VERTICAL_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
SEARCH_ENGINE_CONFIG_FIELD_NUMBER
public static final int SEARCH_ENGINE_CONFIG_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
SOLUTION_TYPE_FIELD_NUMBER
public static final int SOLUTION_TYPE_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
Static Methods
getDefaultInstance()
public static Engine getDefaultInstance()
Returns | |
---|---|
Type | Description |
Engine |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
newBuilder()
public static Engine.Builder newBuilder()
Returns | |
---|---|
Type | Description |
Engine.Builder |
newBuilder(Engine prototype)
public static Engine.Builder newBuilder(Engine prototype)
Parameter | |
---|---|
Name | Description |
prototype |
Engine |
Returns | |
---|---|
Type | Description |
Engine.Builder |
parseDelimitedFrom(InputStream input)
public static Engine parseDelimitedFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input |
InputStream |
Returns | |
---|---|
Type | Description |
Engine |
Exceptions | |
---|---|
Type | Description |
IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Engine parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Engine |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(byte[] data)
public static Engine parseFrom(byte[] data)
Parameter | |
---|---|
Name | Description |
data |
byte[] |
Returns | |
---|---|
Type | Description |
Engine |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Engine parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Engine |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data)
public static Engine parseFrom(ByteString data)
Parameter | |
---|---|
Name | Description |
data |
ByteString |
Returns | |
---|---|
Type | Description |
Engine |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Engine parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Engine |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static Engine parseFrom(CodedInputStream input)
Parameter | |
---|---|
Name | Description |
input |
CodedInputStream |
Returns | |
---|---|
Type | Description |
Engine |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Engine parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Engine |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input)
public static Engine parseFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input |
InputStream |
Returns | |
---|---|
Type | Description |
Engine |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Engine parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Engine |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static Engine parseFrom(ByteBuffer data)
Parameter | |
---|---|
Name | Description |
data |
ByteBuffer |
Returns | |
---|---|
Type | Description |
Engine |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Engine parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Engine |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<Engine> parser()
Returns | |
---|---|
Type | Description |
Parser<Engine> |
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter | |
---|---|
Name | Description |
obj |
Object |
Returns | |
---|---|
Type | Description |
boolean |
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. |
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. |
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. |
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. |
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 |
int The 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 |
int The 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 |
getDisableAnalytics()
public boolean getDisableAnalytics()
Optional. Whether to disable analytics for searches performed on this engine.
bool disable_analytics = 26 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
boolean |
The disableAnalytics. |
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 linked 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 linked 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}/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}/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. |
getParserForType()
public Parser<Engine> getParserForType()
Returns | |
---|---|
Type | Description |
Parser<Engine> |
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. |
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 |
getSerializedSize()
public int getSerializedSize()
Returns | |
---|---|
Type | Description |
int |
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. |
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. |
hashCode()
public int hashCode()
Returns | |
---|---|
Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
newBuilderForType()
public Engine.Builder newBuilderForType()
Returns | |
---|---|
Type | Description |
Engine.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Engine.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter | |
---|---|
Name | Description |
parent |
BuilderParent |
Returns | |
---|---|
Type | Description |
Engine.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter | |
---|---|
Name | Description |
unused |
UnusedPrivateParameter |
Returns | |
---|---|
Type | Description |
Object |
toBuilder()
public Engine.Builder toBuilder()
Returns | |
---|---|
Type | Description |
Engine.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter | |
---|---|
Name | Description |
output |
CodedOutputStream |
Exceptions | |
---|---|
Type | Description |
IOException |