Package org.mlflow.api.proto

Class Service.GetMetricHistoryBulkInterval

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

org.mlflow.api.proto.Service.GetMetricHistoryBulkInterval

All Implemented Interfaces:

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

Enclosing class:

Service

public static final class Service.GetMetricHistoryBulkInterval
extends com.google.protobuf.GeneratedMessageV3
implements Service.GetMetricHistoryBulkIntervalOrBuilder

Protobuf type mlflow.GetMetricHistoryBulkInterval

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Service.GetMetricHistoryBulkInterval.Builder	Protobuf type mlflow.GetMetricHistoryBulkInterval
static class	Service.GetMetricHistoryBulkInterval.Response	Protobuf type mlflow.GetMetricHistoryBulkInterval.Response
static interface	Service.GetMetricHistoryBulkInterval.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	END_STEP_FIELD_NUMBER
static int	MAX_RESULTS_FIELD_NUMBER
static int	METRIC_KEY_FIELD_NUMBER
static com.google.protobuf.Parser<Service.GetMetricHistoryBulkInterval>	PARSER	Deprecated.
static int	RUN_IDS_FIELD_NUMBER
static int	START_STEP_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.GetMetricHistoryBulkInterval	getDefaultInstance()
Service.GetMetricHistoryBulkInterval	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
int	getEndStep()	Optional end step to only fetch metrics before the specified step.
int	getMaxResults()	Maximum number of results to fetch per run specified.
java.lang.String	getMetricKey()	Name of the metric.
com.google.protobuf.ByteString	getMetricKeyBytes()	Name of the metric.
com.google.protobuf.Parser<Service.GetMetricHistoryBulkInterval>	getParserForType()
java.lang.String	getRunIds(int index)	ID(s) of the run(s) from which to fetch metric values.
com.google.protobuf.ByteString	getRunIdsBytes(int index)	ID(s) of the run(s) from which to fetch metric values.
int	getRunIdsCount()	ID(s) of the run(s) from which to fetch metric values.
com.google.protobuf.ProtocolStringList	getRunIdsList()	ID(s) of the run(s) from which to fetch metric values.
int	getSerializedSize()
int	getStartStep()	Optional start step to only fetch metrics after the specified step.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasEndStep()	Optional end step to only fetch metrics before the specified step.
int	hashCode()
boolean	hasMaxResults()	Maximum number of results to fetch per run specified.
boolean	hasMetricKey()	Name of the metric.
boolean	hasStartStep()	Optional start step to only fetch metrics after the specified step.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Service.GetMetricHistoryBulkInterval.Builder	newBuilder()
static Service.GetMetricHistoryBulkInterval.Builder	newBuilder(Service.GetMetricHistoryBulkInterval prototype)
Service.GetMetricHistoryBulkInterval.Builder	newBuilderForType()
protected Service.GetMetricHistoryBulkInterval.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected java.lang.Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Service.GetMetricHistoryBulkInterval	parseDelimitedFrom(java.io.InputStream input)
static Service.GetMetricHistoryBulkInterval	parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Service.GetMetricHistoryBulkInterval	parseFrom(byte[] data)
static Service.GetMetricHistoryBulkInterval	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Service.GetMetricHistoryBulkInterval	parseFrom(com.google.protobuf.ByteString data)
static Service.GetMetricHistoryBulkInterval	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Service.GetMetricHistoryBulkInterval	parseFrom(com.google.protobuf.CodedInputStream input)
static Service.GetMetricHistoryBulkInterval	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Service.GetMetricHistoryBulkInterval	parseFrom(java.io.InputStream input)
static Service.GetMetricHistoryBulkInterval	parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Service.GetMetricHistoryBulkInterval	parseFrom(java.nio.ByteBuffer data)
static Service.GetMetricHistoryBulkInterval	parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Service.GetMetricHistoryBulkInterval>	parser()
Service.GetMetricHistoryBulkInterval.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

RUN_IDS_FIELD_NUMBER

public static final int RUN_IDS_FIELD_NUMBER

See Also:

Constant Field Values

METRIC_KEY_FIELD_NUMBER

public static final int METRIC_KEY_FIELD_NUMBER

See Also:

Constant Field Values

START_STEP_FIELD_NUMBER

public static final int START_STEP_FIELD_NUMBER

See Also:

Constant Field Values

END_STEP_FIELD_NUMBER

public static final int END_STEP_FIELD_NUMBER

See Also:

Constant Field Values

MAX_RESULTS_FIELD_NUMBER

public static final int MAX_RESULTS_FIELD_NUMBER

See Also:

Constant Field Values

PARSER

@Deprecated
public static final com.google.protobuf.Parser<Service.GetMetricHistoryBulkInterval> 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

getRunIdsList

public com.google.protobuf.ProtocolStringList getRunIdsList()

 ID(s) of the run(s) from which to fetch metric values. Must be provided.
 

repeated string run_ids = 1;

Specified by:

getRunIdsList in interface Service.GetMetricHistoryBulkIntervalOrBuilder

Returns:

A list containing the runIds.

getRunIdsCount

public int getRunIdsCount()

 ID(s) of the run(s) from which to fetch metric values. Must be provided.
 

repeated string run_ids = 1;

Specified by:

getRunIdsCount in interface Service.GetMetricHistoryBulkIntervalOrBuilder

Returns:

The count of runIds.

getRunIds

public java.lang.String getRunIds(int index)

 ID(s) of the run(s) from which to fetch metric values. Must be provided.
 

repeated string run_ids = 1;

Specified by:

getRunIds in interface Service.GetMetricHistoryBulkIntervalOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The runIds at the given index.

getRunIdsBytes

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

 ID(s) of the run(s) from which to fetch metric values. Must be provided.
 

repeated string run_ids = 1;

Specified by:

getRunIdsBytes in interface Service.GetMetricHistoryBulkIntervalOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the runIds at the given index.

hasMetricKey

public boolean hasMetricKey()

 Name of the metric.
 

optional string metric_key = 2 [(.mlflow.validate_required) = true];

Specified by:

hasMetricKey in interface Service.GetMetricHistoryBulkIntervalOrBuilder

Returns:

Whether the metricKey field is set.

getMetricKey

public java.lang.String getMetricKey()

 Name of the metric.
 

optional string metric_key = 2 [(.mlflow.validate_required) = true];

Specified by:

getMetricKey in interface Service.GetMetricHistoryBulkIntervalOrBuilder

Returns:

The metricKey.

getMetricKeyBytes

public com.google.protobuf.ByteString getMetricKeyBytes()

 Name of the metric.
 

optional string metric_key = 2 [(.mlflow.validate_required) = true];

Specified by:

getMetricKeyBytes in interface Service.GetMetricHistoryBulkIntervalOrBuilder

Returns:

The bytes for metricKey.

hasStartStep

public boolean hasStartStep()

 Optional start step to only fetch metrics after the specified step. Must be defined if
 end_step is defined.
 

optional int32 start_step = 3;

Specified by:

hasStartStep in interface Service.GetMetricHistoryBulkIntervalOrBuilder

Returns:

Whether the startStep field is set.

getStartStep

public int getStartStep()

 Optional start step to only fetch metrics after the specified step. Must be defined if
 end_step is defined.
 

optional int32 start_step = 3;

Specified by:

getStartStep in interface Service.GetMetricHistoryBulkIntervalOrBuilder

Returns:

The startStep.

hasEndStep

public boolean hasEndStep()

 Optional end step to only fetch metrics before the specified step. Must be defined if
 start_step is defined.
 

optional int32 end_step = 4;

Specified by:

hasEndStep in interface Service.GetMetricHistoryBulkIntervalOrBuilder

Returns:

Whether the endStep field is set.

getEndStep

public int getEndStep()

 Optional end step to only fetch metrics before the specified step. Must be defined if
 start_step is defined.
 

optional int32 end_step = 4;

Specified by:

getEndStep in interface Service.GetMetricHistoryBulkIntervalOrBuilder

Returns:

The endStep.

hasMaxResults

public boolean hasMaxResults()

 Maximum number of results to fetch per run specified. Must be set to a positive number.
 Note, in reality, the API returns at most (max_results + # of run IDs) x (# run IDs) metric
 data points.
 

optional int32 max_results = 5;

Specified by:

hasMaxResults in interface Service.GetMetricHistoryBulkIntervalOrBuilder

Returns:

Whether the maxResults field is set.

getMaxResults

public int getMaxResults()

 Maximum number of results to fetch per run specified. Must be set to a positive number.
 Note, in reality, the API returns at most (max_results + # of run IDs) x (# run IDs) metric
 data points.
 

optional int32 max_results = 5;

Specified by:

getMaxResults in interface Service.GetMetricHistoryBulkIntervalOrBuilder

Returns:

The maxResults.

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

java.io.IOException

parseFrom

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

Throws:

java.io.IOException

parseDelimitedFrom

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

Throws:

java.io.IOException

parseDelimitedFrom

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

Throws:

java.io.IOException

parseFrom

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

Throws:

java.io.IOException

parseFrom

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

Throws:

java.io.IOException

newBuilderForType

public Service.GetMetricHistoryBulkInterval.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Service.GetMetricHistoryBulkInterval.Builder newBuilder()

newBuilder

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

toBuilder

public Service.GetMetricHistoryBulkInterval.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Service.GetMetricHistoryBulkInterval getDefaultInstance()

parser

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

getParserForType

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

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder