Package com.google.cloud.discoveryengine.v1alpha

Class Engine.RecommendationMetadata.Builder

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

  • 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.Builder<Engine.RecommendationMetadata.Builder>

    • clear

      public Engine.RecommendationMetadata.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<Engine.RecommendationMetadata.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<Engine.RecommendationMetadata.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public Engine.RecommendationMetadata.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Engine.RecommendationMetadata.Builder>

    • mergeFrom

      public Engine.RecommendationMetadata.Builder mergeFrom(Engine.RecommendationMetadata other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<Engine.RecommendationMetadata.Builder>

    • mergeFrom

      public Engine.RecommendationMetadata.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Engine.RecommendationMetadata.Builder>
      Throws:
      IOException

    • 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.

    • setServingStateValue

      public Engine.RecommendationMetadata.Builder setServingStateValue(int value)
       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];
      Parameters:
      value - The enum numeric value on the wire for servingState to set.
      Returns:
      This builder for chaining.

    • 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.

    • setServingState

      public Engine.RecommendationMetadata.Builder setServingState(Engine.RecommendationMetadata.ServingState value)
       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];
      Parameters:
      value - The servingState to set.
      Returns:
      This builder for chaining.

    • clearServingState

      public Engine.RecommendationMetadata.Builder clearServingState()
       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:
      This builder for chaining.

    • 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.

    • setDataStateValue

      public Engine.RecommendationMetadata.Builder setDataStateValue(int value)
       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];
      Parameters:
      value - The enum numeric value on the wire for dataState to set.
      Returns:
      This builder for chaining.

    • 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.

    • setDataState

      public Engine.RecommendationMetadata.Builder setDataState(Engine.RecommendationMetadata.DataState value)
       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];
      Parameters:
      value - The dataState to set.
      Returns:
      This builder for chaining.

    • clearDataState

      public Engine.RecommendationMetadata.Builder clearDataState()
       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:
      This builder for chaining.

    • 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.

    • setLastTuneTime

      public Engine.RecommendationMetadata.Builder setLastTuneTime(com.google.protobuf.Timestamp value)
       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];

    • setLastTuneTime

      public Engine.RecommendationMetadata.Builder setLastTuneTime(com.google.protobuf.Timestamp.Builder builderForValue)
       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];

    • mergeLastTuneTime

      public Engine.RecommendationMetadata.Builder mergeLastTuneTime(com.google.protobuf.Timestamp value)
       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];

    • clearLastTuneTime

      public Engine.RecommendationMetadata.Builder clearLastTuneTime()
       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];

    • getLastTuneTimeBuilder

      public com.google.protobuf.Timestamp.Builder getLastTuneTimeBuilder()
       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];

    • 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.

    • setTuningOperation

      public Engine.RecommendationMetadata.Builder setTuningOperation(String value)
       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];
      Parameters:
      value - The tuningOperation to set.
      Returns:
      This builder for chaining.

    • clearTuningOperation

      public Engine.RecommendationMetadata.Builder clearTuningOperation()
       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:
      This builder for chaining.

    • setTuningOperationBytes

      public Engine.RecommendationMetadata.Builder setTuningOperationBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for tuningOperation to set.
      Returns:
      This builder for chaining.