1 /* 2 * Copyright 2020 Google LLC 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * https://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 // Generated by the protocol buffer compiler. DO NOT EDIT! 17 // source: google/cloud/aiplatform/v1/dataset.proto 18 19 package com.google.cloud.aiplatform.v1; 20 21 public interface DatasetOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.aiplatform.v1.Dataset) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * Output only. The resource name of the Dataset. 31 * </pre> 32 * 33 * <code>string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 34 * 35 * @return The name. 36 */ getName()37 java.lang.String getName(); 38 /** 39 * 40 * 41 * <pre> 42 * Output only. The resource name of the Dataset. 43 * </pre> 44 * 45 * <code>string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 46 * 47 * @return The bytes for name. 48 */ getNameBytes()49 com.google.protobuf.ByteString getNameBytes(); 50 51 /** 52 * 53 * 54 * <pre> 55 * Required. The user-defined name of the Dataset. 56 * The name can be up to 128 characters long and can consist of any UTF-8 57 * characters. 58 * </pre> 59 * 60 * <code>string display_name = 2 [(.google.api.field_behavior) = REQUIRED];</code> 61 * 62 * @return The displayName. 63 */ getDisplayName()64 java.lang.String getDisplayName(); 65 /** 66 * 67 * 68 * <pre> 69 * Required. The user-defined name of the Dataset. 70 * The name can be up to 128 characters long and can consist of any UTF-8 71 * characters. 72 * </pre> 73 * 74 * <code>string display_name = 2 [(.google.api.field_behavior) = REQUIRED];</code> 75 * 76 * @return The bytes for displayName. 77 */ getDisplayNameBytes()78 com.google.protobuf.ByteString getDisplayNameBytes(); 79 80 /** 81 * 82 * 83 * <pre> 84 * The description of the Dataset. 85 * </pre> 86 * 87 * <code>string description = 16;</code> 88 * 89 * @return The description. 90 */ getDescription()91 java.lang.String getDescription(); 92 /** 93 * 94 * 95 * <pre> 96 * The description of the Dataset. 97 * </pre> 98 * 99 * <code>string description = 16;</code> 100 * 101 * @return The bytes for description. 102 */ getDescriptionBytes()103 com.google.protobuf.ByteString getDescriptionBytes(); 104 105 /** 106 * 107 * 108 * <pre> 109 * Required. Points to a YAML file stored on Google Cloud Storage describing 110 * additional information about the Dataset. The schema is defined as an 111 * OpenAPI 3.0.2 Schema Object. The schema files that can be used here are 112 * found in gs://google-cloud-aiplatform/schema/dataset/metadata/. 113 * </pre> 114 * 115 * <code>string metadata_schema_uri = 3 [(.google.api.field_behavior) = REQUIRED];</code> 116 * 117 * @return The metadataSchemaUri. 118 */ getMetadataSchemaUri()119 java.lang.String getMetadataSchemaUri(); 120 /** 121 * 122 * 123 * <pre> 124 * Required. Points to a YAML file stored on Google Cloud Storage describing 125 * additional information about the Dataset. The schema is defined as an 126 * OpenAPI 3.0.2 Schema Object. The schema files that can be used here are 127 * found in gs://google-cloud-aiplatform/schema/dataset/metadata/. 128 * </pre> 129 * 130 * <code>string metadata_schema_uri = 3 [(.google.api.field_behavior) = REQUIRED];</code> 131 * 132 * @return The bytes for metadataSchemaUri. 133 */ getMetadataSchemaUriBytes()134 com.google.protobuf.ByteString getMetadataSchemaUriBytes(); 135 136 /** 137 * 138 * 139 * <pre> 140 * Required. Additional information about the Dataset. 141 * </pre> 142 * 143 * <code>.google.protobuf.Value metadata = 8 [(.google.api.field_behavior) = REQUIRED];</code> 144 * 145 * @return Whether the metadata field is set. 146 */ hasMetadata()147 boolean hasMetadata(); 148 /** 149 * 150 * 151 * <pre> 152 * Required. Additional information about the Dataset. 153 * </pre> 154 * 155 * <code>.google.protobuf.Value metadata = 8 [(.google.api.field_behavior) = REQUIRED];</code> 156 * 157 * @return The metadata. 158 */ getMetadata()159 com.google.protobuf.Value getMetadata(); 160 /** 161 * 162 * 163 * <pre> 164 * Required. Additional information about the Dataset. 165 * </pre> 166 * 167 * <code>.google.protobuf.Value metadata = 8 [(.google.api.field_behavior) = REQUIRED];</code> 168 */ getMetadataOrBuilder()169 com.google.protobuf.ValueOrBuilder getMetadataOrBuilder(); 170 171 /** 172 * 173 * 174 * <pre> 175 * Output only. Timestamp when this Dataset was created. 176 * </pre> 177 * 178 * <code>.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; 179 * </code> 180 * 181 * @return Whether the createTime field is set. 182 */ hasCreateTime()183 boolean hasCreateTime(); 184 /** 185 * 186 * 187 * <pre> 188 * Output only. Timestamp when this Dataset was created. 189 * </pre> 190 * 191 * <code>.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; 192 * </code> 193 * 194 * @return The createTime. 195 */ getCreateTime()196 com.google.protobuf.Timestamp getCreateTime(); 197 /** 198 * 199 * 200 * <pre> 201 * Output only. Timestamp when this Dataset was created. 202 * </pre> 203 * 204 * <code>.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; 205 * </code> 206 */ getCreateTimeOrBuilder()207 com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder(); 208 209 /** 210 * 211 * 212 * <pre> 213 * Output only. Timestamp when this Dataset was last updated. 214 * </pre> 215 * 216 * <code>.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; 217 * </code> 218 * 219 * @return Whether the updateTime field is set. 220 */ hasUpdateTime()221 boolean hasUpdateTime(); 222 /** 223 * 224 * 225 * <pre> 226 * Output only. Timestamp when this Dataset was last updated. 227 * </pre> 228 * 229 * <code>.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; 230 * </code> 231 * 232 * @return The updateTime. 233 */ getUpdateTime()234 com.google.protobuf.Timestamp getUpdateTime(); 235 /** 236 * 237 * 238 * <pre> 239 * Output only. Timestamp when this Dataset was last updated. 240 * </pre> 241 * 242 * <code>.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; 243 * </code> 244 */ getUpdateTimeOrBuilder()245 com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder(); 246 247 /** 248 * 249 * 250 * <pre> 251 * Used to perform consistent read-modify-write updates. If not set, a blind 252 * "overwrite" update happens. 253 * </pre> 254 * 255 * <code>string etag = 6;</code> 256 * 257 * @return The etag. 258 */ getEtag()259 java.lang.String getEtag(); 260 /** 261 * 262 * 263 * <pre> 264 * Used to perform consistent read-modify-write updates. If not set, a blind 265 * "overwrite" update happens. 266 * </pre> 267 * 268 * <code>string etag = 6;</code> 269 * 270 * @return The bytes for etag. 271 */ getEtagBytes()272 com.google.protobuf.ByteString getEtagBytes(); 273 274 /** 275 * 276 * 277 * <pre> 278 * The labels with user-defined metadata to organize your Datasets. 279 * Label keys and values can be no longer than 64 characters 280 * (Unicode codepoints), can only contain lowercase letters, numeric 281 * characters, underscores and dashes. International characters are allowed. 282 * No more than 64 user labels can be associated with one Dataset (System 283 * labels are excluded). 284 * See https://goo.gl/xmQnxf for more information and examples of labels. 285 * System reserved label keys are prefixed with "aiplatform.googleapis.com/" 286 * and are immutable. Following system labels exist for each Dataset: 287 * * "aiplatform.googleapis.com/dataset_metadata_schema": output only, its 288 * value is the 289 * [metadata_schema's][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri] 290 * title. 291 * </pre> 292 * 293 * <code>map<string, string> labels = 7;</code> 294 */ getLabelsCount()295 int getLabelsCount(); 296 /** 297 * 298 * 299 * <pre> 300 * The labels with user-defined metadata to organize your Datasets. 301 * Label keys and values can be no longer than 64 characters 302 * (Unicode codepoints), can only contain lowercase letters, numeric 303 * characters, underscores and dashes. International characters are allowed. 304 * No more than 64 user labels can be associated with one Dataset (System 305 * labels are excluded). 306 * See https://goo.gl/xmQnxf for more information and examples of labels. 307 * System reserved label keys are prefixed with "aiplatform.googleapis.com/" 308 * and are immutable. Following system labels exist for each Dataset: 309 * * "aiplatform.googleapis.com/dataset_metadata_schema": output only, its 310 * value is the 311 * [metadata_schema's][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri] 312 * title. 313 * </pre> 314 * 315 * <code>map<string, string> labels = 7;</code> 316 */ containsLabels(java.lang.String key)317 boolean containsLabels(java.lang.String key); 318 /** Use {@link #getLabelsMap()} instead. */ 319 @java.lang.Deprecated getLabels()320 java.util.Map<java.lang.String, java.lang.String> getLabels(); 321 /** 322 * 323 * 324 * <pre> 325 * The labels with user-defined metadata to organize your Datasets. 326 * Label keys and values can be no longer than 64 characters 327 * (Unicode codepoints), can only contain lowercase letters, numeric 328 * characters, underscores and dashes. International characters are allowed. 329 * No more than 64 user labels can be associated with one Dataset (System 330 * labels are excluded). 331 * See https://goo.gl/xmQnxf for more information and examples of labels. 332 * System reserved label keys are prefixed with "aiplatform.googleapis.com/" 333 * and are immutable. Following system labels exist for each Dataset: 334 * * "aiplatform.googleapis.com/dataset_metadata_schema": output only, its 335 * value is the 336 * [metadata_schema's][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri] 337 * title. 338 * </pre> 339 * 340 * <code>map<string, string> labels = 7;</code> 341 */ getLabelsMap()342 java.util.Map<java.lang.String, java.lang.String> getLabelsMap(); 343 /** 344 * 345 * 346 * <pre> 347 * The labels with user-defined metadata to organize your Datasets. 348 * Label keys and values can be no longer than 64 characters 349 * (Unicode codepoints), can only contain lowercase letters, numeric 350 * characters, underscores and dashes. International characters are allowed. 351 * No more than 64 user labels can be associated with one Dataset (System 352 * labels are excluded). 353 * See https://goo.gl/xmQnxf for more information and examples of labels. 354 * System reserved label keys are prefixed with "aiplatform.googleapis.com/" 355 * and are immutable. Following system labels exist for each Dataset: 356 * * "aiplatform.googleapis.com/dataset_metadata_schema": output only, its 357 * value is the 358 * [metadata_schema's][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri] 359 * title. 360 * </pre> 361 * 362 * <code>map<string, string> labels = 7;</code> 363 */ 364 /* nullable */ getLabelsOrDefault( java.lang.String key, java.lang.String defaultValue)365 java.lang.String getLabelsOrDefault( 366 java.lang.String key, 367 /* nullable */ 368 java.lang.String defaultValue); 369 /** 370 * 371 * 372 * <pre> 373 * The labels with user-defined metadata to organize your Datasets. 374 * Label keys and values can be no longer than 64 characters 375 * (Unicode codepoints), can only contain lowercase letters, numeric 376 * characters, underscores and dashes. International characters are allowed. 377 * No more than 64 user labels can be associated with one Dataset (System 378 * labels are excluded). 379 * See https://goo.gl/xmQnxf for more information and examples of labels. 380 * System reserved label keys are prefixed with "aiplatform.googleapis.com/" 381 * and are immutable. Following system labels exist for each Dataset: 382 * * "aiplatform.googleapis.com/dataset_metadata_schema": output only, its 383 * value is the 384 * [metadata_schema's][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri] 385 * title. 386 * </pre> 387 * 388 * <code>map<string, string> labels = 7;</code> 389 */ getLabelsOrThrow(java.lang.String key)390 java.lang.String getLabelsOrThrow(java.lang.String key); 391 392 /** 393 * 394 * 395 * <pre> 396 * All SavedQueries belong to the Dataset will be returned in List/Get 397 * Dataset response. The annotation_specs field 398 * will not be populated except for UI cases which will only use 399 * [annotation_spec_count][google.cloud.aiplatform.v1.SavedQuery.annotation_spec_count]. 400 * In CreateDataset request, a SavedQuery is created together if 401 * this field is set, up to one SavedQuery can be set in CreateDatasetRequest. 402 * The SavedQuery should not contain any AnnotationSpec. 403 * </pre> 404 * 405 * <code>repeated .google.cloud.aiplatform.v1.SavedQuery saved_queries = 9;</code> 406 */ getSavedQueriesList()407 java.util.List<com.google.cloud.aiplatform.v1.SavedQuery> getSavedQueriesList(); 408 /** 409 * 410 * 411 * <pre> 412 * All SavedQueries belong to the Dataset will be returned in List/Get 413 * Dataset response. The annotation_specs field 414 * will not be populated except for UI cases which will only use 415 * [annotation_spec_count][google.cloud.aiplatform.v1.SavedQuery.annotation_spec_count]. 416 * In CreateDataset request, a SavedQuery is created together if 417 * this field is set, up to one SavedQuery can be set in CreateDatasetRequest. 418 * The SavedQuery should not contain any AnnotationSpec. 419 * </pre> 420 * 421 * <code>repeated .google.cloud.aiplatform.v1.SavedQuery saved_queries = 9;</code> 422 */ getSavedQueries(int index)423 com.google.cloud.aiplatform.v1.SavedQuery getSavedQueries(int index); 424 /** 425 * 426 * 427 * <pre> 428 * All SavedQueries belong to the Dataset will be returned in List/Get 429 * Dataset response. The annotation_specs field 430 * will not be populated except for UI cases which will only use 431 * [annotation_spec_count][google.cloud.aiplatform.v1.SavedQuery.annotation_spec_count]. 432 * In CreateDataset request, a SavedQuery is created together if 433 * this field is set, up to one SavedQuery can be set in CreateDatasetRequest. 434 * The SavedQuery should not contain any AnnotationSpec. 435 * </pre> 436 * 437 * <code>repeated .google.cloud.aiplatform.v1.SavedQuery saved_queries = 9;</code> 438 */ getSavedQueriesCount()439 int getSavedQueriesCount(); 440 /** 441 * 442 * 443 * <pre> 444 * All SavedQueries belong to the Dataset will be returned in List/Get 445 * Dataset response. The annotation_specs field 446 * will not be populated except for UI cases which will only use 447 * [annotation_spec_count][google.cloud.aiplatform.v1.SavedQuery.annotation_spec_count]. 448 * In CreateDataset request, a SavedQuery is created together if 449 * this field is set, up to one SavedQuery can be set in CreateDatasetRequest. 450 * The SavedQuery should not contain any AnnotationSpec. 451 * </pre> 452 * 453 * <code>repeated .google.cloud.aiplatform.v1.SavedQuery saved_queries = 9;</code> 454 */ 455 java.util.List<? extends com.google.cloud.aiplatform.v1.SavedQueryOrBuilder> getSavedQueriesOrBuilderList()456 getSavedQueriesOrBuilderList(); 457 /** 458 * 459 * 460 * <pre> 461 * All SavedQueries belong to the Dataset will be returned in List/Get 462 * Dataset response. The annotation_specs field 463 * will not be populated except for UI cases which will only use 464 * [annotation_spec_count][google.cloud.aiplatform.v1.SavedQuery.annotation_spec_count]. 465 * In CreateDataset request, a SavedQuery is created together if 466 * this field is set, up to one SavedQuery can be set in CreateDatasetRequest. 467 * The SavedQuery should not contain any AnnotationSpec. 468 * </pre> 469 * 470 * <code>repeated .google.cloud.aiplatform.v1.SavedQuery saved_queries = 9;</code> 471 */ getSavedQueriesOrBuilder(int index)472 com.google.cloud.aiplatform.v1.SavedQueryOrBuilder getSavedQueriesOrBuilder(int index); 473 474 /** 475 * 476 * 477 * <pre> 478 * Customer-managed encryption key spec for a Dataset. If set, this Dataset 479 * and all sub-resources of this Dataset will be secured by this key. 480 * </pre> 481 * 482 * <code>.google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 11;</code> 483 * 484 * @return Whether the encryptionSpec field is set. 485 */ hasEncryptionSpec()486 boolean hasEncryptionSpec(); 487 /** 488 * 489 * 490 * <pre> 491 * Customer-managed encryption key spec for a Dataset. If set, this Dataset 492 * and all sub-resources of this Dataset will be secured by this key. 493 * </pre> 494 * 495 * <code>.google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 11;</code> 496 * 497 * @return The encryptionSpec. 498 */ getEncryptionSpec()499 com.google.cloud.aiplatform.v1.EncryptionSpec getEncryptionSpec(); 500 /** 501 * 502 * 503 * <pre> 504 * Customer-managed encryption key spec for a Dataset. If set, this Dataset 505 * and all sub-resources of this Dataset will be secured by this key. 506 * </pre> 507 * 508 * <code>.google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 11;</code> 509 */ getEncryptionSpecOrBuilder()510 com.google.cloud.aiplatform.v1.EncryptionSpecOrBuilder getEncryptionSpecOrBuilder(); 511 512 /** 513 * 514 * 515 * <pre> 516 * Output only. The resource name of the Artifact that was created in 517 * MetadataStore when creating the Dataset. The Artifact resource name pattern 518 * is 519 * `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`. 520 * </pre> 521 * 522 * <code>string metadata_artifact = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 523 * 524 * @return The metadataArtifact. 525 */ getMetadataArtifact()526 java.lang.String getMetadataArtifact(); 527 /** 528 * 529 * 530 * <pre> 531 * Output only. The resource name of the Artifact that was created in 532 * MetadataStore when creating the Dataset. The Artifact resource name pattern 533 * is 534 * `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`. 535 * </pre> 536 * 537 * <code>string metadata_artifact = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 538 * 539 * @return The bytes for metadataArtifact. 540 */ getMetadataArtifactBytes()541 com.google.protobuf.ByteString getMetadataArtifactBytes(); 542 } 543