Package org.mlflow.api.proto

Class Service.Dataset

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
org.mlflow.api.proto.Service.Dataset
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, Service.DatasetOrBuilder
Enclosing class:
Service
public static final class Service.Dataset extends com.google.protobuf.GeneratedMessageV3 implements Service.DatasetOrBuilder
 Dataset. Represents a reference to data used for training, testing, or evaluation during
 the model development process.
Protobuf type mlflow.Dataset
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Service.Dataset.Builder
    Dataset.

    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 final int
    DIGEST_FIELD_NUMBER
     
    static final int
    NAME_FIELD_NUMBER
     
    static final com.google.protobuf.Parser<Service.Dataset>
    PARSER
    Deprecated.
    static final int
    PROFILE_FIELD_NUMBER
     
    static final int
    SCHEMA_FIELD_NUMBER
     
    static final int
    SOURCE_FIELD_NUMBER
     
    static final int
    SOURCE_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(Object obj)
     
    static Service.Dataset
    getDefaultInstance()
     
    Service.Dataset
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getDigest()
    Dataset digest, e.g.
    com.google.protobuf.ByteString
    getDigestBytes()
    Dataset digest, e.g.
    String
    getName()
    The name of the dataset.
    com.google.protobuf.ByteString
    getNameBytes()
    The name of the dataset.
    com.google.protobuf.Parser<Service.Dataset>
    getParserForType()
     
    String
    getProfile()
    The profile of the dataset.
    com.google.protobuf.ByteString
    getProfileBytes()
    The profile of the dataset.
    String
    getSchema()
    The schema of the dataset.
    com.google.protobuf.ByteString
    getSchemaBytes()
    The schema of the dataset.
    int
    getSerializedSize()
     
    String
    getSource()
    Source information for the dataset.
    com.google.protobuf.ByteString
    getSourceBytes()
    Source information for the dataset.
    String
    getSourceType()
    The type of the dataset source, e.g.
    com.google.protobuf.ByteString
    getSourceTypeBytes()
    The type of the dataset source, e.g.
    final com.google.protobuf.UnknownFieldSet
    getUnknownFields()
     
    boolean
    hasDigest()
    Dataset digest, e.g.
    int
    hashCode()
     
    boolean
    hasName()
    The name of the dataset.
    boolean
    hasProfile()
    The profile of the dataset.
    boolean
    hasSchema()
    The schema of the dataset.
    boolean
    hasSource()
    Source information for the dataset.
    boolean
    hasSourceType()
    The type of the dataset source, e.g.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Service.Dataset.Builder
    newBuilder()
     
    static Service.Dataset.Builder
    newBuilder(Service.Dataset prototype)
     
    Service.Dataset.Builder
    newBuilderForType()
     
    protected Service.Dataset.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static Service.Dataset
    parseDelimitedFrom(InputStream input)
     
    static Service.Dataset
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Service.Dataset
    parseFrom(byte[] data)
     
    static Service.Dataset
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Service.Dataset
    parseFrom(com.google.protobuf.ByteString data)
     
    static Service.Dataset
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Service.Dataset
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Service.Dataset
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Service.Dataset
    parseFrom(InputStream input)
     
    static Service.Dataset
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Service.Dataset
    parseFrom(ByteBuffer data)
     
    static Service.Dataset
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Service.Dataset>
    parser()
     
    Service.Dataset.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 Details

  • Method Details

    • newInstance

      protected 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

    • hasName

      public boolean hasName()
       The name of the dataset. E.g. "my.uc.table@2" "nyc-taxi-dataset", "fantastic-elk-3"
      optional string name = 1 [(.mlflow.validate_required) = true];
      Specified by:
      hasName in interface Service.DatasetOrBuilder
      Returns:
      Whether the name field is set.

    • getName

      public String getName()
       The name of the dataset. E.g. "my.uc.table@2" "nyc-taxi-dataset", "fantastic-elk-3"
      optional string name = 1 [(.mlflow.validate_required) = true];
      Specified by:
      getName in interface Service.DatasetOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       The name of the dataset. E.g. "my.uc.table@2" "nyc-taxi-dataset", "fantastic-elk-3"
      optional string name = 1 [(.mlflow.validate_required) = true];
      Specified by:
      getNameBytes in interface Service.DatasetOrBuilder
      Returns:
      The bytes for name.

    • hasDigest

      public boolean hasDigest()
       Dataset digest, e.g. an md5 hash of the dataset that uniquely identifies it
 within datasets of the same name.
      optional string digest = 2 [(.mlflow.validate_required) = true];
      Specified by:
      hasDigest in interface Service.DatasetOrBuilder
      Returns:
      Whether the digest field is set.

    • getDigest

      public String getDigest()
       Dataset digest, e.g. an md5 hash of the dataset that uniquely identifies it
 within datasets of the same name.
      optional string digest = 2 [(.mlflow.validate_required) = true];
      Specified by:
      getDigest in interface Service.DatasetOrBuilder
      Returns:
      The digest.

    • getDigestBytes

      public com.google.protobuf.ByteString getDigestBytes()
       Dataset digest, e.g. an md5 hash of the dataset that uniquely identifies it
 within datasets of the same name.
      optional string digest = 2 [(.mlflow.validate_required) = true];
      Specified by:
      getDigestBytes in interface Service.DatasetOrBuilder
      Returns:
      The bytes for digest.

    • hasSourceType

      public boolean hasSourceType()
       The type of the dataset source, e.g. 'databricks-uc-table', 'DBFS', 'S3', ...
      optional string source_type = 3 [(.mlflow.validate_required) = true];
      Specified by:
      hasSourceType in interface Service.DatasetOrBuilder
      Returns:
      Whether the sourceType field is set.

    • getSourceType

      public String getSourceType()
       The type of the dataset source, e.g. 'databricks-uc-table', 'DBFS', 'S3', ...
      optional string source_type = 3 [(.mlflow.validate_required) = true];
      Specified by:
      getSourceType in interface Service.DatasetOrBuilder
      Returns:
      The sourceType.

    • getSourceTypeBytes

      public com.google.protobuf.ByteString getSourceTypeBytes()
       The type of the dataset source, e.g. 'databricks-uc-table', 'DBFS', 'S3', ...
      optional string source_type = 3 [(.mlflow.validate_required) = true];
      Specified by:
      getSourceTypeBytes in interface Service.DatasetOrBuilder
      Returns:
      The bytes for sourceType.

    • hasSource

      public boolean hasSource()
       Source information for the dataset. Note that the source may not exactly reproduce the
 dataset if it was transformed / modified before use with MLflow.
      optional string source = 4 [(.mlflow.validate_required) = true];
      Specified by:
      hasSource in interface Service.DatasetOrBuilder
      Returns:
      Whether the source field is set.

    • getSource

      public String getSource()
       Source information for the dataset. Note that the source may not exactly reproduce the
 dataset if it was transformed / modified before use with MLflow.
      optional string source = 4 [(.mlflow.validate_required) = true];
      Specified by:
      getSource in interface Service.DatasetOrBuilder
      Returns:
      The source.

    • getSourceBytes

      public com.google.protobuf.ByteString getSourceBytes()
       Source information for the dataset. Note that the source may not exactly reproduce the
 dataset if it was transformed / modified before use with MLflow.
      optional string source = 4 [(.mlflow.validate_required) = true];
      Specified by:
      getSourceBytes in interface Service.DatasetOrBuilder
      Returns:
      The bytes for source.

    • hasSchema

      public boolean hasSchema()
       The schema of the dataset. E.g., MLflow ColSpec JSON for a dataframe, MLflow TensorSpec JSON
 for an ndarray, or another schema format.
      optional string schema = 5;
      Specified by:
      hasSchema in interface Service.DatasetOrBuilder
      Returns:
      Whether the schema field is set.

    • getSchema

      public String getSchema()
       The schema of the dataset. E.g., MLflow ColSpec JSON for a dataframe, MLflow TensorSpec JSON
 for an ndarray, or another schema format.
      optional string schema = 5;
      Specified by:
      getSchema in interface Service.DatasetOrBuilder
      Returns:
      The schema.

    • getSchemaBytes

      public com.google.protobuf.ByteString getSchemaBytes()
       The schema of the dataset. E.g., MLflow ColSpec JSON for a dataframe, MLflow TensorSpec JSON
 for an ndarray, or another schema format.
      optional string schema = 5;
      Specified by:
      getSchemaBytes in interface Service.DatasetOrBuilder
      Returns:
      The bytes for schema.

    • hasProfile

      public boolean hasProfile()
       The profile of the dataset. Summary statistics for the dataset, such as the number of rows
 in a table, the mean / std / mode of each column in a table, or the number of elements
 in an array.
      optional string profile = 6;
      Specified by:
      hasProfile in interface Service.DatasetOrBuilder
      Returns:
      Whether the profile field is set.

    • getProfile

      public String getProfile()
       The profile of the dataset. Summary statistics for the dataset, such as the number of rows
 in a table, the mean / std / mode of each column in a table, or the number of elements
 in an array.
      optional string profile = 6;
      Specified by:
      getProfile in interface Service.DatasetOrBuilder
      Returns:
      The profile.

    • getProfileBytes

      public com.google.protobuf.ByteString getProfileBytes()
       The profile of the dataset. Summary statistics for the dataset, such as the number of rows
 in a table, the mean / std / mode of each column in a table, or the number of elements
 in an array.
      optional string profile = 6;
      Specified by:
      getProfileBytes in interface Service.DatasetOrBuilder
      Returns:
      The bytes for profile.

    • 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.Dataset parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static Service.Dataset parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static Service.Dataset parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static Service.Dataset parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

      public static Service.Dataset parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

      public Service.Dataset.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Service.Dataset.Builder newBuilder()

    • newBuilder

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

    • toBuilder

      public Service.Dataset.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Service.Dataset.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static Service.Dataset getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<Service.Dataset> 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.Dataset getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder