/*
* Copyright 2020 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/automl/v1/model.proto
package com.google.cloud.automl.v1;
public interface ModelOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.automl.v1.Model)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Metadata for translation models.
*
*
* .google.cloud.automl.v1.TranslationModelMetadata translation_model_metadata = 15;
*
* @return Whether the translationModelMetadata field is set.
*/
boolean hasTranslationModelMetadata();
/**
*
*
*
* Metadata for translation models.
*
*
* .google.cloud.automl.v1.TranslationModelMetadata translation_model_metadata = 15;
*
* @return The translationModelMetadata.
*/
com.google.cloud.automl.v1.TranslationModelMetadata getTranslationModelMetadata();
/**
*
*
*
* Metadata for translation models.
*
*
* .google.cloud.automl.v1.TranslationModelMetadata translation_model_metadata = 15;
*/
com.google.cloud.automl.v1.TranslationModelMetadataOrBuilder
getTranslationModelMetadataOrBuilder();
/**
*
*
*
* Metadata for image classification models.
*
*
*
* .google.cloud.automl.v1.ImageClassificationModelMetadata image_classification_model_metadata = 13;
*
*
* @return Whether the imageClassificationModelMetadata field is set.
*/
boolean hasImageClassificationModelMetadata();
/**
*
*
*
* Metadata for image classification models.
*
*
*
* .google.cloud.automl.v1.ImageClassificationModelMetadata image_classification_model_metadata = 13;
*
*
* @return The imageClassificationModelMetadata.
*/
com.google.cloud.automl.v1.ImageClassificationModelMetadata getImageClassificationModelMetadata();
/**
*
*
*
* Metadata for image classification models.
*
*
*
* .google.cloud.automl.v1.ImageClassificationModelMetadata image_classification_model_metadata = 13;
*
*/
com.google.cloud.automl.v1.ImageClassificationModelMetadataOrBuilder
getImageClassificationModelMetadataOrBuilder();
/**
*
*
*
* Metadata for text classification models.
*
*
*
* .google.cloud.automl.v1.TextClassificationModelMetadata text_classification_model_metadata = 14;
*
*
* @return Whether the textClassificationModelMetadata field is set.
*/
boolean hasTextClassificationModelMetadata();
/**
*
*
*
* Metadata for text classification models.
*
*
*
* .google.cloud.automl.v1.TextClassificationModelMetadata text_classification_model_metadata = 14;
*
*
* @return The textClassificationModelMetadata.
*/
com.google.cloud.automl.v1.TextClassificationModelMetadata getTextClassificationModelMetadata();
/**
*
*
*
* Metadata for text classification models.
*
*
*
* .google.cloud.automl.v1.TextClassificationModelMetadata text_classification_model_metadata = 14;
*
*/
com.google.cloud.automl.v1.TextClassificationModelMetadataOrBuilder
getTextClassificationModelMetadataOrBuilder();
/**
*
*
*
* Metadata for image object detection models.
*
*
*
* .google.cloud.automl.v1.ImageObjectDetectionModelMetadata image_object_detection_model_metadata = 20;
*
*
* @return Whether the imageObjectDetectionModelMetadata field is set.
*/
boolean hasImageObjectDetectionModelMetadata();
/**
*
*
*
* Metadata for image object detection models.
*
*
*
* .google.cloud.automl.v1.ImageObjectDetectionModelMetadata image_object_detection_model_metadata = 20;
*
*
* @return The imageObjectDetectionModelMetadata.
*/
com.google.cloud.automl.v1.ImageObjectDetectionModelMetadata
getImageObjectDetectionModelMetadata();
/**
*
*
*
* Metadata for image object detection models.
*
*
*
* .google.cloud.automl.v1.ImageObjectDetectionModelMetadata image_object_detection_model_metadata = 20;
*
*/
com.google.cloud.automl.v1.ImageObjectDetectionModelMetadataOrBuilder
getImageObjectDetectionModelMetadataOrBuilder();
/**
*
*
*
* Metadata for text extraction models.
*
*
* .google.cloud.automl.v1.TextExtractionModelMetadata text_extraction_model_metadata = 19;
*
*
* @return Whether the textExtractionModelMetadata field is set.
*/
boolean hasTextExtractionModelMetadata();
/**
*
*
*
* Metadata for text extraction models.
*
*
* .google.cloud.automl.v1.TextExtractionModelMetadata text_extraction_model_metadata = 19;
*
*
* @return The textExtractionModelMetadata.
*/
com.google.cloud.automl.v1.TextExtractionModelMetadata getTextExtractionModelMetadata();
/**
*
*
*
* Metadata for text extraction models.
*
*
* .google.cloud.automl.v1.TextExtractionModelMetadata text_extraction_model_metadata = 19;
*
*/
com.google.cloud.automl.v1.TextExtractionModelMetadataOrBuilder
getTextExtractionModelMetadataOrBuilder();
/**
*
*
*
* Metadata for text sentiment models.
*
*
* .google.cloud.automl.v1.TextSentimentModelMetadata text_sentiment_model_metadata = 22;
*
*
* @return Whether the textSentimentModelMetadata field is set.
*/
boolean hasTextSentimentModelMetadata();
/**
*
*
*
* Metadata for text sentiment models.
*
*
* .google.cloud.automl.v1.TextSentimentModelMetadata text_sentiment_model_metadata = 22;
*
*
* @return The textSentimentModelMetadata.
*/
com.google.cloud.automl.v1.TextSentimentModelMetadata getTextSentimentModelMetadata();
/**
*
*
*
* Metadata for text sentiment models.
*
*
* .google.cloud.automl.v1.TextSentimentModelMetadata text_sentiment_model_metadata = 22;
*
*/
com.google.cloud.automl.v1.TextSentimentModelMetadataOrBuilder
getTextSentimentModelMetadataOrBuilder();
/**
*
*
*
* Output only. Resource name of the model.
* Format: `projects/{project_id}/locations/{location_id}/models/{model_id}`
*
*
* string name = 1;
*
* @return The name.
*/
java.lang.String getName();
/**
*
*
*
* Output only. Resource name of the model.
* Format: `projects/{project_id}/locations/{location_id}/models/{model_id}`
*
*
* string name = 1;
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* Required. The name of the model to show in the interface. The name can be
* up to 32 characters long and can consist only of ASCII Latin letters A-Z
* and a-z, underscores
* (_), and ASCII digits 0-9. It must start with a letter.
*
*
* string display_name = 2;
*
* @return The displayName.
*/
java.lang.String getDisplayName();
/**
*
*
*
* Required. The name of the model to show in the interface. The name can be
* up to 32 characters long and can consist only of ASCII Latin letters A-Z
* and a-z, underscores
* (_), and ASCII digits 0-9. It must start with a letter.
*
*
* string display_name = 2;
*
* @return The bytes for displayName.
*/
com.google.protobuf.ByteString getDisplayNameBytes();
/**
*
*
*
* Required. The resource ID of the dataset used to create the model. The dataset must
* come from the same ancestor project and location.
*
*
* string dataset_id = 3;
*
* @return The datasetId.
*/
java.lang.String getDatasetId();
/**
*
*
*
* Required. The resource ID of the dataset used to create the model. The dataset must
* come from the same ancestor project and location.
*
*
* string dataset_id = 3;
*
* @return The bytes for datasetId.
*/
com.google.protobuf.ByteString getDatasetIdBytes();
/**
*
*
*
* Output only. Timestamp when the model training finished and can be used for prediction.
*
*
* .google.protobuf.Timestamp create_time = 7;
*
* @return Whether the createTime field is set.
*/
boolean hasCreateTime();
/**
*
*
*
* Output only. Timestamp when the model training finished and can be used for prediction.
*
*
* .google.protobuf.Timestamp create_time = 7;
*
* @return The createTime.
*/
com.google.protobuf.Timestamp getCreateTime();
/**
*
*
*
* Output only. Timestamp when the model training finished and can be used for prediction.
*
*
* .google.protobuf.Timestamp create_time = 7;
*/
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder();
/**
*
*
*
* Output only. Timestamp when this model was last updated.
*
*
* .google.protobuf.Timestamp update_time = 11;
*
* @return Whether the updateTime field is set.
*/
boolean hasUpdateTime();
/**
*
*
*
* Output only. Timestamp when this model was last updated.
*
*
* .google.protobuf.Timestamp update_time = 11;
*
* @return The updateTime.
*/
com.google.protobuf.Timestamp getUpdateTime();
/**
*
*
*
* Output only. Timestamp when this model was last updated.
*
*
* .google.protobuf.Timestamp update_time = 11;
*/
com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder();
/**
*
*
*
* Output only. Deployment state of the model. A model can only serve
* prediction requests after it gets deployed.
*
*
* .google.cloud.automl.v1.Model.DeploymentState deployment_state = 8;
*
* @return The enum numeric value on the wire for deploymentState.
*/
int getDeploymentStateValue();
/**
*
*
*
* Output only. Deployment state of the model. A model can only serve
* prediction requests after it gets deployed.
*
*
* .google.cloud.automl.v1.Model.DeploymentState deployment_state = 8;
*
* @return The deploymentState.
*/
com.google.cloud.automl.v1.Model.DeploymentState getDeploymentState();
/**
*
*
*
* Used to perform a consistent read-modify-write updates. If not set, a blind
* "overwrite" update happens.
*
*
* string etag = 10;
*
* @return The etag.
*/
java.lang.String getEtag();
/**
*
*
*
* Used to perform a consistent read-modify-write updates. If not set, a blind
* "overwrite" update happens.
*
*
* string etag = 10;
*
* @return The bytes for etag.
*/
com.google.protobuf.ByteString getEtagBytes();
/**
*
*
*
* Optional. The labels with user-defined metadata to organize your model.
* Label keys and values can be no longer than 64 characters
* (Unicode codepoints), can only contain lowercase letters, numeric
* characters, underscores and dashes. International characters are allowed.
* Label values are optional. Label keys must start with a letter.
* See https://goo.gl/xmQnxf for more information on and examples of labels.
*
*
* map<string, string> labels = 34;
*/
int getLabelsCount();
/**
*
*
*
* Optional. The labels with user-defined metadata to organize your model.
* Label keys and values can be no longer than 64 characters
* (Unicode codepoints), can only contain lowercase letters, numeric
* characters, underscores and dashes. International characters are allowed.
* Label values are optional. Label keys must start with a letter.
* See https://goo.gl/xmQnxf for more information on and examples of labels.
*
*
* map<string, string> labels = 34;
*/
boolean containsLabels(java.lang.String key);
/** Use {@link #getLabelsMap()} instead. */
@java.lang.Deprecated
java.util.Map getLabels();
/**
*
*
*
* Optional. The labels with user-defined metadata to organize your model.
* Label keys and values can be no longer than 64 characters
* (Unicode codepoints), can only contain lowercase letters, numeric
* characters, underscores and dashes. International characters are allowed.
* Label values are optional. Label keys must start with a letter.
* See https://goo.gl/xmQnxf for more information on and examples of labels.
*
*
* map<string, string> labels = 34;
*/
java.util.Map getLabelsMap();
/**
*
*
*
* Optional. The labels with user-defined metadata to organize your model.
* Label keys and values can be no longer than 64 characters
* (Unicode codepoints), can only contain lowercase letters, numeric
* characters, underscores and dashes. International characters are allowed.
* Label values are optional. Label keys must start with a letter.
* See https://goo.gl/xmQnxf for more information on and examples of labels.
*
*
* map<string, string> labels = 34;
*/
/* nullable */
java.lang.String getLabelsOrDefault(
java.lang.String key,
/* nullable */
java.lang.String defaultValue);
/**
*
*
*
* Optional. The labels with user-defined metadata to organize your model.
* Label keys and values can be no longer than 64 characters
* (Unicode codepoints), can only contain lowercase letters, numeric
* characters, underscores and dashes. International characters are allowed.
* Label values are optional. Label keys must start with a letter.
* See https://goo.gl/xmQnxf for more information on and examples of labels.
*
*
* map<string, string> labels = 34;
*/
java.lang.String getLabelsOrThrow(java.lang.String key);
public com.google.cloud.automl.v1.Model.ModelMetadataCase getModelMetadataCase();
}