Package com.google.cloud.discoveryengine.v1alpha

Interface Engine.RecommendationMetadataOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Engine.RecommendationMetadata, Engine.RecommendationMetadata.Builder
Enclosing class:
Engine
public static interface Engine.RecommendationMetadataOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getServingStateValue

      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:
      The enum numeric value on the wire for servingState.

    • getServingState

      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:
      The servingState.

    • getDataStateValue

      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:
      The enum numeric value on the wire for dataState.

    • getDataState

      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:
      The dataState.

    • hasLastTuneTime

      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:
      Whether the lastTuneTime field is set.

    • getLastTuneTime

      com.google.protobuf.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:
      The lastTuneTime.

    • getLastTuneTimeOrBuilder

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

    • getTuningOperation

      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:
      The tuningOperation.

    • getTuningOperationBytes

      com.google.protobuf.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:
      The bytes for tuningOperation.