Package org.mlflow.api.proto

Class Service.SearchExperiments

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

org.mlflow.api.proto.Service.SearchExperiments

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable, Service.SearchExperimentsOrBuilder

Enclosing class:

Service

public static final class Service.SearchExperiments
extends com.google.protobuf.GeneratedMessageV3
implements Service.SearchExperimentsOrBuilder

Protobuf type mlflow.SearchExperiments

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Service.SearchExperiments.Builder	Protobuf type mlflow.SearchExperiments
static class	Service.SearchExperiments.Response	Protobuf type mlflow.SearchExperiments.Response
static interface	Service.SearchExperiments.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, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

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

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
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.SearchExperiments>	PARSER	Deprecated.
static int	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	Description
boolean	equals(java.lang.Object obj)
static Service.SearchExperiments	getDefaultInstance()
Service.SearchExperiments	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
java.lang.String	getFilter()	A filter expression over experiment attributes and tags that allows returning a subset of experiments.
com.google.protobuf.ByteString	getFilterBytes()	A filter expression over experiment attributes and tags that allows returning a subset of experiments.
long	getMaxResults()	Maximum number of experiments desired.
java.lang.String	getOrderBy(int index)	List of columns for ordering search results, which can include experiment name and id with an optional "DESC" or "ASC" annotation, where "ASC" is the default.
com.google.protobuf.ByteString	getOrderByBytes(int index)	List of columns for ordering search results, which can include experiment name and id with an optional "DESC" or "ASC" annotation, where "ASC" is the default.
int	getOrderByCount()	List of columns for ordering search results, which can include experiment name and id with an optional "DESC" or "ASC" annotation, where "ASC" is the default.
com.google.protobuf.ProtocolStringList	getOrderByList()	List of columns for ordering search results, which can include experiment name and id with an optional "DESC" or "ASC" annotation, where "ASC" is the default.
java.lang.String	getPageToken()	Token indicating the page of experiments to fetch
com.google.protobuf.ByteString	getPageTokenBytes()	Token indicating the page of experiments to fetch
com.google.protobuf.Parser<Service.SearchExperiments>	getParserForType()
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
Service.ViewType	getViewType()	Qualifier for type of experiments to be returned.
boolean	hasFilter()	A filter expression over experiment attributes and tags that allows returning a subset of experiments.
int	hashCode()
boolean	hasMaxResults()	Maximum number of experiments desired.
boolean	hasPageToken()	Token indicating the page of experiments to fetch
boolean	hasViewType()	Qualifier for type of experiments to be returned.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Service.SearchExperiments.Builder	newBuilder()
static Service.SearchExperiments.Builder	newBuilder(Service.SearchExperiments prototype)
Service.SearchExperiments.Builder	newBuilderForType()
protected Service.SearchExperiments.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected java.lang.Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Service.SearchExperiments	parseDelimitedFrom(java.io.InputStream input)
static Service.SearchExperiments	parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Service.SearchExperiments	parseFrom(byte[] data)
static Service.SearchExperiments	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Service.SearchExperiments	parseFrom(com.google.protobuf.ByteString data)
static Service.SearchExperiments	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Service.SearchExperiments	parseFrom(com.google.protobuf.CodedInputStream input)
static Service.SearchExperiments	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Service.SearchExperiments	parseFrom(java.io.InputStream input)
static Service.SearchExperiments	parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Service.SearchExperiments	parseFrom(java.nio.ByteBuffer data)
static Service.SearchExperiments	parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Service.SearchExperiments>	parser()
Service.SearchExperiments.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Field Detail

MAX_RESULTS_FIELD_NUMBER

public static final int MAX_RESULTS_FIELD_NUMBER

See Also:

Constant Field Values

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER

See Also:

Constant Field Values

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER

See Also:

Constant Field Values

ORDER_BY_FIELD_NUMBER

public static final int ORDER_BY_FIELD_NUMBER

See Also:

Constant Field Values

VIEW_TYPE_FIELD_NUMBER

public static final int VIEW_TYPE_FIELD_NUMBER

See Also:

Constant Field Values

PARSER

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

Deprecated.

Method Detail

newInstance

protected java.lang.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

hasMaxResults

public boolean hasMaxResults()

 Maximum number of experiments desired.
 Servers may select a desired default `max_results` value. All servers are
 guaranteed to support a `max_results` threshold of at least 1,000 but may
 support more. Callers of this endpoint are encouraged to pass max_results
 explicitly and leverage page_token to iterate through experiments.
 

optional int64 max_results = 1;

Specified by:

hasMaxResults in interface Service.SearchExperimentsOrBuilder

Returns:

Whether the maxResults field is set.

getMaxResults

public long getMaxResults()

 Maximum number of experiments desired.
 Servers may select a desired default `max_results` value. All servers are
 guaranteed to support a `max_results` threshold of at least 1,000 but may
 support more. Callers of this endpoint are encouraged to pass max_results
 explicitly and leverage page_token to iterate through experiments.
 

optional int64 max_results = 1;

Specified by:

getMaxResults in interface Service.SearchExperimentsOrBuilder

Returns:

The maxResults.

hasPageToken

public boolean hasPageToken()

 Token indicating the page of experiments to fetch
 

optional string page_token = 2;

Specified by:

hasPageToken in interface Service.SearchExperimentsOrBuilder

Returns:

Whether the pageToken field is set.

getPageToken

public java.lang.String getPageToken()

 Token indicating the page of experiments to fetch
 

optional string page_token = 2;

Specified by:

getPageToken in interface Service.SearchExperimentsOrBuilder

Returns:

The pageToken.

getPageTokenBytes

public com.google.protobuf.ByteString getPageTokenBytes()

 Token indicating the page of experiments to fetch
 

optional string page_token = 2;

Specified by:

getPageTokenBytes in interface Service.SearchExperimentsOrBuilder

Returns:

The bytes for pageToken.

hasFilter

public boolean hasFilter()

 A filter expression over experiment attributes and tags that allows returning a subset of
 experiments. The syntax is a subset of SQL that supports ANDing together binary operations
 between an attribute or tag, and a constant.
 Example: ``name LIKE 'test-%' AND tags.key = 'value'``
 You can select columns with special characters (hyphen, space, period, etc.) by using
 double quotes or backticks.
 Example: ``tags."extra-key" = 'value'`` or ``tags.`extra-key` = 'value'``
 Supported operators are ``=``, ``!=``, ``LIKE``, and ``ILIKE``.
 

optional string filter = 3;

Specified by:

hasFilter in interface Service.SearchExperimentsOrBuilder

Returns:

Whether the filter field is set.

getFilter

public java.lang.String getFilter()

 A filter expression over experiment attributes and tags that allows returning a subset of
 experiments. The syntax is a subset of SQL that supports ANDing together binary operations
 between an attribute or tag, and a constant.
 Example: ``name LIKE 'test-%' AND tags.key = 'value'``
 You can select columns with special characters (hyphen, space, period, etc.) by using
 double quotes or backticks.
 Example: ``tags."extra-key" = 'value'`` or ``tags.`extra-key` = 'value'``
 Supported operators are ``=``, ``!=``, ``LIKE``, and ``ILIKE``.
 

optional string filter = 3;

Specified by:

getFilter in interface Service.SearchExperimentsOrBuilder

Returns:

The filter.

getFilterBytes

public com.google.protobuf.ByteString getFilterBytes()

 A filter expression over experiment attributes and tags that allows returning a subset of
 experiments. The syntax is a subset of SQL that supports ANDing together binary operations
 between an attribute or tag, and a constant.
 Example: ``name LIKE 'test-%' AND tags.key = 'value'``
 You can select columns with special characters (hyphen, space, period, etc.) by using
 double quotes or backticks.
 Example: ``tags."extra-key" = 'value'`` or ``tags.`extra-key` = 'value'``
 Supported operators are ``=``, ``!=``, ``LIKE``, and ``ILIKE``.
 

optional string filter = 3;

Specified by:

getFilterBytes in interface Service.SearchExperimentsOrBuilder

Returns:

The bytes for filter.

getOrderByList

public com.google.protobuf.ProtocolStringList getOrderByList()

 List of columns for ordering search results, which can include experiment name and id
 with an optional "DESC" or "ASC" annotation, where "ASC" is the default.
 Tiebreaks are done by experiment id DESC.
 

repeated string order_by = 4;

Specified by:

getOrderByList in interface Service.SearchExperimentsOrBuilder

Returns:

A list containing the orderBy.

getOrderByCount

public int getOrderByCount()

 List of columns for ordering search results, which can include experiment name and id
 with an optional "DESC" or "ASC" annotation, where "ASC" is the default.
 Tiebreaks are done by experiment id DESC.
 

repeated string order_by = 4;

Specified by:

getOrderByCount in interface Service.SearchExperimentsOrBuilder

Returns:

The count of orderBy.

getOrderBy

public java.lang.String getOrderBy(int index)

 List of columns for ordering search results, which can include experiment name and id
 with an optional "DESC" or "ASC" annotation, where "ASC" is the default.
 Tiebreaks are done by experiment id DESC.
 

repeated string order_by = 4;

Specified by:

getOrderBy in interface Service.SearchExperimentsOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The orderBy at the given index.

getOrderByBytes

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

 List of columns for ordering search results, which can include experiment name and id
 with an optional "DESC" or "ASC" annotation, where "ASC" is the default.
 Tiebreaks are done by experiment id DESC.
 

repeated string order_by = 4;

Specified by:

getOrderByBytes in interface Service.SearchExperimentsOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the orderBy at the given index.

hasViewType

public boolean hasViewType()

 Qualifier for type of experiments to be returned.
 If unspecified, return only active experiments.
 

optional .mlflow.ViewType view_type = 5;

Specified by:

hasViewType in interface Service.SearchExperimentsOrBuilder

Returns:

Whether the viewType field is set.

getViewType

public Service.ViewType getViewType()

 Qualifier for type of experiments to be returned.
 If unspecified, return only active experiments.
 

optional .mlflow.ViewType view_type = 5;

Specified by:

getViewType in interface Service.SearchExperimentsOrBuilder

Returns:

The viewType.

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 java.io.IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

java.io.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(java.lang.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.SearchExperiments parseFrom(java.nio.ByteBuffer data)
                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Service.SearchExperiments parseFrom(java.io.InputStream input)
                                           throws java.io.IOException

Throws:

java.io.IOException

parseFrom

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

Throws:

java.io.IOException

parseDelimitedFrom

public static Service.SearchExperiments parseDelimitedFrom(java.io.InputStream input)
                                                    throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

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

Throws:

java.io.IOException

parseFrom

public static Service.SearchExperiments parseFrom(com.google.protobuf.CodedInputStream input)
                                           throws java.io.IOException

Throws:

java.io.IOException

parseFrom

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

Throws:

java.io.IOException

newBuilderForType

public Service.SearchExperiments.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Service.SearchExperiments.Builder newBuilder()

newBuilder

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

toBuilder

public Service.SearchExperiments.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Service.SearchExperiments getDefaultInstance()

parser

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

getParserForType

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

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder