com.clarifai.grpc.api.ModelOrBuilder Maven / Gradle / Ivy
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: proto/clarifai/api/resources.proto
package com.clarifai.grpc.api;
public interface ModelOrBuilder extends
// @@protoc_insertion_point(interface_extends:clarifai.api.Model)
com.google.protobuf.MessageOrBuilder {
/**
*
* The model's ID. Must be unique within a particular app and URL-friendly.
*
*
* string id = 1;
* @return The id.
*/
java.lang.String getId();
/**
*
* The model's ID. Must be unique within a particular app and URL-friendly.
*
*
* string id = 1;
* @return The bytes for id.
*/
com.google.protobuf.ByteString
getIdBytes();
/**
*
* A nicer-to-read name for the model. Can have spaces and special characters.
*
*
* string name = 2;
* @return The name.
*/
java.lang.String getName();
/**
*
* A nicer-to-read name for the model. Can have spaces and special characters.
*
*
* string name = 2;
* @return The bytes for name.
*/
com.google.protobuf.ByteString
getNameBytes();
/**
*
* When the model was created. We follow the XXXX timestamp
* format. We use https://www.ietf.org/rfc/rfc3339.txt format:
* "2006-01-02T15:04:05.999999Z" so you can expect results like
* the following from the API:
* "2017-04-11T21:50:50.223962Z"
*
*
* .google.protobuf.Timestamp created_at = 3;
* @return Whether the createdAt field is set.
*/
boolean hasCreatedAt();
/**
*
* When the model was created. We follow the XXXX timestamp
* format. We use https://www.ietf.org/rfc/rfc3339.txt format:
* "2006-01-02T15:04:05.999999Z" so you can expect results like
* the following from the API:
* "2017-04-11T21:50:50.223962Z"
*
*
* .google.protobuf.Timestamp created_at = 3;
* @return The createdAt.
*/
com.google.protobuf.Timestamp getCreatedAt();
/**
*
* When the model was created. We follow the XXXX timestamp
* format. We use https://www.ietf.org/rfc/rfc3339.txt format:
* "2006-01-02T15:04:05.999999Z" so you can expect results like
* the following from the API:
* "2017-04-11T21:50:50.223962Z"
*
*
* .google.protobuf.Timestamp created_at = 3;
*/
com.google.protobuf.TimestampOrBuilder getCreatedAtOrBuilder();
/**
*
* When was the most recent model version created at
*
*
* .google.protobuf.Timestamp modified_at = 19;
* @return Whether the modifiedAt field is set.
*/
boolean hasModifiedAt();
/**
*
* When was the most recent model version created at
*
*
* .google.protobuf.Timestamp modified_at = 19;
* @return The modifiedAt.
*/
com.google.protobuf.Timestamp getModifiedAt();
/**
*
* When was the most recent model version created at
*
*
* .google.protobuf.Timestamp modified_at = 19;
*/
com.google.protobuf.TimestampOrBuilder getModifiedAtOrBuilder();
/**
*
* The app the model belongs to.
*
*
* string app_id = 4 [(.clarifai.api.utils.cl_show_if_empty) = true];
* @return The appId.
*/
java.lang.String getAppId();
/**
*
* The app the model belongs to.
*
*
* string app_id = 4 [(.clarifai.api.utils.cl_show_if_empty) = true];
* @return The bytes for appId.
*/
com.google.protobuf.ByteString
getAppIdBytes();
/**
*
* Info about the model's output and configuration.
*
*
* .clarifai.api.OutputInfo output_info = 5;
* @return Whether the outputInfo field is set.
*/
boolean hasOutputInfo();
/**
*
* Info about the model's output and configuration.
*
*
* .clarifai.api.OutputInfo output_info = 5;
* @return The outputInfo.
*/
com.clarifai.grpc.api.OutputInfo getOutputInfo();
/**
*
* Info about the model's output and configuration.
*
*
* .clarifai.api.OutputInfo output_info = 5;
*/
com.clarifai.grpc.api.OutputInfoOrBuilder getOutputInfoOrBuilder();
/**
*
* A particular version of the model, e.g., to specify the version when creating a workflow.
*
*
* .clarifai.api.ModelVersion model_version = 6;
* @return Whether the modelVersion field is set.
*/
boolean hasModelVersion();
/**
*
* A particular version of the model, e.g., to specify the version when creating a workflow.
*
*
* .clarifai.api.ModelVersion model_version = 6;
* @return The modelVersion.
*/
com.clarifai.grpc.api.ModelVersion getModelVersion();
/**
*
* A particular version of the model, e.g., to specify the version when creating a workflow.
*
*
* .clarifai.api.ModelVersion model_version = 6;
*/
com.clarifai.grpc.api.ModelVersionOrBuilder getModelVersionOrBuilder();
/**
*
* An even nicer-to-read name for public Clarifai models where we're not happy with the name but
* need a temporary workaround while we check what depends on these names.
*
*
* string display_name = 7;
* @return The displayName.
*/
java.lang.String getDisplayName();
/**
*
* An even nicer-to-read name for public Clarifai models where we're not happy with the name but
* need a temporary workaround while we check what depends on these names.
*
*
* string display_name = 7;
* @return The bytes for displayName.
*/
com.google.protobuf.ByteString
getDisplayNameBytes();
/**
*
* The user id that the model belongs to.
*
*
* string user_id = 9;
* @return The userId.
*/
java.lang.String getUserId();
/**
*
* The user id that the model belongs to.
*
*
* string user_id = 9;
* @return The bytes for userId.
*/
com.google.protobuf.ByteString
getUserIdBytes();
/**
*
* Info about the models' input and configuration of them.
*
*
* .clarifai.api.InputInfo input_info = 12;
* @return Whether the inputInfo field is set.
*/
boolean hasInputInfo();
/**
*
* Info about the models' input and configuration of them.
*
*
* .clarifai.api.InputInfo input_info = 12;
* @return The inputInfo.
*/
com.clarifai.grpc.api.InputInfo getInputInfo();
/**
*
* Info about the models' input and configuration of them.
*
*
* .clarifai.api.InputInfo input_info = 12;
*/
com.clarifai.grpc.api.InputInfoOrBuilder getInputInfoOrBuilder();
/**
*
* Configuration for the training process of this model.
*
*
* .clarifai.api.TrainInfo train_info = 13;
* @return Whether the trainInfo field is set.
*/
boolean hasTrainInfo();
/**
*
* Configuration for the training process of this model.
*
*
* .clarifai.api.TrainInfo train_info = 13;
* @return The trainInfo.
*/
com.clarifai.grpc.api.TrainInfo getTrainInfo();
/**
*
* Configuration for the training process of this model.
*
*
* .clarifai.api.TrainInfo train_info = 13;
*/
com.clarifai.grpc.api.TrainInfoOrBuilder getTrainInfoOrBuilder();
/**
*
* The ModelType.Id that is used for this model. This is used for all versions and you cannot
* change model_type_id between versions of the same model.
*
*
* string model_type_id = 14;
* @return The modelTypeId.
*/
java.lang.String getModelTypeId();
/**
*
* The ModelType.Id that is used for this model. This is used for all versions and you cannot
* change model_type_id between versions of the same model.
*
*
* string model_type_id = 14;
* @return The bytes for modelTypeId.
*/
com.google.protobuf.ByteString
getModelTypeIdBytes();
/**
*
* The visibility field represents whether this message is privately/publicly visible.
* To be visible to the public the App that contains it AND the User that contains the App must
* also be publicly visible.
*
*
* .clarifai.api.Visibility visibility = 15;
* @return Whether the visibility field is set.
*/
boolean hasVisibility();
/**
*
* The visibility field represents whether this message is privately/publicly visible.
* To be visible to the public the App that contains it AND the User that contains the App must
* also be publicly visible.
*
*
* .clarifai.api.Visibility visibility = 15;
* @return The visibility.
*/
com.clarifai.grpc.api.Visibility getVisibility();
/**
*
* The visibility field represents whether this message is privately/publicly visible.
* To be visible to the public the App that contains it AND the User that contains the App must
* also be publicly visible.
*
*
* .clarifai.api.Visibility visibility = 15;
*/
com.clarifai.grpc.api.VisibilityOrBuilder getVisibilityOrBuilder();
/**
*
* Short description about this model
*
*
* string description = 16;
* @return The description.
*/
java.lang.String getDescription();
/**
*
* Short description about this model
*
*
* string description = 16;
* @return The bytes for description.
*/
com.google.protobuf.ByteString
getDescriptionBytes();
/**
*
* To handle arbitrary json metadata you can use a struct field:
* https://github.com/google/protobuf/blob/master/src/google/protobuf/struct.proto
*
*
* .google.protobuf.Struct metadata = 17;
* @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
*
*
* .google.protobuf.Struct metadata = 17;
* @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
*
*
* .google.protobuf.Struct metadata = 17;
*/
com.google.protobuf.StructOrBuilder getMetadataOrBuilder();
/**
*
* Notes for the model
* This field should be used for in-depth notes and supports up to 64Kbs.
*
*
* string notes = 18;
* @return The notes.
*/
java.lang.String getNotes();
/**
*
* Notes for the model
* This field should be used for in-depth notes and supports up to 64Kbs.
*
*
* string notes = 18;
* @return The bytes for notes.
*/
com.google.protobuf.ByteString
getNotesBytes();
/**
*
* Tags from toolkits category
*
*
* repeated string toolkits = 20 [(.clarifai.api.utils.cl_show_if_empty) = true];
* @return A list containing the toolkits.
*/
java.util.List
getToolkitsList();
/**
*
* Tags from toolkits category
*
*
* repeated string toolkits = 20 [(.clarifai.api.utils.cl_show_if_empty) = true];
* @return The count of toolkits.
*/
int getToolkitsCount();
/**
*
* Tags from toolkits category
*
*
* repeated string toolkits = 20 [(.clarifai.api.utils.cl_show_if_empty) = true];
* @param index The index of the element to return.
* @return The toolkits at the given index.
*/
java.lang.String getToolkits(int index);
/**
*
* Tags from toolkits category
*
*
* repeated string toolkits = 20 [(.clarifai.api.utils.cl_show_if_empty) = true];
* @param index The index of the value to return.
* @return The bytes of the toolkits at the given index.
*/
com.google.protobuf.ByteString
getToolkitsBytes(int index);
/**
*
* Tags from use_cases category
*
*
* repeated string use_cases = 21 [(.clarifai.api.utils.cl_show_if_empty) = true];
* @return A list containing the useCases.
*/
java.util.List
getUseCasesList();
/**
*
* Tags from use_cases category
*
*
* repeated string use_cases = 21 [(.clarifai.api.utils.cl_show_if_empty) = true];
* @return The count of useCases.
*/
int getUseCasesCount();
/**
*
* Tags from use_cases category
*
*
* repeated string use_cases = 21 [(.clarifai.api.utils.cl_show_if_empty) = true];
* @param index The index of the element to return.
* @return The useCases at the given index.
*/
java.lang.String getUseCases(int index);
/**
*
* Tags from use_cases category
*
*
* repeated string use_cases = 21 [(.clarifai.api.utils.cl_show_if_empty) = true];
* @param index The index of the value to return.
* @return The bytes of the useCases at the given index.
*/
com.google.protobuf.ByteString
getUseCasesBytes(int index);
/**
*
* Tags from languages category.
*
*
* repeated string languages = 25 [(.clarifai.api.utils.cl_show_if_empty) = true];
* @return A list containing the languages.
*/
java.util.List
getLanguagesList();
/**
*
* Tags from languages category.
*
*
* repeated string languages = 25 [(.clarifai.api.utils.cl_show_if_empty) = true];
* @return The count of languages.
*/
int getLanguagesCount();
/**
*
* Tags from languages category.
*
*
* repeated string languages = 25 [(.clarifai.api.utils.cl_show_if_empty) = true];
* @param index The index of the element to return.
* @return The languages at the given index.
*/
java.lang.String getLanguages(int index);
/**
*
* Tags from languages category.
*
*
* repeated string languages = 25 [(.clarifai.api.utils.cl_show_if_empty) = true];
* @param index The index of the value to return.
* @return The bytes of the languages at the given index.
*/
com.google.protobuf.ByteString
getLanguagesBytes(int index);
/**
*
* Is starred by the requesting user (only showed on get/list requests)
* Please use PostModelStars/DeleteModelStars endpoints to star/unstar a model
*
*
* bool is_starred = 22;
* @return The isStarred.
*/
boolean getIsStarred();
/**
*
* How many users have starred the model (only showed on get/list requests)
* Computed value, not editable
*
*
* int32 star_count = 23;
* @return The starCount.
*/
int getStarCount();
/**
*
* Configuration used to import model from third-party toolkits
*
*
* .clarifai.api.ImportInfo import_info = 24;
* @return Whether the importInfo field is set.
*/
boolean hasImportInfo();
/**
*
* Configuration used to import model from third-party toolkits
*
*
* .clarifai.api.ImportInfo import_info = 24;
* @return The importInfo.
*/
com.clarifai.grpc.api.ImportInfo getImportInfo();
/**
*
* Configuration used to import model from third-party toolkits
*
*
* .clarifai.api.ImportInfo import_info = 24;
*/
com.clarifai.grpc.api.ImportInfoOrBuilder getImportInfoOrBuilder();
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy