Class Dataset (2.44.0)

public final class Dataset extends 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

Implements

DatasetOrBuilder

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_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

EXAMPLE_COUNT_FIELD_NUMBER

public static final int EXAMPLE_COUNT_FIELD_NUMBER
Field Value
Type Description
int

IMAGE_CLASSIFICATION_DATASET_METADATA_FIELD_NUMBER

public static final int IMAGE_CLASSIFICATION_DATASET_METADATA_FIELD_NUMBER
Field Value
Type Description
int

IMAGE_OBJECT_DETECTION_DATASET_METADATA_FIELD_NUMBER

public static final int IMAGE_OBJECT_DETECTION_DATASET_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_DATASET_METADATA_FIELD_NUMBER

public static final int TEXT_CLASSIFICATION_DATASET_METADATA_FIELD_NUMBER
Field Value
Type Description
int

TEXT_EXTRACTION_DATASET_METADATA_FIELD_NUMBER

public static final int TEXT_EXTRACTION_DATASET_METADATA_FIELD_NUMBER
Field Value
Type Description
int

TEXT_SENTIMENT_DATASET_METADATA_FIELD_NUMBER

public static final int TEXT_SENTIMENT_DATASET_METADATA_FIELD_NUMBER
Field Value
Type Description
int

TRANSLATION_DATASET_METADATA_FIELD_NUMBER

public static final int TRANSLATION_DATASET_METADATA_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Dataset getDefaultInstance()
Returns
Type Description
Dataset

getDescriptor()

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

newBuilder()

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

newBuilder(Dataset prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

containsLabels(String key)

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;

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 this dataset was created.

.google.protobuf.Timestamp create_time = 14;

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Timestamp when this dataset was created.

.google.protobuf.Timestamp create_time = 14;

Returns
Type Description
TimestampOrBuilder

getDatasetMetadataCase()

public Dataset.DatasetMetadataCase getDatasetMetadataCase()
Returns
Type Description
Dataset.DatasetMetadataCase

getDefaultInstanceForType()

public Dataset getDefaultInstanceForType()
Returns
Type Description
Dataset

getDescription()

public String getDescription()

User-provided description of the dataset. The description can be up to 25000 characters long.

string description = 3;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

User-provided description of the dataset. The description can be up to 25000 characters long.

string description = 3;

Returns
Type Description
ByteString

The bytes for description.

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;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

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

Returns
Type Description
ByteString

The bytes for displayName.

getEtag()

public String getEtag()

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

string etag = 17;

Returns
Type Description
String

The etag.

getEtagBytes()

public ByteString getEtagBytes()

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

string etag = 17;

Returns
Type Description
ByteString

The bytes for etag.

getExampleCount()

public int getExampleCount()

Output only. The number of examples in the dataset.

int32 example_count = 21;

Returns
Type Description
int

The exampleCount.

getImageClassificationDatasetMetadata()

public ImageClassificationDatasetMetadata getImageClassificationDatasetMetadata()

Metadata for a dataset used for image classification.

.google.cloud.automl.v1.ImageClassificationDatasetMetadata image_classification_dataset_metadata = 24;

Returns
Type Description
ImageClassificationDatasetMetadata

The imageClassificationDatasetMetadata.

getImageClassificationDatasetMetadataOrBuilder()

public ImageClassificationDatasetMetadataOrBuilder getImageClassificationDatasetMetadataOrBuilder()

Metadata for a dataset used for image classification.

.google.cloud.automl.v1.ImageClassificationDatasetMetadata image_classification_dataset_metadata = 24;

Returns
Type Description
ImageClassificationDatasetMetadataOrBuilder

getImageObjectDetectionDatasetMetadata()

public ImageObjectDetectionDatasetMetadata getImageObjectDetectionDatasetMetadata()

Metadata for a dataset used for image object detection.

.google.cloud.automl.v1.ImageObjectDetectionDatasetMetadata image_object_detection_dataset_metadata = 26;

Returns
Type Description
ImageObjectDetectionDatasetMetadata

The imageObjectDetectionDatasetMetadata.

getImageObjectDetectionDatasetMetadataOrBuilder()

public ImageObjectDetectionDatasetMetadataOrBuilder getImageObjectDetectionDatasetMetadataOrBuilder()

Metadata for a dataset used for image object detection.

.google.cloud.automl.v1.ImageObjectDetectionDatasetMetadata image_object_detection_dataset_metadata = 26;

Returns
Type Description
ImageObjectDetectionDatasetMetadataOrBuilder

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

Returns
Type Description
int

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;

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

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

Parameter
Name Description
key String
Returns
Type Description
String

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;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The resource name of the dataset. Form: projects/{project_id}/locations/{location_id}/datasets/{dataset_id}

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTextClassificationDatasetMetadata()

public TextClassificationDatasetMetadata getTextClassificationDatasetMetadata()

Metadata for a dataset used for text classification.

.google.cloud.automl.v1.TextClassificationDatasetMetadata text_classification_dataset_metadata = 25;

Returns
Type Description
TextClassificationDatasetMetadata

The textClassificationDatasetMetadata.

getTextClassificationDatasetMetadataOrBuilder()

public TextClassificationDatasetMetadataOrBuilder getTextClassificationDatasetMetadataOrBuilder()

Metadata for a dataset used for text classification.

.google.cloud.automl.v1.TextClassificationDatasetMetadata text_classification_dataset_metadata = 25;

Returns
Type Description
TextClassificationDatasetMetadataOrBuilder

getTextExtractionDatasetMetadata()

public TextExtractionDatasetMetadata getTextExtractionDatasetMetadata()

Metadata for a dataset used for text extraction.

.google.cloud.automl.v1.TextExtractionDatasetMetadata text_extraction_dataset_metadata = 28;

Returns
Type Description
TextExtractionDatasetMetadata

The textExtractionDatasetMetadata.

getTextExtractionDatasetMetadataOrBuilder()

public TextExtractionDatasetMetadataOrBuilder getTextExtractionDatasetMetadataOrBuilder()

Metadata for a dataset used for text extraction.

.google.cloud.automl.v1.TextExtractionDatasetMetadata text_extraction_dataset_metadata = 28;

Returns
Type Description
TextExtractionDatasetMetadataOrBuilder

getTextSentimentDatasetMetadata()

public TextSentimentDatasetMetadata getTextSentimentDatasetMetadata()

Metadata for a dataset used for text sentiment.

.google.cloud.automl.v1.TextSentimentDatasetMetadata text_sentiment_dataset_metadata = 30;

Returns
Type Description
TextSentimentDatasetMetadata

The textSentimentDatasetMetadata.

getTextSentimentDatasetMetadataOrBuilder()

public TextSentimentDatasetMetadataOrBuilder getTextSentimentDatasetMetadataOrBuilder()

Metadata for a dataset used for text sentiment.

.google.cloud.automl.v1.TextSentimentDatasetMetadata text_sentiment_dataset_metadata = 30;

Returns
Type Description
TextSentimentDatasetMetadataOrBuilder

getTranslationDatasetMetadata()

public TranslationDatasetMetadata getTranslationDatasetMetadata()

Metadata for a dataset used for translation.

.google.cloud.automl.v1.TranslationDatasetMetadata translation_dataset_metadata = 23;

Returns
Type Description
TranslationDatasetMetadata

The translationDatasetMetadata.

getTranslationDatasetMetadataOrBuilder()

public TranslationDatasetMetadataOrBuilder getTranslationDatasetMetadataOrBuilder()

Metadata for a dataset used for translation.

.google.cloud.automl.v1.TranslationDatasetMetadata translation_dataset_metadata = 23;

Returns
Type Description
TranslationDatasetMetadataOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. Timestamp when this dataset was created.

.google.protobuf.Timestamp create_time = 14;

Returns
Type Description
boolean

Whether the createTime 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;

Returns
Type Description
boolean

Whether the imageClassificationDatasetMetadata 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;

Returns
Type Description
boolean

Whether the imageObjectDetectionDatasetMetadata 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;

Returns
Type Description
boolean

Whether the textClassificationDatasetMetadata 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;

Returns
Type Description
boolean

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;

Returns
Type Description
boolean

Whether the textSentimentDatasetMetadata field is set.

hasTranslationDatasetMetadata()

public boolean hasTranslationDatasetMetadata()

Metadata for a dataset used for translation.

.google.cloud.automl.v1.TranslationDatasetMetadata translation_dataset_metadata = 23;

Returns
Type Description
boolean

Whether the translationDatasetMetadata 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 Dataset.Builder newBuilderForType()
Returns
Type Description
Dataset.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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