Package google.cloud.aiplatform.v1

Index

DatasetService

The service that handles the CRUD of 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.

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.

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.

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.

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.

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.

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.

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.

IndexEndpointService

A service for managing Vertex AI's IndexEndpoints.

CreateIndexEndpoint

rpc CreateIndexEndpoint(CreateIndexEndpointRequest) returns (Operation)

Creates an IndexEndpoint.

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.indexEndpoints.create

For more information, see the IAM documentation.

DeleteIndexEndpoint

rpc DeleteIndexEndpoint(DeleteIndexEndpointRequest) returns (Operation)

Deletes an IndexEndpoint.

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.indexEndpoints.delete

For more information, see the IAM documentation.

DeployIndex

rpc DeployIndex(DeployIndexRequest) returns (Operation)

Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it. Only non-empty Indexes can be deployed.

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 indexEndpoint resource:

  • aiplatform.indexEndpoints.deploy

For more information, see the IAM documentation.

GetIndexEndpoint

rpc GetIndexEndpoint(GetIndexEndpointRequest) returns (IndexEndpoint)

Gets an IndexEndpoint.

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.indexEndpoints.get

For more information, see the IAM documentation.

ListIndexEndpoints

rpc ListIndexEndpoints(ListIndexEndpointsRequest) returns (ListIndexEndpointsResponse)

Lists IndexEndpoints 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.indexEndpoints.list

For more information, see the IAM documentation.

MutateDeployedIndex

rpc MutateDeployedIndex(MutateDeployedIndexRequest) returns (Operation)

Update an existing DeployedIndex under an IndexEndpoint.

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 indexEndpoint resource:

  • aiplatform.indexEndpoints.deploy

For more information, see the IAM documentation.

UndeployIndex

rpc UndeployIndex(UndeployIndexRequest) returns (Operation)

Undeploys an Index from an IndexEndpoint, removing a DeployedIndex 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 indexEndpoint resource:

  • aiplatform.indexEndpoints.undeploy

For more information, see the IAM documentation.

UpdateIndexEndpoint

rpc UpdateIndexEndpoint(UpdateIndexEndpointRequest) returns (IndexEndpoint)

Updates an IndexEndpoint.

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.indexEndpoints.update

For more information, see the IAM documentation.

IndexService

A service for creating and managing Vertex AI's Index resources.

CreateIndex

rpc CreateIndex(CreateIndexRequest) returns (Operation)

Creates an Index.

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.indexes.create

For more information, see the IAM documentation.

DeleteIndex

rpc DeleteIndex(DeleteIndexRequest) returns (Operation)

Deletes an Index. An Index can only be deleted when all its DeployedIndexes had been undeployed.

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.indexes.delete

For more information, see the IAM documentation.

GetIndex

rpc GetIndex(GetIndexRequest) returns (Index)

Gets an Index.

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.indexes.get

For more information, see the IAM documentation.

ListIndexes

rpc ListIndexes(ListIndexesRequest) returns (ListIndexesResponse)

Lists Indexes 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.indexes.list

For more information, see the IAM documentation.

UpdateIndex

rpc UpdateIndex(UpdateIndexRequest) returns (Operation)

Updates an Index.

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.indexes.update

For more information, see the IAM documentation.

JobService

A service for creating and managing Vertex AI's jobs.

CancelBatchPredictionJob

rpc CancelBatchPredictionJob(CancelBatchPredictionJobRequest) returns (Empty)

Cancels a BatchPredictionJob.

Starts asynchronous cancellation on the BatchPredictionJob. The server makes the best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetBatchPredictionJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On a successful cancellation, the BatchPredictionJob is not deleted;instead its BatchPredictionJob.state is set to CANCELLED. Any files already outputted by the job are not deleted.

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.batchPredictionJobs.cancel

For more information, see the IAM documentation.

CancelCustomJob

rpc CancelCustomJob(CancelCustomJobRequest) returns (Empty)

Cancels a CustomJob. Starts asynchronous cancellation on the CustomJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetCustomJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the CustomJob is not deleted; instead it becomes a job with a CustomJob.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED, and CustomJob.state is set to CANCELLED.

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.customJobs.cancel

For more information, see the IAM documentation.

CancelDataLabelingJob

rpc CancelDataLabelingJob(CancelDataLabelingJobRequest) returns (Empty)

Cancels a DataLabelingJob. Success of cancellation is not guaranteed.

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.dataLabelingJobs.cancel

For more information, see the IAM documentation.

CancelHyperparameterTuningJob

rpc CancelHyperparameterTuningJob(CancelHyperparameterTuningJobRequest) returns (Empty)

Cancels a HyperparameterTuningJob. Starts asynchronous cancellation on the HyperparameterTuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetHyperparameterTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the HyperparameterTuningJob is not deleted; instead it becomes a job with a HyperparameterTuningJob.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED, and HyperparameterTuningJob.state is set to CANCELLED.

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.hyperparameterTuningJobs.cancel

For more information, see the IAM documentation.

CreateBatchPredictionJob

rpc CreateBatchPredictionJob(CreateBatchPredictionJobRequest) returns (BatchPredictionJob)

Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start.

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.batchPredictionJobs.create

For more information, see the IAM documentation.

CreateCustomJob

rpc CreateCustomJob(CreateCustomJobRequest) returns (CustomJob)

Creates a CustomJob. A created CustomJob right away will be attempted to be run.

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.customJobs.create

For more information, see the IAM documentation.

CreateDataLabelingJob

rpc CreateDataLabelingJob(CreateDataLabelingJobRequest) returns (DataLabelingJob)

Creates a DataLabelingJob.

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.dataLabelingJobs.create

For more information, see the IAM documentation.

CreateHyperparameterTuningJob

rpc CreateHyperparameterTuningJob(CreateHyperparameterTuningJobRequest) returns (HyperparameterTuningJob)

Creates a HyperparameterTuningJob

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.hyperparameterTuningJobs.create

For more information, see the IAM documentation.

CreateModelDeploymentMonitoringJob

rpc CreateModelDeploymentMonitoringJob(CreateModelDeploymentMonitoringJobRequest) returns (ModelDeploymentMonitoringJob)

Creates a ModelDeploymentMonitoringJob. It will run periodically on a configured interval.

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.modelDeploymentMonitoringJobs.create

For more information, see the IAM documentation.

DeleteBatchPredictionJob

rpc DeleteBatchPredictionJob(DeleteBatchPredictionJobRequest) returns (Operation)

Deletes a BatchPredictionJob. Can only be called on jobs that already finished.

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.batchPredictionJobs.delete

For more information, see the IAM documentation.

DeleteCustomJob

rpc DeleteCustomJob(DeleteCustomJobRequest) returns (Operation)

Deletes a CustomJob.

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.customJobs.delete

For more information, see the IAM documentation.

DeleteDataLabelingJob

rpc DeleteDataLabelingJob(DeleteDataLabelingJobRequest) returns (Operation)

Deletes a DataLabelingJob.

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.dataLabelingJobs.delete

For more information, see the IAM documentation.

DeleteHyperparameterTuningJob

rpc DeleteHyperparameterTuningJob(DeleteHyperparameterTuningJobRequest) returns (Operation)

Deletes a HyperparameterTuningJob.

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.hyperparameterTuningJobs.delete

For more information, see the IAM documentation.

DeleteModelDeploymentMonitoringJob

rpc DeleteModelDeploymentMonitoringJob(DeleteModelDeploymentMonitoringJobRequest) returns (Operation)

Deletes a ModelDeploymentMonitoringJob.

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.modelDeploymentMonitoringJobs.delete

For more information, see the IAM documentation.

GetBatchPredictionJob

rpc GetBatchPredictionJob(GetBatchPredictionJobRequest) returns (BatchPredictionJob)

Gets a BatchPredictionJob

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.batchPredictionJobs.get

For more information, see the IAM documentation.

GetCustomJob

rpc GetCustomJob(GetCustomJobRequest) returns (CustomJob)

Gets a CustomJob.

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.customJobs.get

For more information, see the IAM documentation.

GetDataLabelingJob

rpc GetDataLabelingJob(GetDataLabelingJobRequest) returns (DataLabelingJob)

Gets a DataLabelingJob.

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.dataLabelingJobs.get

For more information, see the IAM documentation.

GetHyperparameterTuningJob

rpc GetHyperparameterTuningJob(GetHyperparameterTuningJobRequest) returns (HyperparameterTuningJob)

Gets a HyperparameterTuningJob

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.hyperparameterTuningJobs.get

For more information, see the IAM documentation.

GetModelDeploymentMonitoringJob

rpc GetModelDeploymentMonitoringJob(GetModelDeploymentMonitoringJobRequest) returns (ModelDeploymentMonitoringJob)

Gets a ModelDeploymentMonitoringJob.

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.modelDeploymentMonitoringJobs.get

For more information, see the IAM documentation.

ListBatchPredictionJobs

rpc ListBatchPredictionJobs(ListBatchPredictionJobsRequest) returns (ListBatchPredictionJobsResponse)

Lists BatchPredictionJobs 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.batchPredictionJobs.list

For more information, see the IAM documentation.

ListCustomJobs

rpc ListCustomJobs(ListCustomJobsRequest) returns (ListCustomJobsResponse)

Lists CustomJobs 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.customJobs.list

For more information, see the IAM documentation.

ListDataLabelingJobs

rpc ListDataLabelingJobs(ListDataLabelingJobsRequest) returns (ListDataLabelingJobsResponse)

Lists DataLabelingJobs 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.dataLabelingJobs.list

For more information, see the IAM documentation.

ListHyperparameterTuningJobs

rpc ListHyperparameterTuningJobs(ListHyperparameterTuningJobsRequest) returns (ListHyperparameterTuningJobsResponse)

Lists HyperparameterTuningJobs 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.hyperparameterTuningJobs.list

For more information, see the IAM documentation.

ListModelDeploymentMonitoringJobs

rpc ListModelDeploymentMonitoringJobs(ListModelDeploymentMonitoringJobsRequest) returns (ListModelDeploymentMonitoringJobsResponse)

Lists ModelDeploymentMonitoringJobs 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.modelDeploymentMonitoringJobs.list

For more information, see the IAM documentation.

PauseModelDeploymentMonitoringJob

rpc PauseModelDeploymentMonitoringJob(PauseModelDeploymentMonitoringJobRequest) returns (Empty)

Pauses a ModelDeploymentMonitoringJob. If the job is running, the server makes a best effort to cancel the job. Will mark ModelDeploymentMonitoringJob.state to 'PAUSED'.

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.modelDeploymentMonitoringJobs.pause

For more information, see the IAM documentation.

ResumeModelDeploymentMonitoringJob

rpc ResumeModelDeploymentMonitoringJob(ResumeModelDeploymentMonitoringJobRequest) returns (Empty)

Resumes a paused ModelDeploymentMonitoringJob. It will start to run from next scheduled time. A deleted ModelDeploymentMonitoringJob can't be resumed.

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.modelDeploymentMonitoringJobs.resume

For more information, see the IAM documentation.

SearchModelDeploymentMonitoringStatsAnomalies

rpc SearchModelDeploymentMonitoringStatsAnomalies(SearchModelDeploymentMonitoringStatsAnomaliesRequest) returns (SearchModelDeploymentMonitoringStatsAnomaliesResponse)

Searches Model Monitoring Statistics generated within a given time window.

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 modelDeploymentMonitoringJob resource:

  • aiplatform.modelDeploymentMonitoringJobs.searchStatsAnomalies

For more information, see the IAM documentation.

UpdateModelDeploymentMonitoringJob

rpc UpdateModelDeploymentMonitoringJob(UpdateModelDeploymentMonitoringJobRequest) returns (Operation)

Updates a ModelDeploymentMonitoringJob.

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.modelDeploymentMonitoringJobs.update

For more information, see the IAM documentation.

MetadataService

Service for reading and writing metadata entries.

AddContextArtifactsAndExecutions

rpc AddContextArtifactsAndExecutions(AddContextArtifactsAndExecutionsRequest) returns (AddContextArtifactsAndExecutionsResponse)

Adds a set of Artifacts and Executions to a Context. If any of the Artifacts or Executions have already been added to a Context, they are simply skipped.

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 context resource:

  • aiplatform.contexts.addContextArtifactsAndExecutions

For more information, see the IAM documentation.

AddContextChildren

rpc AddContextChildren(AddContextChildrenRequest) returns (AddContextChildrenResponse)

Adds a set of Contexts as children to a parent Context. If any of the child Contexts have already been added to the parent Context, they are simply skipped. If this call would create a cycle or cause any Context to have more than 10 parents, the request will fail with an INVALID_ARGUMENT error.

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 context resource:

  • aiplatform.contexts.addContextChildren

For more information, see the IAM documentation.

AddExecutionEvents

rpc AddExecutionEvents(AddExecutionEventsRequest) returns (AddExecutionEventsResponse)

Adds Events to the specified Execution. An Event indicates whether an Artifact was used as an input or output for an Execution. If an Event already exists between the Execution and the Artifact, the Event is skipped.

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 execution resource:

  • aiplatform.executions.addExecutionEvents

For more information, see the IAM documentation.

CreateArtifact

rpc CreateArtifact(CreateArtifactRequest) returns (Artifact)

Creates an Artifact associated with a MetadataStore.

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.artifacts.create

For more information, see the IAM documentation.

CreateContext

rpc CreateContext(CreateContextRequest) returns (Context)

Creates a Context associated with a MetadataStore.

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.contexts.create

For more information, see the IAM documentation.

CreateExecution

rpc CreateExecution(CreateExecutionRequest) returns (Execution)

Creates an Execution associated with a MetadataStore.

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.executions.create

For more information, see the IAM documentation.

CreateMetadataSchema

rpc CreateMetadataSchema(CreateMetadataSchemaRequest) returns (MetadataSchema)

Creates a MetadataSchema.

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.metadataSchemas.create

For more information, see the IAM documentation.

CreateMetadataStore

rpc CreateMetadataStore(CreateMetadataStoreRequest) returns (Operation)

Initializes a MetadataStore, including allocation of resources.

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.metadataStores.create

For more information, see the IAM documentation.

DeleteArtifact

rpc DeleteArtifact(DeleteArtifactRequest) returns (Operation)

Deletes an Artifact.

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.artifacts.delete

For more information, see the IAM documentation.

DeleteContext

rpc DeleteContext(DeleteContextRequest) returns (Operation)

Deletes a stored Context.

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.contexts.delete

For more information, see the IAM documentation.

DeleteExecution

rpc DeleteExecution(DeleteExecutionRequest) returns (Operation)

Deletes an Execution.

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.executions.delete

For more information, see the IAM documentation.

DeleteMetadataStore

rpc DeleteMetadataStore(