blob: 1f519c2c23ca31254422aba8522d3dcbe30e239e [file] [log] [blame]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="aiplatform_v1beta1.html">Vertex AI API</a> . <a href="aiplatform_v1beta1.projects.html">projects</a> . <a href="aiplatform_v1beta1.projects.locations.html">locations</a> . <a href="aiplatform_v1beta1.projects.locations.migratableResources.html">migratableResources</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="aiplatform_v1beta1.projects.locations.migratableResources.operations.html">operations()</a></code>
</p>
<p class="firstline">Returns the operations Resource.</p>
<p class="toc_element">
<code><a href="#batchMigrate">batchMigrate(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Batch migrates resources from ml.googleapis.com, automl.googleapis.com, and datalabeling.googleapis.com to Vertex AI.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#search">search(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">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.</p>
<p class="toc_element">
<code><a href="#search_next">search_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="batchMigrate">batchMigrate(parent, body=None, x__xgafv=None)</code>
<pre>Batch migrates resources from ml.googleapis.com, automl.googleapis.com, and datalabeling.googleapis.com to Vertex AI.
Args:
parent: string, Required. The location of the migrated resource will live in. Format: `projects/{project}/locations/{location}` (required)
body: object, The request body.
The object takes the form of:
{ # Request message for MigrationService.BatchMigrateResources.
&quot;migrateResourceRequests&quot;: [ # Required. The request messages specifying the resources to migrate. They must be in the same location as the destination. Up to 50 resources can be migrated in one batch.
{ # Config of migrating one resource from automl.googleapis.com, datalabeling.googleapis.com and ml.googleapis.com to Vertex AI.
&quot;migrateAutomlDatasetConfig&quot;: { # Config for migrating Dataset in automl.googleapis.com to Vertex AI&#x27;s Dataset. # Config for migrating Dataset in automl.googleapis.com to Vertex AI&#x27;s Dataset.
&quot;dataset&quot;: &quot;A String&quot;, # Required. Full resource name of automl Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}`.
&quot;datasetDisplayName&quot;: &quot;A String&quot;, # Required. Display name of the Dataset in Vertex AI. System will pick a display name if unspecified.
},
&quot;migrateAutomlModelConfig&quot;: { # Config for migrating Model in automl.googleapis.com to Vertex AI&#x27;s Model. # Config for migrating Model in automl.googleapis.com to Vertex AI&#x27;s Model.
&quot;model&quot;: &quot;A String&quot;, # Required. Full resource name of automl Model. Format: `projects/{project}/locations/{location}/models/{model}`.
&quot;modelDisplayName&quot;: &quot;A String&quot;, # Optional. Display name of the model in Vertex AI. System will pick a display name if unspecified.
},
&quot;migrateDataLabelingDatasetConfig&quot;: { # Config for migrating Dataset in datalabeling.googleapis.com to Vertex AI&#x27;s Dataset. # Config for migrating Dataset in datalabeling.googleapis.com to Vertex AI&#x27;s Dataset.
&quot;dataset&quot;: &quot;A String&quot;, # Required. Full resource name of data labeling Dataset. Format: `projects/{project}/datasets/{dataset}`.
&quot;datasetDisplayName&quot;: &quot;A String&quot;, # Optional. Display name of the Dataset in Vertex AI. System will pick a display name if unspecified.
&quot;migrateDataLabelingAnnotatedDatasetConfigs&quot;: [ # Optional. Configs for migrating AnnotatedDataset in datalabeling.googleapis.com to Vertex AI&#x27;s SavedQuery. The specified AnnotatedDatasets have to belong to the datalabeling Dataset.
{ # Config for migrating AnnotatedDataset in datalabeling.googleapis.com to Vertex AI&#x27;s SavedQuery.
&quot;annotatedDataset&quot;: &quot;A String&quot;, # Required. Full resource name of data labeling AnnotatedDataset. Format: `projects/{project}/datasets/{dataset}/annotatedDatasets/{annotated_dataset}`.
},
],
},
&quot;migrateMlEngineModelVersionConfig&quot;: { # Config for migrating version in ml.googleapis.com to Vertex AI&#x27;s Model. # Config for migrating Version in ml.googleapis.com to Vertex AI&#x27;s Model.
&quot;endpoint&quot;: &quot;A String&quot;, # Required. The ml.googleapis.com endpoint that this model version should be migrated from. Example values: * ml.googleapis.com * us-centrall-ml.googleapis.com * europe-west4-ml.googleapis.com * asia-east1-ml.googleapis.com
&quot;modelDisplayName&quot;: &quot;A String&quot;, # Required. Display name of the model in Vertex AI. System will pick a display name if unspecified.
&quot;modelVersion&quot;: &quot;A String&quot;, # Required. Full resource name of ml engine model version. Format: `projects/{project}/models/{model}/versions/{version}`.
},
},
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
&quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
&quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
&quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
],
&quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
&quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
&quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
&quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="search">search(parent, body=None, x__xgafv=None)</code>
<pre>Searches all of the resources in automl.googleapis.com, datalabeling.googleapis.com and ml.googleapis.com that can be migrated to Vertex AI&#x27;s given location.
Args:
parent: string, Required. The location that the migratable resources should be searched from. It&#x27;s the Vertex AI location that the resources can be migrated to, not the resources&#x27; original location. Format: `projects/{project}/locations/{location}` (required)
body: object, The request body.
The object takes the form of:
{ # Request message for MigrationService.SearchMigratableResources.
&quot;filter&quot;: &quot;A String&quot;, # 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: * `ml_engine_model_version:*` * `automl_model:*` * `automl_dataset:*` * `data_labeling_dataset:*` * &quot;Migrated or not&quot; filters. The following strings filter for resources that either have or have not already been migrated: * `last_migrate_time:*` filters for migrated resources. * `NOT last_migrate_time:*` filters for not yet migrated resources.
&quot;pageSize&quot;: 42, # The standard page size. The default and maximum value is 100.
&quot;pageToken&quot;: &quot;A String&quot;, # The standard page token.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for MigrationService.SearchMigratableResources.
&quot;migratableResources&quot;: [ # All migratable resources that can be migrated to the location specified in the request.
{ # Represents one resource that exists in automl.googleapis.com, datalabeling.googleapis.com or ml.googleapis.com.
&quot;automlDataset&quot;: { # Represents one Dataset in automl.googleapis.com. # Output only. Represents one Dataset in automl.googleapis.com.
&quot;dataset&quot;: &quot;A String&quot;, # Full resource name of automl Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}`.
&quot;datasetDisplayName&quot;: &quot;A String&quot;, # The Dataset&#x27;s display name in automl.googleapis.com.
},
&quot;automlModel&quot;: { # Represents one Model in automl.googleapis.com. # Output only. Represents one Model in automl.googleapis.com.
&quot;model&quot;: &quot;A String&quot;, # Full resource name of automl Model. Format: `projects/{project}/locations/{location}/models/{model}`.
&quot;modelDisplayName&quot;: &quot;A String&quot;, # The Model&#x27;s display name in automl.googleapis.com.
},
&quot;dataLabelingDataset&quot;: { # Represents one Dataset in datalabeling.googleapis.com. # Output only. Represents one Dataset in datalabeling.googleapis.com.
&quot;dataLabelingAnnotatedDatasets&quot;: [ # The migratable AnnotatedDataset in datalabeling.googleapis.com belongs to the data labeling Dataset.
{ # Represents one AnnotatedDataset in datalabeling.googleapis.com.
&quot;annotatedDataset&quot;: &quot;A String&quot;, # Full resource name of data labeling AnnotatedDataset. Format: `projects/{project}/datasets/{dataset}/annotatedDatasets/{annotated_dataset}`.
&quot;annotatedDatasetDisplayName&quot;: &quot;A String&quot;, # The AnnotatedDataset&#x27;s display name in datalabeling.googleapis.com.
},
],
&quot;dataset&quot;: &quot;A String&quot;, # Full resource name of data labeling Dataset. Format: `projects/{project}/datasets/{dataset}`.
&quot;datasetDisplayName&quot;: &quot;A String&quot;, # The Dataset&#x27;s display name in datalabeling.googleapis.com.
},
&quot;lastMigrateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when the last migration attempt on this MigratableResource started. Will not be set if there&#x27;s no migration attempt on this MigratableResource.
&quot;lastUpdateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this MigratableResource was last updated.
&quot;mlEngineModelVersion&quot;: { # Represents one model Version in ml.googleapis.com. # Output only. Represents one Version in ml.googleapis.com.
&quot;endpoint&quot;: &quot;A String&quot;, # 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
&quot;version&quot;: &quot;A String&quot;, # Full resource name of ml engine model Version. Format: `projects/{project}/models/{model}/versions/{version}`.
},
},
],
&quot;nextPageToken&quot;: &quot;A String&quot;, # The standard next-page token. The migratable_resources may not fill page_size in SearchMigratableResourcesRequest even when there are subsequent pages.
}</pre>
</div>
<div class="method">
<code class="details" id="search_next">search_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call &#x27;execute()&#x27; on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>