Class Model (2.51.0)

public final class Model extends GeneratedMessageV3 implements ModelOrBuilder

API proto representing a trained machine learning model.

Protobuf type google.cloud.automl.v1.Model

Implements

ModelOrBuilder

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DATASET_ID_FIELD_NUMBER

public static final int DATASET_ID_FIELD_NUMBER
Field Value
Type Description
int

DEPLOYMENT_STATE_FIELD_NUMBER

public static final int DEPLOYMENT_STATE_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

ETAG_FIELD_NUMBER

public static final int ETAG_FIELD_NUMBER
Field Value
Type Description
int

IMAGE_CLASSIFICATION_MODEL_METADATA_FIELD_NUMBER

public static final int IMAGE_CLASSIFICATION_MODEL_METADATA_FIELD_NUMBER
Field Value
Type Description
int

IMAGE_OBJECT_DETECTION_MODEL_METADATA_FIELD_NUMBER

public static final int IMAGE_OBJECT_DETECTION_MODEL_METADATA_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

TEXT_CLASSIFICATION_MODEL_METADATA_FIELD_NUMBER

public static final int TEXT_CLASSIFICATION_MODEL_METADATA_FIELD_NUMBER
Field Value
Type Description
int

TEXT_EXTRACTION_MODEL_METADATA_FIELD_NUMBER

public static final int TEXT_EXTRACTION_MODEL_METADATA_FIELD_NUMBER
Field Value
Type Description
int

TEXT_SENTIMENT_MODEL_METADATA_FIELD_NUMBER

public static final int TEXT_SENTIMENT_MODEL_METADATA_FIELD_NUMBER
Field Value
Type Description
int

TRANSLATION_MODEL_METADATA_FIELD_NUMBER

public static final int TRANSLATION_MODEL_METADATA_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Model getDefaultInstance()
Returns
Type Description
Model

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Model.Builder newBuilder()
Returns
Type Description
Model.Builder

newBuilder(Model prototype)

public static Model.Builder newBuilder(Model prototype)
Parameter
Name Description
prototype Model
Returns
Type Description
Model.Builder

parseDelimitedFrom(InputStream input)

public static Model parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Model
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Model parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Model
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Model parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Model
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Model parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Model
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Model parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Model
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Model parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Model
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Model parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Model
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Model parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Model
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Model parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Model
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Model parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Model
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Model parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Model
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Model parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Model
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Model> parser()
Returns
Type Description
Parser<Model>

Methods

containsLabels(String key)

public 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

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCreateTime()

public 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 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 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 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.

getDefaultInstanceForType()

public Model getDefaultInstanceForType()
Returns
Type Description
Model

getDeploymentState()

public 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 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 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 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 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 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 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 ImageClassificationModelMetadataOrBuilder getImageClassificationModelMetadataOrBuilder()

Metadata for image classification models.

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

Returns
Type Description
ImageClassificationModelMetadataOrBuilder

getImageObjectDetectionModelMetadata()

public 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 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 Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public 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 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 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 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 Model.ModelMetadataCase getModelMetadataCase()
Returns
Type Description
Model.ModelMetadataCase

getName()

public 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 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.

getParserForType()

public Parser<Model> getParserForType()
Returns
Type Description
Parser<Model>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTextClassificationModelMetadata()

public 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 TextClassificationModelMetadataOrBuilder getTextClassificationModelMetadataOrBuilder()

Metadata for text classification models.

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

Returns
Type Description
TextClassificationModelMetadataOrBuilder

getTextExtractionModelMetadata()

public 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 TextExtractionModelMetadataOrBuilder getTextExtractionModelMetadataOrBuilder()

Metadata for text extraction models.

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

Returns
Type Description
TextExtractionModelMetadataOrBuilder

getTextSentimentModelMetadata()

public 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 TextSentimentModelMetadataOrBuilder getTextSentimentModelMetadataOrBuilder()

Metadata for text sentiment models.

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

Returns
Type Description
TextSentimentModelMetadataOrBuilder

getTranslationModelMetadata()

public TranslationModelMetadata getTranslationModelMetadata()

Metadata for translation models.

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

Returns
Type Description
TranslationModelMetadata

The translationModelMetadata.

getTranslationModelMetadataOrBuilder()

public TranslationModelMetadataOrBuilder getTranslationModelMetadataOrBuilder()

Metadata for translation models.

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

Returns
Type Description
TranslationModelMetadataOrBuilder

getUpdateTime()

public 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 TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Timestamp when this model was last updated.

.google.protobuf.Timestamp update_time = 11;

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public 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 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 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 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 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 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 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 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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Model.Builder newBuilderForType()
Returns
Type Description
Model.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Model.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Model.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Model.Builder toBuilder()
Returns
Type Description
Model.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException