Package com.google.cloud.automl.v1

Class Dataset

  • All Implemented Interfaces:
    DatasetOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Dataset
extends com.google.protobuf.GeneratedMessageV3
implements DatasetOrBuilder
     A workspace for solving a single, particular machine learning (ML) problem.
 A workspace contains examples that may be annotated.
    Protobuf type google.cloud.automl.v1.Dataset
    See Also:
    Serialized Form

    • Field Detail

      • TRANSLATION_DATASET_METADATA_FIELD_NUMBER

        public static final int TRANSLATION_DATASET_METADATA_FIELD_NUMBER
        See Also:
        Constant Field Values

      • IMAGE_CLASSIFICATION_DATASET_METADATA_FIELD_NUMBER

        public static final int IMAGE_CLASSIFICATION_DATASET_METADATA_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TEXT_CLASSIFICATION_DATASET_METADATA_FIELD_NUMBER

        public static final int TEXT_CLASSIFICATION_DATASET_METADATA_FIELD_NUMBER
        See Also:
        Constant Field Values

      • IMAGE_OBJECT_DETECTION_DATASET_METADATA_FIELD_NUMBER

        public static final int IMAGE_OBJECT_DETECTION_DATASET_METADATA_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TEXT_EXTRACTION_DATASET_METADATA_FIELD_NUMBER

        public static final int TEXT_EXTRACTION_DATASET_METADATA_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TEXT_SENTIMENT_DATASET_METADATA_FIELD_NUMBER

        public static final int TEXT_SENTIMENT_DATASET_METADATA_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DISPLAY_NAME_FIELD_NUMBER

        public static final int DISPLAY_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DESCRIPTION_FIELD_NUMBER

        public static final int DESCRIPTION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • EXAMPLE_COUNT_FIELD_NUMBER

        public static final int EXAMPLE_COUNT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CREATE_TIME_FIELD_NUMBER

        public static final int CREATE_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

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

      • hasTranslationDatasetMetadata

        public boolean hasTranslationDatasetMetadata()
         Metadata for a dataset used for translation.
        .google.cloud.automl.v1.TranslationDatasetMetadata translation_dataset_metadata = 23;
        Specified by:
        hasTranslationDatasetMetadata in interface DatasetOrBuilder
        Returns:
        Whether the translationDatasetMetadata field is set.

      • hasImageClassificationDatasetMetadata

        public boolean hasImageClassificationDatasetMetadata()
         Metadata for a dataset used for image classification.
        .google.cloud.automl.v1.ImageClassificationDatasetMetadata image_classification_dataset_metadata = 24;
        Specified by:
        hasImageClassificationDatasetMetadata in interface DatasetOrBuilder
        Returns:
        Whether the imageClassificationDatasetMetadata field is set.

      • hasTextClassificationDatasetMetadata

        public boolean hasTextClassificationDatasetMetadata()
         Metadata for a dataset used for text classification.
        .google.cloud.automl.v1.TextClassificationDatasetMetadata text_classification_dataset_metadata = 25;
        Specified by:
        hasTextClassificationDatasetMetadata in interface DatasetOrBuilder
        Returns:
        Whether the textClassificationDatasetMetadata field is set.

      • hasImageObjectDetectionDatasetMetadata

        public boolean hasImageObjectDetectionDatasetMetadata()
         Metadata for a dataset used for image object detection.
        .google.cloud.automl.v1.ImageObjectDetectionDatasetMetadata image_object_detection_dataset_metadata = 26;
        Specified by:
        hasImageObjectDetectionDatasetMetadata in interface DatasetOrBuilder
        Returns:
        Whether the imageObjectDetectionDatasetMetadata field is set.

      • hasTextExtractionDatasetMetadata

        public boolean hasTextExtractionDatasetMetadata()
         Metadata for a dataset used for text extraction.
        .google.cloud.automl.v1.TextExtractionDatasetMetadata text_extraction_dataset_metadata = 28;
        Specified by:
        hasTextExtractionDatasetMetadata in interface DatasetOrBuilder
        Returns:
        Whether the textExtractionDatasetMetadata field is set.

      • hasTextSentimentDatasetMetadata

        public boolean hasTextSentimentDatasetMetadata()
         Metadata for a dataset used for text sentiment.
        .google.cloud.automl.v1.TextSentimentDatasetMetadata text_sentiment_dataset_metadata = 30;
        Specified by:
        hasTextSentimentDatasetMetadata in interface DatasetOrBuilder
        Returns:
        Whether the textSentimentDatasetMetadata field is set.

      • getName

        public String getName()
         Output only. The resource name of the dataset.
 Form: `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`
        string name = 1;
        Specified by:
        getName in interface DatasetOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Output only. The resource name of the dataset.
 Form: `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`
        string name = 1;
        Specified by:
        getNameBytes in interface DatasetOrBuilder
        Returns:
        The bytes for name.

      • getDisplayName

        public String getDisplayName()
         Required. The name of the dataset 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.
        string display_name = 2;
        Specified by:
        getDisplayName in interface DatasetOrBuilder
        Returns:
        The displayName.

      • getDisplayNameBytes

        public com.google.protobuf.ByteString getDisplayNameBytes()
         Required. The name of the dataset 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.
        string display_name = 2;
        Specified by:
        getDisplayNameBytes in interface DatasetOrBuilder
        Returns:
        The bytes for displayName.

      • getDescription

        public String getDescription()
         User-provided description of the dataset. The description can be up to
 25000 characters long.
        string description = 3;
        Specified by:
        getDescription in interface DatasetOrBuilder
        Returns:
        The description.

      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         User-provided description of the dataset. The description can be up to
 25000 characters long.
        string description = 3;
        Specified by:
        getDescriptionBytes in interface DatasetOrBuilder
        Returns:
        The bytes for description.

      • getExampleCount

        public int getExampleCount()
         Output only. The number of examples in the dataset.
        int32 example_count = 21;
        Specified by:
        getExampleCount in interface DatasetOrBuilder
        Returns:
        The exampleCount.

      • hasCreateTime

        public boolean hasCreateTime()
         Output only. Timestamp when this dataset was created.
        .google.protobuf.Timestamp create_time = 14;
        Specified by:
        hasCreateTime in interface DatasetOrBuilder
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         Output only. Timestamp when this dataset was created.
        .google.protobuf.Timestamp create_time = 14;
        Specified by:
        getCreateTime in interface DatasetOrBuilder
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. Timestamp when this dataset was created.
        .google.protobuf.Timestamp create_time = 14;
        Specified by:
        getCreateTimeOrBuilder in interface DatasetOrBuilder

      • getEtag

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

      • getEtagBytes

        public com.google.protobuf.ByteString getEtagBytes()
         Used to perform consistent read-modify-write updates. If not set, a blind
 "overwrite" update happens.
        string etag = 17;
        Specified by:
        getEtagBytes in interface DatasetOrBuilder
        Returns:
        The bytes for etag.

      • getLabelsCount

        public int getLabelsCount()
        Description copied from interface: DatasetOrBuilder
         Optional. The labels with user-defined metadata to organize your dataset.

 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 = 39;
        Specified by:
        getLabelsCount in interface DatasetOrBuilder

      • containsLabels

        public boolean containsLabels​(String key)
         Optional. The labels with user-defined metadata to organize your dataset.

 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 = 39;
        Specified by:
        containsLabels in interface DatasetOrBuilder

      • getLabelsMap

        public Map<String,​String> getLabelsMap()
         Optional. The labels with user-defined metadata to organize your dataset.

 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 = 39;
        Specified by:
        getLabelsMap in interface DatasetOrBuilder

      • getLabelsOrDefault

        public String getLabelsOrDefault​(String key,
                                 String defaultValue)
         Optional. The labels with user-defined metadata to organize your dataset.

 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 = 39;
        Specified by:
        getLabelsOrDefault in interface DatasetOrBuilder

      • getLabelsOrThrow

        public String getLabelsOrThrow​(String key)
         Optional. The labels with user-defined metadata to organize your dataset.

 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 = 39;
        Specified by:
        getLabelsOrThrow in interface DatasetOrBuilder

      • isInitialized

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

      • 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.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

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

      • 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 Dataset parseFrom​(ByteBuffer data)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected Dataset.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static Dataset getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<Dataset> 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.GeneratedMessageV3

      • getDefaultInstanceForType

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