Package org.mlflow.api.proto

Class Service.GetMetricHistory.Builder

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

  • Method Details

    • 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.Builder<Service.GetMetricHistory.Builder>

    • clear

      public Service.GetMetricHistory.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessageV3.Builder<Service.GetMetricHistory.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Service.GetMetricHistory.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

      public Service.GetMetricHistory.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<Service.GetMetricHistory.Builder>

    • setField

      public Service.GetMetricHistory.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<Service.GetMetricHistory.Builder>

    • clearField

      public Service.GetMetricHistory.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Service.GetMetricHistory.Builder>

    • clearOneof

      public Service.GetMetricHistory.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Service.GetMetricHistory.Builder>

    • setRepeatedField

      public Service.GetMetricHistory.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Service.GetMetricHistory.Builder>

    • addRepeatedField

      public Service.GetMetricHistory.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Service.GetMetricHistory.Builder>

    • mergeFrom

      public Service.GetMetricHistory.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Service.GetMetricHistory.Builder>

    • mergeFrom

      public Service.GetMetricHistory.Builder mergeFrom(Service.GetMetricHistory other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Service.GetMetricHistory.Builder>

    • mergeFrom

      public Service.GetMetricHistory.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Service.GetMetricHistory.Builder>
      Throws:
      IOException

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

    • setRunId

      public Service.GetMetricHistory.Builder setRunId(String value)
       ID of the run from which to fetch metric values. Must be provided.
      optional string run_id = 3;
      Parameters:
      value - The runId to set.
      Returns:
      This builder for chaining.

    • clearRunId

      public Service.GetMetricHistory.Builder clearRunId()
       ID of the run from which to fetch metric values. Must be provided.
      optional string run_id = 3;
      Returns:
      This builder for chaining.

    • setRunIdBytes

      public Service.GetMetricHistory.Builder setRunIdBytes(com.google.protobuf.ByteString value)
       ID of the run from which to fetch metric values. Must be provided.
      optional string run_id = 3;
      Parameters:
      value - The bytes for runId to set.
      Returns:
      This builder for chaining.

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

    • setRunUuid

      public Service.GetMetricHistory.Builder setRunUuid(String value)
       [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;
      Parameters:
      value - The runUuid to set.
      Returns:
      This builder for chaining.

    • clearRunUuid

      public Service.GetMetricHistory.Builder clearRunUuid()
       [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;
      Returns:
      This builder for chaining.

    • setRunUuidBytes

      public Service.GetMetricHistory.Builder setRunUuidBytes(com.google.protobuf.ByteString value)
       [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;
      Parameters:
      value - The bytes for runUuid to set.
      Returns:
      This builder for chaining.

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

    • setMetricKey

      public Service.GetMetricHistory.Builder setMetricKey(String value)
       Name of the metric.
      optional string metric_key = 2 [(.mlflow.validate_required) = true];
      Parameters:
      value - The metricKey to set.
      Returns:
      This builder for chaining.

    • clearMetricKey

      public Service.GetMetricHistory.Builder clearMetricKey()
       Name of the metric.
      optional string metric_key = 2 [(.mlflow.validate_required) = true];
      Returns:
      This builder for chaining.

    • setMetricKeyBytes

      public Service.GetMetricHistory.Builder setMetricKeyBytes(com.google.protobuf.ByteString value)
       Name of the metric.
      optional string metric_key = 2 [(.mlflow.validate_required) = true];
      Parameters:
      value - The bytes for metricKey to set.
      Returns:
      This builder for chaining.

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

    • setPageToken

      public Service.GetMetricHistory.Builder setPageToken(String value)
       Token indicating the page of metric history to fetch
      optional string page_token = 4;
      Parameters:
      value - The pageToken to set.
      Returns:
      This builder for chaining.

    • clearPageToken

      public Service.GetMetricHistory.Builder clearPageToken()
       Token indicating the page of metric history to fetch
      optional string page_token = 4;
      Returns:
      This builder for chaining.

    • setPageTokenBytes

      public Service.GetMetricHistory.Builder setPageTokenBytes(com.google.protobuf.ByteString value)
       Token indicating the page of metric history to fetch
      optional string page_token = 4;
      Parameters:
      value - The bytes for pageToken to set.
      Returns:
      This builder for chaining.

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

    • setMaxResults

      public Service.GetMetricHistory.Builder setMaxResults(int value)
       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;
      Parameters:
      value - The maxResults to set.
      Returns:
      This builder for chaining.

    • clearMaxResults

      public Service.GetMetricHistory.Builder clearMaxResults()
       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;
      Returns:
      This builder for chaining.

    • setUnknownFields

      public final Service.GetMetricHistory.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Service.GetMetricHistory.Builder>

    • mergeUnknownFields

      public final Service.GetMetricHistory.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Service.GetMetricHistory.Builder>