Package org.mlflow.api.proto

Class Service.GetMetricHistoryBulkInterval

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
org.mlflow.api.proto.Service.GetMetricHistoryBulkInterval
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, Service.GetMetricHistoryBulkIntervalOrBuilder
Enclosing class:
Service
public static final class Service.GetMetricHistoryBulkInterval extends com.google.protobuf.GeneratedMessageV3 implements Service.GetMetricHistoryBulkIntervalOrBuilder
Protobuf type mlflow.GetMetricHistoryBulkInterval
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

    • getRunIdsList

      public com.google.protobuf.ProtocolStringList getRunIdsList()
       ID(s) of the run(s) from which to fetch metric values. Must be provided.
      repeated string run_ids = 1;
      Specified by:
      getRunIdsList in interface Service.GetMetricHistoryBulkIntervalOrBuilder
      Returns:
      A list containing the runIds.

    • getRunIdsCount

      public int getRunIdsCount()
       ID(s) of the run(s) from which to fetch metric values. Must be provided.
      repeated string run_ids = 1;
      Specified by:
      getRunIdsCount in interface Service.GetMetricHistoryBulkIntervalOrBuilder
      Returns:
      The count of runIds.

    • getRunIds

      public String getRunIds(int index)
       ID(s) of the run(s) from which to fetch metric values. Must be provided.
      repeated string run_ids = 1;
      Specified by:
      getRunIds in interface Service.GetMetricHistoryBulkIntervalOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The runIds at the given index.

    • getRunIdsBytes

      public com.google.protobuf.ByteString getRunIdsBytes(int index)
       ID(s) of the run(s) from which to fetch metric values. Must be provided.
      repeated string run_ids = 1;
      Specified by:
      getRunIdsBytes in interface Service.GetMetricHistoryBulkIntervalOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the runIds at the given index.

    • hasMetricKey

      public boolean hasMetricKey()
       Name of the metric.
      optional string metric_key = 2 [(.mlflow.validate_required) = true];
      Specified by:
      hasMetricKey in interface Service.GetMetricHistoryBulkIntervalOrBuilder
      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.GetMetricHistoryBulkIntervalOrBuilder
      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.GetMetricHistoryBulkIntervalOrBuilder
      Returns:
      The bytes for metricKey.

    • hasStartStep

      public boolean hasStartStep()
       Optional start step to only fetch metrics after the specified step. Must be defined if
 end_step is defined.
      optional int32 start_step = 3;
      Specified by:
      hasStartStep in interface Service.GetMetricHistoryBulkIntervalOrBuilder
      Returns:
      Whether the startStep field is set.

    • getStartStep

      public int getStartStep()
       Optional start step to only fetch metrics after the specified step. Must be defined if
 end_step is defined.
      optional int32 start_step = 3;
      Specified by:
      getStartStep in interface Service.GetMetricHistoryBulkIntervalOrBuilder
      Returns:
      The startStep.

    • hasEndStep

      public boolean hasEndStep()
       Optional end step to only fetch metrics before the specified step. Must be defined if
 start_step is defined.
      optional int32 end_step = 4;
      Specified by:
      hasEndStep in interface Service.GetMetricHistoryBulkIntervalOrBuilder
      Returns:
      Whether the endStep field is set.

    • getEndStep

      public int getEndStep()
       Optional end step to only fetch metrics before the specified step. Must be defined if
 start_step is defined.
      optional int32 end_step = 4;
      Specified by:
      getEndStep in interface Service.GetMetricHistoryBulkIntervalOrBuilder
      Returns:
      The endStep.

    • hasMaxResults

      public boolean hasMaxResults()
       Maximum number of results to fetch per run specified. Must be set to a positive number.
 Note, in reality, the API returns at most (max_results + # of run IDs) x (# run IDs) metric
 data points.
      optional int32 max_results = 5;
      Specified by:
      hasMaxResults in interface Service.GetMetricHistoryBulkIntervalOrBuilder
      Returns:
      Whether the maxResults field is set.

    • getMaxResults

      public int getMaxResults()
       Maximum number of results to fetch per run specified. Must be set to a positive number.
 Note, in reality, the API returns at most (max_results + # of run IDs) x (# run IDs) metric
 data points.
      optional int32 max_results = 5;
      Specified by:
      getMaxResults in interface Service.GetMetricHistoryBulkIntervalOrBuilder
      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.GetMetricHistoryBulkInterval parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static Service.GetMetricHistoryBulkInterval 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.GetMetricHistoryBulkInterval parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Service.GetMetricHistoryBulkInterval.Builder newBuilder()

    • newBuilder

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

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static Service.GetMetricHistoryBulkInterval getDefaultInstance()

    • parser

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

    • getParserForType

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