Package com.google.cloud.automl.v1

Class Model

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.automl.v1.Model
All Implemented Interfaces:
ModelOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Model extends com.google.protobuf.GeneratedMessage implements ModelOrBuilder
 API proto representing a trained machine learning model.
Protobuf type google.cloud.automl.v1.Model
See Also:

  • Field Details

    • TRANSLATION_MODEL_METADATA_FIELD_NUMBER

      public static final int TRANSLATION_MODEL_METADATA_FIELD_NUMBER
      See Also:

    • IMAGE_CLASSIFICATION_MODEL_METADATA_FIELD_NUMBER

      public static final int IMAGE_CLASSIFICATION_MODEL_METADATA_FIELD_NUMBER
      See Also:

    • TEXT_CLASSIFICATION_MODEL_METADATA_FIELD_NUMBER

      public static final int TEXT_CLASSIFICATION_MODEL_METADATA_FIELD_NUMBER
      See Also:

    • IMAGE_OBJECT_DETECTION_MODEL_METADATA_FIELD_NUMBER

      public static final int IMAGE_OBJECT_DETECTION_MODEL_METADATA_FIELD_NUMBER
      See Also:

    • TEXT_EXTRACTION_MODEL_METADATA_FIELD_NUMBER

      public static final int TEXT_EXTRACTION_MODEL_METADATA_FIELD_NUMBER
      See Also:

    • TEXT_SENTIMENT_MODEL_METADATA_FIELD_NUMBER

      public static final int TEXT_SENTIMENT_MODEL_METADATA_FIELD_NUMBER
      See Also:

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • DISPLAY_NAME_FIELD_NUMBER

      public static final int DISPLAY_NAME_FIELD_NUMBER
      See Also:

    • DATASET_ID_FIELD_NUMBER

      public static final int DATASET_ID_FIELD_NUMBER
      See Also:

    • CREATE_TIME_FIELD_NUMBER

      public static final int CREATE_TIME_FIELD_NUMBER
      See Also:

    • UPDATE_TIME_FIELD_NUMBER

      public static final int UPDATE_TIME_FIELD_NUMBER
      See Also:

    • DEPLOYMENT_STATE_FIELD_NUMBER

      public static final int DEPLOYMENT_STATE_FIELD_NUMBER
      See Also:

    • ETAG_FIELD_NUMBER

      public static final int ETAG_FIELD_NUMBER
      See Also:

    • LABELS_FIELD_NUMBER

      public static final int LABELS_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getModelMetadataCase

      public Model.ModelMetadataCase getModelMetadataCase()
      Specified by:
      getModelMetadataCase in interface ModelOrBuilder

    • hasTranslationModelMetadata

      public boolean hasTranslationModelMetadata()
       Metadata for translation models.
      .google.cloud.automl.v1.TranslationModelMetadata translation_model_metadata = 15;
      Specified by:
      hasTranslationModelMetadata in interface ModelOrBuilder
      Returns:
      Whether the translationModelMetadata field is set.

    • getTranslationModelMetadata

      public TranslationModelMetadata getTranslationModelMetadata()
       Metadata for translation models.
      .google.cloud.automl.v1.TranslationModelMetadata translation_model_metadata = 15;
      Specified by:
      getTranslationModelMetadata in interface ModelOrBuilder
      Returns:
      The translationModelMetadata.

    • getTranslationModelMetadataOrBuilder

      public TranslationModelMetadataOrBuilder getTranslationModelMetadataOrBuilder()
       Metadata for translation models.
      .google.cloud.automl.v1.TranslationModelMetadata translation_model_metadata = 15;
      Specified by:
      getTranslationModelMetadataOrBuilder in interface ModelOrBuilder

    • hasImageClassificationModelMetadata

      public boolean hasImageClassificationModelMetadata()
       Metadata for image classification models.
      .google.cloud.automl.v1.ImageClassificationModelMetadata image_classification_model_metadata = 13;
      Specified by:
      hasImageClassificationModelMetadata in interface ModelOrBuilder
      Returns:
      Whether the imageClassificationModelMetadata field is set.

    • getImageClassificationModelMetadata

      public ImageClassificationModelMetadata getImageClassificationModelMetadata()
       Metadata for image classification models.
      .google.cloud.automl.v1.ImageClassificationModelMetadata image_classification_model_metadata = 13;
      Specified by:
      getImageClassificationModelMetadata in interface ModelOrBuilder
      Returns:
      The imageClassificationModelMetadata.

    • getImageClassificationModelMetadataOrBuilder

      public ImageClassificationModelMetadataOrBuilder getImageClassificationModelMetadataOrBuilder()
       Metadata for image classification models.
      .google.cloud.automl.v1.ImageClassificationModelMetadata image_classification_model_metadata = 13;
      Specified by:
      getImageClassificationModelMetadataOrBuilder in interface ModelOrBuilder

    • hasTextClassificationModelMetadata

      public boolean hasTextClassificationModelMetadata()
       Metadata for text classification models.
      .google.cloud.automl.v1.TextClassificationModelMetadata text_classification_model_metadata = 14;
      Specified by:
      hasTextClassificationModelMetadata in interface ModelOrBuilder
      Returns:
      Whether the textClassificationModelMetadata field is set.

    • getTextClassificationModelMetadata

      public TextClassificationModelMetadata getTextClassificationModelMetadata()
       Metadata for text classification models.
      .google.cloud.automl.v1.TextClassificationModelMetadata text_classification_model_metadata = 14;
      Specified by:
      getTextClassificationModelMetadata in interface ModelOrBuilder
      Returns:
      The textClassificationModelMetadata.

    • getTextClassificationModelMetadataOrBuilder

      public TextClassificationModelMetadataOrBuilder getTextClassificationModelMetadataOrBuilder()
       Metadata for text classification models.
      .google.cloud.automl.v1.TextClassificationModelMetadata text_classification_model_metadata = 14;
      Specified by:
      getTextClassificationModelMetadataOrBuilder in interface ModelOrBuilder

    • hasImageObjectDetectionModelMetadata

      public boolean hasImageObjectDetectionModelMetadata()
       Metadata for image object detection models.
      .google.cloud.automl.v1.ImageObjectDetectionModelMetadata image_object_detection_model_metadata = 20;
      Specified by:
      hasImageObjectDetectionModelMetadata in interface ModelOrBuilder
      Returns:
      Whether the imageObjectDetectionModelMetadata field is set.

    • getImageObjectDetectionModelMetadata

      public ImageObjectDetectionModelMetadata getImageObjectDetectionModelMetadata()
       Metadata for image object detection models.
      .google.cloud.automl.v1.ImageObjectDetectionModelMetadata image_object_detection_model_metadata = 20;
      Specified by:
      getImageObjectDetectionModelMetadata in interface ModelOrBuilder
      Returns:
      The imageObjectDetectionModelMetadata.

    • getImageObjectDetectionModelMetadataOrBuilder

      public ImageObjectDetectionModelMetadataOrBuilder getImageObjectDetectionModelMetadataOrBuilder()
       Metadata for image object detection models.
      .google.cloud.automl.v1.ImageObjectDetectionModelMetadata image_object_detection_model_metadata = 20;
      Specified by:
      getImageObjectDetectionModelMetadataOrBuilder in interface ModelOrBuilder

    • hasTextExtractionModelMetadata

      public boolean hasTextExtractionModelMetadata()
       Metadata for text extraction models.
      .google.cloud.automl.v1.TextExtractionModelMetadata text_extraction_model_metadata = 19;
      Specified by:
      hasTextExtractionModelMetadata in interface ModelOrBuilder
      Returns:
      Whether the textExtractionModelMetadata field is set.

    • getTextExtractionModelMetadata

      public TextExtractionModelMetadata getTextExtractionModelMetadata()
       Metadata for text extraction models.
      .google.cloud.automl.v1.TextExtractionModelMetadata text_extraction_model_metadata = 19;
      Specified by:
      getTextExtractionModelMetadata in interface ModelOrBuilder
      Returns:
      The textExtractionModelMetadata.

    • getTextExtractionModelMetadataOrBuilder

      public TextExtractionModelMetadataOrBuilder getTextExtractionModelMetadataOrBuilder()
       Metadata for text extraction models.
      .google.cloud.automl.v1.TextExtractionModelMetadata text_extraction_model_metadata = 19;
      Specified by:
      getTextExtractionModelMetadataOrBuilder in interface ModelOrBuilder

    • hasTextSentimentModelMetadata

      public boolean hasTextSentimentModelMetadata()
       Metadata for text sentiment models.
      .google.cloud.automl.v1.TextSentimentModelMetadata text_sentiment_model_metadata = 22;
      Specified by:
      hasTextSentimentModelMetadata in interface ModelOrBuilder
      Returns:
      Whether the textSentimentModelMetadata field is set.

    • getTextSentimentModelMetadata

      public TextSentimentModelMetadata getTextSentimentModelMetadata()
       Metadata for text sentiment models.
      .google.cloud.automl.v1.TextSentimentModelMetadata text_sentiment_model_metadata = 22;
      Specified by:
      getTextSentimentModelMetadata in interface ModelOrBuilder
      Returns:
      The textSentimentModelMetadata.

    • getTextSentimentModelMetadataOrBuilder

      public TextSentimentModelMetadataOrBuilder getTextSentimentModelMetadataOrBuilder()
       Metadata for text sentiment models.
      .google.cloud.automl.v1.TextSentimentModelMetadata text_sentiment_model_metadata = 22;
      Specified by:
      getTextSentimentModelMetadataOrBuilder in interface ModelOrBuilder

    • getName

      public String getName()
       Output only. Resource name of the model.
 Format: `projects/{project_id}/locations/{location_id}/models/{model_id}`
      string name = 1;
      Specified by:
      getName in interface ModelOrBuilder
      Returns:
      The name.

    • getNameBytes

      public 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;
      Specified by:
      getNameBytes in interface ModelOrBuilder
      Returns:
      The bytes for name.

    • 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;
      Specified by:
      getDisplayName in interface ModelOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

      public 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;
      Specified by:
      getDisplayNameBytes in interface ModelOrBuilder
      Returns:
      The bytes for displayName.

    • 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;
      Specified by:
      getDatasetId in interface ModelOrBuilder
      Returns:
      The datasetId.

    • getDatasetIdBytes

      public 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;
      Specified by:
      getDatasetIdBytes in interface ModelOrBuilder
      Returns:
      The bytes for datasetId.

    • hasCreateTime

      public boolean hasCreateTime()
       Output only. Timestamp when the model training finished  and can be used for prediction.
      .google.protobuf.Timestamp create_time = 7;
      Specified by:
      hasCreateTime in interface ModelOrBuilder
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      public 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;
      Specified by:
      getCreateTime in interface ModelOrBuilder
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      public 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;
      Specified by:
      getCreateTimeOrBuilder in interface ModelOrBuilder

    • hasUpdateTime

      public boolean hasUpdateTime()
       Output only. Timestamp when this model was last updated.
      .google.protobuf.Timestamp update_time = 11;
      Specified by:
      hasUpdateTime in interface ModelOrBuilder
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      public com.google.protobuf.Timestamp getUpdateTime()
       Output only. Timestamp when this model was last updated.
      .google.protobuf.Timestamp update_time = 11;
      Specified by:
      getUpdateTime in interface ModelOrBuilder
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. Timestamp when this model was last updated.
      .google.protobuf.Timestamp update_time = 11;
      Specified by:
      getUpdateTimeOrBuilder in interface ModelOrBuilder

    • 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;
      Specified by:
      getDeploymentStateValue in interface ModelOrBuilder
      Returns:
      The enum numeric value on the wire for deploymentState.

    • 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;
      Specified by:
      getDeploymentState in interface ModelOrBuilder
      Returns:
      The deploymentState.

    • getEtag

      public String getEtag()
       Used to perform a consistent read-modify-write updates. If not set, a blind
 "overwrite" update happens.
      string etag = 10;
      Specified by:
      getEtag in interface ModelOrBuilder
      Returns:
      The etag.

    • getEtagBytes

      public 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;
      Specified by:
      getEtagBytes in interface ModelOrBuilder
      Returns:
      The bytes for etag.

    • getLabelsCount

      public int getLabelsCount()
      Description copied from interface: ModelOrBuilder
       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;
      Specified by:
      getLabelsCount in interface ModelOrBuilder

    • containsLabels

      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;
      Specified by:
      containsLabels in interface ModelOrBuilder

    • getLabels

      @Deprecated public Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.
      Specified by:
      getLabels in interface ModelOrBuilder

    • 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;
      Specified by:
      getLabelsMap in interface ModelOrBuilder

    • getLabelsOrDefault

      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;
      Specified by:
      getLabelsOrDefault in interface ModelOrBuilder

    • getLabelsOrThrow

      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;
      Specified by:
      getLabelsOrThrow in interface ModelOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Model parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Model parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Model parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Model parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Model parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Model parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Model parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Model parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Model parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Model parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Model parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Model parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Model.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Model.Builder newBuilder()

    • newBuilder

      public static Model.Builder newBuilder(Model prototype)

    • toBuilder

      public Model.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Model.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Model getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Model> parser()

    • getParserForType

      public com.google.protobuf.Parser<Model> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public Model getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder