com.clarifai.grpc.api.ModuleVersionOrBuilder 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 ModuleVersionOrBuilder extends
// @@protoc_insertion_point(interface_extends:clarifai.api.ModuleVersion)
com.google.protobuf.MessageOrBuilder {
/**
*
* A name for this version like 1_0, 1_1_0, etc.
*
*
* string id = 1;
* @return The id.
*/
java.lang.String getId();
/**
*
* A name for this version like 1_0, 1_1_0, etc.
*
*
* string id = 1;
* @return The bytes for id.
*/
com.google.protobuf.ByteString
getIdBytes();
/**
*
* The module this version belongs to.
*
*
* string module_id = 2;
* @return The moduleId.
*/
java.lang.String getModuleId();
/**
*
* The module this version belongs to.
*
*
* string module_id = 2;
* @return The bytes for moduleId.
*/
com.google.protobuf.ByteString
getModuleIdBytes();
/**
*
* The app_id this module version belongs to.
*
*
* string app_id = 3;
* @return The appId.
*/
java.lang.String getAppId();
/**
*
* The app_id this module version belongs to.
*
*
* string app_id = 3;
* @return The bytes for appId.
*/
com.google.protobuf.ByteString
getAppIdBytes();
/**
*
* The user_id this module version belongs to.
*
*
* string user_id = 4;
* @return The userId.
*/
java.lang.String getUserId();
/**
*
* The user_id this module version belongs to.
*
*
* string user_id = 4;
* @return The bytes for userId.
*/
com.google.protobuf.ByteString
getUserIdBytes();
/**
*
* A short description for this version.
*
*
* string description = 6;
* @return The description.
*/
java.lang.String getDescription();
/**
*
* A short description for this version.
*
*
* string description = 6;
* @return The bytes for description.
*/
com.google.protobuf.ByteString
getDescriptionBytes();
/**
*
* A markdown formatted string to detailed description of the app module.
* This is within each version so that it can be change version to version.
*
*
* string notes = 7;
* @return The notes.
*/
java.lang.String getNotes();
/**
*
* A markdown formatted string to detailed description of the app module.
* This is within each version so that it can be change version to version.
*
*
* string notes = 7;
* @return The bytes for notes.
*/
com.google.protobuf.ByteString
getNotesBytes();
/**
*
* When the app module version was created.
*
*
* .google.protobuf.Timestamp created_at = 8;
* @return Whether the createdAt field is set.
*/
boolean hasCreatedAt();
/**
*
* When the app module version was created.
*
*
* .google.protobuf.Timestamp created_at = 8;
* @return The createdAt.
*/
com.google.protobuf.Timestamp getCreatedAt();
/**
*
* When the app module version was created.
*
*
* .google.protobuf.Timestamp created_at = 8;
*/
com.google.protobuf.TimestampOrBuilder getCreatedAtOrBuilder();
/**
*
* When the app module version was last modified.
*
*
* .google.protobuf.Timestamp modified_at = 9;
* @return Whether the modifiedAt field is set.
*/
boolean hasModifiedAt();
/**
*
* When the app module version was last modified.
*
*
* .google.protobuf.Timestamp modified_at = 9;
* @return The modifiedAt.
*/
com.google.protobuf.Timestamp getModifiedAt();
/**
*
* When the app module version was last modified.
*
*
* .google.protobuf.Timestamp modified_at = 9;
*/
com.google.protobuf.TimestampOrBuilder getModifiedAtOrBuilder();
/**
*
* The code repo of the streamlit app.
* If you are still developing your Module you should create a ModuleVersion
* with an empty git_commit_url and then create an InstalledModuleVersion
* with a pre-deployed deploy_url (such as localhost or streamlit cloud).
* Once you are ready to create a production, create a new ModuleVersion with
* the ready git url to a specific commit that you would like to be reviewed by the
* Clarifai team for approval within our community. You cannot publish a ModuleVersion
* is reviewed and approved. Please only provide the git_commit_url when you're
* ready for a review. This url needs to include a specific commit, for example:
* https://github.com/user/repo/commit/767ff9c08ba3429c8e7b8825da148555
*
*
* string git_commit_url = 10;
* @return The gitCommitUrl.
*/
java.lang.String getGitCommitUrl();
/**
*
* The code repo of the streamlit app.
* If you are still developing your Module you should create a ModuleVersion
* with an empty git_commit_url and then create an InstalledModuleVersion
* with a pre-deployed deploy_url (such as localhost or streamlit cloud).
* Once you are ready to create a production, create a new ModuleVersion with
* the ready git url to a specific commit that you would like to be reviewed by the
* Clarifai team for approval within our community. You cannot publish a ModuleVersion
* is reviewed and approved. Please only provide the git_commit_url when you're
* ready for a review. This url needs to include a specific commit, for example:
* https://github.com/user/repo/commit/767ff9c08ba3429c8e7b8825da148555
*
*
* string git_commit_url = 10;
* @return The bytes for gitCommitUrl.
*/
com.google.protobuf.ByteString
getGitCommitUrlBytes();
/**
* .clarifai.api.ModuleVersion.ModuleNav module_nav = 11;
* @return Whether the moduleNav field is set.
*/
boolean hasModuleNav();
/**
* .clarifai.api.ModuleVersion.ModuleNav module_nav = 11;
* @return The moduleNav.
*/
com.clarifai.grpc.api.ModuleVersion.ModuleNav getModuleNav();
/**
* .clarifai.api.ModuleVersion.ModuleNav module_nav = 11;
*/
com.clarifai.grpc.api.ModuleVersion.ModuleNavOrBuilder getModuleNavOrBuilder();
/**
*
* A boolean to mark if Clarifai has approved this app version.
* This cannot be set in the request to True.
*
*
* bool approved = 12;
* @return The approved.
*/
boolean getApproved();
/**
*
* 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.
* Defaults to PRIVATE if not provided.
*
*
* .clarifai.api.Visibility visibility = 13;
* @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.
* Defaults to PRIVATE if not provided.
*
*
* .clarifai.api.Visibility visibility = 13;
* @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.
* Defaults to PRIVATE if not provided.
*
*
* .clarifai.api.Visibility visibility = 13;
*/
com.clarifai.grpc.api.VisibilityOrBuilder getVisibilityOrBuilder();
/**
*
* 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 = 14;
* @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 = 14;
* @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 = 14;
*/
com.google.protobuf.StructOrBuilder getMetadataOrBuilder();
}