Package com.google.cloud.discoveryengine.v1alpha

Class Engine.RecommendationMetadata

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.discoveryengine.v1alpha.Engine.RecommendationMetadata
All Implemented Interfaces:
Engine.RecommendationMetadataOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
Engine
public static final class Engine.RecommendationMetadata extends com.google.protobuf.GeneratedMessage implements Engine.RecommendationMetadataOrBuilder
 Additional information of a recommendation engine.
Protobuf type google.cloud.discoveryengine.v1alpha.Engine.RecommendationMetadata
See Also:

  • Field Details

    • SERVING_STATE_FIELD_NUMBER

      public static final int SERVING_STATE_FIELD_NUMBER
      See Also:

    • DATA_STATE_FIELD_NUMBER

      public static final int DATA_STATE_FIELD_NUMBER
      See Also:

    • LAST_TUNE_TIME_FIELD_NUMBER

      public static final int LAST_TUNE_TIME_FIELD_NUMBER
      See Also:

    • TUNING_OPERATION_FIELD_NUMBER

      public static final int TUNING_OPERATION_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getServingStateValue

      public 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];
      Specified by:
      getServingStateValue in interface Engine.RecommendationMetadataOrBuilder
      Returns:
      The enum numeric value on the wire for servingState.

    • getServingState

      public 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];
      Specified by:
      getServingState in interface Engine.RecommendationMetadataOrBuilder
      Returns:
      The servingState.

    • getDataStateValue

      public 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];
      Specified by:
      getDataStateValue in interface Engine.RecommendationMetadataOrBuilder
      Returns:
      The enum numeric value on the wire for dataState.

    • getDataState

      public 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];
      Specified by:
      getDataState in interface Engine.RecommendationMetadataOrBuilder
      Returns:
      The dataState.

    • hasLastTuneTime

      public 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];
      Specified by:
      hasLastTuneTime in interface Engine.RecommendationMetadataOrBuilder
      Returns:
      Whether the lastTuneTime field is set.

    • getLastTuneTime

      public 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];
      Specified by:
      getLastTuneTime in interface Engine.RecommendationMetadataOrBuilder
      Returns:
      The lastTuneTime.

    • getLastTuneTimeOrBuilder

      public 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];
      Specified by:
      getLastTuneTimeOrBuilder in interface Engine.RecommendationMetadataOrBuilder

    • getTuningOperation

      public 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];
      Specified by:
      getTuningOperation in interface Engine.RecommendationMetadataOrBuilder
      Returns:
      The tuningOperation.

    • getTuningOperationBytes

      public 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];
      Specified by:
      getTuningOperationBytes in interface Engine.RecommendationMetadataOrBuilder
      Returns:
      The bytes for tuningOperation.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • 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.RecommendationMetadata parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static Engine.RecommendationMetadata 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.RecommendationMetadata parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static Engine.RecommendationMetadata parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static Engine.RecommendationMetadata parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

      public Engine.RecommendationMetadata.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Engine.RecommendationMetadata.Builder newBuilder()

    • newBuilder

      public static Engine.RecommendationMetadata.Builder newBuilder(Engine.RecommendationMetadata prototype)

    • toBuilder

      public Engine.RecommendationMetadata.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Engine.RecommendationMetadata.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Engine.RecommendationMetadata getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<Engine.RecommendationMetadata> 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.GeneratedMessage

    • getDefaultInstanceForType

      public Engine.RecommendationMetadata getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder