com.google.cloud.discoveryengine.v1alpha

Class Engine

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.discoveryengine.v1alpha.Engine

All Implemented Interfaces:

EngineOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class Engine
extends com.google.protobuf.GeneratedMessageV3
implements EngineOrBuilder

 Metadata that describes the training and serving parameters of an
 [Engine][google.cloud.discoveryengine.v1alpha.Engine].
 

Protobuf type google.cloud.discoveryengine.v1alpha.Engine

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Engine.Builder Metadata that describes the training and serving parameters of an [Engine][google.cloud.discoveryengine.v1alpha.Engine].
static class	Engine.ChatEngineConfig Configurations for a Chat Engine.
static interface	Engine.ChatEngineConfigOrBuilder
static class	Engine.ChatEngineMetadata Additional information of a Chat Engine.
static interface	Engine.ChatEngineMetadataOrBuilder
static class	Engine.CommonConfig Common configurations for an Engine.
static interface	Engine.CommonConfigOrBuilder
static class	Engine.EngineConfigCase
static class	Engine.EngineMetadataCase
static class	Engine.MediaRecommendationEngineConfig Additional config specs for a Media Recommendation engine.
static interface	Engine.MediaRecommendationEngineConfigOrBuilder
static class	Engine.RecommendationMetadata Additional information of a recommendation engine.
static interface	Engine.RecommendationMetadataOrBuilder
static class	Engine.SearchEngineConfig Configurations for a Search Engine.
static interface	Engine.SearchEngineConfigOrBuilder
static class	Engine.SimilarDocumentsEngineConfig Additional config specs for a `similar-items` engine.
static interface	Engine.SimilarDocumentsEngineConfigOrBuilder

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	CHAT_ENGINE_CONFIG_FIELD_NUMBER
static int	CHAT_ENGINE_METADATA_FIELD_NUMBER
static int	COMMON_CONFIG_FIELD_NUMBER
static int	CREATE_TIME_FIELD_NUMBER
static int	DATA_STORE_IDS_FIELD_NUMBER
static int	DISPLAY_NAME_FIELD_NUMBER
static int	INDUSTRY_VERTICAL_FIELD_NUMBER
static int	MEDIA_RECOMMENDATION_ENGINE_CONFIG_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	RECOMMENDATION_METADATA_FIELD_NUMBER
static int	SEARCH_ENGINE_CONFIG_FIELD_NUMBER
static int	SIMILAR_DOCUMENTS_CONFIG_FIELD_NUMBER
static int	SOLUTION_TYPE_FIELD_NUMBER
static int	UPDATE_TIME_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Engine.ChatEngineConfig	getChatEngineConfig() Configurations for the Chat Engine.
Engine.ChatEngineConfigOrBuilder	getChatEngineConfigOrBuilder() Configurations for the Chat Engine.
Engine.ChatEngineMetadata	getChatEngineMetadata() Output only.
Engine.ChatEngineMetadataOrBuilder	getChatEngineMetadataOrBuilder() Output only.
Engine.CommonConfig	getCommonConfig() Common config spec that specifies the metadata of the engine.
Engine.CommonConfigOrBuilder	getCommonConfigOrBuilder() Common config spec that specifies the metadata of the engine.
com.google.protobuf.Timestamp	getCreateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder() Output only.
String	getDataStoreIds(int index) The data stores associated with this engine.
com.google.protobuf.ByteString	getDataStoreIdsBytes(int index) The data stores associated with this engine.
int	getDataStoreIdsCount() The data stores associated with this engine.
com.google.protobuf.ProtocolStringList	getDataStoreIdsList() The data stores associated with this engine.
static Engine	getDefaultInstance()
Engine	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getDisplayName() Required.
com.google.protobuf.ByteString	getDisplayNameBytes() Required.
Engine.EngineConfigCase	getEngineConfigCase()
Engine.EngineMetadataCase	getEngineMetadataCase()
IndustryVertical	getIndustryVertical() The industry vertical that the engine registers.
int	getIndustryVerticalValue() The industry vertical that the engine registers.
Engine.MediaRecommendationEngineConfig	getMediaRecommendationEngineConfig() Configurations for the Media Engine.
Engine.MediaRecommendationEngineConfigOrBuilder	getMediaRecommendationEngineConfigOrBuilder() Configurations for the Media Engine.
String	getName() Immutable.
com.google.protobuf.ByteString	getNameBytes() Immutable.
com.google.protobuf.Parser<Engine>	getParserForType()
Engine.RecommendationMetadata	getRecommendationMetadata() Output only.
Engine.RecommendationMetadataOrBuilder	getRecommendationMetadataOrBuilder() Output only.
Engine.SearchEngineConfig	getSearchEngineConfig() Configurations for the Search Engine.
Engine.SearchEngineConfigOrBuilder	getSearchEngineConfigOrBuilder() Configurations for the Search Engine.
int	getSerializedSize()
Engine.SimilarDocumentsEngineConfig	getSimilarDocumentsConfig() Additional config specs for a `similar-items` engine.
Engine.SimilarDocumentsEngineConfigOrBuilder	getSimilarDocumentsConfigOrBuilder() Additional config specs for a `similar-items` engine.
SolutionType	getSolutionType() Required.
int	getSolutionTypeValue() Required.
com.google.protobuf.Timestamp	getUpdateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getUpdateTimeOrBuilder() Output only.
boolean	hasChatEngineConfig() Configurations for the Chat Engine.
boolean	hasChatEngineMetadata() Output only.
boolean	hasCommonConfig() Common config spec that specifies the metadata of the engine.
boolean	hasCreateTime() Output only.
int	hashCode()
boolean	hasMediaRecommendationEngineConfig() Configurations for the Media Engine.
boolean	hasRecommendationMetadata() Output only.
boolean	hasSearchEngineConfig() Configurations for the Search Engine.
boolean	hasSimilarDocumentsConfig() Additional config specs for a `similar-items` engine.
boolean	hasUpdateTime() Output only.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Engine.Builder	newBuilder()
static Engine.Builder	newBuilder(Engine prototype)
Engine.Builder	newBuilderForType()
protected Engine.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Engine	parseDelimitedFrom(InputStream input)
static Engine	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Engine	parseFrom(byte[] data)
static Engine	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Engine	parseFrom(ByteBuffer data)
static Engine	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Engine	parseFrom(com.google.protobuf.ByteString data)
static Engine	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Engine	parseFrom(com.google.protobuf.CodedInputStream input)
static Engine	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Engine	parseFrom(InputStream input)
static Engine	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Engine>	parser()
Engine.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

SIMILAR_DOCUMENTS_CONFIG_FIELD_NUMBER

public static final int SIMILAR_DOCUMENTS_CONFIG_FIELD_NUMBER

See Also:

Constant Field Values

CHAT_ENGINE_CONFIG_FIELD_NUMBER

public static final int CHAT_ENGINE_CONFIG_FIELD_NUMBER

See Also:

Constant Field Values

SEARCH_ENGINE_CONFIG_FIELD_NUMBER

public static final int SEARCH_ENGINE_CONFIG_FIELD_NUMBER

See Also:

Constant Field Values

MEDIA_RECOMMENDATION_ENGINE_CONFIG_FIELD_NUMBER

public static final int MEDIA_RECOMMENDATION_ENGINE_CONFIG_FIELD_NUMBER

See Also:

Constant Field Values

RECOMMENDATION_METADATA_FIELD_NUMBER

public static final int RECOMMENDATION_METADATA_FIELD_NUMBER

See Also:

Constant Field Values

CHAT_ENGINE_METADATA_FIELD_NUMBER

public static final int CHAT_ENGINE_METADATA_FIELD_NUMBER

See Also:

Constant Field Values

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER

See Also:

Constant Field Values

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER

See Also:

Constant Field Values

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER

See Also:

Constant Field Values

DATA_STORE_IDS_FIELD_NUMBER

public static final int DATA_STORE_IDS_FIELD_NUMBER

See Also:

Constant Field Values

SOLUTION_TYPE_FIELD_NUMBER

public static final int SOLUTION_TYPE_FIELD_NUMBER

See Also:

Constant Field Values

INDUSTRY_VERTICAL_FIELD_NUMBER

public static final int INDUSTRY_VERTICAL_FIELD_NUMBER

See Also:

Constant Field Values

COMMON_CONFIG_FIELD_NUMBER

public static final int COMMON_CONFIG_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getEngineConfigCase

public Engine.EngineConfigCase getEngineConfigCase()

Specified by:

getEngineConfigCase in interface EngineOrBuilder

getEngineMetadataCase

public Engine.EngineMetadataCase getEngineMetadataCase()

Specified by:

getEngineMetadataCase in interface EngineOrBuilder

hasSimilarDocumentsConfig

public boolean hasSimilarDocumentsConfig()

 Additional config specs for a `similar-items` engine.
 

.google.cloud.discoveryengine.v1alpha.Engine.SimilarDocumentsEngineConfig similar_documents_config = 9;

Specified by:

hasSimilarDocumentsConfig in interface EngineOrBuilder

Returns:

Whether the similarDocumentsConfig field is set.

getSimilarDocumentsConfig

public Engine.SimilarDocumentsEngineConfig getSimilarDocumentsConfig()

 Additional config specs for a `similar-items` engine.
 

.google.cloud.discoveryengine.v1alpha.Engine.SimilarDocumentsEngineConfig similar_documents_config = 9;

Specified by:

getSimilarDocumentsConfig in interface EngineOrBuilder

Returns:

The similarDocumentsConfig.

getSimilarDocumentsConfigOrBuilder

public Engine.SimilarDocumentsEngineConfigOrBuilder getSimilarDocumentsConfigOrBuilder()

 Additional config specs for a `similar-items` engine.
 

.google.cloud.discoveryengine.v1alpha.Engine.SimilarDocumentsEngineConfig similar_documents_config = 9;

Specified by:

getSimilarDocumentsConfigOrBuilder in interface EngineOrBuilder

hasChatEngineConfig

public boolean hasChatEngineConfig()

 Configurations for the Chat Engine. Only applicable if
 [solution_type][google.cloud.discoveryengine.v1alpha.Engine.solution_type]
 is
 [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_CHAT].
 

.google.cloud.discoveryengine.v1alpha.Engine.ChatEngineConfig chat_engine_config = 11;

Specified by:

hasChatEngineConfig in interface EngineOrBuilder

Returns:

Whether the chatEngineConfig field is set.

getChatEngineConfig

public Engine.ChatEngineConfig getChatEngineConfig()

 Configurations for the Chat Engine. Only applicable if
 [solution_type][google.cloud.discoveryengine.v1alpha.Engine.solution_type]
 is
 [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_CHAT].
 

.google.cloud.discoveryengine.v1alpha.Engine.ChatEngineConfig chat_engine_config = 11;

Specified by:

getChatEngineConfig in interface EngineOrBuilder

Returns:

The chatEngineConfig.

getChatEngineConfigOrBuilder

public Engine.ChatEngineConfigOrBuilder getChatEngineConfigOrBuilder()

 Configurations for the Chat Engine. Only applicable if
 [solution_type][google.cloud.discoveryengine.v1alpha.Engine.solution_type]
 is
 [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_CHAT].
 

.google.cloud.discoveryengine.v1alpha.Engine.ChatEngineConfig chat_engine_config = 11;

Specified by:

getChatEngineConfigOrBuilder in interface EngineOrBuilder

hasSearchEngineConfig

public boolean hasSearchEngineConfig()

 Configurations for the Search Engine. Only applicable if
 [solution_type][google.cloud.discoveryengine.v1alpha.Engine.solution_type]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH].
 

.google.cloud.discoveryengine.v1alpha.Engine.SearchEngineConfig search_engine_config = 13;

Specified by:

hasSearchEngineConfig in interface EngineOrBuilder

Returns:

Whether the searchEngineConfig field is set.

getSearchEngineConfig

public Engine.SearchEngineConfig getSearchEngineConfig()

 Configurations for the Search Engine. Only applicable if
 [solution_type][google.cloud.discoveryengine.v1alpha.Engine.solution_type]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH].
 

.google.cloud.discoveryengine.v1alpha.Engine.SearchEngineConfig search_engine_config = 13;

Specified by:

getSearchEngineConfig in interface EngineOrBuilder

Returns:

The searchEngineConfig.

getSearchEngineConfigOrBuilder

public Engine.SearchEngineConfigOrBuilder getSearchEngineConfigOrBuilder()

 Configurations for the Search Engine. Only applicable if
 [solution_type][google.cloud.discoveryengine.v1alpha.Engine.solution_type]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH].
 

.google.cloud.discoveryengine.v1alpha.Engine.SearchEngineConfig search_engine_config = 13;

Specified by:

getSearchEngineConfigOrBuilder in interface EngineOrBuilder

hasMediaRecommendationEngineConfig

public boolean hasMediaRecommendationEngineConfig()

 Configurations for the Media Engine. Only applicable on the data
 stores with
 [solution_type][google.cloud.discoveryengine.v1alpha.Engine.solution_type]
 [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION]
 and
 [IndustryVertical.MEDIA][google.cloud.discoveryengine.v1alpha.IndustryVertical.MEDIA]
 vertical.
 

.google.cloud.discoveryengine.v1alpha.Engine.MediaRecommendationEngineConfig media_recommendation_engine_config = 14;

Specified by:

hasMediaRecommendationEngineConfig in interface EngineOrBuilder

Returns:

Whether the mediaRecommendationEngineConfig field is set.

getMediaRecommendationEngineConfig

public Engine.MediaRecommendationEngineConfig getMediaRecommendationEngineConfig()

 Configurations for the Media Engine. Only applicable on the data
 stores with
 [solution_type][google.cloud.discoveryengine.v1alpha.Engine.solution_type]
 [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION]
 and
 [IndustryVertical.MEDIA][google.cloud.discoveryengine.v1alpha.IndustryVertical.MEDIA]
 vertical.
 

.google.cloud.discoveryengine.v1alpha.Engine.MediaRecommendationEngineConfig media_recommendation_engine_config = 14;

Specified by:

getMediaRecommendationEngineConfig in interface EngineOrBuilder

Returns:

The mediaRecommendationEngineConfig.

getMediaRecommendationEngineConfigOrBuilder

public Engine.MediaRecommendationEngineConfigOrBuilder getMediaRecommendationEngineConfigOrBuilder()

 Configurations for the Media Engine. Only applicable on the data
 stores with
 [solution_type][google.cloud.discoveryengine.v1alpha.Engine.solution_type]
 [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION]
 and
 [IndustryVertical.MEDIA][google.cloud.discoveryengine.v1alpha.IndustryVertical.MEDIA]
 vertical.
 

.google.cloud.discoveryengine.v1alpha.Engine.MediaRecommendationEngineConfig media_recommendation_engine_config = 14;

Specified by:

getMediaRecommendationEngineConfigOrBuilder in interface EngineOrBuilder

hasRecommendationMetadata

public boolean hasRecommendationMetadata()

 Output only. Additional information of a recommendation engine. Only
 applicable if
 [solution_type][google.cloud.discoveryengine.v1alpha.Engine.solution_type]
 is
 [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
 

.google.cloud.discoveryengine.v1alpha.Engine.RecommendationMetadata recommendation_metadata = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

hasRecommendationMetadata in interface EngineOrBuilder

Returns:

Whether the recommendationMetadata field is set.

getRecommendationMetadata

public Engine.RecommendationMetadata getRecommendationMetadata()

 Output only. Additional information of a recommendation engine. Only
 applicable if
 [solution_type][google.cloud.discoveryengine.v1alpha.Engine.solution_type]
 is
 [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
 

.google.cloud.discoveryengine.v1alpha.Engine.RecommendationMetadata recommendation_metadata = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getRecommendationMetadata in interface EngineOrBuilder

Returns:

The recommendationMetadata.

getRecommendationMetadataOrBuilder

public Engine.RecommendationMetadataOrBuilder getRecommendationMetadataOrBuilder()

 Output only. Additional information of a recommendation engine. Only
 applicable if
 [solution_type][google.cloud.discoveryengine.v1alpha.Engine.solution_type]
 is
 [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
 

.google.cloud.discoveryengine.v1alpha.Engine.RecommendationMetadata recommendation_metadata = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getRecommendationMetadataOrBuilder in interface EngineOrBuilder

hasChatEngineMetadata

public boolean hasChatEngineMetadata()

 Output only. Additional information of the Chat Engine. Only applicable
 if
 [solution_type][google.cloud.discoveryengine.v1alpha.Engine.solution_type]
 is
 [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_CHAT].
 

.google.cloud.discoveryengine.v1alpha.Engine.ChatEngineMetadata chat_engine_metadata = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

hasChatEngineMetadata in interface EngineOrBuilder

Returns:

Whether the chatEngineMetadata field is set.

getChatEngineMetadata

public Engine.ChatEngineMetadata getChatEngineMetadata()

 Output only. Additional information of the Chat Engine. Only applicable
 if
 [solution_type][google.cloud.discoveryengine.v1alpha.Engine.solution_type]
 is
 [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_CHAT].
 

.google.cloud.discoveryengine.v1alpha.Engine.ChatEngineMetadata chat_engine_metadata = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getChatEngineMetadata in interface EngineOrBuilder

Returns:

The chatEngineMetadata.

getChatEngineMetadataOrBuilder

public Engine.ChatEngineMetadataOrBuilder getChatEngineMetadataOrBuilder()

 Output only. Additional information of the Chat Engine. Only applicable
 if
 [solution_type][google.cloud.discoveryengine.v1alpha.Engine.solution_type]
 is
 [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_CHAT].
 

.google.cloud.discoveryengine.v1alpha.Engine.ChatEngineMetadata chat_engine_metadata = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getChatEngineMetadataOrBuilder in interface EngineOrBuilder

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][a-z0-9-_]*/. Otherwise, an INVALID_ARGUMENT error is returned.
 

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Specified by:

getName in interface EngineOrBuilder

Returns:

The name.

getNameBytes

public com.google.protobuf.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][a-z0-9-_]*/. Otherwise, an INVALID_ARGUMENT error is returned.
 

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Specified by:

getNameBytes in interface EngineOrBuilder

Returns:

The bytes for name.

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

Specified by:

getDisplayName in interface EngineOrBuilder

Returns:

The displayName.

getDisplayNameBytes

public com.google.protobuf.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];

Specified by:

getDisplayNameBytes in interface EngineOrBuilder

Returns:

The bytes for displayName.

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

Specified by:

hasCreateTime in interface EngineOrBuilder

Returns:

Whether the createTime field is set.

getCreateTime

public com.google.protobuf.Timestamp getCreateTime()

 Output only. Timestamp the Recommendation Engine was created at.
 

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getCreateTime in interface EngineOrBuilder

Returns:

The createTime.

getCreateTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()

 Output only. Timestamp the Recommendation Engine was created at.
 

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getCreateTimeOrBuilder in interface EngineOrBuilder

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

Specified by:

hasUpdateTime in interface EngineOrBuilder

Returns:

Whether the updateTime field is set.

getUpdateTime

public com.google.protobuf.Timestamp getUpdateTime()

 Output only. Timestamp the Recommendation Engine was last updated.
 

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getUpdateTime in interface EngineOrBuilder

Returns:

The updateTime.

getUpdateTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()

 Output only. Timestamp the Recommendation Engine was last updated.
 

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getUpdateTimeOrBuilder in interface EngineOrBuilder

getDataStoreIdsList

public com.google.protobuf.ProtocolStringList getDataStoreIdsList()

 The data stores associated with this engine.

 For
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH]
 and
 [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION]
 type of engines, they can only associate with at most one data store.

 If
 [solution_type][google.cloud.discoveryengine.v1alpha.Engine.solution_type]
 is
 [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_CHAT],
 multiple [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]s in
 the same [Collection][google.cloud.discoveryengine.v1alpha.Collection] can
 be associated here.

 Note that when used in
 [CreateEngineRequest][google.cloud.discoveryengine.v1alpha.CreateEngineRequest],
 one DataStore id must be provided as the system will use it for necessary
 initializations.
 

repeated string data_store_ids = 5;

Specified by:

getDataStoreIdsList in interface EngineOrBuilder

Returns:

A list containing the dataStoreIds.

getDataStoreIdsCount

public int getDataStoreIdsCount()

 The data stores associated with this engine.

 For
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH]
 and
 [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION]
 type of engines, they can only associate with at most one data store.

 If
 [solution_type][google.cloud.discoveryengine.v1alpha.Engine.solution_type]
 is
 [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_CHAT],
 multiple [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]s in
 the same [Collection][google.cloud.discoveryengine.v1alpha.Collection] can
 be associated here.

 Note that when used in
 [CreateEngineRequest][google.cloud.discoveryengine.v1alpha.CreateEngineRequest],
 one DataStore id must be provided as the system will use it for necessary
 initializations.
 

repeated string data_store_ids = 5;

Specified by:

getDataStoreIdsCount in interface EngineOrBuilder

Returns:

The count of dataStoreIds.

getDataStoreIds

public String getDataStoreIds(int index)

 The data stores associated with this engine.

 For
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH]
 and
 [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION]
 type of engines, they can only associate with at most one data store.

 If
 [solution_type][google.cloud.discoveryengine.v1alpha.Engine.solution_type]
 is
 [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_CHAT],
 multiple [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]s in
 the same [Collection][google.cloud.discoveryengine.v1alpha.Collection] can
 be associated here.

 Note that when used in
 [CreateEngineRequest][google.cloud.discoveryengine.v1alpha.CreateEngineRequest],
 one DataStore id must be provided as the system will use it for necessary
 initializations.
 

repeated string data_store_ids = 5;

Specified by:

getDataStoreIds in interface EngineOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The dataStoreIds at the given index.

getDataStoreIdsBytes

public com.google.protobuf.ByteString getDataStoreIdsBytes(int index)

 The data stores associated with this engine.

 For
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH]
 and
 [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION]
 type of engines, they can only associate with at most one data store.

 If
 [solution_type][google.cloud.discoveryengine.v1alpha.Engine.solution_type]
 is
 [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_CHAT],
 multiple [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]s in
 the same [Collection][google.cloud.discoveryengine.v1alpha.Collection] can
 be associated here.

 Note that when used in
 [CreateEngineRequest][google.cloud.discoveryengine.v1alpha.CreateEngineRequest],
 one DataStore id must be provided as the system will use it for necessary
 initializations.
 

repeated string data_store_ids = 5;

Specified by:

getDataStoreIdsBytes in interface EngineOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the dataStoreIds at the given index.

getSolutionTypeValue

public int getSolutionTypeValue()

 Required. The solutions of the engine.
 

.google.cloud.discoveryengine.v1alpha.SolutionType solution_type = 6 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getSolutionTypeValue in interface EngineOrBuilder

Returns:

The enum numeric value on the wire for solutionType.

getSolutionType

public SolutionType getSolutionType()

 Required. The solutions of the engine.
 

.google.cloud.discoveryengine.v1alpha.SolutionType solution_type = 6 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getSolutionType in interface EngineOrBuilder

Returns:

The solutionType.

getIndustryVerticalValue

public int getIndustryVerticalValue()

 The industry vertical that the engine registers.
 The restriction of the Engine industry vertical is based on
 [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]: If
 unspecified, default to `GENERIC`. Vertical on Engine has to match vertical
 of the DataStore linked to the engine.
 

.google.cloud.discoveryengine.v1alpha.IndustryVertical industry_vertical = 16;

Specified by:

getIndustryVerticalValue in interface EngineOrBuilder

Returns:

The enum numeric value on the wire for industryVertical.

getIndustryVertical

public IndustryVertical getIndustryVertical()

 The industry vertical that the engine registers.
 The restriction of the Engine industry vertical is based on
 [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]: If
 unspecified, default to `GENERIC`. Vertical on Engine has to match vertical
 of the DataStore linked to the engine.
 

.google.cloud.discoveryengine.v1alpha.IndustryVertical industry_vertical = 16;

Specified by:

getIndustryVertical in interface EngineOrBuilder

Returns:

The industryVertical.

hasCommonConfig

public boolean hasCommonConfig()

 Common config spec that specifies the metadata of the engine.
 

.google.cloud.discoveryengine.v1alpha.Engine.CommonConfig common_config = 15;

Specified by:

hasCommonConfig in interface EngineOrBuilder

Returns:

Whether the commonConfig field is set.

getCommonConfig

public Engine.CommonConfig getCommonConfig()

 Common config spec that specifies the metadata of the engine.
 

.google.cloud.discoveryengine.v1alpha.Engine.CommonConfig common_config = 15;

Specified by:

getCommonConfig in interface EngineOrBuilder

Returns:

The commonConfig.

getCommonConfigOrBuilder

public Engine.CommonConfigOrBuilder getCommonConfigOrBuilder()

 Common config spec that specifies the metadata of the engine.
 

.google.cloud.discoveryengine.v1alpha.Engine.CommonConfig common_config = 15;

Specified by:

getCommonConfigOrBuilder in interface EngineOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static Engine parseFrom(ByteBuffer data)
                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Engine parseFrom(ByteBuffer data,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Engine parseFrom(com.google.protobuf.ByteString data)
                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Engine parseFrom(com.google.protobuf.ByteString data,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Engine parseFrom(byte[] data)
                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Engine parseFrom(byte[] data,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Engine parseFrom(InputStream input)
                        throws IOException

Throws:

IOException

parseFrom

public static Engine parseFrom(InputStream input,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws IOException

Throws:

IOException

parseDelimitedFrom

public static Engine parseDelimitedFrom(InputStream input)
                                 throws IOException

Throws:

IOException

parseDelimitedFrom

public static Engine parseDelimitedFrom(InputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws IOException

Throws:

IOException

parseFrom

public static Engine parseFrom(com.google.protobuf.CodedInputStream input)
                        throws IOException

Throws:

IOException

parseFrom

public static Engine parseFrom(com.google.protobuf.CodedInputStream input,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws IOException

Throws:

IOException

newBuilderForType

public Engine.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Engine.Builder newBuilder()

newBuilder

public static Engine.Builder newBuilder(Engine prototype)

toBuilder

public Engine.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Engine.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Engine getDefaultInstance()

parser

public static com.google.protobuf.Parser<Engine> parser()

getParserForType

public com.google.protobuf.Parser<Engine> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public Engine getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder