- 3.52.0 (latest)
- 3.50.0
- 3.49.0
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.2
- 3.3.0
- 3.2.0
- 3.0.0
- 2.9.8
- 2.8.9
- 2.7.4
- 2.5.3
- 2.4.0
public interface DatasetOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
containsLabels(String key)
public abstract 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 |
|
getCreateTime()
public abstract 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 abstract 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 abstract 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. |
getDescription()
public abstract String getDescription()The description of the Dataset.
string description = 16;
| Returns | |
|---|---|
| Type | Description |
String |
The description. |
getDescriptionBytes()
public abstract ByteString getDescriptionBytes()The description of the Dataset.
string description = 16;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for description. |
getDisplayName()
public abstract 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 abstract 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 abstract 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;
| Returns | |
|---|---|
| Type | Description |
EncryptionSpec |
The encryptionSpec. |
getEncryptionSpecOrBuilder()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
EncryptionSpecOrBuilder |
|
getEtag()
public abstract 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 abstract 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 abstract Map<String,String> getLabels()Use #getLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getLabelsCount()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract ValueOrBuilder getMetadataOrBuilder()Required. Additional information about the Dataset.
.google.protobuf.Value metadata = 8 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ValueOrBuilder |
|
getMetadataSchemaUri()
public abstract 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 abstract 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. |
getModelReference()
public abstract 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. |
getModelReferenceBytes()
public abstract 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. |
getName()
public abstract 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 abstract 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. |
getSavedQueries(int index)
public abstract 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 |
| Returns | |
|---|---|
| Type | Description |
SavedQuery |
|
getSavedQueriesCount()
public abstract 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 |
|
getSavedQueriesList()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
List<SavedQuery> |
|
getSavedQueriesOrBuilder(int index)
public abstract 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 |
| Returns | |
|---|---|
| Type | Description |
SavedQueryOrBuilder |
|
getSavedQueriesOrBuilderList()
public abstract 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> |
|
getUpdateTime()
public abstract 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 abstract 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 abstract 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 abstract 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. |
hasMetadata()
public abstract 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 abstract 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. |