Package org.mlflow.api.proto

Interface Service.LogParamOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Service.LogParam, Service.LogParam.Builder
    Enclosing class:
    Service
    public static interface Service.LogParamOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getKey()
      Name of the param.
      com.google.protobuf.ByteString getKeyBytes()
      Name of the param.
      java.lang.String getRunId()
      ID of the run under which to log the param.
      com.google.protobuf.ByteString getRunIdBytes()
      ID of the run under which to log the param.
      java.lang.String getRunUuid()
      [Deprecated, use run_id instead] ID of the run under which to log the param.
      com.google.protobuf.ByteString getRunUuidBytes()
      [Deprecated, use run_id instead] ID of the run under which to log the param.
      java.lang.String getValue()
      String value of the param being logged.
      com.google.protobuf.ByteString getValueBytes()
      String value of the param being logged.
      boolean hasKey()
      Name of the param.
      boolean hasRunId()
      ID of the run under which to log the param.
      boolean hasRunUuid()
      [Deprecated, use run_id instead] ID of the run under which to log the param.
      boolean hasValue()
      String value of the param being logged.

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

      • hasRunId

        boolean hasRunId()
         ID of the run under which to log the param. Must be provided.
        optional string run_id = 4;
        Returns:
        Whether the runId field is set.

      • getRunId

        java.lang.String getRunId()
         ID of the run under which to log the param. Must be provided.
        optional string run_id = 4;
        Returns:
        The runId.

      • getRunIdBytes

        com.google.protobuf.ByteString getRunIdBytes()
         ID of the run under which to log the param. Must be provided.
        optional string run_id = 4;
        Returns:
        The bytes for runId.

      • hasRunUuid

        boolean hasRunUuid()
         [Deprecated, use run_id instead] ID of the run under which to log the param. This field will
 be removed in a future MLflow version.
        optional string run_uuid = 1;
        Returns:
        Whether the runUuid field is set.

      • getRunUuid

        java.lang.String getRunUuid()
         [Deprecated, use run_id instead] ID of the run under which to log the param. This field will
 be removed in a future MLflow version.
        optional string run_uuid = 1;
        Returns:
        The runUuid.

      • getRunUuidBytes

        com.google.protobuf.ByteString getRunUuidBytes()
         [Deprecated, use run_id instead] ID of the run under which to log the param. This field will
 be removed in a future MLflow version.
        optional string run_uuid = 1;
        Returns:
        The bytes for runUuid.

      • hasKey

        boolean hasKey()
         Name of the param. Maximum size is 255 bytes.
        optional string key = 2 [(.mlflow.validate_required) = true];
        Returns:
        Whether the key field is set.

      • getKey

        java.lang.String getKey()
         Name of the param. Maximum size is 255 bytes.
        optional string key = 2 [(.mlflow.validate_required) = true];
        Returns:
        The key.

      • getKeyBytes

        com.google.protobuf.ByteString getKeyBytes()
         Name of the param. Maximum size is 255 bytes.
        optional string key = 2 [(.mlflow.validate_required) = true];
        Returns:
        The bytes for key.

      • hasValue

        boolean hasValue()
         String value of the param being logged. Maximum size is 6000 bytes.
        optional string value = 3 [(.mlflow.validate_required) = true];
        Returns:
        Whether the value field is set.

      • getValue

        java.lang.String getValue()
         String value of the param being logged. Maximum size is 6000 bytes.
        optional string value = 3 [(.mlflow.validate_required) = true];
        Returns:
        The value.

      • getValueBytes

        com.google.protobuf.ByteString getValueBytes()
         String value of the param being logged. Maximum size is 6000 bytes.
        optional string value = 3 [(.mlflow.validate_required) = true];
        Returns:
        The bytes for value.