com.google.cloud.automl.v1

Interface ModelOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Model, Model.Builder

public interface ModelOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsLabels(String key) Optional.
com.google.protobuf.Timestamp	getCreateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder() Output only.
String	getDatasetId() Required.
com.google.protobuf.ByteString	getDatasetIdBytes() Required.
Model.DeploymentState	getDeploymentState() Output only.
int	getDeploymentStateValue() Output only.
String	getDisplayName() Required.
com.google.protobuf.ByteString	getDisplayNameBytes() Required.
String	getEtag() Used to perform a consistent read-modify-write updates.
com.google.protobuf.ByteString	getEtagBytes() Used to perform a consistent read-modify-write updates.
ImageClassificationModelMetadata	getImageClassificationModelMetadata() Metadata for image classification models.
ImageClassificationModelMetadataOrBuilder	getImageClassificationModelMetadataOrBuilder() Metadata for image classification models.
ImageObjectDetectionModelMetadata	getImageObjectDetectionModelMetadata() Metadata for image object detection models.
ImageObjectDetectionModelMetadataOrBuilder	getImageObjectDetectionModelMetadataOrBuilder() Metadata for image object detection models.
Map<String,String>	getLabels() Deprecated.
int	getLabelsCount() Optional.
Map<String,String>	getLabelsMap() Optional.
String	getLabelsOrDefault(String key, String defaultValue) Optional.
String	getLabelsOrThrow(String key) Optional.
Model.ModelMetadataCase	getModelMetadataCase()
String	getName() Output only.
com.google.protobuf.ByteString	getNameBytes() Output only.
TextClassificationModelMetadata	getTextClassificationModelMetadata() Metadata for text classification models.
TextClassificationModelMetadataOrBuilder	getTextClassificationModelMetadataOrBuilder() Metadata for text classification models.
TextExtractionModelMetadata	getTextExtractionModelMetadata() Metadata for text extraction models.
TextExtractionModelMetadataOrBuilder	getTextExtractionModelMetadataOrBuilder() Metadata for text extraction models.
TextSentimentModelMetadata	getTextSentimentModelMetadata() Metadata for text sentiment models.
TextSentimentModelMetadataOrBuilder	getTextSentimentModelMetadataOrBuilder() Metadata for text sentiment models.
TranslationModelMetadata	getTranslationModelMetadata() Metadata for translation models.
TranslationModelMetadataOrBuilder	getTranslationModelMetadataOrBuilder() Metadata for translation models.
com.google.protobuf.Timestamp	getUpdateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getUpdateTimeOrBuilder() Output only.
boolean	hasCreateTime() Output only.
boolean	hasImageClassificationModelMetadata() Metadata for image classification models.
boolean	hasImageObjectDetectionModelMetadata() Metadata for image object detection models.
boolean	hasTextClassificationModelMetadata() Metadata for text classification models.
boolean	hasTextExtractionModelMetadata() Metadata for text extraction models.
boolean	hasTextSentimentModelMetadata() Metadata for text sentiment models.
boolean	hasTranslationModelMetadata() Metadata for translation models.
boolean	hasUpdateTime() Output only.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasTranslationModelMetadata

boolean hasTranslationModelMetadata()

 Metadata for translation models.
 

.google.cloud.automl.v1.TranslationModelMetadata translation_model_metadata = 15;

Returns:

Whether the translationModelMetadata field is set.

getTranslationModelMetadata

TranslationModelMetadata getTranslationModelMetadata()

 Metadata for translation models.
 

.google.cloud.automl.v1.TranslationModelMetadata translation_model_metadata = 15;

Returns:

The translationModelMetadata.

getTranslationModelMetadataOrBuilder

TranslationModelMetadataOrBuilder getTranslationModelMetadataOrBuilder()

 Metadata for translation models.
 

.google.cloud.automl.v1.TranslationModelMetadata translation_model_metadata = 15;

hasImageClassificationModelMetadata

boolean hasImageClassificationModelMetadata()

 Metadata for image classification models.
 

.google.cloud.automl.v1.ImageClassificationModelMetadata image_classification_model_metadata = 13;

Returns:

Whether the imageClassificationModelMetadata field is set.

getImageClassificationModelMetadata

ImageClassificationModelMetadata getImageClassificationModelMetadata()

 Metadata for image classification models.
 

.google.cloud.automl.v1.ImageClassificationModelMetadata image_classification_model_metadata = 13;

Returns:

The imageClassificationModelMetadata.

getImageClassificationModelMetadataOrBuilder

ImageClassificationModelMetadataOrBuilder getImageClassificationModelMetadataOrBuilder()

 Metadata for image classification models.
 

.google.cloud.automl.v1.ImageClassificationModelMetadata image_classification_model_metadata = 13;

hasTextClassificationModelMetadata

boolean hasTextClassificationModelMetadata()

 Metadata for text classification models.
 

.google.cloud.automl.v1.TextClassificationModelMetadata text_classification_model_metadata = 14;

Returns:

Whether the textClassificationModelMetadata field is set.

getTextClassificationModelMetadata

TextClassificationModelMetadata getTextClassificationModelMetadata()

 Metadata for text classification models.
 

.google.cloud.automl.v1.TextClassificationModelMetadata text_classification_model_metadata = 14;

Returns:

The textClassificationModelMetadata.

getTextClassificationModelMetadataOrBuilder

TextClassificationModelMetadataOrBuilder getTextClassificationModelMetadataOrBuilder()

 Metadata for text classification models.
 

.google.cloud.automl.v1.TextClassificationModelMetadata text_classification_model_metadata = 14;

hasImageObjectDetectionModelMetadata

boolean hasImageObjectDetectionModelMetadata()

 Metadata for image object detection models.
 

.google.cloud.automl.v1.ImageObjectDetectionModelMetadata image_object_detection_model_metadata = 20;

Returns:

Whether the imageObjectDetectionModelMetadata field is set.

getImageObjectDetectionModelMetadata

ImageObjectDetectionModelMetadata getImageObjectDetectionModelMetadata()

 Metadata for image object detection models.
 

.google.cloud.automl.v1.ImageObjectDetectionModelMetadata image_object_detection_model_metadata = 20;

Returns:

The imageObjectDetectionModelMetadata.

getImageObjectDetectionModelMetadataOrBuilder

ImageObjectDetectionModelMetadataOrBuilder getImageObjectDetectionModelMetadataOrBuilder()

 Metadata for image object detection models.
 

.google.cloud.automl.v1.ImageObjectDetectionModelMetadata image_object_detection_model_metadata = 20;

hasTextExtractionModelMetadata

boolean hasTextExtractionModelMetadata()

 Metadata for text extraction models.
 

.google.cloud.automl.v1.TextExtractionModelMetadata text_extraction_model_metadata = 19;

Returns:

Whether the textExtractionModelMetadata field is set.

getTextExtractionModelMetadata

TextExtractionModelMetadata getTextExtractionModelMetadata()

 Metadata for text extraction models.
 

.google.cloud.automl.v1.TextExtractionModelMetadata text_extraction_model_metadata = 19;

Returns:

The textExtractionModelMetadata.

getTextExtractionModelMetadataOrBuilder

TextExtractionModelMetadataOrBuilder getTextExtractionModelMetadataOrBuilder()

 Metadata for text extraction models.
 

.google.cloud.automl.v1.TextExtractionModelMetadata text_extraction_model_metadata = 19;

hasTextSentimentModelMetadata

boolean hasTextSentimentModelMetadata()

 Metadata for text sentiment models.
 

.google.cloud.automl.v1.TextSentimentModelMetadata text_sentiment_model_metadata = 22;

Returns:

Whether the textSentimentModelMetadata field is set.

getTextSentimentModelMetadata

TextSentimentModelMetadata getTextSentimentModelMetadata()

 Metadata for text sentiment models.
 

.google.cloud.automl.v1.TextSentimentModelMetadata text_sentiment_model_metadata = 22;

Returns:

The textSentimentModelMetadata.

getTextSentimentModelMetadataOrBuilder

TextSentimentModelMetadataOrBuilder getTextSentimentModelMetadataOrBuilder()

 Metadata for text sentiment models.
 

.google.cloud.automl.v1.TextSentimentModelMetadata text_sentiment_model_metadata = 22;

getName

String getName()

 Output only. Resource name of the model.
 Format: `projects/{project_id}/locations/{location_id}/models/{model_id}`
 

string name = 1;

Returns:

The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 Output only. Resource name of the model.
 Format: `projects/{project_id}/locations/{location_id}/models/{model_id}`
 

string name = 1;

Returns:

The bytes for name.

getDisplayName

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;

Returns:

The displayName.

getDisplayNameBytes

com.google.protobuf.ByteString getDisplayNameBytes()

 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;

Returns:

The bytes for displayName.

getDatasetId

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;

Returns:

The datasetId.

getDatasetIdBytes

com.google.protobuf.ByteString getDatasetIdBytes()

 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;

Returns:

The bytes for datasetId.

hasCreateTime

boolean hasCreateTime()

 Output only. Timestamp when the model training finished  and can be used for prediction.
 

.google.protobuf.Timestamp create_time = 7;

Returns:

Whether the createTime field is set.

getCreateTime

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;

Returns:

The createTime.

getCreateTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()

 Output only. Timestamp when the model training finished  and can be used for prediction.
 

.google.protobuf.Timestamp create_time = 7;

hasUpdateTime

boolean hasUpdateTime()

 Output only. Timestamp when this model was last updated.
 

.google.protobuf.Timestamp update_time = 11;

Returns:

Whether the updateTime field is set.

getUpdateTime

com.google.protobuf.Timestamp getUpdateTime()

 Output only. Timestamp when this model was last updated.
 

.google.protobuf.Timestamp update_time = 11;

Returns:

The updateTime.

getUpdateTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()

 Output only. Timestamp when this model was last updated.
 

.google.protobuf.Timestamp update_time = 11;

getDeploymentStateValue

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;

Returns:

The enum numeric value on the wire for deploymentState.

getDeploymentState

Model.DeploymentState getDeploymentState()

 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;

Returns:

The deploymentState.

getEtag

String getEtag()

 Used to perform a consistent read-modify-write updates. If not set, a blind
 "overwrite" update happens.
 

string etag = 10;

Returns:

The etag.

getEtagBytes

com.google.protobuf.ByteString getEtagBytes()

 Used to perform a consistent read-modify-write updates. If not set, a blind
 "overwrite" update happens.
 

string etag = 10;

Returns:

The bytes for etag.

getLabelsCount

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;

containsLabels

boolean containsLabels(String key)

 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;

getLabels

@Deprecated
Map<String,String> getLabels()

Deprecated.

Use getLabelsMap() instead.

getLabelsMap

Map<String,String> 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;

getLabelsOrDefault

String getLabelsOrDefault(String key,
                          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;

getLabelsOrThrow

String getLabelsOrThrow(String key)

 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;

getModelMetadataCase

Model.ModelMetadataCase getModelMetadataCase()