- 3.55.0 (latest)
- 3.54.0
- 3.53.0
- 3.52.0
- 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 static final class Dataset.Builder extends GeneratedMessageV3.Builder<Dataset.Builder> implements DatasetOrBuilder
A collection of DataItems and Annotations on them.
Protobuf type google.cloud.aiplatform.v1.Dataset
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Dataset.BuilderImplements
DatasetOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addAllSavedQueries(Iterable<? extends SavedQuery> values)
public Dataset.Builder addAllSavedQueries(Iterable<? extends SavedQuery> values)
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 |
values |
Iterable<? extends com.google.cloud.aiplatform.v1.SavedQuery> |
Returns | |
---|---|
Type | Description |
Dataset.Builder |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Dataset.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
Dataset.Builder |
addSavedQueries(SavedQuery value)
public Dataset.Builder addSavedQueries(SavedQuery value)
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 |
value |
SavedQuery |
Returns | |
---|---|
Type | Description |
Dataset.Builder |
addSavedQueries(SavedQuery.Builder builderForValue)
public Dataset.Builder addSavedQueries(SavedQuery.Builder builderForValue)
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 |
builderForValue |
SavedQuery.Builder |
Returns | |
---|---|
Type | Description |
Dataset.Builder |
addSavedQueries(int index, SavedQuery value)
public Dataset.Builder addSavedQueries(int index, SavedQuery value)
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;
Parameters | |
---|---|
Name | Description |
index |
int |
value |
SavedQuery |
Returns | |
---|---|
Type | Description |
Dataset.Builder |
addSavedQueries(int index, SavedQuery.Builder builderForValue)
public Dataset.Builder addSavedQueries(int index, SavedQuery.Builder builderForValue)
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;
Parameters | |
---|---|
Name | Description |
index |
int |
builderForValue |
SavedQuery.Builder |
Returns | |
---|---|
Type | Description |
Dataset.Builder |
addSavedQueriesBuilder()
public SavedQuery.Builder addSavedQueriesBuilder()
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 |
SavedQuery.Builder |
addSavedQueriesBuilder(int index)
public SavedQuery.Builder addSavedQueriesBuilder(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.Builder |
build()
public Dataset build()
Returns | |
---|---|
Type | Description |
Dataset |
buildPartial()
public Dataset buildPartial()
Returns | |
---|---|
Type | Description |
Dataset |
clear()
public Dataset.Builder clear()
Returns | |
---|---|
Type | Description |
Dataset.Builder |
clearCreateTime()
public Dataset.Builder clearCreateTime()
Output only. Timestamp when this Dataset was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Dataset.Builder |
clearDataItemCount()
public Dataset.Builder clearDataItemCount()
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 |
Dataset.Builder |
This builder for chaining. |
clearDescription()
public Dataset.Builder clearDescription()
The description of the Dataset.
string description = 16;
Returns | |
---|---|
Type | Description |
Dataset.Builder |
This builder for chaining. |
clearDisplayName()
public Dataset.Builder clearDisplayName()
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 |
Dataset.Builder |
This builder for chaining. |
clearEncryptionSpec()
public Dataset.Builder clearEncryptionSpec()
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 |
Dataset.Builder |
clearEtag()
public Dataset.Builder clearEtag()
Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
string etag = 6;
Returns | |
---|---|
Type | Description |
Dataset.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public Dataset.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
Dataset.Builder |
clearLabels()
public Dataset.Builder clearLabels()
Returns | |
---|---|
Type | Description |
Dataset.Builder |
clearMetadata()
public Dataset.Builder clearMetadata()
Required. Additional information about the Dataset.
.google.protobuf.Value metadata = 8 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
Dataset.Builder |
clearMetadataArtifact()
public Dataset.Builder clearMetadataArtifact()
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 |
Dataset.Builder |
This builder for chaining. |
clearMetadataSchemaUri()
public Dataset.Builder clearMetadataSchemaUri()
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 |
Dataset.Builder |
This builder for chaining. |
clearName()
public Dataset.Builder clearName()
Output only. The resource name of the Dataset.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Dataset.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Dataset.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
Dataset.Builder |
clearSavedQueries()
public Dataset.Builder clearSavedQueries()
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 |
Dataset.Builder |
clearUpdateTime()
public Dataset.Builder clearUpdateTime()
Output only. Timestamp when this Dataset was last updated.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Dataset.Builder |
clone()
public Dataset.Builder clone()
Returns | |
---|---|
Type | Description |
Dataset.Builder |
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 |
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. |
getCreateTimeBuilder()
public Timestamp.Builder getCreateTimeBuilder()
Output only. Timestamp when this Dataset was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Builder |
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. |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
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.v1.EncryptionSpec encryption_spec = 11;
Returns | |
---|---|
Type | Description |
EncryptionSpec |
The encryptionSpec. |
getEncryptionSpecBuilder()
public EncryptionSpec.Builder getEncryptionSpecBuilder()
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.Builder |
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.v1.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. |
getMetadataBuilder()
public Value.Builder getMetadataBuilder()
Required. Additional information about the Dataset.
.google.protobuf.Value metadata = 8 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
Builder |
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. |
getMutableLabels() (deprecated)
public Map<String,String> getMutableLabels()
Use alternate mutation accessors instead.
Returns | |
---|---|
Type | Description |
Map<String,String> |
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. |
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.v1.SavedQuery saved_queries = 9;
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
SavedQuery |
getSavedQueriesBuilder(int index)
public SavedQuery.Builder getSavedQueriesBuilder(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.Builder |
getSavedQueriesBuilderList()
public List<SavedQuery.Builder> getSavedQueriesBuilderList()
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<Builder> |
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.v1.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.v1.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.v1.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.v1.SavedQuery saved_queries = 9;
Returns | |
---|---|
Type | Description |
List<? extends com.google.cloud.aiplatform.v1.SavedQueryOrBuilder> |
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. |
getUpdateTimeBuilder()
public Timestamp.Builder getUpdateTimeBuilder()
Output only. Timestamp when this Dataset was last updated.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Builder |
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.v1.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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter | |
---|---|
Name | Description |
number |
int |
Returns | |
---|---|
Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter | |
---|---|
Name | Description |
number |
int |
Returns | |
---|---|
Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeCreateTime(Timestamp value)
public Dataset.Builder mergeCreateTime(Timestamp value)
Output only. Timestamp when this Dataset was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
Dataset.Builder |
mergeEncryptionSpec(EncryptionSpec value)
public Dataset.Builder mergeEncryptionSpec(EncryptionSpec value)
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;
Parameter | |
---|---|
Name | Description |
value |
EncryptionSpec |
Returns | |
---|---|
Type | Description |
Dataset.Builder |
mergeFrom(Dataset other)
public Dataset.Builder mergeFrom(Dataset other)
Parameter | |
---|---|
Name | Description |
other |
Dataset |
Returns | |
---|---|
Type | Description |
Dataset.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Dataset.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Dataset.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public Dataset.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
Dataset.Builder |
mergeMetadata(Value value)
public Dataset.Builder mergeMetadata(Value value)
Required. Additional information about the Dataset.
.google.protobuf.Value metadata = 8 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value |
Value |
Returns | |
---|---|
Type | Description |
Dataset.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Dataset.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
Dataset.Builder |
mergeUpdateTime(Timestamp value)
public Dataset.Builder mergeUpdateTime(Timestamp value)
Output only. Timestamp when this Dataset was last updated.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
Dataset.Builder |
putAllLabels(Map<String,String> values)
public Dataset.Builder putAllLabels(Map<String,String> values)
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 |
values |
Map<String,String> |
Returns | |
---|---|
Type | Description |
Dataset.Builder |
putLabels(String key, String value)
public Dataset.Builder putLabels(String key, String value)
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 |
value |
String |
Returns | |
---|---|
Type | Description |
Dataset.Builder |
removeLabels(String key)
public Dataset.Builder removeLabels(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 |
Dataset.Builder |
removeSavedQueries(int index)
public Dataset.Builder removeSavedQueries(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 |
Dataset.Builder |
setCreateTime(Timestamp value)
public Dataset.Builder setCreateTime(Timestamp value)
Output only. Timestamp when this Dataset was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
Dataset.Builder |
setCreateTime(Timestamp.Builder builderForValue)
public Dataset.Builder setCreateTime(Timestamp.Builder builderForValue)
Output only. Timestamp when this Dataset was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
builderForValue |
Builder |
Returns | |
---|---|
Type | Description |
Dataset.Builder |
setDataItemCount(long value)
public Dataset.Builder setDataItemCount(long value)
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];
Parameter | |
---|---|
Name | Description |
value |
long The dataItemCount to set. |
Returns | |
---|---|
Type | Description |
Dataset.Builder |
This builder for chaining. |
setDescription(String value)
public Dataset.Builder setDescription(String value)
The description of the Dataset.
string description = 16;
Parameter | |
---|---|
Name | Description |
value |
String The description to set. |
Returns | |
---|---|
Type | Description |
Dataset.Builder |
This builder for chaining. |
setDescriptionBytes(ByteString value)
public Dataset.Builder setDescriptionBytes(ByteString value)
The description of the Dataset.
string description = 16;
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for description to set. |
Returns | |
---|---|
Type | Description |
Dataset.Builder |
This builder for chaining. |
setDisplayName(String value)
public Dataset.Builder setDisplayName(String value)
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];
Parameter | |
---|---|
Name | Description |
value |
String The displayName to set. |
Returns | |
---|---|
Type | Description |
Dataset.Builder |
This builder for chaining. |
setDisplayNameBytes(ByteString value)
public Dataset.Builder setDisplayNameBytes(ByteString value)
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];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for displayName to set. |
Returns | |
---|---|
Type | Description |
Dataset.Builder |
This builder for chaining. |
setEncryptionSpec(EncryptionSpec value)
public Dataset.Builder setEncryptionSpec(EncryptionSpec value)
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;
Parameter | |
---|---|
Name | Description |
value |
EncryptionSpec |
Returns | |
---|---|
Type | Description |
Dataset.Builder |
setEncryptionSpec(EncryptionSpec.Builder builderForValue)
public Dataset.Builder setEncryptionSpec(EncryptionSpec.Builder builderForValue)
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;
Parameter | |
---|---|
Name | Description |
builderForValue |
EncryptionSpec.Builder |
Returns | |
---|---|
Type | Description |
Dataset.Builder |
setEtag(String value)
public Dataset.Builder setEtag(String value)
Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
string etag = 6;
Parameter | |
---|---|
Name | Description |
value |
String The etag to set. |
Returns | |
---|---|
Type | Description |
Dataset.Builder |
This builder for chaining. |
setEtagBytes(ByteString value)
public Dataset.Builder setEtagBytes(ByteString value)
Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
string etag = 6;
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for etag to set. |
Returns | |
---|---|
Type | Description |
Dataset.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public Dataset.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
Dataset.Builder |
setMetadata(Value value)
public Dataset.Builder setMetadata(Value value)
Required. Additional information about the Dataset.
.google.protobuf.Value metadata = 8 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value |
Value |
Returns | |
---|---|
Type | Description |
Dataset.Builder |
setMetadata(Value.Builder builderForValue)
public Dataset.Builder setMetadata(Value.Builder builderForValue)
Required. Additional information about the Dataset.
.google.protobuf.Value metadata = 8 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
builderForValue |
Builder |
Returns | |
---|---|
Type | Description |
Dataset.Builder |
setMetadataArtifact(String value)
public Dataset.Builder setMetadataArtifact(String value)
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];
Parameter | |
---|---|
Name | Description |
value |
String The metadataArtifact to set. |
Returns | |
---|---|
Type | Description |
Dataset.Builder |
This builder for chaining. |
setMetadataArtifactBytes(ByteString value)
public Dataset.Builder setMetadataArtifactBytes(ByteString value)
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];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for metadataArtifact to set. |
Returns | |
---|---|
Type | Description |
Dataset.Builder |
This builder for chaining. |
setMetadataSchemaUri(String value)
public Dataset.Builder setMetadataSchemaUri(String value)
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];
Parameter | |
---|---|
Name | Description |
value |
String The metadataSchemaUri to set. |
Returns | |
---|---|
Type | Description |
Dataset.Builder |
This builder for chaining. |
setMetadataSchemaUriBytes(ByteString value)
public Dataset.Builder setMetadataSchemaUriBytes(ByteString value)
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];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for metadataSchemaUri to set. |
Returns | |
---|---|
Type | Description |
Dataset.Builder |
This builder for chaining. |
setName(String value)
public Dataset.Builder setName(String value)
Output only. The resource name of the Dataset.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
String The name to set. |
Returns | |
---|---|
Type | Description |
Dataset.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public Dataset.Builder setNameBytes(ByteString value)
Output only. The resource name of the Dataset.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for name to set. |
Returns | |
---|---|
Type | Description |
Dataset.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Dataset.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
Dataset.Builder |
setSavedQueries(int index, SavedQuery value)
public Dataset.Builder setSavedQueries(int index, SavedQuery value)
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;
Parameters | |
---|---|
Name | Description |
index |
int |
value |
SavedQuery |
Returns | |
---|---|
Type | Description |
Dataset.Builder |
setSavedQueries(int index, SavedQuery.Builder builderForValue)
public Dataset.Builder setSavedQueries(int index, SavedQuery.Builder builderForValue)
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;
Parameters | |
---|---|
Name | Description |
index |
int |
builderForValue |
SavedQuery.Builder |
Returns | |
---|---|
Type | Description |
Dataset.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final Dataset.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
Dataset.Builder |
setUpdateTime(Timestamp value)
public Dataset.Builder setUpdateTime(Timestamp value)
Output only. Timestamp when this Dataset was last updated.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
Dataset.Builder |
setUpdateTime(Timestamp.Builder builderForValue)
public Dataset.Builder setUpdateTime(Timestamp.Builder builderForValue)
Output only. Timestamp when this Dataset was last updated.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
builderForValue |
Builder |
Returns | |
---|---|
Type | Description |
Dataset.Builder |