Method: projects.locations.migratableResources.search

Searches all of the resources in automl.googleapis.com, datalabeling.googleapis.com and ml.googleapis.com that can be migrated to Vertex AI's given location.

HTTP request

POST https://{service-endpoint}/v1/{parent}/migratableResources:search

Where {service-endpoint} is one of the supported service endpoints.

Path parameters

Parameters
parent

string

Required. The location that the migratable resources should be searched from. It's the Vertex AI location that the resources can be migrated to, not the resources' original location. Format: projects/{project}/locations/{location}

Request body

The request body contains data with the following structure:

JSON representation 
{
  "pageSize": integer,
  "pageToken": string,
  "filter": string
}
Fields
pageSize

integer

The standard page size. The default and maximum value is 100.
pageToken

string

The standard page token.
filter

string

A filter for your search. You can use the following types of filters:

  • Resource type filters. The following strings filter for a specific type of MigratableResource:
    • mlEngineModelVersion:*
    • automlModel:*
    • automlDataset:*
    • dataLabelingDataset:*
  • "Migrated or not" filters. The following strings filter for resources that either have or have not already been migrated:
    • lastMigrateTime:* filters for migrated resources.
    • NOT lastMigrateTime:* filters for not yet migrated resources.

Response body

Response message for MigrationService.SearchMigratableResources.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "migratableResources": [
    {
      object (MigratableResource)
    }
  ],
  "nextPageToken": string
}
Fields
migratableResources[]

object (MigratableResource)

All migratable resources that can be migrated to the location specified in the request.
nextPageToken

string

The standard next-page token. The migratableResources may not fill pageSize in SearchMigratableResourcesRequest even when there are subsequent pages.

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.migratableResources.search

For more information, see the IAM documentation.

MigratableResource

Represents one resource that exists in automl.googleapis.com, datalabeling.googleapis.com or ml.googleapis.com.

JSON representation 
{
  "lastMigrateTime": string,
  "lastUpdateTime": string,

  // Union field resource can be only one of the following:
  "mlEngineModelVersion": {
    object (MlEngineModelVersion)
  },
  "automlModel": {
    object (AutomlModel)
  },
  "automlDataset": {
    object (AutomlDataset)
  },
  "dataLabelingDataset": {
    object (DataLabelingDataset)
  }
  // End of list of possible types for union field resource.
}
Fields
lastMigrateTime

string (Timestamp format)

Output only. timestamp when the last migration attempt on this MigratableResource started. Will not be set if there's no migration attempt on this MigratableResource.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
lastUpdateTime

string (Timestamp format)

Output only. timestamp when this MigratableResource was last updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

Union field resource.

resource can be only one of the following:
mlEngineModelVersion

object (MlEngineModelVersion)

Output only. Represents one Version in ml.googleapis.com.
automlModel

object (AutomlModel)

Output only. Represents one Model in automl.googleapis.com.
automlDataset

object (AutomlDataset)

Output only. Represents one Dataset in automl.googleapis.com.
dataLabelingDataset

object (DataLabelingDataset)

Output only. Represents one Dataset in datalabeling.googleapis.com.

MlEngineModelVersion

Represents one model Version in ml.googleapis.com.

JSON representation 
{
  "endpoint": string,
  "version": string
}
Fields
endpoint

string

The ml.googleapis.com endpoint that this model Version currently lives in. Example values:

  • ml.googleapis.com
  • us-centrall-ml.googleapis.com
  • europe-west4-ml.googleapis.com
  • asia-east1-ml.googleapis.com
version

string

Full resource name of ml engine model Version. Format: projects/{project}/models/{model}/versions/{version}.

AutomlModel

Represents one Model in automl.googleapis.com.

JSON representation 
{
  "model": string,
  "modelDisplayName": string
}
Fields
model

string

Full resource name of automl Model. Format: projects/{project}/locations/{location}/models/{model}.
modelDisplayName

string

The Model's display name in automl.googleapis.com.

AutomlDataset

Represents one Dataset in automl.googleapis.com.

JSON representation 
{
  "dataset": string,
  "datasetDisplayName": string
}
Fields
dataset

string

Full resource name of automl Dataset. Format: projects/{project}/locations/{location}/datasets/{dataset}.
datasetDisplayName

string

The Dataset's display name in automl.googleapis.com.

DataLabelingDataset

Represents one Dataset in datalabeling.googleapis.com.

JSON representation 
{
  "dataset": string,
  "datasetDisplayName": string,
  "dataLabelingAnnotatedDatasets": [
    {
      object (DataLabelingAnnotatedDataset)
    }
  ]
}
Fields
dataset

string

Full resource name of data labeling Dataset. Format: projects/{project}/datasets/{dataset}.
datasetDisplayName

string

The Dataset's display name in datalabeling.googleapis.com.
dataLabelingAnnotatedDatasets[]

object (DataLabelingAnnotatedDataset)

The migratable AnnotatedDataset in datalabeling.googleapis.com belongs to the data labeling Dataset.

DataLabelingAnnotatedDataset

Represents one AnnotatedDataset in datalabeling.googleapis.com.

JSON representation 
{
  "annotatedDataset": string,
  "annotatedDatasetDisplayName": string
}
Fields
annotatedDataset

string

Full resource name of data labeling AnnotatedDataset. Format: projects/{project}/datasets/{dataset}/annotatedDatasets/{annotatedDataset}.
annotatedDatasetDisplayName

string

The AnnotatedDataset's display name in datalabeling.googleapis.com.