Package org.mlflow.api.proto

Class Service.ListArtifacts

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable, Service.ListArtifactsOrBuilder
    Enclosing class:
    Service
    public static final class Service.ListArtifacts
extends com.google.protobuf.GeneratedMessageV3
implements Service.ListArtifactsOrBuilder
    Protobuf type mlflow.ListArtifacts
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Service.ListArtifacts.Builder
      Protobuf type mlflow.ListArtifacts
      static class  Service.ListArtifacts.Response
      Protobuf type mlflow.ListArtifacts.Response
      static interface  Service.ListArtifacts.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

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      static Service.ListArtifacts getDefaultInstance()  
      Service.ListArtifacts getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      java.lang.String getPageToken()
      Token indicating the page of artifact results to fetch
      com.google.protobuf.ByteString getPageTokenBytes()
      Token indicating the page of artifact results to fetch
      com.google.protobuf.Parser<Service.ListArtifacts> getParserForType()  
      java.lang.String getPath()
      Filter artifacts matching this path (a relative path from the root artifact directory).
      com.google.protobuf.ByteString getPathBytes()
      Filter artifacts matching this path (a relative path from the root artifact directory).
      java.lang.String getRunId()
      ID of the run whose artifacts to list.
      com.google.protobuf.ByteString getRunIdBytes()
      ID of the run whose artifacts to list.
      java.lang.String getRunUuid()
      [Deprecated, use run_id instead] ID of the run whose artifacts to list.
      com.google.protobuf.ByteString getRunUuidBytes()
      [Deprecated, use run_id instead] ID of the run whose artifacts to list.
      int getSerializedSize()  
      com.google.protobuf.UnknownFieldSet getUnknownFields()  
      int hashCode()  
      boolean hasPageToken()
      Token indicating the page of artifact results to fetch
      boolean hasPath()
      Filter artifacts matching this path (a relative path from the root artifact directory).
      boolean hasRunId()
      ID of the run whose artifacts to list.
      boolean hasRunUuid()
      [Deprecated, use run_id instead] ID of the run whose artifacts to list.
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static Service.ListArtifacts.Builder newBuilder()  
      static Service.ListArtifacts.Builder newBuilder​(Service.ListArtifacts prototype)  
      Service.ListArtifacts.Builder newBuilderForType()  
      protected Service.ListArtifacts.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static Service.ListArtifacts parseDelimitedFrom​(java.io.InputStream input)  
      static Service.ListArtifacts parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Service.ListArtifacts parseFrom​(byte[] data)  
      static Service.ListArtifacts parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Service.ListArtifacts parseFrom​(com.google.protobuf.ByteString data)  
      static Service.ListArtifacts parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Service.ListArtifacts parseFrom​(com.google.protobuf.CodedInputStream input)  
      static Service.ListArtifacts parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Service.ListArtifacts parseFrom​(java.io.InputStream input)  
      static Service.ListArtifacts parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Service.ListArtifacts parseFrom​(java.nio.ByteBuffer data)  
      static Service.ListArtifacts parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<Service.ListArtifacts> parser()  
      Service.ListArtifacts.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

    • 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

      • hasRunId

        public boolean hasRunId()
         ID of the run whose artifacts to list. Must be provided.
        optional string run_id = 3;
        Specified by:
        hasRunId in interface Service.ListArtifactsOrBuilder
        Returns:
        Whether the runId field is set.

      • getRunId

        public java.lang.String getRunId()
         ID of the run whose artifacts to list. Must be provided.
        optional string run_id = 3;
        Specified by:
        getRunId in interface Service.ListArtifactsOrBuilder
        Returns:
        The runId.

      • getRunIdBytes

        public com.google.protobuf.ByteString getRunIdBytes()
         ID of the run whose artifacts to list. Must be provided.
        optional string run_id = 3;
        Specified by:
        getRunIdBytes in interface Service.ListArtifactsOrBuilder
        Returns:
        The bytes for runId.

      • hasRunUuid

        public boolean hasRunUuid()
         [Deprecated, use run_id instead] ID of the run whose artifacts to list. This field will
 be removed in a future MLflow version.
        optional string run_uuid = 1;
        Specified by:
        hasRunUuid in interface Service.ListArtifactsOrBuilder
        Returns:
        Whether the runUuid field is set.

      • getRunUuid

        public java.lang.String getRunUuid()
         [Deprecated, use run_id instead] ID of the run whose artifacts to list. This field will
 be removed in a future MLflow version.
        optional string run_uuid = 1;
        Specified by:
        getRunUuid in interface Service.ListArtifactsOrBuilder
        Returns:
        The runUuid.

      • getRunUuidBytes

        public com.google.protobuf.ByteString getRunUuidBytes()
         [Deprecated, use run_id instead] ID of the run whose artifacts to list. This field will
 be removed in a future MLflow version.
        optional string run_uuid = 1;
        Specified by:
        getRunUuidBytes in interface Service.ListArtifactsOrBuilder
        Returns:
        The bytes for runUuid.

      • hasPath

        public boolean hasPath()
         Filter artifacts matching this path (a relative path from the root artifact directory).
        optional string path = 2;
        Specified by:
        hasPath in interface Service.ListArtifactsOrBuilder
        Returns:
        Whether the path field is set.

      • getPath

        public java.lang.String getPath()
         Filter artifacts matching this path (a relative path from the root artifact directory).
        optional string path = 2;
        Specified by:
        getPath in interface Service.ListArtifactsOrBuilder
        Returns:
        The path.

      • getPathBytes

        public com.google.protobuf.ByteString getPathBytes()
         Filter artifacts matching this path (a relative path from the root artifact directory).
        optional string path = 2;
        Specified by:
        getPathBytes in interface Service.ListArtifactsOrBuilder
        Returns:
        The bytes for path.

      • hasPageToken

        public boolean hasPageToken()
         Token indicating the page of artifact results to fetch
        optional string page_token = 4;
        Specified by:
        hasPageToken in interface Service.ListArtifactsOrBuilder
        Returns:
        Whether the pageToken field is set.

      • getPageToken

        public java.lang.String getPageToken()
         Token indicating the page of artifact results to fetch
        optional string page_token = 4;
        Specified by:
        getPageToken in interface Service.ListArtifactsOrBuilder
        Returns:
        The pageToken.

      • getPageTokenBytes

        public com.google.protobuf.ByteString getPageTokenBytes()
         Token indicating the page of artifact results to fetch
        optional string page_token = 4;
        Specified by:
        getPageTokenBytes in interface Service.ListArtifactsOrBuilder
        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 Service.ListArtifacts parseFrom​(java.nio.ByteBuffer data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Service.ListArtifacts parseFrom​(java.nio.ByteBuffer data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

        public static Service.ListArtifacts parseFrom​(java.io.InputStream input)
                                       throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static Service.ListArtifacts parseFrom​(java.io.InputStream input,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static Service.ListArtifacts parseDelimitedFrom​(java.io.InputStream input)
                                                throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static Service.ListArtifacts parseDelimitedFrom​(java.io.InputStream input,
                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static Service.ListArtifacts parseFrom​(com.google.protobuf.CodedInputStream input)
                                       throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static Service.ListArtifacts parseFrom​(com.google.protobuf.CodedInputStream input,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws java.io.IOException
        Throws:
        java.io.IOException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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