Package org.mlflow.api.proto

Interface ReviewQueues.ReviewQueueOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ReviewQueues.ReviewQueue, ReviewQueues.ReviewQueue.Builder
Enclosing class:
ReviewQueues
public static interface ReviewQueues.ReviewQueueOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getCreatedBy()
    The queue's owner.
    com.google.protobuf.ByteString
    getCreatedByBytes()
    The queue's owner.
    long
    getCreationTimeMs()
    optional int64 creation_time_ms = 6;
    String
    getExperimentId()
    Parent experiment ID.
    com.google.protobuf.ByteString
    getExperimentIdBytes()
    Parent experiment ID.
    long
    getLastUpdateTimeMs()
    optional int64 last_update_time_ms = 7;
    String
    getName()
    Queue name.
    com.google.protobuf.ByteString
    getNameBytes()
    Queue name.
    String
    getQueueId()
    Server-generated identifier (prefix `rq-`).
    com.google.protobuf.ByteString
    getQueueIdBytes()
    Server-generated identifier (prefix `rq-`).
    ReviewQueues.ReviewQueueType
    getQueueType()
    optional .mlflow.review_queues.ReviewQueueType queue_type = 4;
    String
    getSchemaIds(int index)
    Attached label-schema ids (the chosen subset for a CUSTOM queue; empty for a USER queue).
    com.google.protobuf.ByteString
    getSchemaIdsBytes(int index)
    Attached label-schema ids (the chosen subset for a CUSTOM queue; empty for a USER queue).
    int
    getSchemaIdsCount()
    Attached label-schema ids (the chosen subset for a CUSTOM queue; empty for a USER queue).
    List<String>
    getSchemaIdsList()
    Attached label-schema ids (the chosen subset for a CUSTOM queue; empty for a USER queue).
    String
    getUsers(int index)
    Assigned-user pool (0..N; exactly one == name for a USER queue).
    com.google.protobuf.ByteString
    getUsersBytes(int index)
    Assigned-user pool (0..N; exactly one == name for a USER queue).
    int
    getUsersCount()
    Assigned-user pool (0..N; exactly one == name for a USER queue).
    List<String>
    getUsersList()
    Assigned-user pool (0..N; exactly one == name for a USER queue).
    boolean
    hasCreatedBy()
    The queue's owner.
    boolean
    hasCreationTimeMs()
    optional int64 creation_time_ms = 6;
    boolean
    hasExperimentId()
    Parent experiment ID.
    boolean
    hasLastUpdateTimeMs()
    optional int64 last_update_time_ms = 7;
    boolean
    hasName()
    Queue name.
    boolean
    hasQueueId()
    Server-generated identifier (prefix `rq-`).
    boolean
    hasQueueType()
    optional .mlflow.review_queues.ReviewQueueType queue_type = 4;

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • hasQueueId

      boolean hasQueueId()
       Server-generated identifier (prefix `rq-`).
      optional string queue_id = 1;
      Returns:
      Whether the queueId field is set.

    • getQueueId

      String getQueueId()
       Server-generated identifier (prefix `rq-`).
      optional string queue_id = 1;
      Returns:
      The queueId.

    • getQueueIdBytes

      com.google.protobuf.ByteString getQueueIdBytes()
       Server-generated identifier (prefix `rq-`).
      optional string queue_id = 1;
      Returns:
      The bytes for queueId.

    • hasExperimentId

      boolean hasExperimentId()
       Parent experiment ID.
      optional string experiment_id = 2;
      Returns:
      Whether the experimentId field is set.

    • getExperimentId

      String getExperimentId()
       Parent experiment ID.
      optional string experiment_id = 2;
      Returns:
      The experimentId.

    • getExperimentIdBytes

      com.google.protobuf.ByteString getExperimentIdBytes()
       Parent experiment ID.
      optional string experiment_id = 2;
      Returns:
      The bytes for experimentId.

    • hasName

      boolean hasName()
       Queue name. For a USER queue this is the (normalized) user identifier.
      optional string name = 3;
      Returns:
      Whether the name field is set.

    • getName

      String getName()
       Queue name. For a USER queue this is the (normalized) user identifier.
      optional string name = 3;
      Returns:
      The name.

    • getNameBytes

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

    • hasQueueType

      boolean hasQueueType()
      optional .mlflow.review_queues.ReviewQueueType queue_type = 4;
      Returns:
      Whether the queueType field is set.

    • getQueueType

      ReviewQueues.ReviewQueueType getQueueType()
      optional .mlflow.review_queues.ReviewQueueType queue_type = 4;
      Returns:
      The queueType.

    • hasCreatedBy

      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;
      Returns:
      Whether the createdBy field is set.

    • getCreatedBy

      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;
      Returns:
      The createdBy.

    • getCreatedByBytes

      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;
      Returns:
      The bytes for createdBy.

    • hasCreationTimeMs

      boolean hasCreationTimeMs()
      optional int64 creation_time_ms = 6;
      Returns:
      Whether the creationTimeMs field is set.

    • getCreationTimeMs

      long getCreationTimeMs()
      optional int64 creation_time_ms = 6;
      Returns:
      The creationTimeMs.

    • hasLastUpdateTimeMs

      boolean hasLastUpdateTimeMs()
      optional int64 last_update_time_ms = 7;
      Returns:
      Whether the lastUpdateTimeMs field is set.

    • getLastUpdateTimeMs

      long getLastUpdateTimeMs()
      optional int64 last_update_time_ms = 7;
      Returns:
      The lastUpdateTimeMs.

    • getUsersList

      List<String> getUsersList()
       Assigned-user pool (0..N; exactly one == name for a USER queue).
      repeated string users = 8;
      Returns:
      A list containing the users.

    • getUsersCount

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

    • getUsers

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

    • getUsersBytes

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

    • getSchemaIdsList

      List<String> getSchemaIdsList()
       Attached label-schema ids (the chosen subset for a CUSTOM queue;
 empty for a USER queue).
      repeated string schema_ids = 9;
      Returns:
      A list containing the schemaIds.

    • getSchemaIdsCount

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

    • getSchemaIds

      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;
      Parameters:
      index - The index of the element to return.
      Returns:
      The schemaIds at the given index.

    • getSchemaIdsBytes

      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;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the schemaIds at the given index.