Package org.mlflow.api.proto
Class Service.SearchUnifiedTraces
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite
-
- com.google.protobuf.AbstractMessage
-
- com.google.protobuf.GeneratedMessageV3
-
- org.mlflow.api.proto.Service.SearchUnifiedTraces
-
- All Implemented Interfaces:
com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,java.io.Serializable
,Service.SearchUnifiedTracesOrBuilder
- Enclosing class:
- Service
public static final class Service.SearchUnifiedTraces extends com.google.protobuf.GeneratedMessageV3 implements Service.SearchUnifiedTracesOrBuilder
Protobuf typemlflow.SearchUnifiedTraces
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Service.SearchUnifiedTraces.Builder
Protobuf typemlflow.SearchUnifiedTraces
static class
Service.SearchUnifiedTraces.Response
Protobuf typemlflow.SearchUnifiedTraces.Response
static interface
Service.SearchUnifiedTraces.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
-
-
Field Summary
Fields Modifier and Type Field Description static int
EXPERIMENT_IDS_FIELD_NUMBER
static int
FILTER_FIELD_NUMBER
static int
MAX_RESULTS_FIELD_NUMBER
static int
MODEL_ID_FIELD_NUMBER
static int
ORDER_BY_FIELD_NUMBER
static int
PAGE_TOKEN_FIELD_NUMBER
static com.google.protobuf.Parser<Service.SearchUnifiedTraces>
PARSER
Deprecated.static int
SQL_WAREHOUSE_ID_FIELD_NUMBER
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
static Service.SearchUnifiedTraces
getDefaultInstance()
Service.SearchUnifiedTraces
getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
java.lang.String
getExperimentIds(int index)
TODO: Eventually we want to provide an API that only uses model_idcom.google.protobuf.ByteString
getExperimentIdsBytes(int index)
TODO: Eventually we want to provide an API that only uses model_idint
getExperimentIdsCount()
TODO: Eventually we want to provide an API that only uses model_idcom.google.protobuf.ProtocolStringList
getExperimentIdsList()
TODO: Eventually we want to provide an API that only uses model_idjava.lang.String
getFilter()
A filter expression over trace attributes and tags that allows returning a subset of traces.com.google.protobuf.ByteString
getFilterBytes()
A filter expression over trace attributes and tags that allows returning a subset of traces.int
getMaxResults()
Maximum number of traces desired.java.lang.String
getModelId()
optional string model_id = 1 [(.mlflow.validate_required) = true];
com.google.protobuf.ByteString
getModelIdBytes()
optional string model_id = 1 [(.mlflow.validate_required) = true];
java.lang.String
getOrderBy(int index)
List of columns for ordering the results, e.g.com.google.protobuf.ByteString
getOrderByBytes(int index)
List of columns for ordering the results, e.g.int
getOrderByCount()
List of columns for ordering the results, e.g.com.google.protobuf.ProtocolStringList
getOrderByList()
List of columns for ordering the results, e.g.java.lang.String
getPageToken()
Token indicating the page of traces to fetch.com.google.protobuf.ByteString
getPageTokenBytes()
Token indicating the page of traces to fetch.com.google.protobuf.Parser<Service.SearchUnifiedTraces>
getParserForType()
int
getSerializedSize()
java.lang.String
getSqlWarehouseId()
optional string sql_warehouse_id = 2 [(.mlflow.validate_required) = true];
com.google.protobuf.ByteString
getSqlWarehouseIdBytes()
optional string sql_warehouse_id = 2 [(.mlflow.validate_required) = true];
com.google.protobuf.UnknownFieldSet
getUnknownFields()
boolean
hasFilter()
A filter expression over trace attributes and tags that allows returning a subset of traces.int
hashCode()
boolean
hasMaxResults()
Maximum number of traces desired.boolean
hasModelId()
optional string model_id = 1 [(.mlflow.validate_required) = true];
boolean
hasPageToken()
Token indicating the page of traces to fetch.boolean
hasSqlWarehouseId()
optional string sql_warehouse_id = 2 [(.mlflow.validate_required) = true];
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable()
boolean
isInitialized()
static Service.SearchUnifiedTraces.Builder
newBuilder()
static Service.SearchUnifiedTraces.Builder
newBuilder(Service.SearchUnifiedTraces prototype)
Service.SearchUnifiedTraces.Builder
newBuilderForType()
protected Service.SearchUnifiedTraces.Builder
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected java.lang.Object
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Service.SearchUnifiedTraces
parseDelimitedFrom(java.io.InputStream input)
static Service.SearchUnifiedTraces
parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Service.SearchUnifiedTraces
parseFrom(byte[] data)
static Service.SearchUnifiedTraces
parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Service.SearchUnifiedTraces
parseFrom(com.google.protobuf.ByteString data)
static Service.SearchUnifiedTraces
parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Service.SearchUnifiedTraces
parseFrom(com.google.protobuf.CodedInputStream input)
static Service.SearchUnifiedTraces
parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Service.SearchUnifiedTraces
parseFrom(java.io.InputStream input)
static Service.SearchUnifiedTraces
parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Service.SearchUnifiedTraces
parseFrom(java.nio.ByteBuffer data)
static Service.SearchUnifiedTraces
parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Service.SearchUnifiedTraces>
parser()
Service.SearchUnifiedTraces.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
-
-
-
-
Field Detail
-
MODEL_ID_FIELD_NUMBER
public static final int MODEL_ID_FIELD_NUMBER
- See Also:
- Constant Field Values
-
SQL_WAREHOUSE_ID_FIELD_NUMBER
public static final int SQL_WAREHOUSE_ID_FIELD_NUMBER
- See Also:
- Constant Field Values
-
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
-
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.SearchUnifiedTraces> PARSER
Deprecated.
-
-
Method Detail
-
newInstance
protected java.lang.Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
- Overrides:
newInstance
in classcom.google.protobuf.GeneratedMessageV3
-
getUnknownFields
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
- Specified by:
getUnknownFields
in interfacecom.google.protobuf.MessageOrBuilder
- Overrides:
getUnknownFields
in classcom.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 classcom.google.protobuf.GeneratedMessageV3
-
hasModelId
public boolean hasModelId()
optional string model_id = 1 [(.mlflow.validate_required) = true];
- Specified by:
hasModelId
in interfaceService.SearchUnifiedTracesOrBuilder
- Returns:
- Whether the modelId field is set.
-
getModelId
public java.lang.String getModelId()
optional string model_id = 1 [(.mlflow.validate_required) = true];
- Specified by:
getModelId
in interfaceService.SearchUnifiedTracesOrBuilder
- Returns:
- The modelId.
-
getModelIdBytes
public com.google.protobuf.ByteString getModelIdBytes()
optional string model_id = 1 [(.mlflow.validate_required) = true];
- Specified by:
getModelIdBytes
in interfaceService.SearchUnifiedTracesOrBuilder
- Returns:
- The bytes for modelId.
-
hasSqlWarehouseId
public boolean hasSqlWarehouseId()
optional string sql_warehouse_id = 2 [(.mlflow.validate_required) = true];
- Specified by:
hasSqlWarehouseId
in interfaceService.SearchUnifiedTracesOrBuilder
- Returns:
- Whether the sqlWarehouseId field is set.
-
getSqlWarehouseId
public java.lang.String getSqlWarehouseId()
optional string sql_warehouse_id = 2 [(.mlflow.validate_required) = true];
- Specified by:
getSqlWarehouseId
in interfaceService.SearchUnifiedTracesOrBuilder
- Returns:
- The sqlWarehouseId.
-
getSqlWarehouseIdBytes
public com.google.protobuf.ByteString getSqlWarehouseIdBytes()
optional string sql_warehouse_id = 2 [(.mlflow.validate_required) = true];
- Specified by:
getSqlWarehouseIdBytes
in interfaceService.SearchUnifiedTracesOrBuilder
- Returns:
- The bytes for sqlWarehouseId.
-
getExperimentIdsList
public com.google.protobuf.ProtocolStringList getExperimentIdsList()
TODO: Eventually we want to provide an API that only uses model_id
repeated string experiment_ids = 3;
- Specified by:
getExperimentIdsList
in interfaceService.SearchUnifiedTracesOrBuilder
- Returns:
- A list containing the experimentIds.
-
getExperimentIdsCount
public int getExperimentIdsCount()
TODO: Eventually we want to provide an API that only uses model_id
repeated string experiment_ids = 3;
- Specified by:
getExperimentIdsCount
in interfaceService.SearchUnifiedTracesOrBuilder
- Returns:
- The count of experimentIds.
-
getExperimentIds
public java.lang.String getExperimentIds(int index)
TODO: Eventually we want to provide an API that only uses model_id
repeated string experiment_ids = 3;
- Specified by:
getExperimentIds
in interfaceService.SearchUnifiedTracesOrBuilder
- Parameters:
index
- The index of the element to return.- Returns:
- The experimentIds at the given index.
-
getExperimentIdsBytes
public com.google.protobuf.ByteString getExperimentIdsBytes(int index)
TODO: Eventually we want to provide an API that only uses model_id
repeated string experiment_ids = 3;
- Specified by:
getExperimentIdsBytes
in interfaceService.SearchUnifiedTracesOrBuilder
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the experimentIds at the given index.
-
hasFilter
public boolean hasFilter()
A filter expression over trace attributes and tags that allows returning a subset of traces. The syntax is a subset of SQL that supports ANDing together binary operations Example: ``trace.status = 'OK' and trace.timestamp_ms > 1711089570679``.
optional string filter = 4;
- Specified by:
hasFilter
in interfaceService.SearchUnifiedTracesOrBuilder
- Returns:
- Whether the filter field is set.
-
getFilter
public java.lang.String getFilter()
A filter expression over trace attributes and tags that allows returning a subset of traces. The syntax is a subset of SQL that supports ANDing together binary operations Example: ``trace.status = 'OK' and trace.timestamp_ms > 1711089570679``.
optional string filter = 4;
- Specified by:
getFilter
in interfaceService.SearchUnifiedTracesOrBuilder
- Returns:
- The filter.
-
getFilterBytes
public com.google.protobuf.ByteString getFilterBytes()
A filter expression over trace attributes and tags that allows returning a subset of traces. The syntax is a subset of SQL that supports ANDing together binary operations Example: ``trace.status = 'OK' and trace.timestamp_ms > 1711089570679``.
optional string filter = 4;
- Specified by:
getFilterBytes
in interfaceService.SearchUnifiedTracesOrBuilder
- Returns:
- The bytes for filter.
-
hasMaxResults
public boolean hasMaxResults()
Maximum number of traces desired. Max threshold is 500.
optional int32 max_results = 5 [default = 100];
- Specified by:
hasMaxResults
in interfaceService.SearchUnifiedTracesOrBuilder
- Returns:
- Whether the maxResults field is set.
-
getMaxResults
public int getMaxResults()
Maximum number of traces desired. Max threshold is 500.
optional int32 max_results = 5 [default = 100];
- Specified by:
getMaxResults
in interfaceService.SearchUnifiedTracesOrBuilder
- Returns:
- The maxResults.
-
getOrderByList
public com.google.protobuf.ProtocolStringList getOrderByList()
List of columns for ordering the results, e.g. ``["timestamp_ms DESC"]``.
repeated string order_by = 6;
- Specified by:
getOrderByList
in interfaceService.SearchUnifiedTracesOrBuilder
- Returns:
- A list containing the orderBy.
-
getOrderByCount
public int getOrderByCount()
List of columns for ordering the results, e.g. ``["timestamp_ms DESC"]``.
repeated string order_by = 6;
- Specified by:
getOrderByCount
in interfaceService.SearchUnifiedTracesOrBuilder
- Returns:
- The count of orderBy.
-
getOrderBy
public java.lang.String getOrderBy(int index)
List of columns for ordering the results, e.g. ``["timestamp_ms DESC"]``.
repeated string order_by = 6;
- Specified by:
getOrderBy
in interfaceService.SearchUnifiedTracesOrBuilder
- 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 the results, e.g. ``["timestamp_ms DESC"]``.
repeated string order_by = 6;
- Specified by:
getOrderByBytes
in interfaceService.SearchUnifiedTracesOrBuilder
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the orderBy at the given index.
-
hasPageToken
public boolean hasPageToken()
Token indicating the page of traces to fetch. This is a unified token that encodes both online and offline traces tokens.
optional string page_token = 7;
- Specified by:
hasPageToken
in interfaceService.SearchUnifiedTracesOrBuilder
- Returns:
- Whether the pageToken field is set.
-
getPageToken
public java.lang.String getPageToken()
Token indicating the page of traces to fetch. This is a unified token that encodes both online and offline traces tokens.
optional string page_token = 7;
- Specified by:
getPageToken
in interfaceService.SearchUnifiedTracesOrBuilder
- Returns:
- The pageToken.
-
getPageTokenBytes
public com.google.protobuf.ByteString getPageTokenBytes()
Token indicating the page of traces to fetch. This is a unified token that encodes both online and offline traces tokens.
optional string page_token = 7;
- Specified by:
getPageTokenBytes
in interfaceService.SearchUnifiedTracesOrBuilder
- Returns:
- The bytes for pageToken.
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessageV3
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io.IOException
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessageV3
- Throws:
java.io.IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessageV3
-
equals
public boolean equals(java.lang.Object obj)
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.google.protobuf.AbstractMessage
-
parseFrom
public static Service.SearchUnifiedTraces parseFrom(java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Service.SearchUnifiedTraces parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Service.SearchUnifiedTraces parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Service.SearchUnifiedTraces 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.SearchUnifiedTraces parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Service.SearchUnifiedTraces parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Service.SearchUnifiedTraces parseFrom(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static Service.SearchUnifiedTraces parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseDelimitedFrom
public static Service.SearchUnifiedTraces parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseDelimitedFrom
public static Service.SearchUnifiedTraces parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static Service.SearchUnifiedTraces parseFrom(com.google.protobuf.CodedInputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static Service.SearchUnifiedTraces parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
newBuilderForType
public Service.SearchUnifiedTraces.Builder newBuilderForType()
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
public static Service.SearchUnifiedTraces.Builder newBuilder()
-
newBuilder
public static Service.SearchUnifiedTraces.Builder newBuilder(Service.SearchUnifiedTraces prototype)
-
toBuilder
public Service.SearchUnifiedTraces.Builder toBuilder()
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected Service.SearchUnifiedTraces.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
- Specified by:
newBuilderForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
public static Service.SearchUnifiedTraces getDefaultInstance()
-
parser
public static com.google.protobuf.Parser<Service.SearchUnifiedTraces> parser()
-
getParserForType
public com.google.protobuf.Parser<Service.SearchUnifiedTraces> getParserForType()
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
public Service.SearchUnifiedTraces getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
-