Class Model

public final class Model extends GeneratedMessageV3 implements ModelOrBuilder

API proto representing a trained machine learning model.

Protobuf type google.cloud.automl.v1beta1.Model

Implements

ModelOrBuilder

Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

DATASET_ID_FIELD_NUMBER

public static final int DATASET_ID_FIELD_NUMBER
Field Value
TypeDescription
int

DEPLOYMENT_STATE_FIELD_NUMBER

public static final int DEPLOYMENT_STATE_FIELD_NUMBER
Field Value
TypeDescription
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

IMAGE_CLASSIFICATION_MODEL_METADATA_FIELD_NUMBER

public static final int IMAGE_CLASSIFICATION_MODEL_METADATA_FIELD_NUMBER
Field Value
TypeDescription
int

IMAGE_OBJECT_DETECTION_MODEL_METADATA_FIELD_NUMBER

public static final int IMAGE_OBJECT_DETECTION_MODEL_METADATA_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

TABLES_MODEL_METADATA_FIELD_NUMBER

public static final int TABLES_MODEL_METADATA_FIELD_NUMBER
Field Value
TypeDescription
int

TEXT_CLASSIFICATION_MODEL_METADATA_FIELD_NUMBER

public static final int TEXT_CLASSIFICATION_MODEL_METADATA_FIELD_NUMBER
Field Value
TypeDescription
int

TEXT_EXTRACTION_MODEL_METADATA_FIELD_NUMBER

public static final int TEXT_EXTRACTION_MODEL_METADATA_FIELD_NUMBER
Field Value
TypeDescription
int

TEXT_SENTIMENT_MODEL_METADATA_FIELD_NUMBER

public static final int TEXT_SENTIMENT_MODEL_METADATA_FIELD_NUMBER
Field Value
TypeDescription
int

TRANSLATION_MODEL_METADATA_FIELD_NUMBER

public static final int TRANSLATION_MODEL_METADATA_FIELD_NUMBER
Field Value
TypeDescription
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

VIDEO_CLASSIFICATION_MODEL_METADATA_FIELD_NUMBER

public static final int VIDEO_CLASSIFICATION_MODEL_METADATA_FIELD_NUMBER
Field Value
TypeDescription
int

VIDEO_OBJECT_TRACKING_MODEL_METADATA_FIELD_NUMBER

public static final int VIDEO_OBJECT_TRACKING_MODEL_METADATA_FIELD_NUMBER
Field Value
TypeDescription
int

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for datasetId.

getDefaultInstance()

public static Model getDefaultInstance()
Returns
TypeDescription
Model

getDefaultInstanceForType()

public Model getDefaultInstanceForType()
Returns
TypeDescription
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.v1beta1.Model.DeploymentState deployment_state = 8;

Returns
TypeDescription
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.v1beta1.Model.DeploymentState deployment_state = 8;

Returns
TypeDescription
int

The enum numeric value on the wire for deploymentState.

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

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
TypeDescription
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
TypeDescription
ByteString

The bytes for displayName.

getImageClassificationModelMetadata()

public ImageClassificationModelMetadata getImageClassificationModelMetadata()

Metadata for image classification models.

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

Returns
TypeDescription
ImageClassificationModelMetadata

The imageClassificationModelMetadata.

getImageClassificationModelMetadataOrBuilder()

public ImageClassificationModelMetadataOrBuilder getImageClassificationModelMetadataOrBuilder()

Metadata for image classification models.

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

Returns
TypeDescription
ImageClassificationModelMetadataOrBuilder

getImageObjectDetectionModelMetadata()

public ImageObjectDetectionModelMetadata getImageObjectDetectionModelMetadata()

Metadata for image object detection models.

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

Returns
TypeDescription
ImageObjectDetectionModelMetadata

The imageObjectDetectionModelMetadata.

getImageObjectDetectionModelMetadataOrBuilder()

public ImageObjectDetectionModelMetadataOrBuilder getImageObjectDetectionModelMetadataOrBuilder()

Metadata for image object detection models.

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

Returns
TypeDescription
ImageObjectDetectionModelMetadataOrBuilder

getModelMetadataCase()

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

The bytes for name.

getParserForType()

public Parser<Model> getParserForType()
Returns
TypeDescription
Parser<Model>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getTablesModelMetadata()

public TablesModelMetadata getTablesModelMetadata()

Metadata for Tables models.

.google.cloud.automl.v1beta1.TablesModelMetadata tables_model_metadata = 24;

Returns
TypeDescription
TablesModelMetadata

The tablesModelMetadata.

getTablesModelMetadataOrBuilder()

public TablesModelMetadataOrBuilder getTablesModelMetadataOrBuilder()

Metadata for Tables models.

.google.cloud.automl.v1beta1.TablesModelMetadata tables_model_metadata = 24;

Returns
TypeDescription
TablesModelMetadataOrBuilder

getTextClassificationModelMetadata()

public TextClassificationModelMetadata getTextClassificationModelMetadata()

Metadata for text classification models.

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

Returns
TypeDescription
TextClassificationModelMetadata

The textClassificationModelMetadata.

getTextClassificationModelMetadataOrBuilder()

public TextClassificationModelMetadataOrBuilder getTextClassificationModelMetadataOrBuilder()

Metadata for text classification models.

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

Returns
TypeDescription
TextClassificationModelMetadataOrBuilder

getTextExtractionModelMetadata()

public TextExtractionModelMetadata getTextExtractionModelMetadata()

Metadata for text extraction models.

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

Returns
TypeDescription
TextExtractionModelMetadata

The textExtractionModelMetadata.

getTextExtractionModelMetadataOrBuilder()

public TextExtractionModelMetadataOrBuilder getTextExtractionModelMetadataOrBuilder()

Metadata for text extraction models.

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

Returns
TypeDescription
TextExtractionModelMetadataOrBuilder

getTextSentimentModelMetadata()

public TextSentimentModelMetadata getTextSentimentModelMetadata()

Metadata for text sentiment models.

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

Returns
TypeDescription
TextSentimentModelMetadata

The textSentimentModelMetadata.

getTextSentimentModelMetadataOrBuilder()

public TextSentimentModelMetadataOrBuilder getTextSentimentModelMetadataOrBuilder()

Metadata for text sentiment models.

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

Returns
TypeDescription
TextSentimentModelMetadataOrBuilder

getTranslationModelMetadata()

public TranslationModelMetadata getTranslationModelMetadata()

Metadata for translation models.

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

Returns
TypeDescription
TranslationModelMetadata

The translationModelMetadata.

getTranslationModelMetadataOrBuilder()

public TranslationModelMetadataOrBuilder getTranslationModelMetadataOrBuilder()

Metadata for translation models.

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

Returns
TypeDescription
TranslationModelMetadataOrBuilder

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Timestamp when this model was last updated.

.google.protobuf.Timestamp update_time = 11;

Returns
TypeDescription
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Timestamp when this model was last updated.

.google.protobuf.Timestamp update_time = 11;

Returns
TypeDescription
TimestampOrBuilder

getVideoClassificationModelMetadata()

public VideoClassificationModelMetadata getVideoClassificationModelMetadata()

Metadata for video classification models.

.google.cloud.automl.v1beta1.VideoClassificationModelMetadata video_classification_model_metadata = 23;

Returns
TypeDescription
VideoClassificationModelMetadata

The videoClassificationModelMetadata.

getVideoClassificationModelMetadataOrBuilder()

public VideoClassificationModelMetadataOrBuilder getVideoClassificationModelMetadataOrBuilder()

Metadata for video classification models.

.google.cloud.automl.v1beta1.VideoClassificationModelMetadata video_classification_model_metadata = 23;

Returns
TypeDescription
VideoClassificationModelMetadataOrBuilder

getVideoObjectTrackingModelMetadata()

public VideoObjectTrackingModelMetadata getVideoObjectTrackingModelMetadata()

Metadata for video object tracking models.

.google.cloud.automl.v1beta1.VideoObjectTrackingModelMetadata video_object_tracking_model_metadata = 21;

Returns
TypeDescription
VideoObjectTrackingModelMetadata

The videoObjectTrackingModelMetadata.

getVideoObjectTrackingModelMetadataOrBuilder()

public VideoObjectTrackingModelMetadataOrBuilder getVideoObjectTrackingModelMetadataOrBuilder()

Metadata for video object tracking models.

.google.cloud.automl.v1beta1.VideoObjectTrackingModelMetadata video_object_tracking_model_metadata = 21;

Returns
TypeDescription
VideoObjectTrackingModelMetadataOrBuilder

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
TypeDescription
boolean

Whether the createTime field is set.

hasImageClassificationModelMetadata()

public boolean hasImageClassificationModelMetadata()

Metadata for image classification models.

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

Returns
TypeDescription
boolean

Whether the imageClassificationModelMetadata field is set.

hasImageObjectDetectionModelMetadata()

public boolean hasImageObjectDetectionModelMetadata()

Metadata for image object detection models.

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

Returns
TypeDescription
boolean

Whether the imageObjectDetectionModelMetadata field is set.

hasTablesModelMetadata()

public boolean hasTablesModelMetadata()

Metadata for Tables models.

.google.cloud.automl.v1beta1.TablesModelMetadata tables_model_metadata = 24;

Returns
TypeDescription
boolean

Whether the tablesModelMetadata field is set.

hasTextClassificationModelMetadata()

public boolean hasTextClassificationModelMetadata()

Metadata for text classification models.

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

Returns
TypeDescription
boolean

Whether the textClassificationModelMetadata field is set.

hasTextExtractionModelMetadata()

public boolean hasTextExtractionModelMetadata()

Metadata for text extraction models.

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

Returns
TypeDescription
boolean

Whether the textExtractionModelMetadata field is set.

hasTextSentimentModelMetadata()

public boolean hasTextSentimentModelMetadata()

Metadata for text sentiment models.

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

Returns
TypeDescription
boolean

Whether the textSentimentModelMetadata field is set.

hasTranslationModelMetadata()

public boolean hasTranslationModelMetadata()

Metadata for translation models.

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

Returns
TypeDescription
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
TypeDescription
boolean

Whether the updateTime field is set.

hasVideoClassificationModelMetadata()

public boolean hasVideoClassificationModelMetadata()

Metadata for video classification models.

.google.cloud.automl.v1beta1.VideoClassificationModelMetadata video_classification_model_metadata = 23;

Returns
TypeDescription
boolean

Whether the videoClassificationModelMetadata field is set.

hasVideoObjectTrackingModelMetadata()

public boolean hasVideoObjectTrackingModelMetadata()

Metadata for video object tracking models.

.google.cloud.automl.v1beta1.VideoObjectTrackingModelMetadata video_object_tracking_model_metadata = 21;

Returns
TypeDescription
boolean

Whether the videoObjectTrackingModelMetadata field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilder()

public static Model.Builder newBuilder()
Returns
TypeDescription
Model.Builder

newBuilder(Model prototype)

public static Model.Builder newBuilder(Model prototype)
Parameter
NameDescription
prototypeModel
Returns
TypeDescription
Model.Builder

newBuilderForType()

public Model.Builder newBuilderForType()
Returns
TypeDescription
Model.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Model.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Model.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

parseDelimitedFrom(InputStream input)

public static Model parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Model
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Model parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Model
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Model parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Model
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Model parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Model
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Model parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Model
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Model parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Model
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Model parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Model
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Model parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Model
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Model parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Model
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Model parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Model
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Model parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Model
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Model parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Model
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Model> parser()
Returns
TypeDescription
Parser<Model>

toBuilder()

public Model.Builder toBuilder()
Returns
TypeDescription
Model.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException