Package google.cloud.aiplatform.v1

Index

DatasetService

The service that manages Vertex AI Dataset and its child resources.

CreateDataset

rpc CreateDataset(CreateDatasetRequest) returns (Operation)

Creates a Dataset.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • aiplatform.datasets.create

For more information, see the IAM documentation.

CreateDatasetVersion

rpc CreateDatasetVersion(CreateDatasetVersionRequest) returns (Operation)

Create a version from a Dataset.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • aiplatform.datasetVersions.create

For more information, see the IAM documentation.

DeleteDataset

rpc DeleteDataset(DeleteDatasetRequest) returns (Operation)

Deletes a Dataset.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • aiplatform.datasets.delete

For more information, see the IAM documentation.

DeleteDatasetVersion

rpc DeleteDatasetVersion(DeleteDatasetVersionRequest) returns (Operation)

Deletes a Dataset version.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • aiplatform.datasetVersions.delete

For more information, see the IAM documentation.

DeleteSavedQuery

rpc DeleteSavedQuery(DeleteSavedQueryRequest) returns (Operation)

Deletes a SavedQuery.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • aiplatform.datasets.delete

For more information, see the IAM documentation.

ExportData

rpc ExportData(ExportDataRequest) returns (Operation)

Exports data from a Dataset.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • aiplatform.datasets.export

For more information, see the IAM documentation.

GetAnnotationSpec

rpc GetAnnotationSpec(GetAnnotationSpecRequest) returns (AnnotationSpec)

Gets an AnnotationSpec.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • aiplatform.annotationSpecs.get

For more information, see the IAM documentation.

GetDataset

rpc GetDataset(GetDatasetRequest) returns (Dataset)

Gets a Dataset.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • aiplatform.datasets.get

For more information, see the IAM documentation.

GetDatasetVersion

rpc GetDatasetVersion(GetDatasetVersionRequest) returns (DatasetVersion)

Gets a Dataset version.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • aiplatform.datasetVersions.get

For more information, see the IAM documentation.

ImportData

rpc ImportData(ImportDataRequest) returns (Operation)

Imports data into a Dataset.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • aiplatform.datasets.import

For more information, see the IAM documentation.

ListAnnotations

rpc ListAnnotations(ListAnnotationsRequest) returns (ListAnnotationsResponse)

Lists Annotations belongs to a dataitem

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • aiplatform.annotations.list

For more information, see the IAM documentation.

ListDataItems

rpc ListDataItems(ListDataItemsRequest) returns (ListDataItemsResponse)

Lists DataItems in a Dataset.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • aiplatform.dataItems.list

For more information, see the IAM documentation.

ListDatasetVersions

rpc ListDatasetVersions(ListDatasetVersionsRequest) returns (ListDatasetVersionsResponse)

Lists DatasetVersions in a Dataset.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • aiplatform.datasetVersions.list

For more information, see the IAM documentation.

ListDatasets

rpc ListDatasets(ListDatasetsRequest) returns (ListDatasetsResponse)

Lists Datasets in a Location.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • aiplatform.datasets.list

For more information, see the IAM documentation.

ListSavedQueries

rpc ListSavedQueries(ListSavedQueriesRequest) returns (ListSavedQueriesResponse)

Lists SavedQueries in a Dataset.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • aiplatform.datasets.get

For more information, see the IAM documentation.

RestoreDatasetVersion

rpc RestoreDatasetVersion(RestoreDatasetVersionRequest) returns (Operation)

Restores a dataset version.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • aiplatform.datasetVersions.restore

For more information, see the IAM documentation.

SearchDataItems

rpc SearchDataItems(SearchDataItemsRequest) returns (SearchDataItemsResponse)

Searches DataItems in a Dataset.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the dataset resource:

  • aiplatform.dataItems.list

For more information, see the IAM documentation.

UpdateDataset

rpc UpdateDataset(UpdateDatasetRequest) returns (Dataset)

Updates a Dataset.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • aiplatform.datasets.update

For more information, see the IAM documentation.

DeploymentResourcePoolService

A service that manages the DeploymentResourcePool resource.

CreateDeploymentResourcePool

rpc CreateDeploymentResourcePool(CreateDeploymentResourcePoolRequest) returns (Operation)

Create a DeploymentResourcePool.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • aiplatform.deploymentResourcePools.create

For more information, see the IAM documentation.

DeleteDeploymentResourcePool

rpc DeleteDeploymentResourcePool(DeleteDeploymentResourcePoolRequest) returns (Operation)

Delete a DeploymentResourcePool.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • aiplatform.deploymentResourcePools.delete

For more information, see the IAM documentation.

GetDeploymentResourcePool

rpc GetDeploymentResourcePool(GetDeploymentResourcePoolRequest) returns (DeploymentResourcePool)

Get a DeploymentResourcePool.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • aiplatform.deploymentResourcePools.get

For more information, see the IAM documentation.

ListDeploymentResourcePools

rpc ListDeploymentResourcePools(ListDeploymentResourcePoolsRequest) returns (ListDeploymentResourcePoolsResponse)

List DeploymentResourcePools in a location.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • aiplatform.deploymentResourcePools.list

For more information, see the IAM documentation.

QueryDeployedModels

rpc QueryDeployedModels(QueryDeployedModelsRequest) returns (QueryDeployedModelsResponse)

List DeployedModels that have been deployed on this DeploymentResourcePool.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the deploymentResourcePool resource:

  • aiplatform.deploymentResourcePools.queryDeployedModels

For more information, see the IAM documentation.

EndpointService

A service for managing Vertex AI's Endpoints.

CreateEndpoint

rpc CreateEndpoint(CreateEndpointRequest) returns (Operation)

Creates an Endpoint.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • aiplatform.endpoints.create

For more information, see the IAM documentation.

DeleteEndpoint

rpc DeleteEndpoint(DeleteEndpointRequest) returns (Operation)

Deletes an Endpoint.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • aiplatform.endpoints.delete

For more information, see the IAM documentation.

DeployModel

rpc DeployModel(DeployModelRequest) returns (Operation)

Deploys a Model into this Endpoint, creating a DeployedModel within it.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the endpoint resource:

  • aiplatform.endpoints.deploy

For more information, see the IAM documentation.

GetEndpoint

rpc GetEndpoint(GetEndpointRequest) returns (Endpoint)

Gets an Endpoint.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • aiplatform.endpoints.get

For more information, see the IAM documentation.

ListEndpoints

rpc ListEndpoints(ListEndpointsRequest) returns (ListEndpointsResponse)

Lists Endpoints in a Location.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • aiplatform.endpoints.list

For more information, see the IAM documentation.

MutateDeployedModel

rpc MutateDeployedModel(MutateDeployedModelRequest) returns (Operation)

Updates an existing deployed model. Updatable fields include min_replica_count, max_replica_count, autoscaling_metric_specs, disable_container_logging (v1 only), and enable_container_logging (v1beta1 only).

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the endpoint resource:

  • aiplatform.endpoints.deploy

For more information, see the IAM documentation.

UndeployModel

rpc UndeployModel(UndeployModelRequest) returns (Operation)

Undeploys a Model from an Endpoint, removing a DeployedModel from it, and freeing all resources it's using.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the endpoint resource:

  • aiplatform.endpoints.undeploy

For more information, see the IAM documentation.

UpdateEndpoint

rpc UpdateEndpoint(UpdateEndpointRequest) returns (Endpoint)

Updates an Endpoint.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • aiplatform.endpoints.update

For more information, see the IAM documentation.

FeatureOnlineStoreAdminService

The service that handles CRUD and List for resources for FeatureOnlineStore.

CreateFeatureOnlineStore

rpc CreateFeatureOnlineStore(CreateFeatureOnlineStoreRequest) returns (Operation)

Creates a new FeatureOnlineStore in a given project and location.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • aiplatform.featureOnlineStores.create

For more information, see the IAM documentation.

CreateFeatureView

rpc CreateFeatureView(CreateFeatureViewRequest) returns (Operation)

Creates a new FeatureView in a given FeatureOnlineStore.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • aiplatform.featureViews.create

For more information, see the IAM documentation.

DeleteFeatureOnlineStore

rpc DeleteFeatureOnlineStore(DeleteFeatureOnlineStoreRequest) returns (Operation)

Deletes a single FeatureOnlineStore. The FeatureOnlineStore must not contain any FeatureViews.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • aiplatform.featureOnlineStores.delete

For more information, see the IAM documentation.

DeleteFeatureView

rpc DeleteFeatureView(DeleteFeatureViewRequest) returns (Operation)

Deletes a single FeatureView.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • aiplatform.featureViews.delete

For more information, see the IAM documentation.

GetFeatureOnlineStore

rpc GetFeatureOnlineStore(GetFeatureOnlineStoreRequest) returns (FeatureOnlineStore)

Gets details of a single FeatureOnlineStore.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • aiplatform.featureOnlineStores.get

For more information, see the IAM documentation.

GetFeatureView

rpc GetFeatureView(GetFeatureViewRequest) returns (FeatureView)

Gets details of a single FeatureView.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • aiplatform.featureViews.get

For more information, see the IAM documentation.

GetFeatureViewSync

rpc GetFeatureViewSync(GetFeatureViewSyncRequest) returns (FeatureViewSync)

Gets details of a single FeatureViewSync.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • aiplatform.featureViewSyncs.get

For more information, see the IAM documentation.

ListFeatureOnlineStores

rpc ListFeatureOnlineStores(ListFeatureOnlineStoresRequest) returns (ListFeatureOnlineStoresResponse)

Lists FeatureOnlineStores in a given project and location.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • aiplatform.featureOnlineStores.list

For more information, see the IAM documentation.

ListFeatureViewSyncs

rpc ListFeatureViewSyncs(ListFeatureViewSyncsRequest) returns (ListFeatureViewSyncsResponse)

Lists FeatureViewSyncs in a given FeatureView.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • aiplatform.featureViewSyncs.list

For more information, see the IAM documentation.

ListFeatureViews

rpc ListFeatureViews(ListFeatureViewsRequest) returns (ListFeatureViewsResponse)

Lists FeatureViews in a given FeatureOnlineStore.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • aiplatform.featureViews.list

For more information, see the IAM documentation.

SyncFeatureView

rpc SyncFeatureView(SyncFeatureViewRequest) returns (SyncFeatureViewResponse)

Triggers on-demand sync for the FeatureView.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the featureView resource:

  • aiplatform.featureViews.sync

For more information, see the IAM documentation.

UpdateFeatureOnlineStore

rpc UpdateFeatureOnlineStore(UpdateFeatureOnlineStoreRequest) returns (Operation)

Updates the parameters of a single FeatureOnlineStore.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • aiplatform.featureOnlineStores.update

For more information, see the IAM documentation.

UpdateFeatureView

rpc UpdateFeatureView(UpdateFeatureViewRequest) returns (Operation)

Updates the parameters of a single FeatureView.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • aiplatform.featureViews.update

For more information, see the IAM documentation.

FeatureOnlineStoreService

A service for fetching feature values from the online store.

FetchFeatureValues

rpc FetchFeatureValues(FetchFeatureValuesRequest) returns (FetchFeatureValuesResponse)

Fetch feature values under a FeatureView.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the featureView resource:

  • aiplatform.featureViews.fetchFeatureValues

For more information, see the IAM documentation.

SearchNearestEntities

rpc SearchNearestEntities(SearchNearestEntitiesRequest) returns (SearchNearestEntitiesResponse)

Search the nearest entities under a FeatureView. Search only works for indexable feature view; if a feature view isn't indexable, returns Invalid argument response.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the featureView resource:

  • aiplatform.featureViews.searchNearestEntities

For more information, see the IAM documentation.

FeatureRegistryService

The service that handles CRUD and List for resources for FeatureRegistry.

CreateFeature

rpc CreateFeature(CreateFeatureRequest) returns (Operation)

Creates a new Feature in a given FeatureGroup.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • aiplatform.features.create

For more information, see the IAM documentation.

CreateFeatureGroup

rpc CreateFeatureGroup(CreateFeatureGroupRequest) returns (Operation)

Creates a new FeatureGroup in a given project and location.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • aiplatform.featureGroups.create

For more information, see the IAM documentation.

DeleteFeature

rpc DeleteFeature(DeleteFeatureRequest) returns (Operation)

Deletes a single Feature.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • aiplatform.features.delete

For more information, see the IAM documentation.

DeleteFeatureGroup

rpc DeleteFeatureGroup(DeleteFeatureGroupRequest) returns (Operation)

Deletes a single FeatureGroup.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • aiplatform.featureGroups.delete

For more information, see the IAM documentation.

GetFeature

rpc GetFeature(GetFeatureRequest) returns (Feature)

Gets details of a single Feature.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following