Class Dataset (3.44.0)

public final class Dataset extends GeneratedMessageV3 implements DatasetOrBuilder

A collection of DataItems and Annotations on them.

Protobuf type google.cloud.aiplatform.v1beta1.Dataset

Implements

DatasetOrBuilder

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DATA_ITEM_COUNT_FIELD_NUMBER

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

ENCRYPTION_SPEC_FIELD_NUMBER

public static final int ENCRYPTION_SPEC_FIELD_NUMBER
Field Value
Type Description
int

ETAG_FIELD_NUMBER

public static final int ETAG_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

METADATA_ARTIFACT_FIELD_NUMBER

public static final int METADATA_ARTIFACT_FIELD_NUMBER
Field Value
Type Description
int

METADATA_FIELD_NUMBER

public static final int METADATA_FIELD_NUMBER
Field Value
Type Description
int

METADATA_SCHEMA_URI_FIELD_NUMBER

public static final int METADATA_SCHEMA_URI_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

SAVED_QUERIES_FIELD_NUMBER

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

The labels with user-defined metadata to organize your Datasets.

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. No more than 64 user labels can be associated with one Dataset (System labels are excluded).

See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. Following system labels exist for each Dataset:

  • "aiplatform.googleapis.com/dataset_metadata_schema": output only, its value is the metadata_schema's title.

map<string, string> labels = 7;

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 = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Timestamp when this Dataset was created.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDataItemCount()

public long getDataItemCount()

Output only. The number of DataItems in this Dataset. Only apply for non-structured Dataset.

int64 data_item_count = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The dataItemCount.

getDefaultInstanceForType()

public Dataset getDefaultInstanceForType()
Returns
Type Description
Dataset

getDescription()

public String getDescription()

The description of the Dataset.

string description = 16;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

The description of the Dataset.

string description = 16;

Returns
Type Description
ByteString

The bytes for description.

getDisplayName()

public String getDisplayName()

Required. The user-defined name of the Dataset. The name can be up to 128 characters long and can consist of any UTF-8 characters.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Required. The user-defined name of the Dataset. The name can be up to 128 characters long and can consist of any UTF-8 characters.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for displayName.

getEncryptionSpec()

public EncryptionSpec getEncryptionSpec()

Customer-managed encryption key spec for a Dataset. If set, this Dataset and all sub-resources of this Dataset will be secured by this key.

.google.cloud.aiplatform.v1beta1.EncryptionSpec encryption_spec = 11;

Returns
Type Description
EncryptionSpec

The encryptionSpec.

getEncryptionSpecOrBuilder()

public EncryptionSpecOrBuilder getEncryptionSpecOrBuilder()

Customer-managed encryption key spec for a Dataset. If set, this Dataset and all sub-resources of this Dataset will be secured by this key.

.google.cloud.aiplatform.v1beta1.EncryptionSpec encryption_spec = 11;

Returns
Type Description
EncryptionSpecOrBuilder

getEtag()

public String getEtag()

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

string etag = 6;

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

Returns
Type Description
ByteString

The bytes for etag.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

The labels with user-defined metadata to organize your Datasets.

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. No more than 64 user labels can be associated with one Dataset (System labels are excluded).

See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. Following system labels exist for each Dataset:

  • "aiplatform.googleapis.com/dataset_metadata_schema": output only, its value is the metadata_schema's title.

map<string, string> labels = 7;

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

The labels with user-defined metadata to organize your Datasets.

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. No more than 64 user labels can be associated with one Dataset (System labels are excluded).

See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. Following system labels exist for each Dataset:

  • "aiplatform.googleapis.com/dataset_metadata_schema": output only, its value is the metadata_schema's title.

map<string, string> labels = 7;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

The labels with user-defined metadata to organize your Datasets.

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. No more than 64 user labels can be associated with one Dataset (System labels are excluded).

See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. Following system labels exist for each Dataset:

  • "aiplatform.googleapis.com/dataset_metadata_schema": output only, its value is the metadata_schema's title.

map<string, string> labels = 7;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

The labels with user-defined metadata to organize your Datasets.

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. No more than 64 user labels can be associated with one Dataset (System labels are excluded).

See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. Following system labels exist for each Dataset:

  • "aiplatform.googleapis.com/dataset_metadata_schema": output only, its value is the metadata_schema's title.

map<string, string> labels = 7;

Parameter
Name Description
key String
Returns
Type Description
String

getMetadata()

public Value getMetadata()

Required. Additional information about the Dataset.

.google.protobuf.Value metadata = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Value

The metadata.

getMetadataArtifact()

public String getMetadataArtifact()

Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}.

string metadata_artifact = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The metadataArtifact.

getMetadataArtifactBytes()

public ByteString getMetadataArtifactBytes()

Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}.

string metadata_artifact = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for metadataArtifact.

getMetadataOrBuilder()

public ValueOrBuilder getMetadataOrBuilder()

Required. Additional information about the Dataset.

.google.protobuf.Value metadata = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ValueOrBuilder

getMetadataSchemaUri()

public String getMetadataSchemaUri()

Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/.

string metadata_schema_uri = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The metadataSchemaUri.

getMetadataSchemaUriBytes()

public ByteString getMetadataSchemaUriBytes()

Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/.

string metadata_schema_uri = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for metadataSchemaUri.

getName()

public String getName()

Output only. The resource name of the Dataset.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The resource name of the Dataset.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getSavedQueries(int index)

public SavedQuery getSavedQueries(int index)

All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec.

repeated .google.cloud.aiplatform.v1beta1.SavedQuery saved_queries = 9;

Parameter
Name Description
index int
Returns
Type Description
SavedQuery

getSavedQueriesCount()

public int getSavedQueriesCount()

All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec.

repeated .google.cloud.aiplatform.v1beta1.SavedQuery saved_queries = 9;

Returns
Type Description
int

getSavedQueriesList()

public List<SavedQuery> getSavedQueriesList()

All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec.

repeated .google.cloud.aiplatform.v1beta1.SavedQuery saved_queries = 9;

Returns
Type Description
List<SavedQuery>

getSavedQueriesOrBuilder(int index)

public SavedQueryOrBuilder getSavedQueriesOrBuilder(int index)

All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec.

repeated .google.cloud.aiplatform.v1beta1.SavedQuery saved_queries = 9;

Parameter
Name Description
index int
Returns
Type Description
SavedQueryOrBuilder

getSavedQueriesOrBuilderList()

public List<? extends SavedQueryOrBuilder> getSavedQueriesOrBuilderList()

All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec.

repeated .google.cloud.aiplatform.v1beta1.SavedQuery saved_queries = 9;

Returns
Type Description
List<? extends com.google.cloud.aiplatform.v1beta1.SavedQueryOrBuilder>

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Timestamp when this Dataset was last updated.

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Timestamp when this Dataset was last updated.

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. Timestamp when this Dataset was created.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasEncryptionSpec()

public boolean hasEncryptionSpec()

Customer-managed encryption key spec for a Dataset. If set, this Dataset and all sub-resources of this Dataset will be secured by this key.

.google.cloud.aiplatform.v1beta1.EncryptionSpec encryption_spec = 11;

Returns
Type Description
boolean

Whether the encryptionSpec field is set.

hasMetadata()

public boolean hasMetadata()

Required. Additional information about the Dataset.

.google.protobuf.Value metadata = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the metadata field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Timestamp when this Dataset was last updated.

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

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