Package com.google.cloud.discoveryengine.v1beta

Interface CustomTuningModelOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
CustomTuningModel, CustomTuningModel.Builder
@Generated public interface CustomTuningModelOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    containsMetrics(String key)
    The metrics of the trained model.
    com.google.protobuf.Timestamp
    getCreateTime()
    Deprecated.
    google.cloud.discoveryengine.v1beta.CustomTuningModel.create_time is deprecated.
    com.google.protobuf.TimestampOrBuilder
    getCreateTimeOrBuilder()
    Deprecated.
    String
    getDisplayName()
    The display name of the model.
    com.google.protobuf.ByteString
    getDisplayNameBytes()
    The display name of the model.
    String
    getErrorMessage()
    Currently this is only populated if the model state is `INPUT_VALIDATION_FAILED`.
    com.google.protobuf.ByteString
    getErrorMessageBytes()
    Currently this is only populated if the model state is `INPUT_VALIDATION_FAILED`.
    Map<String,Double>
    getMetrics()
    Deprecated.
    int
    getMetricsCount()
    The metrics of the trained model.
    Map<String,Double>
    getMetricsMap()
    The metrics of the trained model.
    double
    getMetricsOrDefault(String key, double defaultValue)
    The metrics of the trained model.
    double
    getMetricsOrThrow(String key)
    The metrics of the trained model.
    CustomTuningModel.ModelState
    getModelState()
    The state that the model is in (e.g.
    int
    getModelStateValue()
    The state that the model is in (e.g.
    long
    getModelVersion()
    The version of the model.
    String
    getName()
    Required.
    com.google.protobuf.ByteString
    getNameBytes()
    Required.
    com.google.protobuf.Timestamp
    getTrainingStartTime()
    Timestamp the model training was initiated.
    com.google.protobuf.TimestampOrBuilder
    getTrainingStartTimeOrBuilder()
    Timestamp the model training was initiated.
    boolean
    hasCreateTime()
    Deprecated.
    google.cloud.discoveryengine.v1beta.CustomTuningModel.create_time is deprecated.
    boolean
    hasTrainingStartTime()
    Timestamp the model training was initiated.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getName

      String getName()
       Required. The fully qualified resource name of the model.

 Format:
 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`.

 Model must be an alpha-numerical string with limit of 40 characters.
      string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Required. The fully qualified resource name of the model.

 Format:
 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`.

 Model must be an alpha-numerical string with limit of 40 characters.
      string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for name.

    • getDisplayName

      String getDisplayName()
       The display name of the model.
      string display_name = 2;
      Returns:
      The displayName.

    • getDisplayNameBytes

      com.google.protobuf.ByteString getDisplayNameBytes()
       The display name of the model.
      string display_name = 2;
      Returns:
      The bytes for displayName.

    • getModelVersion

      long getModelVersion()
       The version of the model.
      int64 model_version = 3;
      Returns:
      The modelVersion.

    • getModelStateValue

      int getModelStateValue()
       The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).
      .google.cloud.discoveryengine.v1beta.CustomTuningModel.ModelState model_state = 4;
      Returns:
      The enum numeric value on the wire for modelState.

    • getModelState

      CustomTuningModel.ModelState getModelState()
       The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).
      .google.cloud.discoveryengine.v1beta.CustomTuningModel.ModelState model_state = 4;
      Returns:
      The modelState.

    • hasCreateTime

      @Deprecated boolean hasCreateTime()
      Deprecated.
      google.cloud.discoveryengine.v1beta.CustomTuningModel.create_time is deprecated. See google/cloud/discoveryengine/v1beta/custom_tuning_model.proto;l=89
       Deprecated: Timestamp the Model was created at.
      .google.protobuf.Timestamp create_time = 5 [deprecated = true];
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      @Deprecated com.google.protobuf.Timestamp getCreateTime()
      Deprecated.
      google.cloud.discoveryengine.v1beta.CustomTuningModel.create_time is deprecated. See google/cloud/discoveryengine/v1beta/custom_tuning_model.proto;l=89
       Deprecated: Timestamp the Model was created at.
      .google.protobuf.Timestamp create_time = 5 [deprecated = true];
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      @Deprecated com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
      Deprecated.
       Deprecated: Timestamp the Model was created at.
      .google.protobuf.Timestamp create_time = 5 [deprecated = true];

    • hasTrainingStartTime

      boolean hasTrainingStartTime()
       Timestamp the model training was initiated.
      .google.protobuf.Timestamp training_start_time = 6;
      Returns:
      Whether the trainingStartTime field is set.

    • getTrainingStartTime

      com.google.protobuf.Timestamp getTrainingStartTime()
       Timestamp the model training was initiated.
      .google.protobuf.Timestamp training_start_time = 6;
      Returns:
      The trainingStartTime.

    • getTrainingStartTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getTrainingStartTimeOrBuilder()
       Timestamp the model training was initiated.
      .google.protobuf.Timestamp training_start_time = 6;

    • getMetricsCount

      int getMetricsCount()
       The metrics of the trained model.
      map<string, double> metrics = 7;

    • containsMetrics

      boolean containsMetrics(String key)
       The metrics of the trained model.
      map<string, double> metrics = 7;

    • getMetrics

      @Deprecated Map<String,Double> getMetrics()
      Deprecated.
      Use getMetricsMap() instead.

    • getMetricsMap

      Map<String,Double> getMetricsMap()
       The metrics of the trained model.
      map<string, double> metrics = 7;

    • getMetricsOrDefault

      double getMetricsOrDefault(String key, double defaultValue)
       The metrics of the trained model.
      map<string, double> metrics = 7;

    • getMetricsOrThrow

      double getMetricsOrThrow(String key)
       The metrics of the trained model.
      map<string, double> metrics = 7;

    • getErrorMessage

      String getErrorMessage()
       Currently this is only populated if the model state is
 `INPUT_VALIDATION_FAILED`.
      string error_message = 8;
      Returns:
      The errorMessage.

    • getErrorMessageBytes

      com.google.protobuf.ByteString getErrorMessageBytes()
       Currently this is only populated if the model state is
 `INPUT_VALIDATION_FAILED`.
      string error_message = 8;
      Returns:
      The bytes for errorMessage.