Package com.google.cloud.discoveryengine.v1beta

Class CustomTuningModel

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.discoveryengine.v1beta.CustomTuningModel
All Implemented Interfaces:
CustomTuningModelOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class CustomTuningModel extends com.google.protobuf.GeneratedMessage implements CustomTuningModelOrBuilder
 Metadata that describes a custom tuned model.
Protobuf type google.cloud.discoveryengine.v1beta.CustomTuningModel
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • DISPLAY_NAME_FIELD_NUMBER

      public static final int DISPLAY_NAME_FIELD_NUMBER
      See Also:

    • MODEL_VERSION_FIELD_NUMBER

      public static final int MODEL_VERSION_FIELD_NUMBER
      See Also:

    • MODEL_STATE_FIELD_NUMBER

      public static final int MODEL_STATE_FIELD_NUMBER
      See Also:

    • CREATE_TIME_FIELD_NUMBER

      public static final int CREATE_TIME_FIELD_NUMBER
      See Also:

    • TRAINING_START_TIME_FIELD_NUMBER

      public static final int TRAINING_START_TIME_FIELD_NUMBER
      See Also:

    • METRICS_FIELD_NUMBER

      public static final int METRICS_FIELD_NUMBER
      See Also:

    • ERROR_MESSAGE_FIELD_NUMBER

      public static final int ERROR_MESSAGE_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

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

    • getName

      public 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) = { ... }
      Specified by:
      getName in interface CustomTuningModelOrBuilder
      Returns:
      The name.

    • getNameBytes

      public 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) = { ... }
      Specified by:
      getNameBytes in interface CustomTuningModelOrBuilder
      Returns:
      The bytes for name.

    • getDisplayName

      public String getDisplayName()
       The display name of the model.
      string display_name = 2;
      Specified by:
      getDisplayName in interface CustomTuningModelOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

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

    • getModelVersion

      public long getModelVersion()
       The version of the model.
      int64 model_version = 3;
      Specified by:
      getModelVersion in interface CustomTuningModelOrBuilder
      Returns:
      The modelVersion.

    • getModelStateValue

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

    • getModelState

      public 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;
      Specified by:
      getModelState in interface CustomTuningModelOrBuilder
      Returns:
      The modelState.

    • hasCreateTime

      @Deprecated public 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];
      Specified by:
      hasCreateTime in interface CustomTuningModelOrBuilder
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      @Deprecated public 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];
      Specified by:
      getCreateTime in interface CustomTuningModelOrBuilder
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

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

    • hasTrainingStartTime

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

    • getTrainingStartTime

      public com.google.protobuf.Timestamp getTrainingStartTime()
       Timestamp the model training was initiated.
      .google.protobuf.Timestamp training_start_time = 6;
      Specified by:
      getTrainingStartTime in interface CustomTuningModelOrBuilder
      Returns:
      The trainingStartTime.

    • getTrainingStartTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getTrainingStartTimeOrBuilder()
       Timestamp the model training was initiated.
      .google.protobuf.Timestamp training_start_time = 6;
      Specified by:
      getTrainingStartTimeOrBuilder in interface CustomTuningModelOrBuilder

    • getMetricsCount

      public int getMetricsCount()
      Description copied from interface: CustomTuningModelOrBuilder
       The metrics of the trained model.
      map<string, double> metrics = 7;
      Specified by:
      getMetricsCount in interface CustomTuningModelOrBuilder

    • containsMetrics

      public boolean containsMetrics(String key)
       The metrics of the trained model.
      map<string, double> metrics = 7;
      Specified by:
      containsMetrics in interface CustomTuningModelOrBuilder

    • getMetrics

      @Deprecated public Map<String,Double> getMetrics()
      Deprecated.
      Use getMetricsMap() instead.
      Specified by:
      getMetrics in interface CustomTuningModelOrBuilder

    • getMetricsMap

      public Map<String,Double> getMetricsMap()
       The metrics of the trained model.
      map<string, double> metrics = 7;
      Specified by:
      getMetricsMap in interface CustomTuningModelOrBuilder

    • getMetricsOrDefault

      public double getMetricsOrDefault(String key, double defaultValue)
       The metrics of the trained model.
      map<string, double> metrics = 7;
      Specified by:
      getMetricsOrDefault in interface CustomTuningModelOrBuilder

    • getMetricsOrThrow

      public double getMetricsOrThrow(String key)
       The metrics of the trained model.
      map<string, double> metrics = 7;
      Specified by:
      getMetricsOrThrow in interface CustomTuningModelOrBuilder

    • getErrorMessage

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

    • getErrorMessageBytes

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

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static CustomTuningModel parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CustomTuningModel parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static CustomTuningModel parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static CustomTuningModel parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static CustomTuningModel.Builder newBuilder()

    • newBuilder

      public static CustomTuningModel.Builder newBuilder(CustomTuningModel prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static CustomTuningModel getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<CustomTuningModel> 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 CustomTuningModel getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder