Package org.mlflow.api.proto

Class Service.GetMetricHistory

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
org.mlflow.api.proto.Service.GetMetricHistory
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, Service.GetMetricHistoryOrBuilder
Enclosing class:
Service
public static final class Service.GetMetricHistory extends com.google.protobuf.GeneratedMessageV3 implements Service.GetMetricHistoryOrBuilder
Protobuf type mlflow.GetMetricHistory
See Also:

  • Field Details

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getUnknownFields

      public final com.google.protobuf.UnknownFieldSet getUnknownFields()
      Specified by:
      getUnknownFields in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getUnknownFields in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

    • hasRunId

      public boolean hasRunId()
       ID of the run from which to fetch metric values. Must be provided.
      optional string run_id = 3;
      Specified by:
      hasRunId in interface Service.GetMetricHistoryOrBuilder
      Returns:
      Whether the runId field is set.

    • getRunId

      public String getRunId()
       ID of the run from which to fetch metric values. Must be provided.
      optional string run_id = 3;
      Specified by:
      getRunId in interface Service.GetMetricHistoryOrBuilder
      Returns:
      The runId.

    • getRunIdBytes

      public com.google.protobuf.ByteString getRunIdBytes()
       ID of the run from which to fetch metric values. Must be provided.
      optional string run_id = 3;
      Specified by:
      getRunIdBytes in interface Service.GetMetricHistoryOrBuilder
      Returns:
      The bytes for runId.

    • hasRunUuid

      public boolean hasRunUuid()
       [Deprecated, use run_id instead] ID of the run from which to fetch metric values. This field
 will be removed in a future MLflow version.
      optional string run_uuid = 1;
      Specified by:
      hasRunUuid in interface Service.GetMetricHistoryOrBuilder
      Returns:
      Whether the runUuid field is set.

    • getRunUuid

      public String getRunUuid()
       [Deprecated, use run_id instead] ID of the run from which to fetch metric values. This field
 will be removed in a future MLflow version.
      optional string run_uuid = 1;
      Specified by:
      getRunUuid in interface Service.GetMetricHistoryOrBuilder
      Returns:
      The runUuid.

    • getRunUuidBytes

      public com.google.protobuf.ByteString getRunUuidBytes()
       [Deprecated, use run_id instead] ID of the run from which to fetch metric values. This field
 will be removed in a future MLflow version.
      optional string run_uuid = 1;
      Specified by:
      getRunUuidBytes in interface Service.GetMetricHistoryOrBuilder
      Returns:
      The bytes for runUuid.

    • hasMetricKey

      public boolean hasMetricKey()
       Name of the metric.
      optional string metric_key = 2 [(.mlflow.validate_required) = true];
      Specified by:
      hasMetricKey in interface Service.GetMetricHistoryOrBuilder
      Returns:
      Whether the metricKey field is set.

    • getMetricKey

      public String getMetricKey()
       Name of the metric.
      optional string metric_key = 2 [(.mlflow.validate_required) = true];
      Specified by:
      getMetricKey in interface Service.GetMetricHistoryOrBuilder
      Returns:
      The metricKey.

    • getMetricKeyBytes

      public com.google.protobuf.ByteString getMetricKeyBytes()
       Name of the metric.
      optional string metric_key = 2 [(.mlflow.validate_required) = true];
      Specified by:
      getMetricKeyBytes in interface Service.GetMetricHistoryOrBuilder
      Returns:
      The bytes for metricKey.

    • hasPageToken

      public boolean hasPageToken()
       Token indicating the page of metric history to fetch
      optional string page_token = 4;
      Specified by:
      hasPageToken in interface Service.GetMetricHistoryOrBuilder
      Returns:
      Whether the pageToken field is set.

    • getPageToken

      public String getPageToken()
       Token indicating the page of metric history to fetch
      optional string page_token = 4;
      Specified by:
      getPageToken in interface Service.GetMetricHistoryOrBuilder
      Returns:
      The pageToken.

    • getPageTokenBytes

      public com.google.protobuf.ByteString getPageTokenBytes()
       Token indicating the page of metric history to fetch
      optional string page_token = 4;
      Specified by:
      getPageTokenBytes in interface Service.GetMetricHistoryOrBuilder
      Returns:
      The bytes for pageToken.

    • hasMaxResults

      public boolean hasMaxResults()
       Maximum number of logged instances of a metric for a run to return per call.
 Backend servers may restrict the value of `max_results` depending on performance requirements.
 Requests that do not specify this value will behave as non-paginated queries where all
 metric history values for a given metric within a run are returned in a single response.
      optional int32 max_results = 5;
      Specified by:
      hasMaxResults in interface Service.GetMetricHistoryOrBuilder
      Returns:
      Whether the maxResults field is set.

    • getMaxResults

      public int getMaxResults()
       Maximum number of logged instances of a metric for a run to return per call.
 Backend servers may restrict the value of `max_results` depending on performance requirements.
 Requests that do not specify this value will behave as non-paginated queries where all
 metric history values for a given metric within a run are returned in a single response.
      optional int32 max_results = 5;
      Specified by:
      getMaxResults in interface Service.GetMetricHistoryOrBuilder
      Returns:
      The maxResults.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • 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.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static Service.GetMetricHistory parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static Service.GetMetricHistory parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Service.GetMetricHistory.Builder newBuilder()

    • newBuilder

      public static Service.GetMetricHistory.Builder newBuilder(Service.GetMetricHistory prototype)

    • toBuilder

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

    • newBuilderForType

      protected Service.GetMetricHistory.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static Service.GetMetricHistory getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<Service.GetMetricHistory> 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.GeneratedMessageV3

    • getDefaultInstanceForType

      public Service.GetMetricHistory getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder