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

    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 Details

    • hasRunId

      boolean hasRunId()
       ID of the run under which to log the param. Must be provided.
      optional string run_id = 4;

    • getRunId

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

    • getRunIdBytes

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

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

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

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

    • hasKey

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

    • getKey

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

    • getKeyBytes

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

    • hasValue

      boolean hasValue()
       String value of the param being logged. Maximum size is 500 bytes.
      optional string value = 3 [(.mlflow.validate_required) = true];

    • getValue

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

    • getValueBytes

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