com.clarifai.grpc.api.DatasetVersionOrBuilder 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 DatasetVersionOrBuilder extends
// @@protoc_insertion_point(interface_extends:clarifai.api.DatasetVersion)
com.google.protobuf.MessageOrBuilder {
/**
*
* The ID for the dataset version
*
*
* string id = 1;
* @return The id.
*/
java.lang.String getId();
/**
*
* The ID for the dataset version
*
*
* string id = 1;
* @return The bytes for id.
*/
com.google.protobuf.ByteString
getIdBytes();
/**
*
* When the dataset version was created.
* The format is https://www.ietf.org/rfc/rfc3339.txt.
* Example: "2006-01-02T15:04:05.999999Z".
*
*
* .google.protobuf.Timestamp created_at = 2;
* @return Whether the createdAt field is set.
*/
boolean hasCreatedAt();
/**
*
* When the dataset version was created.
* The format is https://www.ietf.org/rfc/rfc3339.txt.
* Example: "2006-01-02T15:04:05.999999Z".
*
*
* .google.protobuf.Timestamp created_at = 2;
* @return The createdAt.
*/
com.google.protobuf.Timestamp getCreatedAt();
/**
*
* When the dataset version was created.
* The format is https://www.ietf.org/rfc/rfc3339.txt.
* Example: "2006-01-02T15:04:05.999999Z".
*
*
* .google.protobuf.Timestamp created_at = 2;
*/
com.google.protobuf.TimestampOrBuilder getCreatedAtOrBuilder();
/**
*
* When the dataset version was modified.
* The format is https://www.ietf.org/rfc/rfc3339.txt.
* Example: "2006-01-02T15:04:05.999999Z".
*
*
* .google.protobuf.Timestamp modified_at = 3;
* @return Whether the modifiedAt field is set.
*/
boolean hasModifiedAt();
/**
*
* When the dataset version was modified.
* The format is https://www.ietf.org/rfc/rfc3339.txt.
* Example: "2006-01-02T15:04:05.999999Z".
*
*
* .google.protobuf.Timestamp modified_at = 3;
* @return The modifiedAt.
*/
com.google.protobuf.Timestamp getModifiedAt();
/**
*
* When the dataset version was modified.
* The format is https://www.ietf.org/rfc/rfc3339.txt.
* Example: "2006-01-02T15:04:05.999999Z".
*
*
* .google.protobuf.Timestamp modified_at = 3;
*/
com.google.protobuf.TimestampOrBuilder getModifiedAtOrBuilder();
/**
*
* The app the dataset version belongs to.
*
*
* string app_id = 4;
* @return The appId.
*/
java.lang.String getAppId();
/**
*
* The app the dataset version belongs to.
*
*
* string app_id = 4;
* @return The bytes for appId.
*/
com.google.protobuf.ByteString
getAppIdBytes();
/**
*
* The user the dataset version belongs to.
*
*
* string user_id = 5;
* @return The userId.
*/
java.lang.String getUserId();
/**
*
* The user the dataset version belongs to.
*
*
* string user_id = 5;
* @return The bytes for userId.
*/
com.google.protobuf.ByteString
getUserIdBytes();
/**
*
* The dataset the dataset version belongs to.
*
*
* string dataset_id = 6;
* @return The datasetId.
*/
java.lang.String getDatasetId();
/**
*
* The dataset the dataset version belongs to.
*
*
* string dataset_id = 6;
* @return The bytes for datasetId.
*/
com.google.protobuf.ByteString
getDatasetIdBytes();
/**
*
* The dataset version will be generated based on a single annotation filter.
*
*
* .clarifai.api.AnnotationFilterConfig annotation_filter_config = 15;
* @return Whether the annotationFilterConfig field is set.
*/
boolean hasAnnotationFilterConfig();
/**
*
* The dataset version will be generated based on a single annotation filter.
*
*
* .clarifai.api.AnnotationFilterConfig annotation_filter_config = 15;
* @return The annotationFilterConfig.
*/
com.clarifai.grpc.api.AnnotationFilterConfig getAnnotationFilterConfig();
/**
*
* The dataset version will be generated based on a single annotation filter.
*
*
* .clarifai.api.AnnotationFilterConfig annotation_filter_config = 15;
*/
com.clarifai.grpc.api.AnnotationFilterConfigOrBuilder getAnnotationFilterConfigOrBuilder();
/**
*
* The dataset version will be generated based on model version inferences.
*
*
* .clarifai.api.ModelPredictConfig model_predict_config = 18;
* @return Whether the modelPredictConfig field is set.
*/
boolean hasModelPredictConfig();
/**
*
* The dataset version will be generated based on model version inferences.
*
*
* .clarifai.api.ModelPredictConfig model_predict_config = 18;
* @return The modelPredictConfig.
*/
com.clarifai.grpc.api.ModelPredictConfig getModelPredictConfig();
/**
*
* The dataset version will be generated based on model version inferences.
*
*
* .clarifai.api.ModelPredictConfig model_predict_config = 18;
*/
com.clarifai.grpc.api.ModelPredictConfigOrBuilder getModelPredictConfigOrBuilder();
/**
*
* Status for this dataset version.
*
*
* .clarifai.api.status.Status status = 8;
* @return Whether the status field is set.
*/
boolean hasStatus();
/**
*
* Status for this dataset version.
*
*
* .clarifai.api.status.Status status = 8;
* @return The status.
*/
com.clarifai.grpc.api.status.Status getStatus();
/**
*
* Status for this dataset version.
*
*
* .clarifai.api.status.Status status = 8;
*/
com.clarifai.grpc.api.status.StatusOrBuilder getStatusOrBuilder();
/**
*
* Description of the dataset version
*
*
* string description = 10;
* @return The description.
*/
java.lang.String getDescription();
/**
*
* Description of the dataset version
*
*
* string description = 10;
* @return The bytes for description.
*/
com.google.protobuf.ByteString
getDescriptionBytes();
/**
*
* Dataset version processing. If this is not set when the dataset version is
* created, then the dataset default_processing_info is copied instead. Later
* updates to default_processing_info will not apply to existing versions.
*
*
* .clarifai.api.DatasetVersionProcessingInfo processing_info = 19;
* @return Whether the processingInfo field is set.
*/
boolean hasProcessingInfo();
/**
*
* Dataset version processing. If this is not set when the dataset version is
* created, then the dataset default_processing_info is copied instead. Later
* updates to default_processing_info will not apply to existing versions.
*
*
* .clarifai.api.DatasetVersionProcessingInfo processing_info = 19;
* @return The processingInfo.
*/
com.clarifai.grpc.api.DatasetVersionProcessingInfo getProcessingInfo();
/**
*
* Dataset version processing. If this is not set when the dataset version is
* created, then the dataset default_processing_info is copied instead. Later
* updates to default_processing_info will not apply to existing versions.
*
*
* .clarifai.api.DatasetVersionProcessingInfo processing_info = 19;
*/
com.clarifai.grpc.api.DatasetVersionProcessingInfoOrBuilder getProcessingInfoOrBuilder();
/**
*
* Dataset version metrics
*
*
* map<string, .clarifai.api.DatasetVersionMetrics> metrics = 16;
*/
int getMetricsCount();
/**
*
* Dataset version metrics
*
*
* map<string, .clarifai.api.DatasetVersionMetrics> metrics = 16;
*/
boolean containsMetrics(
java.lang.String key);
/**
* Use {@link #getMetricsMap()} instead.
*/
@java.lang.Deprecated
java.util.Map
getMetrics();
/**
*
* Dataset version metrics
*
*
* map<string, .clarifai.api.DatasetVersionMetrics> metrics = 16;
*/
java.util.Map
getMetricsMap();
/**
*
* Dataset version metrics
*
*
* map<string, .clarifai.api.DatasetVersionMetrics> metrics = 16;
*/
/* nullable */
com.clarifai.grpc.api.DatasetVersionMetrics getMetricsOrDefault(
java.lang.String key,
/* nullable */
com.clarifai.grpc.api.DatasetVersionMetrics defaultValue);
/**
*
* Dataset version metrics
*
*
* map<string, .clarifai.api.DatasetVersionMetrics> metrics = 16;
*/
com.clarifai.grpc.api.DatasetVersionMetrics getMetricsOrThrow(
java.lang.String key);
/**
*
* Dataset version exports
*
*
* .clarifai.api.DatasetVersionExportInfo export_info = 17;
* @return Whether the exportInfo field is set.
*/
boolean hasExportInfo();
/**
*
* Dataset version exports
*
*
* .clarifai.api.DatasetVersionExportInfo export_info = 17;
* @return The exportInfo.
*/
com.clarifai.grpc.api.DatasetVersionExportInfo getExportInfo();
/**
*
* Dataset version exports
*
*
* .clarifai.api.DatasetVersionExportInfo export_info = 17;
*/
com.clarifai.grpc.api.DatasetVersionExportInfoOrBuilder getExportInfoOrBuilder();
/**
*
* 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 = 12;
* @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 = 12;
* @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 = 12;
*/
com.google.protobuf.StructOrBuilder getMetadataOrBuilder();
/**
*
* 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 = 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.
*
*
* .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.
*
*
* .clarifai.api.Visibility visibility = 13;
*/
com.clarifai.grpc.api.VisibilityOrBuilder getVisibilityOrBuilder();
/**
*
* The embedding models to return embeddings for. If empty, no embeddings are returned.
*
*
* repeated string embed_model_version_ids = 14;
* @return A list containing the embedModelVersionIds.
*/
java.util.List
getEmbedModelVersionIdsList();
/**
*
* The embedding models to return embeddings for. If empty, no embeddings are returned.
*
*
* repeated string embed_model_version_ids = 14;
* @return The count of embedModelVersionIds.
*/
int getEmbedModelVersionIdsCount();
/**
*
* The embedding models to return embeddings for. If empty, no embeddings are returned.
*
*
* repeated string embed_model_version_ids = 14;
* @param index The index of the element to return.
* @return The embedModelVersionIds at the given index.
*/
java.lang.String getEmbedModelVersionIds(int index);
/**
*
* The embedding models to return embeddings for. If empty, no embeddings are returned.
*
*
* repeated string embed_model_version_ids = 14;
* @param index The index of the value to return.
* @return The bytes of the embedModelVersionIds at the given index.
*/
com.google.protobuf.ByteString
getEmbedModelVersionIdsBytes(int index);
/**
*
* Read Only. Cannot be Set
* Origin of request for new dataset version
*
*
* .clarifai.api.DatasetVersionRequestOrigin request_origin = 20;
* @return The enum numeric value on the wire for requestOrigin.
*/
int getRequestOriginValue();
/**
*
* Read Only. Cannot be Set
* Origin of request for new dataset version
*
*
* .clarifai.api.DatasetVersionRequestOrigin request_origin = 20;
* @return The requestOrigin.
*/
com.clarifai.grpc.api.DatasetVersionRequestOrigin getRequestOrigin();
public com.clarifai.grpc.api.DatasetVersion.DataConfigCase getDataConfigCase();
}