public final class Dataset extends GeneratedMessageV3 implements DatasetOrBuilder
A collection of DataItems and Annotations on them.
Protobuf type google.cloud.aiplatform.v1.Dataset
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int DATA_ITEM_COUNT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int ENCRYPTION_SPEC_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int ETAG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int LABELS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int METADATA_ARTIFACT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int METADATA_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int METADATA_SCHEMA_URI_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int MODEL_REFERENCE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int SAVED_QUERIES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static Dataset getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static Dataset.Builder newBuilder()
public static Dataset.Builder newBuilder(Dataset prototype)
| Parameter |
| Name |
Description |
prototype |
Dataset
|
public static Dataset parseDelimitedFrom(InputStream input)
public static Dataset parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Dataset parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static Dataset parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Dataset parseFrom(ByteString data)
public static Dataset parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Dataset parseFrom(CodedInputStream input)
public static Dataset parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Dataset parseFrom(InputStream input)
public static Dataset parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Dataset parseFrom(ByteBuffer data)
public static Dataset parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<Dataset> parser()
Methods
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
|
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
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.
|
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Timestamp when this Dataset was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
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.
|
public Dataset getDefaultInstanceForType()
public String getDescription()
The description of the Dataset.
string description = 16;
| Returns |
| Type |
Description |
String |
The description.
|
public ByteString getDescriptionBytes()
The description of the Dataset.
string description = 16;
| Returns |
| Type |
Description |
ByteString |
The bytes for description.
|
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.
|
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.
|
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.v1.EncryptionSpec encryption_spec = 11;
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.v1.EncryptionSpec encryption_spec = 11;
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.
|
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.
|
public Map<String,String> getLabels()
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 |
|
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;
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;
| Returns |
| Type |
Description |
String |
|
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 |
|
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.
|
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.
|
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.
|
public ValueOrBuilder getMetadataOrBuilder()
Required. Additional information about the Dataset.
.google.protobuf.Value metadata = 8 [(.google.api.field_behavior) = REQUIRED];
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.
|
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.
|
public String getModelReference()
Optional. Reference to the public base model last used by the dataset. Only
set for prompt datasets.
string model_reference = 18 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
The modelReference.
|
public ByteString getModelReferenceBytes()
Optional. Reference to the public base model last used by the dataset. Only
set for prompt datasets.
string model_reference = 18 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
ByteString |
The bytes for modelReference.
|
Output only. The resource name of the Dataset.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
String |
The name.
|
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.
|
public Parser<Dataset> getParserForType()
Overrides
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.v1.SavedQuery saved_queries = 9;
| Parameter |
| Name |
Description |
index |
int
|
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.v1.SavedQuery saved_queries = 9;
| Returns |
| Type |
Description |
int |
|
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.v1.SavedQuery saved_queries = 9;
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.v1.SavedQuery saved_queries = 9;
| Parameter |
| Name |
Description |
index |
int
|
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.v1.SavedQuery saved_queries = 9;
| Returns |
| Type |
Description |
List<? extends com.google.cloud.aiplatform.v1.SavedQueryOrBuilder> |
|
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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.
|
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. Timestamp when this Dataset was last updated.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
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.
|
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.v1.EncryptionSpec encryption_spec = 11;
| Returns |
| Type |
Description |
boolean |
Whether the encryptionSpec field is set.
|
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.
|
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.
|
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
public final boolean isInitialized()
Overrides
public Dataset.Builder newBuilderForType()
protected Dataset.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
public Dataset.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
