com.clarifai.grpc.api.InstalledModuleVersionOrBuilder 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 InstalledModuleVersionOrBuilder extends
// @@protoc_insertion_point(interface_extends:clarifai.api.InstalledModuleVersion)
com.google.protobuf.MessageOrBuilder {
/**
*
* A unique id for this install. This will be used in the browser url.
*
*
* string id = 1;
* @return The id.
*/
java.lang.String getId();
/**
*
* A unique id for this install. This will be used in the browser url.
*
*
* string id = 1;
* @return The bytes for id.
*/
com.google.protobuf.ByteString
getIdBytes();
/**
*
* The installed module version provided here so that we users don't need to do an additional
* fetch. When creating a new InstalledModuleVersion you should provide the:
* module_version.user_id
* module_version.app_id
* module_version.module_id
* module_version.id
* in order to uniquely define which module version.
*
*
* .clarifai.api.ModuleVersion module_version = 2;
* @return Whether the moduleVersion field is set.
*/
boolean hasModuleVersion();
/**
*
* The installed module version provided here so that we users don't need to do an additional
* fetch. When creating a new InstalledModuleVersion you should provide the:
* module_version.user_id
* module_version.app_id
* module_version.module_id
* module_version.id
* in order to uniquely define which module version.
*
*
* .clarifai.api.ModuleVersion module_version = 2;
* @return The moduleVersion.
*/
com.clarifai.grpc.api.ModuleVersion getModuleVersion();
/**
*
* The installed module version provided here so that we users don't need to do an additional
* fetch. When creating a new InstalledModuleVersion you should provide the:
* module_version.user_id
* module_version.app_id
* module_version.module_id
* module_version.id
* in order to uniquely define which module version.
*
*
* .clarifai.api.ModuleVersion module_version = 2;
*/
com.clarifai.grpc.api.ModuleVersionOrBuilder getModuleVersionOrBuilder();
/**
*
* The app_id the ModuleVersion is installed into (not necessary where the ModuleVersion was
* created). This doesn't have to be provided in requests to install, but will be returned in
* responses.
*
*
* string app_id = 3;
* @return The appId.
*/
java.lang.String getAppId();
/**
*
* The app_id the ModuleVersion is installed into (not necessary where the ModuleVersion was
* created). This doesn't have to be provided in requests to install, but will be returned in
* responses.
*
*
* string app_id = 3;
* @return The bytes for appId.
*/
com.google.protobuf.ByteString
getAppIdBytes();
/**
*
* The user that the app belongs to where the ModuleVersion is installed into (not necessary where
* the ModuleVersion was created). This doesn't have to be provided in requests to install, but
* will be returned in responses.
*
*
* string user_id = 4;
* @return The userId.
*/
java.lang.String getUserId();
/**
*
* The user that the app belongs to where the ModuleVersion is installed into (not necessary where
* the ModuleVersion was created). This doesn't have to be provided in requests to install, but
* will be returned in responses.
*
*
* string user_id = 4;
* @return The bytes for userId.
*/
com.google.protobuf.ByteString
getUserIdBytes();
/**
*
* When the install was created.
*
*
* .google.protobuf.Timestamp created_at = 5;
* @return Whether the createdAt field is set.
*/
boolean hasCreatedAt();
/**
*
* When the install was created.
*
*
* .google.protobuf.Timestamp created_at = 5;
* @return The createdAt.
*/
com.google.protobuf.Timestamp getCreatedAt();
/**
*
* When the install was created.
*
*
* .google.protobuf.Timestamp created_at = 5;
*/
com.google.protobuf.TimestampOrBuilder getCreatedAtOrBuilder();
/**
*
* When the install was last modified.
*
*
* .google.protobuf.Timestamp modified_at = 6;
* @return Whether the modifiedAt field is set.
*/
boolean hasModifiedAt();
/**
*
* When the install was last modified.
*
*
* .google.protobuf.Timestamp modified_at = 6;
* @return The modifiedAt.
*/
com.google.protobuf.Timestamp getModifiedAt();
/**
*
* When the install was last modified.
*
*
* .google.protobuf.Timestamp modified_at = 6;
*/
com.google.protobuf.TimestampOrBuilder getModifiedAtOrBuilder();
/**
*
* The URL of where this app module version is deployed.
* If you provide this deploy_url when creating the install then it will
* be treated as a pre-deployed module. You can only use a pre-deployed module
* in when installing to an app_id that you own as the creator of the module.
* If you want to install someone elses module or to rely on Clarifai deploying
* your module for you, leave deploy_url empty when creating the install.
* If it is left empty, then deployment will occur when this module version is
* installed into an app using the git_commit_url of the ModuleVersion.
*
*
* string deploy_url = 7;
* @return The deployUrl.
*/
java.lang.String getDeployUrl();
/**
*
* The URL of where this app module version is deployed.
* If you provide this deploy_url when creating the install then it will
* be treated as a pre-deployed module. You can only use a pre-deployed module
* in when installing to an app_id that you own as the creator of the module.
* If you want to install someone elses module or to rely on Clarifai deploying
* your module for you, leave deploy_url empty when creating the install.
* If it is left empty, then deployment will occur when this module version is
* installed into an app using the git_commit_url of the ModuleVersion.
*
*
* string deploy_url = 7;
* @return The bytes for deployUrl.
*/
com.google.protobuf.ByteString
getDeployUrlBytes();
/**
*
* 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. For the InstalledModuleVersion this allows the app owner who
* installed the module version to decide if they want other users of their app to have
* the added functionality that the modules version provides to their app.
* Defaults to PRIVATE if not provided.
*
*
* .clarifai.api.Visibility visibility = 8;
* @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. For the InstalledModuleVersion this allows the app owner who
* installed the module version to decide if they want other users of their app to have
* the added functionality that the modules version provides to their app.
* Defaults to PRIVATE if not provided.
*
*
* .clarifai.api.Visibility visibility = 8;
* @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. For the InstalledModuleVersion this allows the app owner who
* installed the module version to decide if they want other users of their app to have
* the added functionality that the modules version provides to their app.
* Defaults to PRIVATE if not provided.
*
*
* .clarifai.api.Visibility visibility = 8;
*/
com.clarifai.grpc.api.VisibilityOrBuilder getVisibilityOrBuilder();
/**
*
* The key ID to use for making requests to the API for this module.
* This key is associated to this installed module version by PostInstalledModuleVersionsKey
* request. The key is associated with the CALLER not the App Owner where this module is installed
* nor the author of the module. This allows the module to act on behalf of the caller at all
* times so we get proper permissions the caller has (such as if they are stranger, teammate or
* collaborator). This key should be a personal access token to enable modules to work across apps
* and have necessary abilities beyond what app-specific keys offer.
*
*
* string key_id = 9;
* @return The keyId.
*/
java.lang.String getKeyId();
/**
*
* The key ID to use for making requests to the API for this module.
* This key is associated to this installed module version by PostInstalledModuleVersionsKey
* request. The key is associated with the CALLER not the App Owner where this module is installed
* nor the author of the module. This allows the module to act on behalf of the caller at all
* times so we get proper permissions the caller has (such as if they are stranger, teammate or
* collaborator). This key should be a personal access token to enable modules to work across apps
* and have necessary abilities beyond what app-specific keys offer.
*
*
* string key_id = 9;
* @return The bytes for keyId.
*/
com.google.protobuf.ByteString
getKeyIdBytes();
}