Package org.mlflow.api.proto

Class Service.SearchLoggedModels.OrderBy.Builder

    • Method Detail

      • 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.SearchLoggedModels.OrderBy.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.SearchLoggedModels.OrderBy.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • isInitialized

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

      • mergeFrom

        public Service.SearchLoggedModels.OrderBy.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                     throws java.io.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.SearchLoggedModels.OrderBy.Builder>
        Throws:
        java.io.IOException

      • hasFieldName

        public boolean hasFieldName()
         Name of the field to order by, e.g. "metrics.accuracy".
        optional string field_name = 1 [(.mlflow.validate_required) = true];
        Specified by:
        hasFieldName in interface Service.SearchLoggedModels.OrderByOrBuilder
        Returns:
        Whether the fieldName field is set.

      • getFieldName

        public java.lang.String getFieldName()
         Name of the field to order by, e.g. "metrics.accuracy".
        optional string field_name = 1 [(.mlflow.validate_required) = true];
        Specified by:
        getFieldName in interface Service.SearchLoggedModels.OrderByOrBuilder
        Returns:
        The fieldName.

      • getFieldNameBytes

        public com.google.protobuf.ByteString getFieldNameBytes()
         Name of the field to order by, e.g. "metrics.accuracy".
        optional string field_name = 1 [(.mlflow.validate_required) = true];
        Specified by:
        getFieldNameBytes in interface Service.SearchLoggedModels.OrderByOrBuilder
        Returns:
        The bytes for fieldName.

      • setFieldName

        public Service.SearchLoggedModels.OrderBy.Builder setFieldName​(java.lang.String value)
         Name of the field to order by, e.g. "metrics.accuracy".
        optional string field_name = 1 [(.mlflow.validate_required) = true];
        Parameters:
        value - The fieldName to set.
        Returns:
        This builder for chaining.

      • clearFieldName

        public Service.SearchLoggedModels.OrderBy.Builder clearFieldName()
         Name of the field to order by, e.g. "metrics.accuracy".
        optional string field_name = 1 [(.mlflow.validate_required) = true];
        Returns:
        This builder for chaining.

      • setFieldNameBytes

        public Service.SearchLoggedModels.OrderBy.Builder setFieldNameBytes​(com.google.protobuf.ByteString value)
         Name of the field to order by, e.g. "metrics.accuracy".
        optional string field_name = 1 [(.mlflow.validate_required) = true];
        Parameters:
        value - The bytes for fieldName to set.
        Returns:
        This builder for chaining.

      • setAscending

        public Service.SearchLoggedModels.OrderBy.Builder setAscending​(boolean value)
         Whether the order is ascending or not.
        optional bool ascending = 2 [default = true];
        Parameters:
        value - The ascending to set.
        Returns:
        This builder for chaining.

      • hasDatasetName

        public boolean hasDatasetName()
         If ``field_name`` refers to a metric, this field specifies the name of the dataset
 associated with the metric. Only metrics associated with the specified dataset name will be
 considered for ordering. This field may only be set if ``field_name`` refers to a metric.
        optional string dataset_name = 3;
        Specified by:
        hasDatasetName in interface Service.SearchLoggedModels.OrderByOrBuilder
        Returns:
        Whether the datasetName field is set.

      • getDatasetName

        public java.lang.String getDatasetName()
         If ``field_name`` refers to a metric, this field specifies the name of the dataset
 associated with the metric. Only metrics associated with the specified dataset name will be
 considered for ordering. This field may only be set if ``field_name`` refers to a metric.
        optional string dataset_name = 3;
        Specified by:
        getDatasetName in interface Service.SearchLoggedModels.OrderByOrBuilder
        Returns:
        The datasetName.

      • getDatasetNameBytes

        public com.google.protobuf.ByteString getDatasetNameBytes()
         If ``field_name`` refers to a metric, this field specifies the name of the dataset
 associated with the metric. Only metrics associated with the specified dataset name will be
 considered for ordering. This field may only be set if ``field_name`` refers to a metric.
        optional string dataset_name = 3;
        Specified by:
        getDatasetNameBytes in interface Service.SearchLoggedModels.OrderByOrBuilder
        Returns:
        The bytes for datasetName.

      • setDatasetName

        public Service.SearchLoggedModels.OrderBy.Builder setDatasetName​(java.lang.String value)
         If ``field_name`` refers to a metric, this field specifies the name of the dataset
 associated with the metric. Only metrics associated with the specified dataset name will be
 considered for ordering. This field may only be set if ``field_name`` refers to a metric.
        optional string dataset_name = 3;
        Parameters:
        value - The datasetName to set.
        Returns:
        This builder for chaining.

      • clearDatasetName

        public Service.SearchLoggedModels.OrderBy.Builder clearDatasetName()
         If ``field_name`` refers to a metric, this field specifies the name of the dataset
 associated with the metric. Only metrics associated with the specified dataset name will be
 considered for ordering. This field may only be set if ``field_name`` refers to a metric.
        optional string dataset_name = 3;
        Returns:
        This builder for chaining.

      • setDatasetNameBytes

        public Service.SearchLoggedModels.OrderBy.Builder setDatasetNameBytes​(com.google.protobuf.ByteString value)
         If ``field_name`` refers to a metric, this field specifies the name of the dataset
 associated with the metric. Only metrics associated with the specified dataset name will be
 considered for ordering. This field may only be set if ``field_name`` refers to a metric.
        optional string dataset_name = 3;
        Parameters:
        value - The bytes for datasetName to set.
        Returns:
        This builder for chaining.

      • hasDatasetDigest

        public boolean hasDatasetDigest()
         If ``field_name`` refers to a metric, this field specifies the digest of the dataset
 associated with the metric. Only metrics associated with the specified dataset name
 and digest will be considered for ordering. This field may only be set if ``dataset_name``
 is also set.
        optional string dataset_digest = 4;
        Specified by:
        hasDatasetDigest in interface Service.SearchLoggedModels.OrderByOrBuilder
        Returns:
        Whether the datasetDigest field is set.

      • getDatasetDigest

        public java.lang.String getDatasetDigest()
         If ``field_name`` refers to a metric, this field specifies the digest of the dataset
 associated with the metric. Only metrics associated with the specified dataset name
 and digest will be considered for ordering. This field may only be set if ``dataset_name``
 is also set.
        optional string dataset_digest = 4;
        Specified by:
        getDatasetDigest in interface Service.SearchLoggedModels.OrderByOrBuilder
        Returns:
        The datasetDigest.

      • getDatasetDigestBytes

        public com.google.protobuf.ByteString getDatasetDigestBytes()
         If ``field_name`` refers to a metric, this field specifies the digest of the dataset
 associated with the metric. Only metrics associated with the specified dataset name
 and digest will be considered for ordering. This field may only be set if ``dataset_name``
 is also set.
        optional string dataset_digest = 4;
        Specified by:
        getDatasetDigestBytes in interface Service.SearchLoggedModels.OrderByOrBuilder
        Returns:
        The bytes for datasetDigest.

      • setDatasetDigest

        public Service.SearchLoggedModels.OrderBy.Builder setDatasetDigest​(java.lang.String value)
         If ``field_name`` refers to a metric, this field specifies the digest of the dataset
 associated with the metric. Only metrics associated with the specified dataset name
 and digest will be considered for ordering. This field may only be set if ``dataset_name``
 is also set.
        optional string dataset_digest = 4;
        Parameters:
        value - The datasetDigest to set.
        Returns:
        This builder for chaining.

      • clearDatasetDigest

        public Service.SearchLoggedModels.OrderBy.Builder clearDatasetDigest()
         If ``field_name`` refers to a metric, this field specifies the digest of the dataset
 associated with the metric. Only metrics associated with the specified dataset name
 and digest will be considered for ordering. This field may only be set if ``dataset_name``
 is also set.
        optional string dataset_digest = 4;
        Returns:
        This builder for chaining.

      • setDatasetDigestBytes

        public Service.SearchLoggedModels.OrderBy.Builder setDatasetDigestBytes​(com.google.protobuf.ByteString value)
         If ``field_name`` refers to a metric, this field specifies the digest of the dataset
 associated with the metric. Only metrics associated with the specified dataset name
 and digest will be considered for ordering. This field may only be set if ``dataset_name``
 is also set.
        optional string dataset_digest = 4;
        Parameters:
        value - The bytes for datasetDigest to set.
        Returns:
        This builder for chaining.