org.mlflow.api.proto

Class Service.SearchRuns

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

org.mlflow.api.proto.Service.SearchRuns

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, Service.SearchRunsOrBuilder

Enclosing class:

Service

public static final class Service.SearchRuns
extends com.google.protobuf.GeneratedMessageV3
implements Service.SearchRunsOrBuilder

Protobuf type mlflow.SearchRuns

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Service.SearchRuns.Builder Protobuf type mlflow.SearchRuns
static class	Service.SearchRuns.Response Protobuf type mlflow.SearchRuns.Response
static interface	Service.SearchRuns.ResponseOrBuilder

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields

Modifier and Type	Field and Description
static int	EXPERIMENT_IDS_FIELD_NUMBER
static int	FILTER_FIELD_NUMBER
static int	MAX_RESULTS_FIELD_NUMBER
static int	ORDER_BY_FIELD_NUMBER
static int	PAGE_TOKEN_FIELD_NUMBER
static com.google.protobuf.Parser<Service.SearchRuns>	PARSER Deprecated.
static int	RUN_VIEW_TYPE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static Service.SearchRuns	getDefaultInstance()
Service.SearchRuns	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getExperimentIds(int index) List of experiment IDs to search over.
com.google.protobuf.ByteString	getExperimentIdsBytes(int index) List of experiment IDs to search over.
int	getExperimentIdsCount() List of experiment IDs to search over.
com.google.protobuf.ProtocolStringList	getExperimentIdsList() List of experiment IDs to search over.
String	getFilter() A filter expression over params, metrics, and tags, that allows returning a subset of runs.
com.google.protobuf.ByteString	getFilterBytes() A filter expression over params, metrics, and tags, that allows returning a subset of runs.
int	getMaxResults() Maximum number of runs desired.
String	getOrderBy(int index) List of columns to be ordered by, including attributes, params, metrics, and tags with an optional "DESC" or "ASC" annotation, where "ASC" is the default.
com.google.protobuf.ByteString	getOrderByBytes(int index) List of columns to be ordered by, including attributes, params, metrics, and tags with an optional "DESC" or "ASC" annotation, where "ASC" is the default.
int	getOrderByCount() List of columns to be ordered by, including attributes, params, metrics, and tags with an optional "DESC" or "ASC" annotation, where "ASC" is the default.
com.google.protobuf.ProtocolStringList	getOrderByList() List of columns to be ordered by, including attributes, params, metrics, and tags with an optional "DESC" or "ASC" annotation, where "ASC" is the default.
String	getPageToken() optional string page_token = 7;
com.google.protobuf.ByteString	getPageTokenBytes() optional string page_token = 7;
com.google.protobuf.Parser<Service.SearchRuns>	getParserForType()
Service.ViewType	getRunViewType() Whether to display only active, only deleted, or all runs.
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasFilter() A filter expression over params, metrics, and tags, that allows returning a subset of runs.
int	hashCode()
boolean	hasMaxResults() Maximum number of runs desired.
boolean	hasPageToken() optional string page_token = 7;
boolean	hasRunViewType() Whether to display only active, only deleted, or all runs.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Service.SearchRuns.Builder	newBuilder()
static Service.SearchRuns.Builder	newBuilder(Service.SearchRuns prototype)
Service.SearchRuns.Builder	newBuilderForType()
protected Service.SearchRuns.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static Service.SearchRuns	parseDelimitedFrom(InputStream input)
static Service.SearchRuns	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Service.SearchRuns	parseFrom(byte[] data)
static Service.SearchRuns	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Service.SearchRuns	parseFrom(ByteBuffer data)
static Service.SearchRuns	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Service.SearchRuns	parseFrom(com.google.protobuf.ByteString data)
static Service.SearchRuns	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Service.SearchRuns	parseFrom(com.google.protobuf.CodedInputStream input)
static Service.SearchRuns	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Service.SearchRuns	parseFrom(InputStream input)
static Service.SearchRuns	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Service.SearchRuns>	parser()
Service.SearchRuns.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

EXPERIMENT_IDS_FIELD_NUMBER

public static final int EXPERIMENT_IDS_FIELD_NUMBER

See Also:

Constant Field Values

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER

See Also:

Constant Field Values

RUN_VIEW_TYPE_FIELD_NUMBER

public static final int RUN_VIEW_TYPE_FIELD_NUMBER

See Also:

Constant Field Values

MAX_RESULTS_FIELD_NUMBER

public static final int MAX_RESULTS_FIELD_NUMBER

See Also:

Constant Field Values

ORDER_BY_FIELD_NUMBER

public static final int ORDER_BY_FIELD_NUMBER

See Also:

Constant Field Values

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER

See Also:

Constant Field Values

PARSER

@Deprecated
public static final com.google.protobuf.Parser<Service.SearchRuns> PARSER

Deprecated.

Method Detail

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

getExperimentIdsList

public com.google.protobuf.ProtocolStringList getExperimentIdsList()

 List of experiment IDs to search over.
 

repeated string experiment_ids = 1;

Specified by:

getExperimentIdsList in interface Service.SearchRunsOrBuilder

getExperimentIdsCount

public int getExperimentIdsCount()

 List of experiment IDs to search over.
 

repeated string experiment_ids = 1;

Specified by:

getExperimentIdsCount in interface Service.SearchRunsOrBuilder

getExperimentIds

public String getExperimentIds(int index)

 List of experiment IDs to search over.
 

repeated string experiment_ids = 1;

Specified by:

getExperimentIds in interface Service.SearchRunsOrBuilder

getExperimentIdsBytes

public com.google.protobuf.ByteString getExperimentIdsBytes(int index)

 List of experiment IDs to search over.
 

repeated string experiment_ids = 1;

Specified by:

getExperimentIdsBytes in interface Service.SearchRunsOrBuilder

hasFilter

public boolean hasFilter()

 A filter expression over params, metrics, and tags, that allows returning a subset of
 runs. The syntax is a subset of SQL that supports ANDing together binary operations
 between a param, metric, or tag and a constant.
 Example: ``metrics.rmse < 1 and params.model_class = 'LogisticRegression'``
 You can select columns with special characters (hyphen, space, period, etc.) by using double quotes:
 ``metrics."model class" = 'LinearRegression' and tags."user-name" = 'Tomas'``
 Supported operators are ``=``, ``!=``, ``>``, ``>=``, ``<``, and ``<=``.
 

optional string filter = 4;

Specified by:

hasFilter in interface Service.SearchRunsOrBuilder

getFilter

public String getFilter()

 A filter expression over params, metrics, and tags, that allows returning a subset of
 runs. The syntax is a subset of SQL that supports ANDing together binary operations
 between a param, metric, or tag and a constant.
 Example: ``metrics.rmse < 1 and params.model_class = 'LogisticRegression'``
 You can select columns with special characters (hyphen, space, period, etc.) by using double quotes:
 ``metrics."model class" = 'LinearRegression' and tags."user-name" = 'Tomas'``
 Supported operators are ``=``, ``!=``, ``>``, ``>=``, ``<``, and ``<=``.
 

optional string filter = 4;

Specified by:

getFilter in interface Service.SearchRunsOrBuilder

getFilterBytes

public com.google.protobuf.ByteString getFilterBytes()

 A filter expression over params, metrics, and tags, that allows returning a subset of
 runs. The syntax is a subset of SQL that supports ANDing together binary operations
 between a param, metric, or tag and a constant.
 Example: ``metrics.rmse < 1 and params.model_class = 'LogisticRegression'``
 You can select columns with special characters (hyphen, space, period, etc.) by using double quotes:
 ``metrics."model class" = 'LinearRegression' and tags."user-name" = 'Tomas'``
 Supported operators are ``=``, ``!=``, ``>``, ``>=``, ``<``, and ``<=``.
 

optional string filter = 4;

Specified by:

getFilterBytes in interface Service.SearchRunsOrBuilder

hasRunViewType

public boolean hasRunViewType()

 Whether to display only active, only deleted, or all runs.
 Defaults to only active runs.
 

optional .mlflow.ViewType run_view_type = 3 [default = ACTIVE_ONLY];

Specified by:

hasRunViewType in interface Service.SearchRunsOrBuilder

getRunViewType

public Service.ViewType getRunViewType()

 Whether to display only active, only deleted, or all runs.
 Defaults to only active runs.
 

optional .mlflow.ViewType run_view_type = 3 [default = ACTIVE_ONLY];

Specified by:

getRunViewType in interface Service.SearchRunsOrBuilder

hasMaxResults

public boolean hasMaxResults()

 Maximum number of runs desired. Max threshold is 50000
 

optional int32 max_results = 5 [default = 1000];

Specified by:

hasMaxResults in interface Service.SearchRunsOrBuilder

getMaxResults

public int getMaxResults()

 Maximum number of runs desired. Max threshold is 50000
 

optional int32 max_results = 5 [default = 1000];

Specified by:

getMaxResults in interface Service.SearchRunsOrBuilder

getOrderByList

public com.google.protobuf.ProtocolStringList getOrderByList()

 List of columns to be ordered by, including attributes, params, metrics, and tags with an
 optional "DESC" or "ASC" annotation, where "ASC" is the default.
 Example: ["params.input DESC", "metrics.alpha ASC", "metrics.rmse"]
 Tiebreaks are done by start_time DESC followed by run_id for runs with the same start time
 (and this is the default ordering criterion if order_by is not provided).
 

repeated string order_by = 6;

Specified by:

getOrderByList in interface Service.SearchRunsOrBuilder

getOrderByCount

public int getOrderByCount()

 List of columns to be ordered by, including attributes, params, metrics, and tags with an
 optional "DESC" or "ASC" annotation, where "ASC" is the default.
 Example: ["params.input DESC", "metrics.alpha ASC", "metrics.rmse"]
 Tiebreaks are done by start_time DESC followed by run_id for runs with the same start time
 (and this is the default ordering criterion if order_by is not provided).
 

repeated string order_by = 6;

Specified by:

getOrderByCount in interface Service.SearchRunsOrBuilder

getOrderBy

public String getOrderBy(int index)

 List of columns to be ordered by, including attributes, params, metrics, and tags with an
 optional "DESC" or "ASC" annotation, where "ASC" is the default.
 Example: ["params.input DESC", "metrics.alpha ASC", "metrics.rmse"]
 Tiebreaks are done by start_time DESC followed by run_id for runs with the same start time
 (and this is the default ordering criterion if order_by is not provided).
 

repeated string order_by = 6;

Specified by:

getOrderBy in interface Service.SearchRunsOrBuilder

getOrderByBytes

public com.google.protobuf.ByteString getOrderByBytes(int index)

 List of columns to be ordered by, including attributes, params, metrics, and tags with an
 optional "DESC" or "ASC" annotation, where "ASC" is the default.
 Example: ["params.input DESC", "metrics.alpha ASC", "metrics.rmse"]
 Tiebreaks are done by start_time DESC followed by run_id for runs with the same start time
 (and this is the default ordering criterion if order_by is not provided).
 

repeated string order_by = 6;

Specified by:

getOrderByBytes in interface Service.SearchRunsOrBuilder

hasPageToken

public boolean hasPageToken()

optional string page_token = 7;

Specified by:

hasPageToken in interface Service.SearchRunsOrBuilder

getPageToken

public String getPageToken()

optional string page_token = 7;

Specified by:

getPageToken in interface Service.SearchRunsOrBuilder

getPageTokenBytes

public com.google.protobuf.ByteString getPageTokenBytes()

optional string page_token = 7;

Specified by:

getPageTokenBytes in interface Service.SearchRunsOrBuilder

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.SearchRuns parseFrom(ByteBuffer data)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Service.SearchRuns parseFrom(com.google.protobuf.ByteString data)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Service.SearchRuns parseFrom(InputStream input)
                                    throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static Service.SearchRuns parseDelimitedFrom(InputStream input)
                                             throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

public static Service.SearchRuns parseFrom(com.google.protobuf.CodedInputStream input)
                                    throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public Service.SearchRuns.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Service.SearchRuns.Builder newBuilder()

newBuilder

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

toBuilder

public Service.SearchRuns.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Service.SearchRuns.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Service.SearchRuns getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<Service.SearchRuns> 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.SearchRuns getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder