Interface Engine.RecommendationMetadataOrBuilder (0.43.0)

Version 0.43.0

• 0.49.0 (latest)
• 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 static interface Engine.RecommendationMetadataOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDataState()

public abstract Engine.RecommendationMetadata.DataState getDataState()

Output only. The state of data requirements for this engine: DATA_OK and DATA_ERROR.

Engine cannot be trained if the data is in DATA_ERROR state. Engine can have DATA_ERROR state even if serving state is ACTIVE: engines were trained successfully before, but cannot be refreshed because the underlying engine no longer has sufficient data for training.

.google.cloud.discoveryengine.v1alpha.Engine.RecommendationMetadata.DataState data_state = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Engine.RecommendationMetadata.DataState	The dataState.

getDataStateValue()

public abstract int getDataStateValue()

Output only. The state of data requirements for this engine: DATA_OK and DATA_ERROR.

Engine cannot be trained if the data is in DATA_ERROR state. Engine can have DATA_ERROR state even if serving state is ACTIVE: engines were trained successfully before, but cannot be refreshed because the underlying engine no longer has sufficient data for training.

.google.cloud.discoveryengine.v1alpha.Engine.RecommendationMetadata.DataState data_state = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int	The enum numeric value on the wire for dataState.

getLastTuneTime()

public abstract Timestamp getLastTuneTime()

Output only. The timestamp when the latest successful tune finished. Only applicable on Media Recommendation engines.

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

Returns
Type	Description
Timestamp	The lastTuneTime.

getLastTuneTimeOrBuilder()

public abstract TimestampOrBuilder getLastTuneTimeOrBuilder()

Output only. The timestamp when the latest successful tune finished. Only applicable on Media Recommendation engines.

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

Returns
Type	Description
TimestampOrBuilder

getServingState()

public abstract Engine.RecommendationMetadata.ServingState getServingState()

Output only. The serving state of the engine: ACTIVE, NOT_ACTIVE.

.google.cloud.discoveryengine.v1alpha.Engine.RecommendationMetadata.ServingState serving_state = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Engine.RecommendationMetadata.ServingState	The servingState.

getServingStateValue()

public abstract int getServingStateValue()

Output only. The serving state of the engine: ACTIVE, NOT_ACTIVE.

.google.cloud.discoveryengine.v1alpha.Engine.RecommendationMetadata.ServingState serving_state = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int	The enum numeric value on the wire for servingState.

getTuningOperation()

public abstract String getTuningOperation()

Output only. The latest tune operation id associated with the engine. Only applicable on Media Recommendation engines.

If present, this operation id can be used to determine if there is an ongoing tune for this engine. To check the operation status, send the GetOperation request with this operation id in the engine resource format. If no tuning has happened for this engine, the string is empty.

string tuning_operation = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The tuningOperation.

getTuningOperationBytes()

public abstract ByteString getTuningOperationBytes()

Output only. The latest tune operation id associated with the engine. Only applicable on Media Recommendation engines.

If present, this operation id can be used to determine if there is an ongoing tune for this engine. To check the operation status, send the GetOperation request with this operation id in the engine resource format. If no tuning has happened for this engine, the string is empty.

string tuning_operation = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for tuningOperation.

hasLastTuneTime()

public abstract boolean hasLastTuneTime()

Output only. The timestamp when the latest successful tune finished. Only applicable on Media Recommendation engines.

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

Returns
Type	Description
boolean	Whether the lastTuneTime field is set.