com.clarifai.grpc.api.AppOrBuilder 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 AppOrBuilder extends
// @@protoc_insertion_point(interface_extends:clarifai.api.App)
com.google.protobuf.MessageOrBuilder {
/**
* string id = 1;
* @return The id.
*/
java.lang.String getId();
/**
* string id = 1;
* @return The bytes for id.
*/
com.google.protobuf.ByteString
getIdBytes();
/**
* string name = 2;
* @return The name.
*/
java.lang.String getName();
/**
* string name = 2;
* @return The bytes for name.
*/
com.google.protobuf.ByteString
getNameBytes();
/**
* string default_language = 3;
* @return The defaultLanguage.
*/
java.lang.String getDefaultLanguage();
/**
* string default_language = 3;
* @return The bytes for defaultLanguage.
*/
com.google.protobuf.ByteString
getDefaultLanguageBytes();
/**
*
* Default workflow id deprecated in favor of default_workflow
*
*
* string default_workflow_id = 4;
* @return The defaultWorkflowId.
*/
java.lang.String getDefaultWorkflowId();
/**
*
* Default workflow id deprecated in favor of default_workflow
*
*
* string default_workflow_id = 4;
* @return The bytes for defaultWorkflowId.
*/
com.google.protobuf.ByteString
getDefaultWorkflowIdBytes();
/**
* .clarifai.api.Workflow default_workflow = 23;
* @return Whether the defaultWorkflow field is set.
*/
boolean hasDefaultWorkflow();
/**
* .clarifai.api.Workflow default_workflow = 23;
* @return The defaultWorkflow.
*/
com.clarifai.grpc.api.Workflow getDefaultWorkflow();
/**
* .clarifai.api.Workflow default_workflow = 23;
*/
com.clarifai.grpc.api.WorkflowOrBuilder getDefaultWorkflowOrBuilder();
/**
*
* why is user_id present here when this message type is used in PostApps but completely ignored there? PostApp already
* specifies the userid in path but doesn't even actually use neither of userids, it instead used the id from auth context.
* This creates a lot of ambiguity, should always have different message types for Post/Get endpoints so that the minimum interface for each op can be described
*
*
* string user_id = 5;
* @return The userId.
*/
java.lang.String getUserId();
/**
*
* why is user_id present here when this message type is used in PostApps but completely ignored there? PostApp already
* specifies the userid in path but doesn't even actually use neither of userids, it instead used the id from auth context.
* This creates a lot of ambiguity, should always have different message types for Post/Get endpoints so that the minimum interface for each op can be described
*
*
* string user_id = 5;
* @return The bytes for userId.
*/
com.google.protobuf.ByteString
getUserIdBytes();
/**
*
* When the app 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 = 6;
* @return Whether the createdAt field is set.
*/
boolean hasCreatedAt();
/**
*
* When the app 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 = 6;
* @return The createdAt.
*/
com.google.protobuf.Timestamp getCreatedAt();
/**
*
* When the app 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 = 6;
*/
com.google.protobuf.TimestampOrBuilder getCreatedAtOrBuilder();
/**
*
* When the app was last modified
*
*
* .google.protobuf.Timestamp modified_at = 17;
* @return Whether the modifiedAt field is set.
*/
boolean hasModifiedAt();
/**
*
* When the app was last modified
*
*
* .google.protobuf.Timestamp modified_at = 17;
* @return The modifiedAt.
*/
com.google.protobuf.Timestamp getModifiedAt();
/**
*
* When the app was last modified
*
*
* .google.protobuf.Timestamp modified_at = 17;
*/
com.google.protobuf.TimestampOrBuilder getModifiedAtOrBuilder();
/**
*
* if user accept legal consent for face recognition
*
*
* uint32 legal_consent_status = 7;
* @return The legalConsentStatus.
*/
int getLegalConsentStatus();
/**
*
* 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 = 13;
* @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 = 13;
* @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 = 13;
*/
com.google.protobuf.StructOrBuilder getMetadataOrBuilder();
/**
*
* short description about the app.
*
*
* string description = 14;
* @return The description.
*/
java.lang.String getDescription();
/**
*
* short description about the app.
*
*
* string description = 14;
* @return The bytes for description.
*/
com.google.protobuf.ByteString
getDescriptionBytes();
/**
*
* Default value for model predictions on video: Sample delay for video predicting (1 frame per N milliseconds)
*
*
* uint32 sample_ms = 15;
* @return The sampleMs.
*/
int getSampleMs();
/**
*
* 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 = 16;
* @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 = 16;
* @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 = 16;
*/
com.clarifai.grpc.api.VisibilityOrBuilder getVisibilityOrBuilder();
/**
*
* data tier id this app is using.
*
*
* string data_tier_id = 18;
* @return The dataTierId.
*/
java.lang.String getDataTierId();
/**
*
* data tier id this app is using.
*
*
* string data_tier_id = 18;
* @return The bytes for dataTierId.
*/
com.google.protobuf.ByteString
getDataTierIdBytes();
/**
*
* Is starred by the requesting user (only showed on get/list requests)
* Please use PostAppStars/DeleteAppStars endpoints to star/unstar an app
*
*
* bool is_starred = 19;
* @return The isStarred.
*/
boolean getIsStarred();
/**
*
* How many users have starred the app (only showed on get/list requests)
* Computed value, not editable
*
*
* int32 star_count = 20;
* @return The starCount.
*/
int getStarCount();
/**
*
* Notes for the application
* This field should be used for in-depth notes and supports up to 64Kbs.
*
*
* string notes = 21;
* @return The notes.
*/
java.lang.String getNotes();
/**
*
* Notes for the application
* This field should be used for in-depth notes and supports up to 64Kbs.
*
*
* string notes = 21;
* @return The bytes for notes.
*/
com.google.protobuf.ByteString
getNotesBytes();
/**
*
* Representative image for this app
*
*
* .clarifai.api.Image image = 22;
* @return Whether the image field is set.
*/
boolean hasImage();
/**
*
* Representative image for this app
*
*
* .clarifai.api.Image image = 22;
* @return The image.
*/
com.clarifai.grpc.api.Image getImage();
/**
*
* Representative image for this app
*
*
* .clarifai.api.Image image = 22;
*/
com.clarifai.grpc.api.ImageOrBuilder getImageOrBuilder();
/**
*
* An app marked as a template can be duplicated by any user that can see it,
* including all visible resources within it.
*
*
* .google.protobuf.BoolValue is_template = 25;
* @return Whether the isTemplate field is set.
*/
boolean hasIsTemplate();
/**
*
* An app marked as a template can be duplicated by any user that can see it,
* including all visible resources within it.
*
*
* .google.protobuf.BoolValue is_template = 25;
* @return The isTemplate.
*/
com.google.protobuf.BoolValue getIsTemplate();
/**
*
* An app marked as a template can be duplicated by any user that can see it,
* including all visible resources within it.
*
*
* .google.protobuf.BoolValue is_template = 25;
*/
com.google.protobuf.BoolValueOrBuilder getIsTemplateOrBuilder();
/**
* .clarifai.api.AppExtraInfo extra_info = 24;
* @return Whether the extraInfo field is set.
*/
boolean hasExtraInfo();
/**
* .clarifai.api.AppExtraInfo extra_info = 24;
* @return The extraInfo.
*/
com.clarifai.grpc.api.AppExtraInfo getExtraInfo();
/**
* .clarifai.api.AppExtraInfo extra_info = 24;
*/
com.clarifai.grpc.api.AppExtraInfoOrBuilder getExtraInfoOrBuilder();
}