Package org.mlflow.api.proto

Class ReviewQueues.ReviewQueue

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
org.mlflow.api.proto.ReviewQueues.ReviewQueue
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, ReviewQueues.ReviewQueueOrBuilder
Enclosing class:
ReviewQueues
public static final class ReviewQueues.ReviewQueue extends com.google.protobuf.GeneratedMessageV3 implements ReviewQueues.ReviewQueueOrBuilder
 Full review-queue entity. `users` and `schema_ids` are the queue's
 association sets; `schema_ids` is empty for a USER queue (it resolves
 to all of the experiment's schemas at read time). Attached items are
 paged separately via ListReviewQueueItems.
Protobuf type mlflow.review_queues.ReviewQueue
See Also:

  • 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

    • hasQueueId

      public boolean hasQueueId()
       Server-generated identifier (prefix `rq-`).
      optional string queue_id = 1;
      Specified by:
      hasQueueId in interface ReviewQueues.ReviewQueueOrBuilder
      Returns:
      Whether the queueId field is set.

    • getQueueId

      public String getQueueId()
       Server-generated identifier (prefix `rq-`).
      optional string queue_id = 1;
      Specified by:
      getQueueId in interface ReviewQueues.ReviewQueueOrBuilder
      Returns:
      The queueId.

    • getQueueIdBytes

      public com.google.protobuf.ByteString getQueueIdBytes()
       Server-generated identifier (prefix `rq-`).
      optional string queue_id = 1;
      Specified by:
      getQueueIdBytes in interface ReviewQueues.ReviewQueueOrBuilder
      Returns:
      The bytes for queueId.

    • hasExperimentId

      public boolean hasExperimentId()
       Parent experiment ID.
      optional string experiment_id = 2;
      Specified by:
      hasExperimentId in interface ReviewQueues.ReviewQueueOrBuilder
      Returns:
      Whether the experimentId field is set.

    • getExperimentId

      public String getExperimentId()
       Parent experiment ID.
      optional string experiment_id = 2;
      Specified by:
      getExperimentId in interface ReviewQueues.ReviewQueueOrBuilder
      Returns:
      The experimentId.

    • getExperimentIdBytes

      public com.google.protobuf.ByteString getExperimentIdBytes()
       Parent experiment ID.
      optional string experiment_id = 2;
      Specified by:
      getExperimentIdBytes in interface ReviewQueues.ReviewQueueOrBuilder
      Returns:
      The bytes for experimentId.

    • hasName

      public boolean hasName()
       Queue name. For a USER queue this is the (normalized) user identifier.
      optional string name = 3;
      Specified by:
      hasName in interface ReviewQueues.ReviewQueueOrBuilder
      Returns:
      Whether the name field is set.

    • getName

      public String getName()
       Queue name. For a USER queue this is the (normalized) user identifier.
      optional string name = 3;
      Specified by:
      getName in interface ReviewQueues.ReviewQueueOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Queue name. For a USER queue this is the (normalized) user identifier.
      optional string name = 3;
      Specified by:
      getNameBytes in interface ReviewQueues.ReviewQueueOrBuilder
      Returns:
      The bytes for name.

    • hasQueueType

      public boolean hasQueueType()
      optional .mlflow.review_queues.ReviewQueueType queue_type = 4;
      Specified by:
      hasQueueType in interface ReviewQueues.ReviewQueueOrBuilder
      Returns:
      Whether the queueType field is set.

    • getQueueType

      public ReviewQueues.ReviewQueueType getQueueType()
      optional .mlflow.review_queues.ReviewQueueType queue_type = 4;
      Specified by:
      getQueueType in interface ReviewQueues.ReviewQueueOrBuilder
      Returns:
      The queueType.

    • hasCreatedBy

      public boolean hasCreatedBy()
       The queue's owner. On an authenticated server this is server-stamped to the
 creating user and is the basis for owner-level authorization (an EDIT user
 may manage the queues they own); it can be reassigned (MANAGE-only) via
 UpdateReviewQueue's `new_owner`. On a no-auth server it is meaningless and
 may be unset. For a USER queue it is the assigned user (attribution only).
      optional string created_by = 5;
      Specified by:
      hasCreatedBy in interface ReviewQueues.ReviewQueueOrBuilder
      Returns:
      Whether the createdBy field is set.

    • getCreatedBy

      public String getCreatedBy()
       The queue's owner. On an authenticated server this is server-stamped to the
 creating user and is the basis for owner-level authorization (an EDIT user
 may manage the queues they own); it can be reassigned (MANAGE-only) via
 UpdateReviewQueue's `new_owner`. On a no-auth server it is meaningless and
 may be unset. For a USER queue it is the assigned user (attribution only).
      optional string created_by = 5;
      Specified by:
      getCreatedBy in interface ReviewQueues.ReviewQueueOrBuilder
      Returns:
      The createdBy.

    • getCreatedByBytes

      public com.google.protobuf.ByteString getCreatedByBytes()
       The queue's owner. On an authenticated server this is server-stamped to the
 creating user and is the basis for owner-level authorization (an EDIT user
 may manage the queues they own); it can be reassigned (MANAGE-only) via
 UpdateReviewQueue's `new_owner`. On a no-auth server it is meaningless and
 may be unset. For a USER queue it is the assigned user (attribution only).
      optional string created_by = 5;
      Specified by:
      getCreatedByBytes in interface ReviewQueues.ReviewQueueOrBuilder
      Returns:
      The bytes for createdBy.

    • hasCreationTimeMs

      public boolean hasCreationTimeMs()
      optional int64 creation_time_ms = 6;
      Specified by:
      hasCreationTimeMs in interface ReviewQueues.ReviewQueueOrBuilder
      Returns:
      Whether the creationTimeMs field is set.

    • getCreationTimeMs

      public long getCreationTimeMs()
      optional int64 creation_time_ms = 6;
      Specified by:
      getCreationTimeMs in interface ReviewQueues.ReviewQueueOrBuilder
      Returns:
      The creationTimeMs.

    • hasLastUpdateTimeMs

      public boolean hasLastUpdateTimeMs()
      optional int64 last_update_time_ms = 7;
      Specified by:
      hasLastUpdateTimeMs in interface ReviewQueues.ReviewQueueOrBuilder
      Returns:
      Whether the lastUpdateTimeMs field is set.

    • getLastUpdateTimeMs

      public long getLastUpdateTimeMs()
      optional int64 last_update_time_ms = 7;
      Specified by:
      getLastUpdateTimeMs in interface ReviewQueues.ReviewQueueOrBuilder
      Returns:
      The lastUpdateTimeMs.

    • getUsersList

      public com.google.protobuf.ProtocolStringList getUsersList()
       Assigned-user pool (0..N; exactly one == name for a USER queue).
      repeated string users = 8;
      Specified by:
      getUsersList in interface ReviewQueues.ReviewQueueOrBuilder
      Returns:
      A list containing the users.

    • getUsersCount

      public int getUsersCount()
       Assigned-user pool (0..N; exactly one == name for a USER queue).
      repeated string users = 8;
      Specified by:
      getUsersCount in interface ReviewQueues.ReviewQueueOrBuilder
      Returns:
      The count of users.

    • getUsers

      public String getUsers(int index)
       Assigned-user pool (0..N; exactly one == name for a USER queue).
      repeated string users = 8;
      Specified by:
      getUsers in interface ReviewQueues.ReviewQueueOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The users at the given index.

    • getUsersBytes

      public com.google.protobuf.ByteString getUsersBytes(int index)
       Assigned-user pool (0..N; exactly one == name for a USER queue).
      repeated string users = 8;
      Specified by:
      getUsersBytes in interface ReviewQueues.ReviewQueueOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the users at the given index.

    • getSchemaIdsList

      public com.google.protobuf.ProtocolStringList getSchemaIdsList()
       Attached label-schema ids (the chosen subset for a CUSTOM queue;
 empty for a USER queue).
      repeated string schema_ids = 9;
      Specified by:
      getSchemaIdsList in interface ReviewQueues.ReviewQueueOrBuilder
      Returns:
      A list containing the schemaIds.

    • getSchemaIdsCount

      public int getSchemaIdsCount()
       Attached label-schema ids (the chosen subset for a CUSTOM queue;
 empty for a USER queue).
      repeated string schema_ids = 9;
      Specified by:
      getSchemaIdsCount in interface ReviewQueues.ReviewQueueOrBuilder
      Returns:
      The count of schemaIds.

    • getSchemaIds

      public String getSchemaIds(int index)
       Attached label-schema ids (the chosen subset for a CUSTOM queue;
 empty for a USER queue).
      repeated string schema_ids = 9;
      Specified by:
      getSchemaIds in interface ReviewQueues.ReviewQueueOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The schemaIds at the given index.

    • getSchemaIdsBytes

      public com.google.protobuf.ByteString getSchemaIdsBytes(int index)
       Attached label-schema ids (the chosen subset for a CUSTOM queue;
 empty for a USER queue).
      repeated string schema_ids = 9;
      Specified by:
      getSchemaIdsBytes in interface ReviewQueues.ReviewQueueOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the schemaIds at the given index.

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

    • parseFrom

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

    • parseFrom

      public static ReviewQueues.ReviewQueue parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ReviewQueues.ReviewQueue parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ReviewQueues.ReviewQueue parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static ReviewQueues.ReviewQueue parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static ReviewQueues.ReviewQueue parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

      public static ReviewQueues.ReviewQueue parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static ReviewQueues.ReviewQueue.Builder newBuilder()

    • newBuilder

      public static ReviewQueues.ReviewQueue.Builder newBuilder(ReviewQueues.ReviewQueue prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static ReviewQueues.ReviewQueue getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<ReviewQueues.ReviewQueue> parser()

    • getParserForType

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