Package org.mlflow.api.proto

Class ModelRegistry.SearchRegisteredModels

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

org.mlflow.api.proto.ModelRegistry.SearchRegisteredModels

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable, ModelRegistry.SearchRegisteredModelsOrBuilder

Enclosing class:

ModelRegistry

public static final class ModelRegistry.SearchRegisteredModels
extends com.google.protobuf.GeneratedMessageV3
implements ModelRegistry.SearchRegisteredModelsOrBuilder

Protobuf type mlflow.SearchRegisteredModels

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ModelRegistry.SearchRegisteredModels.Builder	Protobuf type mlflow.SearchRegisteredModels
static class	ModelRegistry.SearchRegisteredModels.Response	Protobuf type mlflow.SearchRegisteredModels.Response
static interface	ModelRegistry.SearchRegisteredModels.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<ModelRegistry.SearchRegisteredModels>	PARSER	Deprecated.

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 ModelRegistry.SearchRegisteredModels	getDefaultInstance()
ModelRegistry.SearchRegisteredModels	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
java.lang.String	getFilter()	String filter condition, like "name LIKE 'my-model-name'".
com.google.protobuf.ByteString	getFilterBytes()	String filter condition, like "name LIKE 'my-model-name'".
long	getMaxResults()	Maximum number of models desired.
java.lang.String	getOrderBy(int index)	List of columns for ordering search results, which can include model name and last updated timestamp 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 model name and last updated timestamp with an optional "DESC" or "ASC" annotation, where "ASC" is the default.
int	getOrderByCount()	List of columns for ordering search results, which can include model name and last updated timestamp 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 model name and last updated timestamp with an optional "DESC" or "ASC" annotation, where "ASC" is the default.
java.lang.String	getPageToken()	Pagination token to go to the next page based on a previous search query.
com.google.protobuf.ByteString	getPageTokenBytes()	Pagination token to go to the next page based on a previous search query.
com.google.protobuf.Parser<ModelRegistry.SearchRegisteredModels>	getParserForType()
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasFilter()	String filter condition, like "name LIKE 'my-model-name'".
int	hashCode()
boolean	hasMaxResults()	Maximum number of models desired.
boolean	hasPageToken()	Pagination token to go to the next page based on a previous search query.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static ModelRegistry.SearchRegisteredModels.Builder	newBuilder()
static ModelRegistry.SearchRegisteredModels.Builder	newBuilder(ModelRegistry.SearchRegisteredModels prototype)
ModelRegistry.SearchRegisteredModels.Builder	newBuilderForType()
protected ModelRegistry.SearchRegisteredModels.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected java.lang.Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static ModelRegistry.SearchRegisteredModels	parseDelimitedFrom(java.io.InputStream input)
static ModelRegistry.SearchRegisteredModels	parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ModelRegistry.SearchRegisteredModels	parseFrom(byte[] data)
static ModelRegistry.SearchRegisteredModels	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ModelRegistry.SearchRegisteredModels	parseFrom(com.google.protobuf.ByteString data)
static ModelRegistry.SearchRegisteredModels	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ModelRegistry.SearchRegisteredModels	parseFrom(com.google.protobuf.CodedInputStream input)
static ModelRegistry.SearchRegisteredModels	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ModelRegistry.SearchRegisteredModels	parseFrom(java.io.InputStream input)
static ModelRegistry.SearchRegisteredModels	parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ModelRegistry.SearchRegisteredModels	parseFrom(java.nio.ByteBuffer data)
static ModelRegistry.SearchRegisteredModels	parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<ModelRegistry.SearchRegisteredModels>	parser()
ModelRegistry.SearchRegisteredModels.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

FILTER_FIELD_NUMBER

public static final int FILTER_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<ModelRegistry.SearchRegisteredModels> 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

hasFilter

public boolean hasFilter()

 String filter condition, like "name LIKE 'my-model-name'".
 Interpreted in the backend automatically as "name LIKE '%my-model-name%'".
 Single boolean condition, with string values wrapped in single quotes.
 

optional string filter = 1;

Specified by:

hasFilter in interface ModelRegistry.SearchRegisteredModelsOrBuilder

Returns:

Whether the filter field is set.

getFilter

public java.lang.String getFilter()

 String filter condition, like "name LIKE 'my-model-name'".
 Interpreted in the backend automatically as "name LIKE '%my-model-name%'".
 Single boolean condition, with string values wrapped in single quotes.
 

optional string filter = 1;

Specified by:

getFilter in interface ModelRegistry.SearchRegisteredModelsOrBuilder

Returns:

The filter.

getFilterBytes

public com.google.protobuf.ByteString getFilterBytes()

 String filter condition, like "name LIKE 'my-model-name'".
 Interpreted in the backend automatically as "name LIKE '%my-model-name%'".
 Single boolean condition, with string values wrapped in single quotes.
 

optional string filter = 1;

Specified by:

getFilterBytes in interface ModelRegistry.SearchRegisteredModelsOrBuilder

Returns:

The bytes for filter.

hasMaxResults

public boolean hasMaxResults()

 Maximum number of models desired. Default is 100. Max threshold is 1000.
 

optional int64 max_results = 2 [default = 100];

Specified by:

hasMaxResults in interface ModelRegistry.SearchRegisteredModelsOrBuilder

Returns:

Whether the maxResults field is set.

getMaxResults

public long getMaxResults()

 Maximum number of models desired. Default is 100. Max threshold is 1000.
 

optional int64 max_results = 2 [default = 100];

Specified by:

getMaxResults in interface ModelRegistry.SearchRegisteredModelsOrBuilder

Returns:

The maxResults.

getOrderByList

public com.google.protobuf.ProtocolStringList getOrderByList()

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

repeated string order_by = 3;

Specified by:

getOrderByList in interface ModelRegistry.SearchRegisteredModelsOrBuilder

Returns:

A list containing the orderBy.

getOrderByCount

public int getOrderByCount()

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

repeated string order_by = 3;

Specified by:

getOrderByCount in interface ModelRegistry.SearchRegisteredModelsOrBuilder

Returns:

The count of orderBy.

getOrderBy

public java.lang.String getOrderBy(int index)

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

repeated string order_by = 3;

Specified by:

getOrderBy in interface ModelRegistry.SearchRegisteredModelsOrBuilder

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 model name and last updated
 timestamp with an optional "DESC" or "ASC" annotation, where "ASC" is the default.
 Tiebreaks are done by model name ASC.
 

repeated string order_by = 3;

Specified by:

getOrderByBytes in interface ModelRegistry.SearchRegisteredModelsOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the orderBy at the given index.

hasPageToken

public boolean hasPageToken()

 Pagination token to go to the next page based on a previous search query.
 

optional string page_token = 4;

Specified by:

hasPageToken in interface ModelRegistry.SearchRegisteredModelsOrBuilder

Returns:

Whether the pageToken field is set.

getPageToken

public java.lang.String getPageToken()

 Pagination token to go to the next page based on a previous search query.
 

optional string page_token = 4;

Specified by:

getPageToken in interface ModelRegistry.SearchRegisteredModelsOrBuilder

Returns:

The pageToken.

getPageTokenBytes

public com.google.protobuf.ByteString getPageTokenBytes()

 Pagination token to go to the next page based on a previous search query.
 

optional string page_token = 4;

Specified by:

getPageTokenBytes in interface ModelRegistry.SearchRegisteredModelsOrBuilder

Returns:

The bytes for pageToken.

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ModelRegistry.SearchRegisteredModels parseFrom(com.google.protobuf.ByteString data)
                                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ModelRegistry.SearchRegisteredModels parseFrom(com.google.protobuf.ByteString data,
                                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ModelRegistry.SearchRegisteredModels parseFrom(byte[] data)
                                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ModelRegistry.SearchRegisteredModels parseFrom(java.io.InputStream input)
                                                      throws java.io.IOException

Throws:

java.io.IOException

parseFrom

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

Throws:

java.io.IOException

parseDelimitedFrom

public static ModelRegistry.SearchRegisteredModels parseDelimitedFrom(java.io.InputStream input)
                                                               throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

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

Throws:

java.io.IOException

parseFrom

public static ModelRegistry.SearchRegisteredModels parseFrom(com.google.protobuf.CodedInputStream input)
                                                      throws java.io.IOException

Throws:

java.io.IOException

parseFrom

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

Throws:

java.io.IOException

newBuilderForType

public ModelRegistry.SearchRegisteredModels.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static ModelRegistry.SearchRegisteredModels.Builder newBuilder()

newBuilder

public static ModelRegistry.SearchRegisteredModels.Builder newBuilder(ModelRegistry.SearchRegisteredModels prototype)

toBuilder

public ModelRegistry.SearchRegisteredModels.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected ModelRegistry.SearchRegisteredModels.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static ModelRegistry.SearchRegisteredModels getDefaultInstance()

parser

public static com.google.protobuf.Parser<ModelRegistry.SearchRegisteredModels> parser()

getParserForType

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

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder