com.clarifai.grpc.api.ModuleOrBuilder 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 ModuleOrBuilder extends
// @@protoc_insertion_point(interface_extends:clarifai.api.Module)
com.google.protobuf.MessageOrBuilder {
/**
*
* A unique ID for this app module.
*
*
* string id = 1;
* @return The id.
*/
java.lang.String getId();
/**
*
* A unique ID for this app module.
*
*
* string id = 1;
* @return The bytes for id.
*/
com.google.protobuf.ByteString
getIdBytes();
/**
*
* A short description for this app module to be used in grids of modules.
*
*
* string description = 3;
* @return The description.
*/
java.lang.String getDescription();
/**
*
* A short description for this app module to be used in grids of modules.
*
*
* string description = 3;
* @return The bytes for description.
*/
com.google.protobuf.ByteString
getDescriptionBytes();
/**
*
* When the app module was created.
*
*
* .google.protobuf.Timestamp created_at = 4;
* @return Whether the createdAt field is set.
*/
boolean hasCreatedAt();
/**
*
* When the app module was created.
*
*
* .google.protobuf.Timestamp created_at = 4;
* @return The createdAt.
*/
com.google.protobuf.Timestamp getCreatedAt();
/**
*
* When the app module was created.
*
*
* .google.protobuf.Timestamp created_at = 4;
*/
com.google.protobuf.TimestampOrBuilder getCreatedAtOrBuilder();
/**
*
* When the app module was last modified.
*
*
* .google.protobuf.Timestamp modified_at = 5;
* @return Whether the modifiedAt field is set.
*/
boolean hasModifiedAt();
/**
*
* When the app module was last modified.
*
*
* .google.protobuf.Timestamp modified_at = 5;
* @return The modifiedAt.
*/
com.google.protobuf.Timestamp getModifiedAt();
/**
*
* When the app module was last modified.
*
*
* .google.protobuf.Timestamp modified_at = 5;
*/
com.google.protobuf.TimestampOrBuilder getModifiedAtOrBuilder();
/**
*
* 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 = 7;
* @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 = 7;
* @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 = 7;
*/
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 = 8;
* @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 = 8;
* @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 = 8;
*/
com.google.protobuf.StructOrBuilder getMetadataOrBuilder();
/**
*
* The creator of the app module.
*
*
* string user_id = 9;
* @return The userId.
*/
java.lang.String getUserId();
/**
*
* The creator of the app module.
*
*
* string user_id = 9;
* @return The bytes for userId.
*/
com.google.protobuf.ByteString
getUserIdBytes();
/**
*
* The app_id this module was created in.
*
*
* string app_id = 10;
* @return The appId.
*/
java.lang.String getAppId();
/**
*
* The app_id this module was created in.
*
*
* string app_id = 10;
* @return The bytes for appId.
*/
com.google.protobuf.ByteString
getAppIdBytes();
/**
*
* A ModuleVersion which is used when listing modules to include the latest module version
* in the response.
*
*
* .clarifai.api.ModuleVersion module_version = 11;
* @return Whether the moduleVersion field is set.
*/
boolean hasModuleVersion();
/**
*
* A ModuleVersion which is used when listing modules to include the latest module version
* in the response.
*
*
* .clarifai.api.ModuleVersion module_version = 11;
* @return The moduleVersion.
*/
com.clarifai.grpc.api.ModuleVersion getModuleVersion();
/**
*
* A ModuleVersion which is used when listing modules to include the latest module version
* in the response.
*
*
* .clarifai.api.ModuleVersion module_version = 11;
*/
com.clarifai.grpc.api.ModuleVersionOrBuilder getModuleVersionOrBuilder();
/**
*
* Is starred by the requesting user (only showed on get/list requests)
* Please use PostModuleStars/DeleteModuleStars endpoints to star/unstar a module
*
*
* bool is_starred = 12;
* @return The isStarred.
*/
boolean getIsStarred();
/**
*
* How many users have starred the module (only showed on get/list requests)
* Computed value, not editable
*
*
* int32 star_count = 13;
* @return The starCount.
*/
int getStarCount();
/**
*
* bookmark info. When set, this module is a bookmarked module of this app.
* Info in this field will allow you to find/access original module.
*
*
* .clarifai.api.BookmarkOrigin bookmark_origin = 14;
* @return Whether the bookmarkOrigin field is set.
*/
boolean hasBookmarkOrigin();
/**
*
* bookmark info. When set, this module is a bookmarked module of this app.
* Info in this field will allow you to find/access original module.
*
*
* .clarifai.api.BookmarkOrigin bookmark_origin = 14;
* @return The bookmarkOrigin.
*/
com.clarifai.grpc.api.BookmarkOrigin getBookmarkOrigin();
/**
*
* bookmark info. When set, this module is a bookmarked module of this app.
* Info in this field will allow you to find/access original module.
*
*
* .clarifai.api.BookmarkOrigin bookmark_origin = 14;
*/
com.clarifai.grpc.api.BookmarkOriginOrBuilder getBookmarkOriginOrBuilder();
/**
*
* Representative image for this module
*
*
* .clarifai.api.Image image = 15;
* @return Whether the image field is set.
*/
boolean hasImage();
/**
*
* Representative image for this module
*
*
* .clarifai.api.Image image = 15;
* @return The image.
*/
com.clarifai.grpc.api.Image getImage();
/**
*
* Representative image for this module
*
*
* .clarifai.api.Image image = 15;
*/
com.clarifai.grpc.api.ImageOrBuilder getImageOrBuilder();
}