Interface ModelOrBuilder (2.48.0)

Version 2.48.0

• 2.53.0 (latest)
• 2.52.0
• 2.51.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.18
• 2.2.3
• 2.1.23

public interface ModelOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract 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;

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getCreateTime()

public abstract Timestamp getCreateTime()

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

.google.protobuf.Timestamp create_time = 7;

Returns
Type	Description
Timestamp	The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

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

.google.protobuf.Timestamp create_time = 7;

Returns
Type	Description
TimestampOrBuilder

getDatasetId()

public abstract 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
Type	Description
String	The datasetId.

getDatasetIdBytes()

public abstract 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
Type	Description
ByteString	The bytes for datasetId.

getDeploymentState()

public abstract 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
Type	Description
Model.DeploymentState	The deploymentState.

getDeploymentStateValue()

public abstract 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
Type	Description
int	The enum numeric value on the wire for deploymentState.

getDisplayName()

public abstract 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
Type	Description
String	The displayName.

getDisplayNameBytes()

public abstract 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
Type	Description
ByteString	The bytes for displayName.

getEtag()

public abstract String getEtag()

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

string etag = 10;

Returns
Type	Description
String	The etag.

getEtagBytes()

public abstract ByteString getEtagBytes()

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

string etag = 10;

Returns
Type	Description
ByteString	The bytes for etag.

getImageClassificationModelMetadata()

public abstract ImageClassificationModelMetadata getImageClassificationModelMetadata()

Metadata for image classification models.

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

Returns
Type	Description
ImageClassificationModelMetadata	The imageClassificationModelMetadata.

getImageClassificationModelMetadataOrBuilder()

public abstract ImageClassificationModelMetadataOrBuilder getImageClassificationModelMetadataOrBuilder()

Metadata for image classification models.

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

Returns
Type	Description
ImageClassificationModelMetadataOrBuilder

getImageObjectDetectionModelMetadata()

public abstract ImageObjectDetectionModelMetadata getImageObjectDetectionModelMetadata()

Metadata for image object detection models.

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

Returns
Type	Description
ImageObjectDetectionModelMetadata	The imageObjectDetectionModelMetadata.

getImageObjectDetectionModelMetadataOrBuilder()

public abstract ImageObjectDetectionModelMetadataOrBuilder getImageObjectDetectionModelMetadataOrBuilder()

Metadata for image object detection models.

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

Returns
Type	Description
ImageObjectDetectionModelMetadataOrBuilder

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
Map<String,String>

getLabelsCount()

public abstract 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;

Returns
Type	Description
int

getLabelsMap()

public abstract 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;

Returns
Type	Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract 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;

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getLabelsOrThrow(String key)

public abstract 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;

Parameter
Name	Description
key	String

Returns
Type	Description
String

getModelMetadataCase()

public abstract Model.ModelMetadataCase getModelMetadataCase()

Returns
Type	Description
Model.ModelMetadataCase

getName()

public abstract String getName()

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

string name = 1;

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

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

string name = 1;

Returns
Type	Description
ByteString	The bytes for name.

getTextClassificationModelMetadata()

public abstract TextClassificationModelMetadata getTextClassificationModelMetadata()

Metadata for text classification models.

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

Returns
Type	Description
TextClassificationModelMetadata	The textClassificationModelMetadata.

getTextClassificationModelMetadataOrBuilder()

public abstract TextClassificationModelMetadataOrBuilder getTextClassificationModelMetadataOrBuilder()

Metadata for text classification models.

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

Returns
Type	Description
TextClassificationModelMetadataOrBuilder

getTextExtractionModelMetadata()

public abstract TextExtractionModelMetadata getTextExtractionModelMetadata()

Metadata for text extraction models.

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

Returns
Type	Description
TextExtractionModelMetadata	The textExtractionModelMetadata.

getTextExtractionModelMetadataOrBuilder()

public abstract TextExtractionModelMetadataOrBuilder getTextExtractionModelMetadataOrBuilder()

Metadata for text extraction models.

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

Returns
Type	Description
TextExtractionModelMetadataOrBuilder

getTextSentimentModelMetadata()

public abstract TextSentimentModelMetadata getTextSentimentModelMetadata()

Metadata for text sentiment models.

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

Returns
Type	Description
TextSentimentModelMetadata	The textSentimentModelMetadata.

getTextSentimentModelMetadataOrBuilder()

public abstract TextSentimentModelMetadataOrBuilder getTextSentimentModelMetadataOrBuilder()

Metadata for text sentiment models.

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

Returns
Type	Description
TextSentimentModelMetadataOrBuilder

getTranslationModelMetadata()

public abstract TranslationModelMetadata getTranslationModelMetadata()

Metadata for translation models.

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

Returns
Type	Description
TranslationModelMetadata	The translationModelMetadata.

getTranslationModelMetadataOrBuilder()

public abstract TranslationModelMetadataOrBuilder getTranslationModelMetadataOrBuilder()

Metadata for translation models.

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

Returns
Type	Description
TranslationModelMetadataOrBuilder

getUpdateTime()

public abstract Timestamp getUpdateTime()

Output only. Timestamp when this model was last updated.

.google.protobuf.Timestamp update_time = 11;

Returns
Type	Description
Timestamp	The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Timestamp when this model was last updated.

.google.protobuf.Timestamp update_time = 11;

Returns
Type	Description
TimestampOrBuilder

hasCreateTime()

public abstract boolean hasCreateTime()

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

.google.protobuf.Timestamp create_time = 7;

Returns
Type	Description
boolean	Whether the createTime field is set.

hasImageClassificationModelMetadata()

public abstract boolean hasImageClassificationModelMetadata()

Metadata for image classification models.

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

Returns
Type	Description
boolean	Whether the imageClassificationModelMetadata field is set.

hasImageObjectDetectionModelMetadata()

public abstract boolean hasImageObjectDetectionModelMetadata()

Metadata for image object detection models.

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

Returns
Type	Description
boolean	Whether the imageObjectDetectionModelMetadata field is set.

hasTextClassificationModelMetadata()

public abstract boolean hasTextClassificationModelMetadata()

Metadata for text classification models.

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

Returns
Type	Description
boolean	Whether the textClassificationModelMetadata field is set.

hasTextExtractionModelMetadata()

public abstract boolean hasTextExtractionModelMetadata()

Metadata for text extraction models.

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

Returns
Type	Description
boolean	Whether the textExtractionModelMetadata field is set.

hasTextSentimentModelMetadata()

public abstract boolean hasTextSentimentModelMetadata()

Metadata for text sentiment models.

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

Returns
Type	Description
boolean	Whether the textSentimentModelMetadata field is set.

hasTranslationModelMetadata()

public abstract boolean hasTranslationModelMetadata()

Metadata for translation models.

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

Returns
Type	Description
boolean	Whether the translationModelMetadata field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

Output only. Timestamp when this model was last updated.

.google.protobuf.Timestamp update_time = 11;

Returns
Type	Description
boolean	Whether the updateTime field is set.