com.clarifai.grpc.api.RunnerOrBuilder Maven / Gradle / Ivy
The newest version!
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: proto/clarifai/api/resources.proto
package com.clarifai.grpc.api;
public interface RunnerOrBuilder extends
// @@protoc_insertion_point(interface_extends:clarifai.api.Runner)
com.google.protobuf.MessageOrBuilder {
/**
*
* A unique ID for this runner.
* This is a UUID since runners can be automatically orchestrated.
*
*
* string id = 1;
* @return The id.
*/
java.lang.String getId();
/**
*
* A unique ID for this runner.
* This is a UUID since runners can be automatically orchestrated.
*
*
* string id = 1;
* @return The bytes for id.
*/
com.google.protobuf.ByteString
getIdBytes();
/**
*
* short description about the runner.
*
*
* string description = 2;
* @return The description.
*/
java.lang.String getDescription();
/**
*
* short description about the runner.
*
*
* string description = 2;
* @return The bytes for description.
*/
com.google.protobuf.ByteString
getDescriptionBytes();
/**
*
* When the runner was created.
*
*
* .google.protobuf.Timestamp created_at = 3;
* @return Whether the createdAt field is set.
*/
boolean hasCreatedAt();
/**
*
* When the runner was created.
*
*
* .google.protobuf.Timestamp created_at = 3;
* @return The createdAt.
*/
com.google.protobuf.Timestamp getCreatedAt();
/**
*
* When the runner was created.
*
*
* .google.protobuf.Timestamp created_at = 3;
*/
com.google.protobuf.TimestampOrBuilder getCreatedAtOrBuilder();
/**
*
* When the runner was last modified.
*
*
* .google.protobuf.Timestamp modified_at = 4;
* @return Whether the modifiedAt field is set.
*/
boolean hasModifiedAt();
/**
*
* When the runner was last modified.
*
*
* .google.protobuf.Timestamp modified_at = 4;
* @return The modifiedAt.
*/
com.google.protobuf.Timestamp getModifiedAt();
/**
*
* When the runner was last modified.
*
*
* .google.protobuf.Timestamp modified_at = 4;
*/
com.google.protobuf.TimestampOrBuilder getModifiedAtOrBuilder();
/**
*
* To handle arbitrary json metadata you can use a struct field:
* https://github.com/google/protobuf/blob/master/src/google/protobuf/struct.proto
* This is an optional arg.
*
*
* .google.protobuf.Struct metadata = 5;
* @return Whether the metadata field is set.
*/
boolean hasMetadata();
/**
*
* To handle arbitrary json metadata you can use a struct field:
* https://github.com/google/protobuf/blob/master/src/google/protobuf/struct.proto
* This is an optional arg.
*
*
* .google.protobuf.Struct metadata = 5;
* @return The metadata.
*/
com.google.protobuf.Struct getMetadata();
/**
*
* To handle arbitrary json metadata you can use a struct field:
* https://github.com/google/protobuf/blob/master/src/google/protobuf/struct.proto
* This is an optional arg.
*
*
* .google.protobuf.Struct metadata = 5;
*/
com.google.protobuf.StructOrBuilder getMetadataOrBuilder();
/**
*
* The owner of the runner. Runners belong to a user/org account.
*
*
* string user_id = 6;
* @return The userId.
*/
java.lang.String getUserId();
/**
*
* The owner of the runner. Runners belong to a user/org account.
*
*
* string user_id = 6;
* @return The bytes for userId.
*/
com.google.protobuf.ByteString
getUserIdBytes();
/**
*
* Labels to match in order to find work.
*
*
* repeated string labels = 7 [deprecated = true];
* @deprecated clarifai.api.Runner.labels is deprecated.
* See proto/clarifai/api/resources.proto;l=4296
* @return A list containing the labels.
*/
@java.lang.Deprecated java.util.List
getLabelsList();
/**
*
* Labels to match in order to find work.
*
*
* repeated string labels = 7 [deprecated = true];
* @deprecated clarifai.api.Runner.labels is deprecated.
* See proto/clarifai/api/resources.proto;l=4296
* @return The count of labels.
*/
@java.lang.Deprecated int getLabelsCount();
/**
*
* Labels to match in order to find work.
*
*
* repeated string labels = 7 [deprecated = true];
* @deprecated clarifai.api.Runner.labels is deprecated.
* See proto/clarifai/api/resources.proto;l=4296
* @param index The index of the element to return.
* @return The labels at the given index.
*/
@java.lang.Deprecated java.lang.String getLabels(int index);
/**
*
* Labels to match in order to find work.
*
*
* repeated string labels = 7 [deprecated = true];
* @deprecated clarifai.api.Runner.labels is deprecated.
* See proto/clarifai/api/resources.proto;l=4296
* @param index The index of the value to return.
* @return The bytes of the labels at the given index.
*/
@java.lang.Deprecated com.google.protobuf.ByteString
getLabelsBytes(int index);
/**
*
* Instead of just matching on labels we might want to have more explicit matching of what
* work this runner is looking for.
* The thing that the autoscaling config applies to for this nodepool.
*
*
* .clarifai.api.Worker worker = 8;
* @return Whether the worker field is set.
*/
boolean hasWorker();
/**
*
* Instead of just matching on labels we might want to have more explicit matching of what
* work this runner is looking for.
* The thing that the autoscaling config applies to for this nodepool.
*
*
* .clarifai.api.Worker worker = 8;
* @return The worker.
*/
com.clarifai.grpc.api.Worker getWorker();
/**
*
* Instead of just matching on labels we might want to have more explicit matching of what
* work this runner is looking for.
* The thing that the autoscaling config applies to for this nodepool.
*
*
* .clarifai.api.Worker worker = 8;
*/
com.clarifai.grpc.api.WorkerOrBuilder getWorkerOrBuilder();
/**
*
* Runners are defined within nodepools so this field needs the id and user_id of the nodepool
* to be provided when creating a Runner.
* This nodepool must be accessible to you or an org you are part of.
*
*
* .clarifai.api.Nodepool nodepool = 9;
* @return Whether the nodepool field is set.
*/
boolean hasNodepool();
/**
*
* Runners are defined within nodepools so this field needs the id and user_id of the nodepool
* to be provided when creating a Runner.
* This nodepool must be accessible to you or an org you are part of.
*
*
* .clarifai.api.Nodepool nodepool = 9;
* @return The nodepool.
*/
com.clarifai.grpc.api.Nodepool getNodepool();
/**
*
* Runners are defined within nodepools so this field needs the id and user_id of the nodepool
* to be provided when creating a Runner.
* This nodepool must be accessible to you or an org you are part of.
*
*
* .clarifai.api.Nodepool nodepool = 9;
*/
com.clarifai.grpc.api.NodepoolOrBuilder getNodepoolOrBuilder();
/**
*
*//////////////////////////
* Need resources on the runner so we can schedule this Runner into the Nodepool.
* If this runner is being orchestrated for a model then the orchestrator will set this to the
* model resource requirements. If a workflow then it'll compute those requirements and set
* populate this resource field.
* Having this on the underlying object like Model and Workflow allows us to represent the minimum
* requirements on those object, which may be less than what the Runner allocates (as a safety
* margin for the runner to for sure run the resource).
*
*
* .clarifai.api.ComputeInfo compute_info = 10;
* @return Whether the computeInfo field is set.
*/
boolean hasComputeInfo();
/**
*
*//////////////////////////
* Need resources on the runner so we can schedule this Runner into the Nodepool.
* If this runner is being orchestrated for a model then the orchestrator will set this to the
* model resource requirements. If a workflow then it'll compute those requirements and set
* populate this resource field.
* Having this on the underlying object like Model and Workflow allows us to represent the minimum
* requirements on those object, which may be less than what the Runner allocates (as a safety
* margin for the runner to for sure run the resource).
*
*
* .clarifai.api.ComputeInfo compute_info = 10;
* @return The computeInfo.
*/
com.clarifai.grpc.api.ComputeInfo getComputeInfo();
/**
*
*//////////////////////////
* Need resources on the runner so we can schedule this Runner into the Nodepool.
* If this runner is being orchestrated for a model then the orchestrator will set this to the
* model resource requirements. If a workflow then it'll compute those requirements and set
* populate this resource field.
* Having this on the underlying object like Model and Workflow allows us to represent the minimum
* requirements on those object, which may be less than what the Runner allocates (as a safety
* margin for the runner to for sure run the resource).
*
*
* .clarifai.api.ComputeInfo compute_info = 10;
*/
com.clarifai.grpc.api.ComputeInfoOrBuilder getComputeInfoOrBuilder();
/**
*
* Number of replicas that this runner should have up.
* We keep it separate from ComputeInfo which defines how many resources each replica needs.
*
*
* uint32 num_replicas = 11;
* @return The numReplicas.
*/
int getNumReplicas();
}