- 1.44.0 (latest)
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.36.0
- 1.35.0
- 1.34.0
- 1.33.0
- 1.32.1
- 1.31.0
- 1.30.0
- 1.26.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.1
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.0
- 1.0.0
- 0.39.0
- 0.38.0
- 0.37.1
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.2
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.13.0
- 0.12.0
- 0.11.1
- 0.10.0
Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class Dataset.
A collection of DataItems and Annotations on them.
Generated from protobuf message google.cloud.aiplatform.v1.Dataset
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Output only. The resource name of the Dataset.
↳ display_name
string
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.
↳ description
string
The description of the Dataset.
↳ metadata_schema_uri
string
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/.
↳ metadata
Google\Protobuf\Value
Required. Additional information about the Dataset.
↳ create_time
Google\Protobuf\Timestamp
Output only. Timestamp when this Dataset was created.
↳ update_time
Google\Protobuf\Timestamp
Output only. Timestamp when this Dataset was last updated.
↳ etag
string
Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
↳ labels
array|Google\Protobuf\Internal\MapField
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.
↳ encryption_spec
Google\Cloud\AIPlatform\V1\EncryptionSpec
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.
↳ metadata_artifact
string
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}
.
getName
Output only. The resource name of the Dataset.
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
string
setName
Output only. The resource name of the Dataset.
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
var
string
$this
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.
Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
string
setDisplayName
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.
Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
var
string
$this
getDescription
The description of the Dataset.
Generated from protobuf field string description = 16;
string
setDescription
The description of the Dataset.
Generated from protobuf field string description = 16;
var
string
$this
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/.
Generated from protobuf field string metadata_schema_uri = 3 [(.google.api.field_behavior) = REQUIRED];
string
setMetadataSchemaUri
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/.
Generated from protobuf field string metadata_schema_uri = 3 [(.google.api.field_behavior) = REQUIRED];
var
string
$this
getMetadata
Required. Additional information about the Dataset.
Generated from protobuf field .google.protobuf.Value metadata = 8 [(.google.api.field_behavior) = REQUIRED];
Google\Protobuf\Value|null
hasMetadata
clearMetadata
setMetadata
Required. Additional information about the Dataset.
Generated from protobuf field .google.protobuf.Value metadata = 8 [(.google.api.field_behavior) = REQUIRED];
var
Google\Protobuf\Value
$this
getCreateTime
Output only. Timestamp when this Dataset was created.
Generated from protobuf field .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Google\Protobuf\Timestamp|null
hasCreateTime
clearCreateTime
setCreateTime
Output only. Timestamp when this Dataset was created.
Generated from protobuf field .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
var
Google\Protobuf\Timestamp
$this
getUpdateTime
Output only. Timestamp when this Dataset was last updated.
Generated from protobuf field .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
Google\Protobuf\Timestamp|null
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Timestamp when this Dataset was last updated.
Generated from protobuf field .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
var
Google\Protobuf\Timestamp
$this
getEtag
Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
Generated from protobuf field string etag = 6;
string
setEtag
Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
Generated from protobuf field string etag = 6;
var
string
$this
getLabels
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.
Generated from protobuf field map<string, string> labels = 7;
Google\Protobuf\Internal\MapField
setLabels
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.
Generated from protobuf field map<string, string> labels = 7;
var
array|Google\Protobuf\Internal\MapField
$this
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.
Generated from protobuf field .google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 11;
hasEncryptionSpec
clearEncryptionSpec
setEncryptionSpec
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.
Generated from protobuf field .google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 11;
$this
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}
.
Generated from protobuf field string metadata_artifact = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
string
setMetadataArtifact
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}
.
Generated from protobuf field string metadata_artifact = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
var
string
$this
