Console
    Contact Us Start free

    VertexAIDataset

    Property Value
    Google Cloud Service Name Vertex AI
    Google Cloud Service Documentation /vertex-ai/docs
    Google Cloud REST Resource Name v1beta1.projects.locations.datasets
    Google Cloud REST Resource Documentation /vertex-ai/docs/reference/rest/v1beta1/projects.locations.datasets
    Config Connector Resource Short Names gcpvertexaidataset
    gcpvertexaidatasets
    vertexaidataset
    Config Connector Service Name aiplatform.googleapis.com
    Config Connector Resource Fully Qualified Name vertexaidatasets.vertexai.cnrm.cloud.google.com
    Can Be Referenced by IAMPolicy/IAMPolicyMember No
    Config Connector Default Average Reconcile Interval In Seconds 600

    Custom Resource Definition Properties

    Spec

    Schema

      displayName 
 : 
  
 string 
 encryptionSpec 
 : 
  
 kmsKeyNameRef 
 : 
  
 external 
 : 
  
 string 
  
 name 
 : 
  
 string 
  
 namespace 
 : 
  
 string 
 metadataSchemaUri 
 : 
  
 string 
 projectRef 
 : 
  
 external 
 : 
  
 string 
  
 name 
 : 
  
 string 
  
 namespace 
 : 
  
 string 
 region 
 : 
  
 string 
 resourceID 
 : 
  
 string
    Fields

    displayName

    Required

    string

    The user-defined name of the Dataset. The name can be up to 128 characters long and can be consist of any UTF-8 characters.

    encryptionSpec

    Optional

    object

    Immutable. 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.

    encryptionSpec.kmsKeyNameRef

    Optional

    object

    Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the compute resource is created.

    encryptionSpec.kmsKeyNameRef.external

    Optional

    string

    Allowed value: The `selfLink` field of a `KMSCryptoKey` resource.

    encryptionSpec.kmsKeyNameRef.name

    Optional

    string

    Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

    encryptionSpec.kmsKeyNameRef.namespace

    Optional

    string

    Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

    metadataSchemaUri

    Required

    string

    Immutable. 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/.

    projectRef

    Required

    object

    The project that this resource belongs to.

    projectRef.external

    Optional

    string

    Allowed value: The `name` field of a `Project` resource.

    projectRef.name

    Optional

    string

    Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

    projectRef.namespace

    Optional

    string

    Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

    region

    Optional

    string

    Immutable. The region of the dataset. eg us-central1.

    resourceID

    Optional

    string

    Immutable. Optional. The service-generated name of the resource. Used for acquisition only. Leave unset to create a new resource.

    Status

    Schema

      conditions 
 : 
 - 
  
 lastTransitionTime 
 : 
  
 string 
  
 message 
 : 
  
 string 
  
 reason 
 : 
  
 string 
  
 status 
 : 
  
 string 
  
 type 
 : 
  
 string 
 observedGeneration 
 : 
  
 integer 
 observedState 
 : 
  
 createTime 
 : 
  
 string 
  
 name 
 : 
  
 string
    Fields
    conditions

    list (object)

    Conditions represent the latest available observation of the resource's current state.
    conditions[]

    object

    conditions[].lastTransitionTime

    string

    Last time the condition transitioned from one status to another.
    conditions[].message

    string

    Human-readable message indicating details about last transition.
    conditions[].reason

    string

    Unique, one-word, CamelCase reason for the condition's last transition.
    conditions[].status

    string

    Status is the status of the condition. Can be True, False, Unknown.
    conditions[].type

    string

    Type is the type of the condition.
    observedGeneration

    integer

    ObservedGeneration is the generation of the resource that was most recently observed by the Config Connector controller. If this is equal to metadata.generation, then that means that the current reported status reflects the most recent desired state of the resource.
    observedState

    object

    The observed state of the underlying GCP resource.
    observedState.createTime

    string

    The timestamp of when the dataset was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    observedState.name

    string

    The resource name of the Dataset. This value is set by Google.

    Sample YAML(s)

    VertexAI Dataset Basic

      # Copyright 2024 Google LLC 
 # 
 # Licensed under the Apache License, Version 2.0 (the "License"); 
 # you may not use this file except in compliance with the License. 
 # You may obtain a copy of the License at 
 # 
 #     http://www.apache.org/licenses/LICENSE-2.0 
 # 
 # Unless required by applicable law or agreed to in writing, software 
 # distributed under the License is distributed on an "AS IS" BASIS, 
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
 # See the License for the specific language governing permissions and 
 # limitations under the License. 
 apiVersion 
 : 
  
 vertexai.cnrm.cloud.google.com/v1beta1 
 kind 
 : 
  
 VertexAIDataset 
 metadata 
 : 
  
 name 
 : 
  
 vertexaidataset-sample-basic 
 spec 
 : 
  
 displayName 
 : 
  
 "example 
  
 vertex 
  
 AI 
  
 dataset" 
  
 metadataSchemaUri 
 : 
  
 "gs://google-cloud-aiplatform/schema/dataset/metadata/image_1.0.0.yaml" 
  
 region 
 : 
  
 us-central1 
  
 projectRef 
 : 
  
 # Replace ${PROJECT_ID?} with your project ID. 
  
 external 
 : 
  
 ${PROJECT_ID?}

    VertexAI Dataset Encryptionkey

      # Copyright 2024 Google LLC 
 # 
 # Licensed under the Apache License, Version 2.0 (the "License"); 
 # you may not use this file except in compliance with the License. 
 # You may obtain a copy of the License at 
 # 
 #     http://www.apache.org/licenses/LICENSE-2.0 
 # 
 # Unless required by applicable law or agreed to in writing, software 
 # distributed under the License is distributed on an "AS IS" BASIS, 
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
 # See the License for the specific language governing permissions and 
 # limitations under the License. 
 apiVersion 
 : 
  
 vertexai.cnrm.cloud.google.com/v1beta1 
 kind 
 : 
  
 VertexAIDataset 
 metadata 
 : 
  
 name 
 : 
  
 vertexaidataset-sample-encryptionkey 
 spec 
 : 
  
 displayName 
 : 
  
 "example 
  
 vertex 
  
 AI 
  
 dataset 
  
 with 
  
 encryption 
  
 key" 
  
 metadataSchemaUri 
 : 
  
 "gs://google-cloud-aiplatform/schema/dataset/metadata/image_1.0.0.yaml" 
  
 region 
 : 
  
 us-central1 
  
 encryptionSpec 
 : 
  
 kmsKeyNameRef 
 : 
  
 name 
 : 
  
 vertexaidataset-dep-encryptionkey 
  
 projectRef 
 : 
  
 # Replace ${PROJECT_ID?} with your project ID. 
  
 external 
 : 
  
 ${PROJECT_ID?} 
 --- 
 # Replace ${PROJECT_ID?} and ${PROJECT_NUMBER?} below with your desired project 
 # ID and project number. 
 apiVersion 
 : 
  
 iam.cnrm.cloud.google.com/v1beta1 
 kind 
 : 
  
 IAMPolicyMember 
 metadata 
 : 
  
 name 
 : 
  
 vertexaidataset-dep-encryptionkey 
 spec 
 : 
  
 memberFrom 
 : 
  
 serviceIdentityRef 
 : 
  
 name 
 : 
  
 vertexaidataset-dep-encryptionkey 
  
 role 
 : 
  
 roles/cloudkms.cryptoKeyEncrypterDecrypter 
  
 # required by vertex AI service agent to access KMS keys 
  
 resourceRef 
 : 
  
 apiVersion 
 : 
  
 resourcemanager.cnrm.cloud.google.com/v1beta1 
  
 kind 
 : 
  
 Project 
  
 external 
 : 
  
 projects/${PROJECT_ID?} 
 --- 
 apiVersion 
 : 
  
 kms.cnrm.cloud.google.com/v1beta1 
 kind 
 : 
  
 KMSCryptoKey 
 metadata 
 : 
  
 name 
 : 
  
 vertexaidataset-dep-encryptionkey 
 spec 
 : 
  
 keyRingRef 
 : 
  
 name 
 : 
  
 vertexaidataset-dep-encryptionkey 
  
 purpose 
 : 
  
 ENCRYPT_DECRYPT 
 --- 
 apiVersion 
 : 
  
 kms.cnrm.cloud.google.com/v1beta1 
 kind 
 : 
  
 KMSKeyRing 
 metadata 
 : 
  
 name 
 : 
  
 vertexaidataset-dep-encryptionkey 
 spec 
 : 
  
 location 
 : 
  
 us-central1 
 --- 
 apiVersion 
 : 
  
 serviceusage.cnrm.cloud.google.com/v1beta1 
 kind 
 : 
  
 ServiceIdentity 
 metadata 
 : 
  
 name 
 : 
  
 vertexaidataset-dep-encryptionkey 
  
 annotations 
 : 
  
 cnrm.cloud.google.com/deletion-policy 
 : 
  
 "abandon" 
 spec 
 : 
  
 projectRef 
 : 
  
 # Replace ${PROJECT_ID?} with your project ID. 
  
 external 
 : 
  
 ${PROJECT_ID?} 
  
 resourceID 
 : 
  
 aiplatform.googleapis.com
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: