VertexAIMetadataStore

Property Value
Google Cloud Service Name Analytics Hub
Google Cloud Service Documentation /bigquery/docs/query-overview
Google Cloud REST Resource Name v1.projects.locations.dataExchanges.listings
Google Cloud REST Resource Documentation /bigquery/docs/reference/analytics-hub/rest/v1/projects.locations.dataExchanges.listings
Config Connector Resource Short Names gcpvertexaimetadatastore
gcpvertexaimetadatastores
vertexaimetadatastore
Config Connector Service Name analyticshub.googleapis.com
Config Connector Resource Fully Qualified Name vertexaimetadatastores.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

dataplexConfig:
  enabledPipelinesLineage: boolean
description: string
encryptionSpec:
  kmsKeyRef:
    external: string
    name: string
    namespace: string
projectRef:
  external: string
  kind: string
  name: string
  namespace: string
region: string
resourceID: string
Fields

dataplexConfig

Optional

object

Optional. Dataplex integration settings.

dataplexConfig.enabledPipelinesLineage

Optional

boolean

Optional. Whether or not Data Lineage synchronization is enabled for Vertex Pipelines.

description

Optional

string

Description of the MetadataStore.

encryptionSpec

Optional

object

Customer-managed encryption key spec for a Metadata Store. If set, this Metadata Store and all sub-resources of this Metadata Store are secured using this key.

encryptionSpec.kmsKeyRef

Required*

object

Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. The key needs to be in the same region as where the compute resource is created.

encryptionSpec.kmsKeyRef.external

Optional

string

A reference to an externally managed KMSCryptoKey. Should be in the format `projects/[kms_project_id]/locations/[region]/keyRings/[key_ring_id]/cryptoKeys/[key]`.

encryptionSpec.kmsKeyRef.name

Optional

string

The `name` of a `KMSCryptoKey` resource.

encryptionSpec.kmsKeyRef.namespace

Optional

string

The `namespace` of a `KMSCryptoKey` resource.

projectRef

Optional

object

The project that this resource belongs to.

projectRef.external

Optional

string

The `projectID` field of a project, when not managed by Config Connector.

projectRef.kind

Optional

string

The kind of the Project resource; optional but must be `Project` if provided.

projectRef.name

Optional

string

The `name` field of a `Project` resource.

projectRef.namespace

Optional

string

The `namespace` field of a `Project` resource.

region

Optional

string

The region of the Metadata Store. eg us-central1.

resourceID

Optional

string

The VertexAIMetadataStore name. If not given, the metadata.name will be used.

* Field is required when parent field is specified

Status

Schema

conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
externalRef: string
observedGeneration: integer
observedState:
  createTime: string
  name: string
  state:
    diskUtilizationBytes: integer
  updateTime: string
Fields
conditions

list (object)

Conditions represent the latest available observations of the object'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.
externalRef

string

A unique specifier for the VertexAIMetadataStore resource in GCP.
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

ObservedState is the state of the resource as most recently observed in GCP.
observedState.createTime

string

Output only. Timestamp when this MetadataStore was created.
observedState.name

string

Output only. The resource name of the MetadataStore instance.
observedState.state

object

Output only. State information of the MetadataStore.
observedState.state.diskUtilizationBytes

integer

The disk utilization of the MetadataStore in bytes.
observedState.updateTime

string

Output only. Timestamp when this MetadataStore was last updated.

Sample YAML(s)

Typical Use Case

# 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: VertexAIMetadataStore
metadata:
  name: metadatastore-sample
spec:
  region: us-central1
  description: "An encrypted metadata store"
  encryptionSpec:
    kmsKeyRef: 
      name: vertexaimetadatastore-dep
  projectRef:
    external: ${PROJECT_ID?}
  dataplexConfig:
    enabledPipelinesLineage: true
---
apiVersion: kms.cnrm.cloud.google.com/v1beta1
kind: KMSCryptoKey
metadata:
  name: vertexaimetadatastore-dep
spec:
  keyRingRef:
    name: vertexaimetadatastore-dep
  purpose: ENCRYPT_DECRYPT
---
apiVersion: kms.cnrm.cloud.google.com/v1beta1
kind: KMSKeyRing
metadata:
  name: vertexaimetadatastore-dep
spec:
  location: us-central1