Package google.cloud.aiplatform.v1beta1

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.

FeaturestoreOnlineServingService

A service for serving online feature values.

ReadFeatureValues

rpc ReadFeatureValues(ReadFeatureValuesRequest) returns (ReadFeatureValuesResponse)

Reads Feature values of a specific entity of an EntityType. For reading feature values of multiple entities of an EntityType, please use StreamingReadFeatureValues.

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

  • aiplatform.entityTypes.readFeatureValues

For more information, see the IAM documentation.

StreamingReadFeatureValues

rpc StreamingReadFeatureValues(StreamingReadFeatureValuesRequest) returns (ReadFeatureValuesResponse)

Reads Feature values for multiple entities. Depending on their size, data for different entities may be broken up across multiple responses.

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

  • aiplatform.entityTypes.streamingReadFeatureValues

For more information, see the IAM documentation.

FeaturestoreService

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

BatchCreateFeatures

rpc BatchCreateFeatures(BatchCreateFeaturesRequest) returns (Operation)

Creates a batch of Features in a given EntityType.

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.

BatchReadFeatureValues

rpc BatchReadFeatureValues(BatchReadFeatureValuesRequest) returns (Operation)

Batch reads Feature values from a Featurestore.

This API enables batch reading Feature values, where each read instance in the batch may read Feature values of entities from one or more EntityTypes. Point-in-time correctness is guaranteed for Feature values of each read instance as of each instance's read timestamp.

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

  • aiplatform.featurestores.batchReadFeatureValues

For more information, see the IAM documentation.

CreateEntityType

rpc CreateEntityType(CreateEntityTypeRequest) returns (Operation)

Creates a new EntityType in a given Featurestore.

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

For more information, see the IAM documentation.

CreateFeature

rpc CreateFeature(CreateFeatureRequest) returns (Operation)

Creates a new Feature in a given EntityType.

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.

CreateFeaturestore

rpc CreateFeaturestore(CreateFeaturestoreRequest) returns (Operation)

Creates a new Featurestore 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.featurestores.create

For more information, see the IAM documentation.

DeleteEntityType

rpc DeleteEntityType(DeleteEntityTypeRequest) returns (Operation)

Deletes a single EntityType. The EntityType must not have any Features or force must be set to true for the request to succeed.

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

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.

DeleteFeaturestore

rpc DeleteFeaturestore(DeleteFeaturestoreRequest) returns (Operation)

Deletes a single Featurestore. The Featurestore must not contain any EntityTypes or force must be set to true for the request to succeed.

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

For more information, see the IAM documentation.

ExportFeatureValues

rpc ExportFeatureValues(ExportFeatureValuesRequest) returns (Operation)

Exports Feature values from all the entities of a target EntityType.

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

  • aiplatform.entityTypes.exportFeatureValues

For more information, see the IAM documentation.

GetEntityType

rpc GetEntityType(GetEntityTypeRequest) returns (EntityType)

Gets details of a single EntityType.

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

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 IAM permission on the name resource:

  • aiplatform.features.get

For more information, see the IAM documentation.

GetFeaturestore

rpc GetFeaturestore(GetFeaturestoreRequest) returns (Featurestore)

Gets details of a single Featurestore.

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

For more information, see the IAM documentation.

ImportFeatureValues

rpc ImportFeatureValues(ImportFeatureValuesRequest) returns (Operation)

Imports Feature values into the Featurestore from a source storage.

The progress of the import is tracked by the returned operation. The imported features are guaranteed to be visible to subsequent read operations after the operation is marked as successfully done.

If an import operation fails, the Feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same import request again and wait till the new operation returned is marked as successfully done.

There are also scenarios where the caller can cause inconsistency.

  • Source data for import contains multiple distinct Feature values for the same entity ID and timestamp.
  • Source is modified during an import. This includes adding, updating, or removing source data and/or metadata. Examples of updating metadata include but are not limited to changing storage location, storage class, or retention policy.
  • Online serving cluster is under-provisioned.
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 entityType resource:

  • aiplatform.entityTypes.importFeatureValues

For more information, see the IAM documentation.

ListEntityTypes

rpc ListEntityTypes(ListEntityTypesRequest) returns (ListEntityTypesResponse)

Lists EntityTypes in a given Featurestore.

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.entityTypes.list

For more information, see the IAM documentation.

ListFeatures

rpc ListFeatures(ListFeaturesRequest) returns (ListFeaturesResponse)

Lists Features in a given EntityType.

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

For more information, see the IAM documentation.

ListFeaturestores

rpc ListFeaturestores(ListFeaturestoresRequest) returns (ListFeaturestoresResponse)

Lists Featurestores 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.featurestores.list

For more information, see the IAM documentation.

SearchFeatures

rpc SearchFeatures(SearchFeaturesRequest) returns (SearchFeaturesResponse)

Searches Features matching a query in a given project.

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

  • aiplatform.features.list

For more information, see the IAM documentation.

UpdateEntityType

rpc UpdateEntityType(UpdateEntityTypeRequest) returns (EntityType)

Updates the parameters of a single EntityType.

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

For more information, see the IAM documentation.

UpdateFeature

rpc UpdateFeature(UpdateFeatureRequest) returns (Feature)

Updates the parameters 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 IAM permission on the name resource:

  • aiplatform.features.update

For more information, see the IAM documentation.

UpdateFeaturestore

rpc UpdateFeaturestore(UpdateFeaturestoreRequest) returns (Operation)

Updates the parameters of a single Featurestore.

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

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(